22 |
[\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] |
[\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] |
23 |
[\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|] |
[\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|] |
24 |
[\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] |
[\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] |
|
[\|\-\-ignore\-case\-regex=\fIregexp\fP\|] |
|
25 |
[\|\-\-help\|] [\|\-\-version\|] |
[\|\-\-help\|] [\|\-\-version\|] |
26 |
\fIfile\fP .\|.\|. |
\fIfile\fP .\|.\|. |
27 |
|
|
35 |
[\|\-\-globals\|] [\|\-\-ignore\-indentation\|] |
[\|\-\-globals\|] [\|\-\-ignore\-indentation\|] |
36 |
[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] |
[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] |
37 |
[\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] |
[\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] |
|
[\|\-\-ignore\-case\-regex=\fIregexp\fP\|] |
|
38 |
[\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|] |
[\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|] |
39 |
[\|\-\-update\|] [\|\-\-no\-warn\|] |
[\|\-\-update\|] [\|\-\-no\-warn\|] |
40 |
[\|\-\-help\|] [\|\-\-version\|] |
[\|\-\-help\|] [\|\-\-version\|] |
49 |
format understood by |
format understood by |
50 |
.BR vi ( 1 )\c |
.BR vi ( 1 )\c |
51 |
\&. Both forms of the program understand |
\&. Both forms of the program understand |
52 |
the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, |
the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML, |
53 |
LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript, |
LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript, |
54 |
Python, Prolog, Scheme and |
Python, Prolog, Scheme and |
55 |
most assembler\-like syntaxes. |
most assembler\-like syntaxes. |
147 |
\fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) |
\fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) |
148 |
.TP |
.TP |
149 |
\fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP |
\fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP |
150 |
.TP |
|
151 |
\fB\-\-ignore\-case\-regex=\fIregexp\fP |
Make tags based on regexp matching for the files following this option, |
152 |
Make tags based on regexp matching for each line of the files |
in addition to the tags made with the standard parsing based on |
153 |
following this option, in addition to the tags made with the standard |
language. May be freely intermixed with filenames and the \fB\-R\fP |
154 |
parsing based on language. When using \fB\-\-regex\fP, case is |
option. The regexps are cumulative, i.e. each such option will add to |
155 |
significant, while it is not with \fB\-\-ignore\-case\-regex\fP. May |
the previous ones. The regexps are of one of the forms: |
156 |
be freely intermixed with filenames and the \fB\-R\fP option. The |
.br |
157 |
regexps are cumulative, i.e. each option will add to the previous |
[\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP |
158 |
ones. The regexps are of the form: |
.br |
159 |
.br |
\fB@\fP\fIregexfile\fP |
160 |
\fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP |
.br |
161 |
.br |
|
162 |
|
where \fItagregexp\fP is used to match the tag. It should not match |
163 |
where \fItagregexp\fP is used to match the lines that must be tagged. |
useless characters. If the match is such that more characters than |
164 |
It should not match useless characters. If the match is |
needed are unavoidably matched by \fItagregexp\fP, it may be useful to |
165 |
such that more characters than needed are unavoidably matched by |
add a \fInameregexp\fP, to narrow down the tag scope. \fBctags\fP |
166 |
\fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to |
ignores regexps without a \fInameregexp\fP. The syntax of regexps is |
167 |
narrow down the tag scope. \fBctags\fP ignores regexps without a |
the same as in emacs. The following character escape sequences are |
168 |
\fInameregexp\fP. The syntax of regexps is the same as in emacs. |
supported: \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v, which |
169 |
The following character escape sequences are supported: |
respectively stand for the ASCII characters BEL, BS, DEL, ESC, FF, NL, |
170 |
\\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v. |
CR, TAB, VT. |
171 |
|
.br |
172 |
|
The \fImodifiers\fP are a sequence of 0 or more characters among |
173 |
|
\fIi\fP, which means to ignore case when matching; \fIm\fP, which means |
174 |
|
that the \fItagregexp\fP will be matched against the whole file contents |
175 |
|
at once, rather than line by line, and the matching sequence can match |
176 |
|
multiple lines; and \fIs\fP, which implies \fIm\fP and means that the |
177 |
|
dot character in \fItagregexp\fP matches the newline char as well. |
178 |
|
.br |
179 |
|
The separator, which is \fB/\fP in the examples, can be any character |
180 |
|
different from space, tab, braces and \fB@\fP. If the separator |
181 |
|
character is needed inside the regular expression, it must be quoted |
182 |
|
by preceding it with \fB\\\fP. |
183 |
|
.br |
184 |
|
The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag |
185 |
|
should be |
186 |
|
created only for files of language \fIlanguage\fP, and ignored |
187 |
|
otherwise. This is particularly useful when storing many predefined |
188 |
|
regexps in a file. |
189 |
|
.br |
190 |
|
In its second form, \fIregexfile\fP is the name of a file that contains |
191 |
|
a number of arguments to the \fI\-\-regex\=\fP option, |
192 |
|
one per line. Lines beginning with a space or tab are assumed |
193 |
|
to be comments, and ignored. |
194 |
|
|
195 |
.br |
.br |
196 |
Here are some examples. All the regexps are quoted to protect them |
Here are some examples. All the regexps are quoted to protect them |
236 |
freely intermixed with filenames and the \fB\-\-regex\fP option. |
freely intermixed with filenames and the \fB\-\-regex\fP option. |
237 |
.TP |
.TP |
238 |
.B \-t, \-\-typedefs |
.B \-t, \-\-typedefs |
239 |
Record typedefs in C code as tags. Since this is the default behaviour |
Record typedefs in C code as tags. Since this is the default behavior |
240 |
of \fBetags\fP, only \fBctags\fP accepts this option. |
of \fBetags\fP, only \fBctags\fP accepts this option. |
241 |
.TP |
.TP |
242 |
.B \-T, \-\-typedefs\-and\-c++ |
.B \-T, \-\-typedefs\-and\-c++ |
243 |
Generate tag entries for typedefs, struct, enum, and union tags, and |
Generate tag entries for typedefs, struct, enum, and union tags, and |
244 |
C++ member functions. Since this is the default behaviour |
C++ member functions. Since this is the default behavior |
245 |
of \fBetags\fP, only \fBctags\fP accepts this option. |
of \fBetags\fP, only \fBctags\fP accepts this option. |
246 |
.TP |
.TP |
247 |
.B \-u, \-\-update |
.B \-u, \-\-update |