-.\" Copyright (c) 1992, 2001 Free Software Foundation
+.\" Copyright (C) 1992, 2001, 2002, 2003, 2004,
+.\" 2005, 2006 Free Software Foundation, Inc.
.\" See section COPYING for conditions for redistribution
-.TH etags 1 "08apr2001" "GNU Tools" "GNU Tools"
+.TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
.de BP
.sp
.ti -.2i
\fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
.if n .br
[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
+[\|\-\-parse\-stdin=\fIfile\fP\|]
.br
[\|\-\-append\|] [\|\-\-no\-defines\|]
[\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
[\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
[\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
[\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
-[\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
[\|\-\-help\|] [\|\-\-version\|]
\fIfile\fP .\|.\|.
\fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
.if n .br
[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
+[\|\-\-parse\-stdin=\fIfile\fP\|]
.br
[\|\-\-append\|] [\|\-\-backward\-search\|]
[\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
[\|\-\-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\|]
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,
-LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, Postscript,
+the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML,
+LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, Pascal, Perl, PHP, Postscript,
Python, Prolog, Scheme and
most assembler\-like syntaxes.
Both forms read the files specified on the command line, and write a tag
\fBctags\fP) in the current working directory.
Files specified with relative file names will be recorded in the tag
table with file names relative to the directory where the tag table
-resides. Files specified with absolute file names will be recorded
-with absolute file names.
+resides. If the tag table is in /dev, however, the file names are made
+relative to the working directory. Files specified with absolute file
+names will be recorded
+with absolute file names. Files generated from a source file\-\-like
+a C file generated from a source Cweb file\-\-will be recorded with
+the name of the source file.
The programs recognize the language used in an input file based on its
file name and contents. The \fB\-\-language\fP switch can be used to force
parsing of the file names following the switch according to the given
.TP
.B \-d, \-\-defines
Create tag entries for C preprocessor constant definitions
-and enum constants, too. This is the
-default behavior for \fBetags\fP.
+and enum constants, too. Since this is the default behavior of
+\fBetags\fP, only \fBctags\fP accepts this option.
.TP
.B \-D, \-\-no\-defines
Do not create tag entries for C preprocessor constant definitions
and enum constants.
This may make the tags file much smaller if many header files are tagged.
-This is the default behavior for \fBctags\fP.
+Since this is the default behavior of \fBctags\fP, only \fBetags\fP
+accepts this option.
.TP
-.B \-g, \-\-globals
+.B \-\-globals
Create tag entries for global variables in C, C++, Objective C, Java,
and Perl.
-This is the default behavior for \fBetags\fP.
+Since this is the default behavior of \fBetags\fP, only \fBctags\fP
+accepts this option.
.TP
-.B \-G, \-\-no\-globals
+.B \-\-no\-globals
Do not tag global variables. Typically this reduces the file size by
-one fourth. This is the default behavior for \fBctags\fP.
+one fourth. Since this is the default behavior of \fBctags\fP, only
+\fBetags\fP accepts this option.
.TP
\fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP
Include a note in the tag file indicating that, when searching for a
tag, one should also consult the tags file \fIfile\fP after checking the
-current file. This options is only accepted by \fBetags\fP.
+current file. Only \fBetags\fP accepts this option.
.TP
.B \-I, \-\-ignore\-indentation
Don't rely on indentation as much as we normally do. Currently, this
.B \-\-packages\-only
Only tag packages in Ada files.
.TP
+\fB\-\-parse\-stdin=\fIfile\fP
+May be used (only once) in place of a file name on the command line.
+\fBetags\fP will read from standard input and mark the produced tags
+as belonging to the file \fBFILE\fP.
+.TP
\fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP
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
-.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\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP
+ [\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP
+.br
+ \fB@\fP\fIregexfile\fP
.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,
-augmented with intervals of the form \\{m,n\\}, as in \fBed\fP or
-\fBgrep\fP.
+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.
Tag the DEFVAR macros in the emacs source files:
.br
\fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"\/'\fP
+.\"" This comment is to avoid confusion to Emacs syntax highlighting
.br
Tag VHDL files (this example is a single long line, broken here for
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
-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
\fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option.
.TP
.B \-h, \-H, \-\-help
-Print usage information.
+Print usage information. Followed by one or more \-\-language=LANG
+prints detailed information about how tags are created for LANG.
.TP
.B \-V, \-\-version
Print the current version of the program (same as the version of the
Copyright
.if t \(co
.if n (c)
-1999, 2001 Free Software Foundation, Inc.
+1999, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
.PP
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1
-or any later version published by the Free Software Foundation;
-with no Invariant Sections, with no Front-Cover Texts, and no
-Back-Cover Texts.
+Permission is granted to make and distribute verbatim copies of this
+document provided the copyright notice and this permission notice are
+preserved on all copies.
.PP
-This document is part of a collection distributed under the GNU Free
-Documentation License. If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
-A copy of the license is included in the
-.BR gfdl ( 1 )
-man page, and in the section entitled "GNU Free Documentation
-License" in the Emacs manual.
+Permission is granted to copy and distribute modified versions of
+this document under the conditions for verbatim copying, provided that
+the entire resulting derived work is distributed under the terms of
+a permission notice identical to this one.
+.PP
+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.
+
+.\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573