Mercurial > emacs
annotate etc/etags.1 @ 90147:e1fbb019c538
Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-39
Merge from emacs--cvs-trunk--0
Patches applied:
* emacs--cvs-trunk--0 (patch 258-271)
- Update from CVS
- Merge from gnus--rel--5.10
* gnus--rel--5.10 (patch 66)
- Update from CVS
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 21 Apr 2005 05:59:53 +0000 |
parents | 566253900690 |
children | 2d92f5c9d6ae |
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\|] |
45658
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
18 [\|\-\-parse\-stdin=\fIfile\fP\|] |
25853 | 19 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
20 [\|\-\-append\|] [\|\-\-no\-defines\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
21 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
22 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
23 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
24 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] |
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\|] |
45658
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
31 [\|\-\-parse\-stdin=\fIfile\fP\|] |
25853 | 32 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
33 [\|\-\-append\|] [\|\-\-backward\-search\|] |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
34 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
35 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
36 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
37 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] |
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 | |
47085 | 52 the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML, |
57086
a10fd092f06f
Added support for the Lua script language.
Francesco Potortì <pot@gnu.org>
parents:
57012
diff
changeset
|
53 LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, 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 | |
57090
297e3051e6ac
When relative file names are given as argument,
Francesco Potortì <pot@gnu.org>
parents:
57086
diff
changeset
|
61 resides. If the tag table is in /dev, however, the file names are made |
297e3051e6ac
When relative file names are given as argument,
Francesco Potortì <pot@gnu.org>
parents:
57086
diff
changeset
|
62 relative to the working directory. Files specified with absolute file |
297e3051e6ac
When relative file names are given as argument,
Francesco Potortì <pot@gnu.org>
parents:
57086
diff
changeset
|
63 names will be recorded |
43874
96f84561b0ab
Use Cweb as an example, not Yacc.
Francesco Potortì <pot@gnu.org>
parents:
43724
diff
changeset
|
64 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
|
65 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
|
66 the name of the source file. |
25853 | 67 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
|
68 file name and contents. The \fB\-\-language\fP switch can be used to force |
25853 | 69 parsing of the file names following the switch according to the given |
70 language, overriding guesses based on filename extensions. | |
71 .SH OPTIONS | |
72 Some options make sense only for the \fBvi\fP style tag files produced | |
73 by ctags; | |
74 \fBetags\fP does not recognize them. | |
75 The programs accept unambiguous abbreviations for long option names. | |
76 .TP | |
77 .B \-a, \-\-append | |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
78 Append to existing tag file. (For \fBvi\fP-format tag files, see also |
25853 | 79 \fB\-\-update\fP.) |
80 .TP | |
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 | |
86 through files. | |
87 Only \fBctags\fP accepts this option. | |
88 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
89 .B \-\-declarations |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
90 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
|
91 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
|
92 .TP |
25853 | 93 .B \-d, \-\-defines |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
94 Create tag entries for C preprocessor constant definitions |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
95 and enum constants, too. This is the |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
96 default behavior for \fBetags\fP. |
25853 | 97 .TP |
98 .B \-D, \-\-no\-defines | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
99 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
|
100 and enum constants. |
25853 | 101 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
|
102 This is the default behavior for \fBctags\fP. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
103 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
104 .B \-g, \-\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
105 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
|
106 and Perl. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
107 This is the default behavior for \fBetags\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 .B \-G, \-\-no\-globals |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
110 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
|
111 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
|
112 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
113 \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
|
114 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
|
115 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
|
116 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
|
117 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
118 .B \-I, \-\-ignore\-indentation |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
119 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
|
120 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
|
121 final brace of a function or structure definition in C and C++. |
25853 | 122 .TP |
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 | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
128 detection of language based on the file name. The `none' |
25853 | 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). | |
131 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
132 .B \-m, \-\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
133 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
|
134 constructs in C++, Objective C, Java. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
135 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
136 .B \-M, \-\-no\-members |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
137 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
|
138 .TP |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
139 .B \-\-packages\-only |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
140 Only tag packages in Ada files. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
141 .TP |
45658
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
142 \fB\-\-parse\-stdin=\fIfile\fP |
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
143 May be used (only once) in place of a file name on the command line. |
45660 | 144 \fBetags\fP will read from standard input and mark the produced tags |
45658
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
145 as belonging to the file \fBFILE\fP. |
b359c7c3e1cb
Document --parse-stdin=FILE.
Francesco Potortì <pot@gnu.org>
parents:
43874
diff
changeset
|
146 .TP |
25853 | 147 \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
|
148 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
|
149 \fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) |
25853 | 150 .TP |
151 \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP | |
45800
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
152 |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
153 Make tags based on regexp matching for the files following this option, |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
154 in addition to the tags made with the standard parsing based on |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
155 language. May be freely intermixed with filenames and the \fB\-R\fP |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
156 option. The regexps are cumulative, i.e. each such option will add to |
45802
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
157 the previous ones. The regexps are of one of the forms: |
25853 | 158 .br |
45802
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
159 [\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP |
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
160 .br |
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
161 \fB@\fP\fIregexfile\fP |
25853 | 162 .br |
163 | |
45800
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
164 where \fItagregexp\fP is used to match the tag. It should not match |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
165 useless characters. If the match is such that more characters than |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
166 needed are unavoidably matched by \fItagregexp\fP, it may be useful to |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
167 add a \fInameregexp\fP, to narrow down the tag scope. \fBctags\fP |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
168 ignores regexps without a \fInameregexp\fP. The syntax of regexps is |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
169 the same as in emacs. The following character escape sequences are |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
170 supported: \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v, which |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
171 respectively stand for the ASCII characters BEL, BS, DEL, ESC, FF, NL, |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
172 CR, TAB, VT. |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
173 .br |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
174 The \fImodifiers\fP are a sequence of 0 or more characters among |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
175 \fIi\fP, which means to ignore case when matching; \fIm\fP, which means |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
176 that the \fItagregexp\fP will be matched against the whole file contents |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
177 at once, rather than line by line, and the matching sequence can match |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
178 multiple lines; and \fIs\fP, which implies \fIm\fP and means that the |
d11816fe2c59
New multi-line regexp and new regexp syntax.
Francesco Potortì <pot@gnu.org>
parents:
45666
diff
changeset
|
179 dot character in \fItagregexp\fP matches the newline char as well. |
45802
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
180 .br |
45885
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
181 The separator, which is \fB/\fP in the examples, can be any character |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
182 different from space, tab, braces and \fB@\fP. If the separator |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
183 character is needed inside the regular expression, it must be quoted |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
184 by preceding it with \fB\\\fP. |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
185 .br |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
186 The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
187 should be |
45802
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
188 created only for files of language \fIlanguage\fP, and ignored |
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
189 otherwise. This is particularly useful when storing many predefined |
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
190 regexps in a file. |
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
191 .br |
45885
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
192 In its second form, \fIregexfile\fP is the name of a file that contains |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
193 a number of arguments to the \fI\-\-regex\=\fP option, |
b2b7c9519909
Specify that the separator character can be different from a slash.
Francesco Potortì <pot@gnu.org>
parents:
45802
diff
changeset
|
194 one per line. Lines beginning with a space or tab are assumed |
45802
d4c9f3bd6dfa
New {language} and @regexp features.
Francesco Potortì <pot@gnu.org>
parents:
45800
diff
changeset
|
195 to be comments, and ignored. |
45666
621742dde467
Document Etags regexp char escape sequences.
Francesco Potortì <pot@gnu.org>
parents:
45660
diff
changeset
|
196 |
25853 | 197 .br |
198 Here are some examples. All the regexps are quoted to protect them | |
199 from shell interpretation. | |
200 .br | |
201 | |
202 Tag the DEFVAR macros in the emacs source files: | |
203 .br | |
204 \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
|
205 .\"" This comment is to avoid confusion to Emacs syntax highlighting |
25853 | 206 .br |
207 | |
208 Tag VHDL files (this example is a single long line, broken here for | |
209 formatting reasons): | |
210 .br | |
211 \fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\ | |
212 CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\ | |
213 \\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\ | |
214 \\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP | |
215 .br | |
216 | |
217 Tag TCL files (this last example shows the usage of a \fItagregexp\fP): | |
218 .br | |
219 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP | |
220 | |
26339
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
221 .br |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
222 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
|
223 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
|
224 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
|
225 \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
|
226 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
|
227 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
|
228 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
|
229 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
230 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
|
231 .br |
37332
446514f572dd
Fix copyright year, update date, and the markup.
Eli Zaretskii <eliz@gnu.org>
parents:
26339
diff
changeset
|
232 \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
|
233 .br |
91bc9f283495
Added wording for the regex files and the --ignore-case-regex option.
Francesco Potortì <pot@gnu.org>
parents:
26292
diff
changeset
|
234 reads the regexes contained in the file regex.file. |
25853 | 235 .TP |
236 .B \-R, \-\-no\-regex | |
237 Don't do any more regexp matching on the following files. May be | |
238 freely intermixed with filenames and the \fB\-\-regex\fP option. | |
239 .TP | |
240 .B \-t, \-\-typedefs | |
47106
7654c5eef71e
Use American spelling of "behavior".
Richard M. Stallman <rms@gnu.org>
parents:
47085
diff
changeset
|
241 Record typedefs in C code as tags. Since this is the default behavior |
25853 | 242 of \fBetags\fP, only \fBctags\fP accepts this option. |
243 .TP | |
244 .B \-T, \-\-typedefs\-and\-c++ | |
245 Generate tag entries for typedefs, struct, enum, and union tags, and | |
47106
7654c5eef71e
Use American spelling of "behavior".
Richard M. Stallman <rms@gnu.org>
parents:
47085
diff
changeset
|
246 C++ member functions. Since this is the default behavior |
25853 | 247 of \fBetags\fP, only \fBctags\fP accepts this option. |
248 .TP | |
249 .B \-u, \-\-update | |
250 Update tag entries for \fIfiles\fP specified on command line, leaving | |
251 tag entries for other files in place. Currently, this is implemented | |
252 by deleting the existing entries for the given files and then | |
253 rewriting the new entries at the end of the tags file. It is often | |
254 faster to simply rebuild the entire tag file than to use this. | |
255 Only \fBctags\fP accepts this option. | |
256 .TP | |
257 .B \-v, \-\-vgrind | |
258 Instead of generating a tag file, write index (in \fBvgrind\fP format) | |
259 to standard output. Only \fBctags\fP accepts this option. | |
260 .TP | |
261 .B \-w, \-\-no\-warn | |
262 Suppress warning messages about duplicate entries. The \fBetags\fP | |
263 program does not check for duplicate entries, so this option is not | |
264 allowed with it. | |
265 .TP | |
266 .B \-x, \-\-cxref | |
267 Instead of generating a tag file, write a cross reference (in | |
268 \fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option. | |
269 .TP | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
25853
diff
changeset
|
270 .B \-h, \-H, \-\-help |
57012
28b649226666
Added reference to the new `etags --help --lang=LANG' option.
Francesco Potortì <pot@gnu.org>
parents:
52401
diff
changeset
|
271 Print usage information. Followed by one or more \-\-language=LANG |
28b649226666
Added reference to the new `etags --help --lang=LANG' option.
Francesco Potortì <pot@gnu.org>
parents:
52401
diff
changeset
|
272 prints detailed information about how tags are created for LANG. |
25853 | 273 .TP |
274 .B \-V, \-\-version | |
275 Print the current version of the program (same as the version of the | |
276 emacs \fBetags\fP is shipped with). | |
277 | |
278 .SH "SEE ALSO" | |
279 `\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard | |
280 Stallman. | |
281 .br | |
282 .BR cxref ( 1 ), | |
283 .BR emacs ( 1 ), | |
284 .BR vgrind ( 1 ), | |
285 .BR vi ( 1 ). | |
286 | |
287 .SH COPYING | |
37784
b2509ef38ea1
Add the latest changes to etags behaviour.
Francesco Potortì <pot@gnu.org>
parents:
37455
diff
changeset
|
288 Copyright |
37363 | 289 .if t \(co |
290 .if n (c) | |
291 1999, 2001 Free Software Foundation, Inc. | |
25853 | 292 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
293 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
|
294 document provided the copyright notice and this permission notice are |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
295 preserved on all copies. |
25853 | 296 .PP |
41397
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
297 Permission is granted to copy and distribute modified versions of |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
298 this document under the conditions for verbatim copying, provided that |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
299 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
|
300 a permission notice identical to this one. |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
301 .PP |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
302 Permission is granted to copy and distribute translations of this |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
303 document into another language, under the above conditions for |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
304 modified versions, except that this permission notice may be stated |
e2c032a0aa44
Modify the distribution terms.
Eli Zaretskii <eliz@gnu.org>
parents:
39760
diff
changeset
|
305 in a translation approved by the Free Software Foundation. |
52401 | 306 |
307 .\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573 |