(auto-revert-interval): Doc fix.

[bpt/emacs.git] / etc / etags.1

diff --git a/etc/etags.1 b/etc/etags.1
index 26381e3..5b95b6c 100644 (file)
--- a/etc/etags.1
+++ b/etc/etags.1
@@ -22,7 +22,6 @@ etags, ctags \- generate tag file for Emacs, vi
 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]

-[\|\-\-ignore\-case\-regex=\fIregexp\fP\|]

 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 


@@ -36,7 +35,6 @@ etags, ctags \- generate tag file for Emacs, vi
 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]

-[\|\-\-ignore\-case\-regex=\fIregexp\fP\|]

 [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
 [\|\-\-update\|] [\|\-\-no\-warn\|]
 [\|\-\-help\|] [\|\-\-version\|]
 [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
 [\|\-\-update\|] [\|\-\-no\-warn\|]
 [\|\-\-help\|] [\|\-\-version\|]


@@ -51,7 +49,7 @@ understood by
 format understood by
 .BR vi ( 1 )\c
 \&.  Both forms of the program understand
 format understood by
 .BR vi ( 1 )\c
 \&.  Both forms of the program understand

-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,

 LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript,
 Python, Prolog, Scheme and
 most assembler\-like syntaxes.
 LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript,
 Python, Prolog, Scheme and
 most assembler\-like syntaxes.


@@ -149,25 +147,51 @@ Explicit name of file for tag table; overrides default \fBTAGS\fP or
 \fBtags\fP.   (But ignored with \fB\-v\fP or \fB\-x\fP.)
 .TP
 \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP
 \fBtags\fP.   (But ignored with \fB\-v\fP or \fB\-x\fP.)
 .TP
 \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP

-.TP
-\fB\-\-ignore\-case\-regex=\fIregexp\fP
-Make tags based on regexp matching for each line of the files
-following this option, in addition to the tags made with the standard
-parsing based on language.  When using \fB\-\-regex\fP, case is
-significant, while it is not with \fB\-\-ignore\-case\-regex\fP. May
-be freely intermixed with filenames and the \fB\-R\fP option.  The
-regexps are cumulative, i.e. each option will add to the previous
-ones.  The regexps are of the form:
+
+Make tags based on regexp matching for the files following this option,
+in addition to the tags made with the standard parsing based on
+language. May be freely intermixed with filenames and the \fB\-R\fP
+option.  The regexps are cumulative, i.e. each such option will add to
+the previous ones.  The regexps are of one of the forms:
+.br
+       [\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP

 .br
 .br

-       \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP
+       \fB@\fP\fIregexfile\fP

 .br
 
 .br
 

-where \fItagregexp\fP is used to match the lines that must be tagged.
-It should not match useless characters.  If the match is
-such that more characters than needed are unavoidably matched by
-\fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to
-narrow down the tag scope.  \fBctags\fP ignores regexps without a
-\fInameregexp\fP.  The syntax of regexps is the same as in emacs.
+where \fItagregexp\fP is used to match the tag.  It should not match
+useless characters.  If the match is such that more characters than
+needed are unavoidably matched by \fItagregexp\fP, it may be useful to
+add a \fInameregexp\fP, to narrow down the tag scope.  \fBctags\fP
+ignores regexps without a \fInameregexp\fP.  The syntax of regexps is
+the same as in emacs.  The following character escape sequences are
+supported: \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v, which
+respectively stand for the ASCII characters BEL, BS, DEL, ESC, FF, NL,
+CR, TAB, VT.
+.br
+The \fImodifiers\fP are a sequence of 0 or more characters among
+\fIi\fP, which means to ignore case when matching; \fIm\fP, which means
+that the \fItagregexp\fP will be matched against the whole file contents
+at once, rather than line by line, and the matching sequence can match
+multiple lines; and \fIs\fP, which implies \fIm\fP and means that the
+dot character in \fItagregexp\fP matches the newline char as well.
+.br
+The separator, which is \fB/\fP in the examples, can be any character
+different from space, tab, braces and \fB@\fP.  If the separator
+character is needed inside the regular expression, it must be quoted
+by preceding it with \fB\\\fP.
+.br
+The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag
+should be
+created only for files of language \fIlanguage\fP, and ignored
+otherwise.  This is particularly useful when storing many predefined
+regexps in a file.
+.br
+In its second form, \fIregexfile\fP is the name of a file that contains
+a number of arguments to the \fI\-\-regex\=\fP option,
+one per line.  Lines beginning with a space or tab are assumed
+to be comments, and ignored.
+

 .br
 Here are some examples.  All the regexps are quoted to protect them
 from shell interpretation.
 .br
 Here are some examples.  All the regexps are quoted to protect them
 from shell interpretation.


@@ -212,12 +236,12 @@ Don't do any more regexp matching on the following files.  May be
 freely intermixed with filenames and the \fB\-\-regex\fP option.
 .TP
 .B \-t, \-\-typedefs
 freely intermixed with filenames and the \fB\-\-regex\fP option.
 .TP
 .B \-t, \-\-typedefs

-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

 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-T, \-\-typedefs\-and\-c++
 Generate tag entries for typedefs, struct, enum, and union tags, and
 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-T, \-\-typedefs\-and\-c++
 Generate tag entries for typedefs, struct, enum, and union tags, and

-C++ member functions.  Since this is the default behaviour
+C++ member functions.  Since this is the default behavior

 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-u, \-\-update
 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-u, \-\-update


@@ -276,3 +300,5 @@ Permission is granted to copy and distribute translations of this
 document into another language, under the above conditions for
 modified versions, except that this permission notice may be stated
 in a translation approved by the Free Software Foundation.
 document into another language, under the above conditions for
 modified versions, except that this permission notice may be stated
 in a translation approved by the Free Software Foundation.

+
+.\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573