1 .\" Copyright (c) 1992, 2001 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
11 etags, ctags \- generate tag file for Emacs, vi
15 \fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
17 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
18 [\|\-\-parse\-stdin=\fIfile\fP\|]
20 [\|\-\-append\|] [\|\-\-no\-defines\|]
21 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
22 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
23 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
24 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
25 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
26 [\|\-\-help\|] [\|\-\-version\|]
29 \fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
31 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
32 [\|\-\-parse\-stdin=\fIfile\fP\|]
34 [\|\-\-append\|] [\|\-\-backward\-search\|]
35 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
36 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
37 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
38 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
39 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
40 [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
41 [\|\-\-update\|] [\|\-\-no\-warn\|]
42 [\|\-\-help\|] [\|\-\-version\|]
47 The \|\fBetags\fP\| program is used to create a tag table file, in a format
50 \&; the \|\fBctags\fP\| program is used to create a similar table in a
53 \&. Both forms of the program understand
54 the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
55 LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript,
56 Python, Prolog, Scheme and
57 most assembler\-like syntaxes.
58 Both forms read the files specified on the command line, and write a tag
59 table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
60 \fBctags\fP) in the current working directory.
61 Files specified with relative file names will be recorded in the tag
62 table with file names relative to the directory where the tag table
63 resides. Files specified with absolute file names will be recorded
64 with absolute file names. Files generated from a source file\-\-like
65 a C file generated from a source Cweb file\-\-will be recorded with
66 the name of the source file.
67 The programs recognize the language used in an input file based on its
68 file name and contents. The \fB\-\-language\fP switch can be used to force
69 parsing of the file names following the switch according to the given
70 language, overriding guesses based on filename extensions.
72 Some options make sense only for the \fBvi\fP style tag files produced
74 \fBetags\fP does not recognize them.
75 The programs accept unambiguous abbreviations for long option names.
78 Append to existing tag file. (For \fBvi\fP-format tag files, see also
81 .B \-B, \-\-backward\-search
82 Tag files written in the format expected by \fBvi\fP contain regular
83 expression search instructions; the \fB\-B\fP option writes them using
84 the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files.
85 The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP
87 Only \fBctags\fP accepts this option.
90 In C and derived languages, create tags for function declarations,
91 and create tags for extern variables unless \-\-no\-globals is used.
94 Create tag entries for C preprocessor constant definitions
95 and enum constants, too. This is the
96 default behavior for \fBetags\fP.
98 .B \-D, \-\-no\-defines
99 Do not create tag entries for C preprocessor constant definitions
101 This may make the tags file much smaller if many header files are tagged.
102 This is the default behavior for \fBctags\fP.
105 Create tag entries for global variables in C, C++, Objective C, Java,
107 This is the default behavior for \fBetags\fP.
109 .B \-G, \-\-no\-globals
110 Do not tag global variables. Typically this reduces the file size by
111 one fourth. This is the default behavior for \fBctags\fP.
113 \fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP
114 Include a note in the tag file indicating that, when searching for a
115 tag, one should also consult the tags file \fIfile\fP after checking the
116 current file. This options is only accepted by \fBetags\fP.
118 .B \-I, \-\-ignore\-indentation
119 Don't rely on indentation as much as we normally do. Currently, this
120 means not to assume that a closing brace in the first column is the
121 final brace of a function or structure definition in C and C++.
123 \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP
124 Parse the following files according to the given language. More than
125 one such options may be intermixed with filenames. Use \fB\-\-help\fP
126 to get a list of the available languages and their default filename
127 extensions. The `auto' language can be used to restore automatic
128 detection of language based on the file name. The `none'
129 language may be used to disable language parsing altogether; only
130 regexp matching is done in this case (see the \fB\-\-regex\fP option).
133 Create tag entries for variables that are members of structure-like
134 constructs in C++, Objective C, Java.
136 .B \-M, \-\-no\-members
137 Do not tag member variables. This is the default behavior.
139 .B \-\-packages\-only
140 Only tag packages in Ada files.
142 \fB\-\-parse\-stdin=\fIfile\fP
143 May be used (only once) in place of a file name on the command line.
144 \fBetags\fP will read from standard input and mark the produced tags
145 as belonging to the file \fBFILE\fP.
147 \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP
148 Explicit name of file for tag table; overrides default \fBTAGS\fP or
149 \fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.)
151 \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP
153 \fB\-\-ignore\-case\-regex=\fIregexp\fP
154 Make tags based on regexp matching for each line of the files
155 following this option, in addition to the tags made with the standard
156 parsing based on language. When using \fB\-\-regex\fP, case is
157 significant, while it is not with \fB\-\-ignore\-case\-regex\fP. May
158 be freely intermixed with filenames and the \fB\-R\fP option. The
159 regexps are cumulative, i.e. each option will add to the previous
160 ones. The regexps are of the form:
162 \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP
165 where \fItagregexp\fP is used to match the lines that must be tagged.
166 It should not match useless characters. If the match is
167 such that more characters than needed are unavoidably matched by
168 \fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to
169 narrow down the tag scope. \fBctags\fP ignores regexps without a
170 \fInameregexp\fP. The syntax of regexps is the same as in emacs.
171 The following character escape sequences are supported:
172 \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v.
175 Here are some examples. All the regexps are quoted to protect them
176 from shell interpretation.
179 Tag the DEFVAR macros in the emacs source files:
181 \fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"\/'\fP
182 .\"" This comment is to avoid confusion to Emacs syntax highlighting
185 Tag VHDL files (this example is a single long line, broken here for
188 \fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\
189 CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\
190 \\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\
191 \\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP
194 Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
196 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP
199 A regexp can be preceded by {\fIlang\fP}, thus restricting it to match
200 lines of files of the specified language. Use \fBetags --help\fP to obtain
201 a list of the recognised languages. This feature is particularly useful inside
202 \fBregex files\fP. A regex file contains one regex per line. Empty lines,
203 and those lines beginning with space or tab are ignored. Lines beginning
204 with @ are references to regex files whose name follows the @ sign. Other
205 lines are considered regular expressions like those following \fB\-\-regex\fP.
207 For example, the command
209 \fIetags \-\-regex=@regex.file *.c\fP
211 reads the regexes contained in the file regex.file.
213 .B \-R, \-\-no\-regex
214 Don't do any more regexp matching on the following files. May be
215 freely intermixed with filenames and the \fB\-\-regex\fP option.
218 Record typedefs in C code as tags. Since this is the default behaviour
219 of \fBetags\fP, only \fBctags\fP accepts this option.
221 .B \-T, \-\-typedefs\-and\-c++
222 Generate tag entries for typedefs, struct, enum, and union tags, and
223 C++ member functions. Since this is the default behaviour
224 of \fBetags\fP, only \fBctags\fP accepts this option.
227 Update tag entries for \fIfiles\fP specified on command line, leaving
228 tag entries for other files in place. Currently, this is implemented
229 by deleting the existing entries for the given files and then
230 rewriting the new entries at the end of the tags file. It is often
231 faster to simply rebuild the entire tag file than to use this.
232 Only \fBctags\fP accepts this option.
235 Instead of generating a tag file, write index (in \fBvgrind\fP format)
236 to standard output. Only \fBctags\fP accepts this option.
239 Suppress warning messages about duplicate entries. The \fBetags\fP
240 program does not check for duplicate entries, so this option is not
244 Instead of generating a tag file, write a cross reference (in
245 \fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option.
247 .B \-h, \-H, \-\-help
248 Print usage information.
251 Print the current version of the program (same as the version of the
252 emacs \fBetags\fP is shipped with).
255 `\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard
267 1999, 2001 Free Software Foundation, Inc.
269 Permission is granted to make and distribute verbatim copies of this
270 document provided the copyright notice and this permission notice are
271 preserved on all copies.
273 Permission is granted to copy and distribute modified versions of
274 this document under the conditions for verbatim copying, provided that
275 the entire resulting derived work is distributed under the terms of
276 a permission notice identical to this one.
278 Permission is granted to copy and distribute translations of this
279 document into another language, under the above conditions for
280 modified versions, except that this permission notice may be stated
281 in a translation approved by the Free Software Foundation.