Mercurial > emacs
annotate etc/etags.1 @ 43030:90bce6424b8b
(hilit-chg-fixup): Don't alter overlay if not ours.
(hilit-chg-set-face-on-change): Rename arg.
(hilit-chg-make-ov): Detect error earlier.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 01 Feb 2002 04:17:59 +0000 |
parents | 0fe5fe39786c |
children | 16affaf7292b |
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 | |
62 with absolute file names. | |
63 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
|
64 file name and contents. The \fB\-\-language\fP switch can be used to force |
25853 | 65 parsing of the file names following the switch according to the given |
66 language, overriding guesses based on filename extensions. | |
67 .SH OPTIONS | |
68 Some options make sense only for the \fBvi\fP style tag files produced | |
69 by ctags; | |
70 \fBetags\fP does not recognize them. | |
71 The programs accept unambiguous abbreviations for long option names. | |
72 .TP | |
73 .B \-a, \-\-append | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
74 Append to existing tag file. (For \fBvi\fP-format tag files, see also |
25853 | 75 \fB\-\-update\fP.) |
76 .TP | |
77 .B \-B, \-\-backward\-search | |
78 Tag files written in the format expected by \fBvi\fP contain regular | |
79 expression search instructions; the \fB\-B\fP option writes them using | |
80 the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files. | |
81 The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP | |
82 through files. | |
83 Only \fBctags\fP accepts this option. | |
84 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
85 .B \-\-declarations |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
86 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
|
87 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
|
88 .TP |
25853 | 89 .B \-d, \-\-defines |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
90 Create tag entries for C preprocessor constant definitions |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
91 and enum constants, too. This is the |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
92 default behavior for \fBetags\fP. |
25853 | 93 .TP |
94 .B \-D, \-\-no\-defines | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
95 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
|
96 and enum constants. |
25853 | 97 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
|
98 This is the default behavior for \fBctags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
99 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
100 .B \-g, \-\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
101 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
|
102 and Perl. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
103 This is the default behavior for \fBetags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
104 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
105 .B \-G, \-\-no\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
106 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
|
107 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
|
108 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
109 \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
|
110 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
|
111 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
|
112 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
|
113 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
114 .B \-I, \-\-ignore\-indentation |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
115 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
|
116 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
|
117 final brace of a function or structure definition in C and C++. |
25853 | 118 .TP |
119 \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP | |
120 Parse the following files according to the given language. More than | |
121 one such options may be intermixed with filenames. Use \fB\-\-help\fP | |
122 to get a list of the available languages and their default filename | |
123 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
|
124 detection of language based on the file name. The `none' |
25853 | 125 language may be used to disable language parsing altogether; only |
126 regexp matching is done in this case (see the \fB\-\-regex\fP option). | |
127 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
128 .B \-m, \-\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
129 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
|
130 constructs in C++, Objective C, Java. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
131 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
132 .B \-M, \-\-no\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
133 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
|
134 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
135 .B \-\-packages\-only |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
136 Only tag packages in Ada files. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
137 .TP |
25853 | 138 \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
|
139 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
|
140 \fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) |
25853 | 141 .TP |
142 \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
|
143 .TP |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
144 \fB\-\-ignore\-case\-regex=\fIregexp\fP |
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
145 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
|
146 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
|
147 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
|
148 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
|
149 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
|
150 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
|
151 ones. The regexps are of the form: |
25853 | 152 .br |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
153 \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP |
25853 | 154 .br |
155 | |
156 where \fItagregexp\fP is used to match the lines that must be tagged. | |
157 It should not match useless characters. If the match is | |
158 such that more characters than needed are unavoidably matched by | |
159 \fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to | |
160 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
|
161 \fInameregexp\fP. The syntax of regexps is the same as in emacs. |
25853 | 162 .br |
163 Here are some examples. All the regexps are quoted to protect them | |
164 from shell interpretation. | |
165 .br | |
166 | |
167 Tag the DEFVAR macros in the emacs source files: | |
168 .br | |
169 \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
|
170 .\"" This comment is to avoid confusion to Emacs syntax highlighting |
25853 | 171 .br |
172 | |
173 Tag VHDL files (this example is a single long line, broken here for | |
174 formatting reasons): | |
175 .br | |
176 \fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\ | |
177 CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\ | |
178 \\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\ | |
179 \\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP | |
180 .br | |
181 | |
182 Tag TCL files (this last example shows the usage of a \fItagregexp\fP): | |
183 .br | |
184 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP | |
185 | |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
186 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
187 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
|
188 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
|
189 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
|
190 \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
|
191 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
|
192 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
|
193 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
|
194 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
195 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
|
196 .br |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
197 \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
|
198 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
199 reads the regexes contained in the file regex.file. |
25853 | 200 .TP |
201 .B \-R, \-\-no\-regex | |
202 Don't do any more regexp matching on the following files. May be | |
203 freely intermixed with filenames and the \fB\-\-regex\fP option. | |
204 .TP | |
205 .B \-t, \-\-typedefs | |
206 Record typedefs in C code as tags. Since this is the default behaviour | |
207 of \fBetags\fP, only \fBctags\fP accepts this option. | |
208 .TP | |
209 .B \-T, \-\-typedefs\-and\-c++ | |
210 Generate tag entries for typedefs, struct, enum, and union tags, and | |
211 C++ member functions. Since this is the default behaviour | |
212 of \fBetags\fP, only \fBctags\fP accepts this option. | |
213 .TP | |
214 .B \-u, \-\-update | |
215 Update tag entries for \fIfiles\fP specified on command line, leaving | |
216 tag entries for other files in place. Currently, this is implemented | |
217 by deleting the existing entries for the given files and then | |
218 rewriting the new entries at the end of the tags file. It is often | |
219 faster to simply rebuild the entire tag file than to use this. | |
220 Only \fBctags\fP accepts this option. | |
221 .TP | |
222 .B \-v, \-\-vgrind | |
223 Instead of generating a tag file, write index (in \fBvgrind\fP format) | |
224 to standard output. Only \fBctags\fP accepts this option. | |
225 .TP | |
226 .B \-w, \-\-no\-warn | |
227 Suppress warning messages about duplicate entries. The \fBetags\fP | |
228 program does not check for duplicate entries, so this option is not | |
229 allowed with it. | |
230 .TP | |
231 .B \-x, \-\-cxref | |
232 Instead of generating a tag file, write a cross reference (in | |
233 \fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option. | |
234 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
235 .B \-h, \-H, \-\-help |
25853 | 236 Print usage information. |
237 .TP | |
238 .B \-V, \-\-version | |
239 Print the current version of the program (same as the version of the | |
240 emacs \fBetags\fP is shipped with). | |
241 | |
242 .SH "SEE ALSO" | |
243 `\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard | |
244 Stallman. | |
245 .br | |
246 .BR cxref ( 1 ), | |
247 .BR emacs ( 1 ), | |
248 .BR vgrind ( 1 ), | |
249 .BR vi ( 1 ). | |
250 | |
251 .SH COPYING | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
252 Copyright |
37363 | 253 .if t \(co |
254 .if n (c) | |
255 1999, 2001 Free Software Foundation, Inc. | |
25853 | 256 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
257 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
|
258 document provided the copyright notice and this permission notice are |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
259 preserved on all copies. |
25853 | 260 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
261 Permission is granted to copy and distribute modified versions of |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
262 this document under the conditions for verbatim copying, provided that |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
263 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
|
264 a permission notice identical to this one. |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
265 .PP |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
266 Permission is granted to copy and distribute translations of this |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
267 document into another language, under the above conditions for |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
268 modified versions, except that this permission notice may be stated |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
269 in a translation approved by the Free Software Foundation. |