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