comparison etc/etags.1 @ 37784:b2509ef38ea1

Add the latest changes to etags behaviour.
author Francesco Potortì <pot@gnu.org>
date Thu, 17 May 2001 13:44:50 +0000
parents 087a220fa7bc
children 5801481e337c
comparison
equal deleted inserted replaced
37783:a319bda61eeb 37784:b2509ef38ea1
10 .SH NAME 10 .SH NAME
11 etags, ctags \- generate tag file for Emacs, vi 11 etags, ctags \- generate tag file for Emacs, vi
12 .SH SYNOPSIS 12 .SH SYNOPSIS
13 .hy 0 13 .hy 0
14 .na 14 .na
15 .B etags [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|] 15 \fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
16 .if n .br 16 .if n .br
17 .B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] 17 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
18 .br 18 .br
19 [\|\-\-append\|] [\|\-\-c++\|] [\|\-\-no\-defines\|] 19 [\|\-\-append\|] [\|\-\-no\-defines\|]
20 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|] 20 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
21 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] 21 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
22 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|] 22 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
23 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] 23 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
24 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|] 24 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
25 [\|\-\-help\|] [\|\-\-version\|] 25 [\|\-\-help\|] [\|\-\-version\|]
26 \fIfile\fP .\|.\|. 26 \fIfile\fP .\|.\|.
27 27
28 .B ctags [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|] 28 \fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
29 .if n .br 29 .if n .br
30 .B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] 30 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
31 .br 31 .br
32 [\|\-\-append\|] [\|\-\-backward\-search\|] [\|\-\-c++\|] 32 [\|\-\-append\|] [\|\-\-backward\-search\|]
33 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|] 33 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
34 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|] 34 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
35 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] 35 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
36 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] 36 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
37 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|] 37 [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
47 .BR emacs ( 1 )\c 47 .BR emacs ( 1 )\c
48 \&; the \|\fBctags\fP\| program is used to create a similar table in a 48 \&; the \|\fBctags\fP\| program is used to create a similar table in a
49 format understood by 49 format understood by
50 .BR vi ( 1 )\c 50 .BR vi ( 1 )\c
51 \&. Both forms of the program understand 51 \&. Both forms of the program understand
52 the syntax of C, Objective C, C++, Java, Fortran, Pascal, Cobol, Ada, Perl, 52 the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
53 LaTeX, Scheme, Emacs Lisp/Common Lisp, Postscript, Erlang, Python, Prolog and 53 LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, Postscript,
54 Python, Prolog, Scheme and
54 most assembler\-like syntaxes. 55 most assembler\-like syntaxes.
55 Both forms read the files specified on the command line, and write a tag 56 Both forms read the files specified on the command line, and write a tag
56 table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for 57 table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
57 \fBctags\fP) in the current working directory. 58 \fBctags\fP) in the current working directory.
58 Files specified with relative file names will be recorded in the tag 59 Files specified with relative file names will be recorded in the tag
79 the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files. 80 the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files.
80 The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP 81 The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP
81 through files. 82 through files.
82 Only \fBctags\fP accepts this option. 83 Only \fBctags\fP accepts this option.
83 .TP 84 .TP
84 .B \-C, \-\-c++
85 Treat files with `\|.c\|' and `\|.h\|' extensions as C++ code, not C
86 code. Files with `\|.C\|', `\|.H\|', `\|.cxx\|', `\|.hxx\|', or
87 `\|.cc\|' extensions are always assumed to be C++ code.
88 .TP
89 .B \-\-declarations 85 .B \-\-declarations
90 In C and derived languages, create tags for function declarations, 86 In C and derived languages, create tags for function declarations,
91 and create tags for extern variables unless \-\-no\-globals is used. 87 and create tags for extern variables unless \-\-no\-globals is used.
92 .TP 88 .TP
93 .B \-d, \-\-defines 89 .B \-d, \-\-defines
123 \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP 119 \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP
124 Parse the following files according to the given language. More than 120 Parse the following files according to the given language. More than
125 one such options may be intermixed with filenames. Use \fB\-\-help\fP 121 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 122 to get a list of the available languages and their default filename
127 extensions. The `auto' language can be used to restore automatic 123 extensions. The `auto' language can be used to restore automatic
128 detection of language based on filename extension. The `none' 124 detection of language based on the file name. The `none'
129 language may be used to disable language parsing altogether; only 125 language may be used to disable language parsing altogether; only
130 regexp matching is done in this case (see the \fB\-\-regex\fP option). 126 regexp matching is done in this case (see the \fB\-\-regex\fP option).
131 .TP 127 .TP
132 .B \-m, \-\-members 128 .B \-m, \-\-members
133 Create tag entries for variables that are members of structure-like 129 Create tag entries for variables that are members of structure-like
187 Tag TCL files (this last example shows the usage of a \fItagregexp\fP): 183 Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
188 .br 184 .br
189 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP 185 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP
190 186
191 .br 187 .br
192 A regexp can be preceded by {\fIlang\fP}, thus restriciting it to match 188 A regexp can be preceded by {\fIlang\fP}, thus restricting it to match
193 lines of files of the specified language. Use \fBetags --help\fP to obtain 189 lines of files of the specified language. Use \fBetags --help\fP to obtain
194 a list of the recognised languages. This feature is particularly useful inside 190 a list of the recognised languages. This feature is particularly useful inside
195 \fBregex files\fP. A regex file contains one regex per line. Empty lines, 191 \fBregex files\fP. A regex file contains one regex per line. Empty lines,
196 and those lines beginning with space or tab are ignored. Lines beginning 192 and those lines beginning with space or tab are ignored. Lines beginning
197 with @ are references to regex files whose name follows the @ sign. Other 193 with @ are references to regex files whose name follows the @ sign. Other
252 .BR emacs ( 1 ), 248 .BR emacs ( 1 ),
253 .BR vgrind ( 1 ), 249 .BR vgrind ( 1 ),
254 .BR vi ( 1 ). 250 .BR vi ( 1 ).
255 251
256 .SH COPYING 252 .SH COPYING
257 Copyright 253 Copyright
258 .if t \(co 254 .if t \(co
259 .if n (c) 255 .if n (c)
260 1999, 2001 Free Software Foundation, Inc. 256 1999, 2001 Free Software Foundation, Inc.
261 .PP 257 .PP
262 Permission is granted to copy, distribute and/or modify this document 258 Permission is granted to copy, distribute and/or modify this document