etags.1 11.7 KB
Newer Older
1
.\" Copyright (c) 1992, 2001 Free Software Foundation
Dave Love's avatar
#  
Dave Love committed
2
.\" See section COPYING for conditions for redistribution
Eli Zaretskii's avatar
Eli Zaretskii committed
3
.TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
Dave Love's avatar
#  
Dave Love committed
4 5 6 7 8 9 10 11 12 13 14
.de BP
.sp
.ti -.2i
\(**
..

.SH NAME
etags, ctags \- generate tag file for Emacs, vi
.SH SYNOPSIS
.hy 0
.na
15
\fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
16
.if n .br
17
[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
18
[\|\-\-parse\-stdin=\fIfile\fP\|]
19
.br
20
[\|\-\-append\|] [\|\-\-no\-defines\|]
21 22 23 24 25 26
[\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
[\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
[\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
[\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
[\|\-\-help\|] [\|\-\-version\|]
\fIfile\fP .\|.\|.
Dave Love's avatar
#  
Dave Love committed
27

28
\fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
29
.if n .br
30
[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
31
[\|\-\-parse\-stdin=\fIfile\fP\|]
32
.br
33
[\|\-\-append\|] [\|\-\-backward\-search\|]
34 35 36 37 38 39
[\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
[\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
[\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
[\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
[\|\-\-update\|] [\|\-\-no\-warn\|]
Dave Love's avatar
#  
Dave Love committed
40
[\|\-\-help\|] [\|\-\-version\|]
41
\fIfile\fP .\|.\|.
Dave Love's avatar
#  
Dave Love committed
42 43 44
.ad b
.hy 1
.SH DESCRIPTION
45
The \|\fBetags\fP\| program is used to create a tag table file, in a format
Dave Love's avatar
#  
Dave Love committed
46 47
understood by
.BR emacs ( 1 )\c
48
\&; the \|\fBctags\fP\| program is used to create a similar table in a
Dave Love's avatar
#  
Dave Love committed
49 50 51
format understood by
.BR vi ( 1 )\c
\&.  Both forms of the program understand
Francesco Potortì's avatar
Francesco Potortì committed
52
the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML,
53
LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript,
54
Python, Prolog, Scheme and
55
most assembler\-like syntaxes.
Dave Love's avatar
#  
Dave Love committed
56
Both forms read the files specified on the command line, and write a tag
57
table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
Dave Love's avatar
#  
Dave Love committed
58 59 60 61
\fBctags\fP) in the current working directory.
Files specified with relative file names will be recorded in the tag
table with file names relative to the directory where the tag table
resides.  Files specified with absolute file names will be recorded
62 63 64
with absolute file names.  Files generated from a source file\-\-like
a C file generated from a source Cweb file\-\-will be recorded with
the name of the source file.
Dave Love's avatar
#  
Dave Love committed
65
The programs recognize the language used in an input file based on its
66
file name and contents.  The \fB\-\-language\fP switch can be used to force
Dave Love's avatar
#  
Dave Love committed
67 68 69 70 71 72 73 74 75
parsing of the file names following the switch according to the given
language, overriding guesses based on filename extensions.
.SH OPTIONS
Some options make sense only for the \fBvi\fP style tag files produced
by ctags;
\fBetags\fP does not recognize them.
The programs accept unambiguous abbreviations for long option names.
.TP
.B \-a, \-\-append
76
Append to existing tag file.  (For \fBvi\fP-format tag files, see also
Dave Love's avatar
#  
Dave Love committed
77 78 79 80 81 82 83 84 85 86
\fB\-\-update\fP.)
.TP
.B \-B, \-\-backward\-search
Tag files written in the format expected by \fBvi\fP contain regular
expression search instructions; the \fB\-B\fP option writes them using
the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files.
The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP
through files.
Only \fBctags\fP accepts this option.
.TP
87 88 89 90
.B \-\-declarations
In C and derived languages, create tags for function declarations,
and create tags for extern variables unless \-\-no\-globals is used.
.TP
Dave Love's avatar
#  
Dave Love committed
91
.B \-d, \-\-defines
92 93 94
Create tag entries for C preprocessor constant definitions
and enum constants, too.  This is the
default behavior for \fBetags\fP.
Dave Love's avatar
#  
Dave Love committed
95 96
.TP
.B \-D, \-\-no\-defines
97 98
Do not create tag entries for C preprocessor constant definitions
and enum constants.
Dave Love's avatar
#  
Dave Love committed
99
This may make the tags file much smaller if many header files are tagged.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
This is the default behavior for \fBctags\fP.
.TP
.B \-g, \-\-globals
Create tag entries for global variables in C, C++, Objective C, Java,
and Perl.
This is the default behavior for \fBetags\fP.
.TP
.B \-G, \-\-no\-globals
Do not tag global variables.  Typically this reduces the file size by
one fourth.  This is the default behavior for \fBctags\fP.
.TP
\fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP
Include a note in the tag file indicating that, when searching for a
tag, one should also consult the tags file \fIfile\fP after checking the
current file.  This options is only accepted by \fBetags\fP.
.TP
.B \-I, \-\-ignore\-indentation
Don't rely on indentation as much as we normally do.  Currently, this
means not to assume that a closing brace in the first column is the
final brace of a function or structure definition in C and C++.
Dave Love's avatar
#  
Dave Love committed
120 121 122 123 124 125
.TP
\fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP
Parse the following files according to the given language.  More than
one such options may be intermixed with filenames.  Use \fB\-\-help\fP
to get a list of the available languages and their default filename
extensions.  The `auto' language can be used to restore automatic
126
detection of language based on the file name.  The `none'
Dave Love's avatar
#  
Dave Love committed
127 128 129
language may be used to disable language parsing altogether; only
regexp matching is done in this case (see the \fB\-\-regex\fP option).
.TP
130 131 132 133 134 135 136 137 138 139
.B \-m, \-\-members
Create tag entries for variables that are members of structure-like
constructs in C++, Objective C, Java.
.TP
.B \-M, \-\-no\-members
Do not tag member variables.  This is the default behavior.
.TP
.B \-\-packages\-only
Only tag packages in Ada files.
.TP
140 141
\fB\-\-parse\-stdin=\fIfile\fP
May be used (only once) in place of a file name on the command line.
Francesco Potortì's avatar
Francesco Potortì committed
142
\fBetags\fP will read from standard input and mark the produced tags
143 144
as belonging to the file \fBFILE\fP.
.TP
Dave Love's avatar
#  
Dave Love committed
145
\fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP
146 147
Explicit name of file for tag table; overrides default \fBTAGS\fP or
\fBtags\fP.   (But ignored with \fB\-v\fP or \fB\-x\fP.)
Dave Love's avatar
#  
Dave Love committed
148 149
.TP
\fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP
150 151 152 153 154

Make tags based on regexp matching for the files following this option,
in addition to the tags made with the standard parsing based on
language. May be freely intermixed with filenames and the \fB\-R\fP
option.  The regexps are cumulative, i.e. each such option will add to
155
the previous ones.  The regexps are of one of the forms:
Dave Love's avatar
#  
Dave Love committed
156
.br
157 158 159
	[\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP
.br
	\fB@\fP\fIregexfile\fP
Dave Love's avatar
#  
Dave Love committed
160 161
.br

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
where \fItagregexp\fP is used to match the tag.  It should not match
useless characters.  If the match is such that more characters than
needed are unavoidably matched by \fItagregexp\fP, it may be useful to
add a \fInameregexp\fP, to narrow down the tag scope.  \fBctags\fP
ignores regexps without a \fInameregexp\fP.  The syntax of regexps is
the same as in emacs.  The following character escape sequences are
supported: \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v, which
respectively stand for the ASCII characters BEL, BS, DEL, ESC, FF, NL,
CR, TAB, VT.
.br
The \fImodifiers\fP are a sequence of 0 or more characters among
\fIi\fP, which means to ignore case when matching; \fIm\fP, which means
that the \fItagregexp\fP will be matched against the whole file contents
at once, rather than line by line, and the matching sequence can match
multiple lines; and \fIs\fP, which implies \fIm\fP and means that the
dot character in \fItagregexp\fP matches the newline char as well.
178
.br
179 180 181 182 183 184 185
The separator, which is \fB/\fP in the examples, can be any character
different from space, tab, braces and \fB@\fP.  If the separator
character is needed inside the regular expression, it must be quoted
by preceding it with \fB\\\fP.
.br
The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag
should be
186 187 188 189
created only for files of language \fIlanguage\fP, and ignored
otherwise.  This is particularly useful when storing many predefined
regexps in a file.
.br
190 191 192
In its second form, \fIregexfile\fP is the name of a file that contains
a number of arguments to the \fI\-\-regex\=\fP option,
one per line.  Lines beginning with a space or tab are assumed
193
to be comments, and ignored.
194

Dave Love's avatar
#  
Dave Love committed
195 196 197 198 199 200 201 202
.br
Here are some examples.  All the regexps are quoted to protect them
from shell interpretation.
.br

Tag the DEFVAR macros in the emacs source files:
.br
\fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"\/'\fP
203
.\"" This comment is to avoid confusion to Emacs syntax highlighting
Dave Love's avatar
#  
Dave Love committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
.br

Tag VHDL files (this example is a single long line, broken here for
formatting reasons):
.br
\fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\
CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\
\\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\
\\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP
.br

Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
.br
\fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP

219
.br
220
A regexp can be preceded by {\fIlang\fP}, thus restricting it to match
221 222 223
lines of files of the specified language.  Use \fBetags --help\fP to obtain
a list of the recognised languages.  This feature is particularly useful inside
\fBregex files\fP.  A regex file contains one regex per line.  Empty lines,
224 225
and those lines beginning with space or tab are ignored.  Lines beginning
with @ are references to regex files whose name follows the @ sign.  Other
226
lines are considered regular expressions like those following \fB\-\-regex\fP.
227 228 229
.br
For example, the command
.br
230
\fIetags \-\-regex=@regex.file *.c\fP
231 232
.br
reads the regexes contained in the file regex.file.
Dave Love's avatar
#  
Dave Love committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
.TP
.B \-R, \-\-no\-regex
Don't do any more regexp matching on the following files.  May be
freely intermixed with filenames and the \fB\-\-regex\fP option.
.TP
.B \-t, \-\-typedefs
Record typedefs in C code as tags.  Since this is the default behaviour
of \fBetags\fP, only \fBctags\fP accepts this option.
.TP
.B \-T, \-\-typedefs\-and\-c++
Generate tag entries for typedefs, struct, enum, and union tags, and
C++ member functions.  Since this is the default behaviour
of \fBetags\fP, only \fBctags\fP accepts this option.
.TP
.B \-u, \-\-update
Update tag entries for \fIfiles\fP specified on command line, leaving
tag entries for other files in place.  Currently, this is implemented
by deleting the existing entries for the given files and then
rewriting the new entries at the end of the tags file.  It is often
faster to simply rebuild the entire tag file than to use this.
Only \fBctags\fP accepts this option.
.TP
.B \-v, \-\-vgrind
Instead of generating a tag file, write index (in \fBvgrind\fP format)
to standard output.  Only \fBctags\fP accepts this option.
.TP
.B \-w, \-\-no\-warn
Suppress warning messages about duplicate entries.  The \fBetags\fP
program does not check for duplicate entries, so this option is not
allowed with it.
.TP
.B \-x, \-\-cxref
Instead of generating a tag file, write a cross reference (in
\fBcxref\fP format) to standard output.  Only \fBctags\fP accepts this option.
.TP
268
.B \-h, \-H, \-\-help
Dave Love's avatar
#  
Dave Love committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
Print usage information.
.TP
.B \-V, \-\-version
Print the current version of the program (same as the version of the
emacs \fBetags\fP is shipped with).

.SH "SEE ALSO"
`\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard
Stallman.
.br
.BR cxref ( 1 ),
.BR emacs ( 1 ),
.BR vgrind ( 1 ),
.BR vi ( 1 ).

.SH COPYING
285
Copyright
Eli Zaretskii's avatar
Eli Zaretskii committed
286 287 288
.if t \(co
.if n (c)
1999, 2001 Free Software Foundation, Inc.
Dave Love's avatar
#  
Dave Love committed
289
.PP
Eli Zaretskii's avatar
Eli Zaretskii committed
290 291 292
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
preserved on all copies.
Dave Love's avatar
#  
Dave Love committed
293
.PP
Eli Zaretskii's avatar
Eli Zaretskii committed
294 295 296 297 298 299 300 301 302
Permission is granted to copy and distribute modified versions of
this document under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of
a permission notice identical to this one.
.PP
Permission is granted to copy and distribute translations of this
document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.