Mercurial > emacs
annotate etc/etags.1 @ 45262:780424a19a2b
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Mon, 13 May 2002 00:05:02 +0000 |
parents | 96f84561b0ab |
children | b359c7c3e1cb |
rev | line source |
---|---|
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
1 .\" Copyright (c) 1992, 2001 Free Software Foundation |
25853 | 2 .\" See section COPYING for conditions for redistribution |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
3 .TH etags 1 "23nov2001" "GNU Tools" "GNU Tools" |
25853 | 4 .de BP |
5 .sp | |
6 .ti -.2i | |
7 \(** | |
8 .. | |
9 | |
10 .SH NAME | |
11 etags, ctags \- generate tag file for Emacs, vi | |
12 .SH SYNOPSIS | |
13 .hy 0 | |
14 .na | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
15 \fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
16 .if n .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
17 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] |
25853 | 18 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
19 [\|\-\-append\|] [\|\-\-no\-defines\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
20 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
21 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
22 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
23 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
24 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
25 [\|\-\-help\|] [\|\-\-version\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
26 \fIfile\fP .\|.\|. |
25853 | 27 |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
28 \fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
29 .if n .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
30 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] |
25853 | 31 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
32 [\|\-\-append\|] [\|\-\-backward\-search\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
33 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
34 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
35 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
36 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
37 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
38 [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
39 [\|\-\-update\|] [\|\-\-no\-warn\|] |
25853 | 40 [\|\-\-help\|] [\|\-\-version\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
41 \fIfile\fP .\|.\|. |
25853 | 42 .ad b |
43 .hy 1 | |
44 .SH DESCRIPTION | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
45 The \|\fBetags\fP\| program is used to create a tag table file, in a format |
25853 | 46 understood by |
47 .BR emacs ( 1 )\c | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
48 \&; the \|\fBctags\fP\| program is used to create a similar table in a |
25853 | 49 format understood by |
50 .BR vi ( 1 )\c | |
51 \&. Both forms of the program understand | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
52 the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, |
42043
0fe5fe39786c
Etags changes for Prolog and PHP.
Francesco Potortì <pot@gnu.org>
parents:
41397
diff
changeset
|
53 LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript, |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
54 Python, Prolog, Scheme and |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
55 most assembler\-like syntaxes. |
25853 | 56 Both forms read the files specified on the command line, and write a tag |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
57 table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for |
25853 | 58 \fBctags\fP) in the current working directory. |
59 Files specified with relative file names will be recorded in the tag | |
60 table with file names relative to the directory where the tag table | |
61 resides. Files specified with absolute file names will be recorded | |
43874
96f84561b0ab
Use Cweb as an example, not Yacc.
Francesco Potortì <pot@gnu.org>
parents:
43724
diff
changeset
|
62 with absolute file names. Files generated from a source file\-\-like |
96f84561b0ab
Use Cweb as an example, not Yacc.
Francesco Potortì <pot@gnu.org>
parents:
43724
diff
changeset
|
63 a C file generated from a source Cweb file\-\-will be recorded with |
96f84561b0ab
Use Cweb as an example, not Yacc.
Francesco Potortì <pot@gnu.org>
parents:
43724
diff
changeset
|
64 the name of the source file. |
25853 | 65 The programs recognize the language used in an input file based on its |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
66 file name and contents. The \fB\-\-language\fP switch can be used to force |
25853 | 67 parsing of the file names following the switch according to the given |
68 language, overriding guesses based on filename extensions. | |
69 .SH OPTIONS | |
70 Some options make sense only for the \fBvi\fP style tag files produced | |
71 by ctags; | |
72 \fBetags\fP does not recognize them. | |
73 The programs accept unambiguous abbreviations for long option names. | |
74 .TP | |
75 .B \-a, \-\-append | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
76 Append to existing tag file. (For \fBvi\fP-format tag files, see also |
25853 | 77 \fB\-\-update\fP.) |
78 .TP | |
79 .B \-B, \-\-backward\-search | |
80 Tag files written in the format expected by \fBvi\fP contain regular | |
81 expression search instructions; the \fB\-B\fP option writes them using | |
82 the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files. | |
83 The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP | |
84 through files. | |
85 Only \fBctags\fP accepts this option. | |
86 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
87 .B \-\-declarations |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
88 In C and derived languages, create tags for function declarations, |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
89 and create tags for extern variables unless \-\-no\-globals is used. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
90 .TP |
25853 | 91 .B \-d, \-\-defines |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
92 Create tag entries for C preprocessor constant definitions |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
93 and enum constants, too. This is the |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
94 default behavior for \fBetags\fP. |
25853 | 95 .TP |
96 .B \-D, \-\-no\-defines | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
97 Do not create tag entries for C preprocessor constant definitions |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
98 and enum constants. |
25853 | 99 This may make the tags file much smaller if many header files are tagged. |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
100 This is the default behavior for \fBctags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
101 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
102 .B \-g, \-\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
103 Create tag entries for global variables in C, C++, Objective C, Java, |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
104 and Perl. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
105 This is the default behavior for \fBetags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
106 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
107 .B \-G, \-\-no\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
108 Do not tag global variables. Typically this reduces the file size by |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
109 one fourth. This is the default behavior for \fBctags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
110 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
111 \fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
112 Include a note in the tag file indicating that, when searching for a |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
113 tag, one should also consult the tags file \fIfile\fP after checking the |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
114 current file. This options is only accepted by \fBetags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
115 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
116 .B \-I, \-\-ignore\-indentation |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
117 Don't rely on indentation as much as we normally do. Currently, this |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
118 means not to assume that a closing brace in the first column is the |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
119 final brace of a function or structure definition in C and C++. |
25853 | 120 .TP |
121 \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP | |
122 Parse the following files according to the given language. More than | |
123 one such options may be intermixed with filenames. Use \fB\-\-help\fP | |
124 to get a list of the available languages and their default filename | |
125 extensions. The `auto' language can be used to restore automatic | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
126 detection of language based on the file name. The `none' |
25853 | 127 language may be used to disable language parsing altogether; only |
128 regexp matching is done in this case (see the \fB\-\-regex\fP option). | |
129 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
130 .B \-m, \-\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
131 Create tag entries for variables that are members of structure-like |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
132 constructs in C++, Objective C, Java. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
133 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
134 .B \-M, \-\-no\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
135 Do not tag member variables. This is the default behavior. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
136 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
137 .B \-\-packages\-only |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
138 Only tag packages in Ada files. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
139 .TP |
25853 | 140 \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
141 Explicit name of file for tag table; overrides default \fBTAGS\fP or |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
142 \fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) |
25853 | 143 .TP |
144 \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
145 .TP |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
146 \fB\-\-ignore\-case\-regex=\fIregexp\fP |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
147 Make tags based on regexp matching for each line of the files |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
148 following this option, in addition to the tags made with the standard |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
149 parsing based on language. When using \fB\-\-regex\fP, case is |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
150 significant, while it is not with \fB\-\-ignore\-case\-regex\fP. May |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
151 be freely intermixed with filenames and the \fB\-R\fP option. The |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
152 regexps are cumulative, i.e. each option will add to the previous |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
153 ones. The regexps are of the form: |
25853 | 154 .br |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
155 \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP |
25853 | 156 .br |
157 | |
158 where \fItagregexp\fP is used to match the lines that must be tagged. | |
159 It should not match useless characters. If the match is | |
160 such that more characters than needed are unavoidably matched by | |
161 \fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to | |
162 narrow down the tag scope. \fBctags\fP ignores regexps without a | |
39760
5801481e337c
Remove out-of-date detail.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37784
diff
changeset
|
163 \fInameregexp\fP. The syntax of regexps is the same as in emacs. |
25853 | 164 .br |
165 Here are some examples. All the regexps are quoted to protect them | |
166 from shell interpretation. | |
167 .br | |
168 | |
169 Tag the DEFVAR macros in the emacs source files: | |
170 .br | |
171 \fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"\/'\fP | |
42043
0fe5fe39786c
Etags changes for Prolog and PHP.
Francesco Potortì <pot@gnu.org>
parents:
41397
diff
changeset
|
172 .\"" This comment is to avoid confusion to Emacs syntax highlighting |
25853 | 173 .br |
174 | |
175 Tag VHDL files (this example is a single long line, broken here for | |
176 formatting reasons): | |
177 .br | |
178 \fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\ | |
179 CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\ | |
180 \\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\ | |
181 \\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP | |
182 .br | |
183 | |
184 Tag TCL files (this last example shows the usage of a \fItagregexp\fP): | |
185 .br | |
186 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP | |
187 | |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
188 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
189 A regexp can be preceded by {\fIlang\fP}, thus restricting it to match |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
190 lines of files of the specified language. Use \fBetags --help\fP to obtain |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
191 a list of the recognised languages. This feature is particularly useful inside |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
192 \fBregex files\fP. A regex file contains one regex per line. Empty lines, |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
193 and those lines beginning with space or tab are ignored. Lines beginning |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
194 with @ are references to regex files whose name follows the @ sign. Other |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
195 lines are considered regular expressions like those following \fB\-\-regex\fP. |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
196 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
197 For example, the command |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
198 .br |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
199 \fIetags \-\-regex=@regex.file *.c\fP |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
200 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
201 reads the regexes contained in the file regex.file. |
25853 | 202 .TP |
203 .B \-R, \-\-no\-regex | |
204 Don't do any more regexp matching on the following files. May be | |
205 freely intermixed with filenames and the \fB\-\-regex\fP option. | |
206 .TP | |
207 .B \-t, \-\-typedefs | |
208 Record typedefs in C code as tags. Since this is the default behaviour | |
209 of \fBetags\fP, only \fBctags\fP accepts this option. | |
210 .TP | |
211 .B \-T, \-\-typedefs\-and\-c++ | |
212 Generate tag entries for typedefs, struct, enum, and union tags, and | |
213 C++ member functions. Since this is the default behaviour | |
214 of \fBetags\fP, only \fBctags\fP accepts this option. | |
215 .TP | |
216 .B \-u, \-\-update | |
217 Update tag entries for \fIfiles\fP specified on command line, leaving | |
218 tag entries for other files in place. Currently, this is implemented | |
219 by deleting the existing entries for the given files and then | |
220 rewriting the new entries at the end of the tags file. It is often | |
221 faster to simply rebuild the entire tag file than to use this. | |
222 Only \fBctags\fP accepts this option. | |
223 .TP | |
224 .B \-v, \-\-vgrind | |
225 Instead of generating a tag file, write index (in \fBvgrind\fP format) | |
226 to standard output. Only \fBctags\fP accepts this option. | |
227 .TP | |
228 .B \-w, \-\-no\-warn | |
229 Suppress warning messages about duplicate entries. The \fBetags\fP | |
230 program does not check for duplicate entries, so this option is not | |
231 allowed with it. | |
232 .TP | |
233 .B \-x, \-\-cxref | |
234 Instead of generating a tag file, write a cross reference (in | |
235 \fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option. | |
236 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
237 .B \-h, \-H, \-\-help |
25853 | 238 Print usage information. |
239 .TP | |
240 .B \-V, \-\-version | |
241 Print the current version of the program (same as the version of the | |
242 emacs \fBetags\fP is shipped with). | |
243 | |
244 .SH "SEE ALSO" | |
245 `\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard | |
246 Stallman. | |
247 .br | |
248 .BR cxref ( 1 ), | |
249 .BR emacs ( 1 ), | |
250 .BR vgrind ( 1 ), | |
251 .BR vi ( 1 ). | |
252 | |
253 .SH COPYING | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
254 Copyright |
37363 | 255 .if t \(co |
256 .if n (c) | |
257 1999, 2001 Free Software Foundation, Inc. | |
25853 | 258 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
259 Permission is granted to make and distribute verbatim copies of this |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
260 document provided the copyright notice and this permission notice are |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
261 preserved on all copies. |
25853 | 262 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
263 Permission is granted to copy and distribute modified versions of |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
264 this document under the conditions for verbatim copying, provided that |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
265 the entire resulting derived work is distributed under the terms of |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
266 a permission notice identical to this one. |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
267 .PP |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
268 Permission is granted to copy and distribute translations of this |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
269 document into another language, under the above conditions for |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
270 modified versions, except that this permission notice may be stated |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
271 in a translation approved by the Free Software Foundation. |