]> code.delx.au - gnu-emacs/blobdiff - doc/man/etags.1
merge trunk
[gnu-emacs] / doc / man / etags.1
index 04b67f389f4965ee93cba199c9ca546b627dccb9..7b5158077822a94023e7d65274e1e4cbafad841e 100644 (file)
@@ -1,6 +1,4 @@
-.\" Copyright (C) 1992, 2001, 2002, 2003, 2004,
-.\"   2005, 2006, 2007  Free Software Foundation, Inc.
-.\" See section COPYING for conditions for redistribution
+.\" See section COPYING for copyright and redistribution information.
 .TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
 .de BP
 .sp
@@ -18,10 +16,10 @@ etags, ctags \- generate tag file for Emacs, vi
 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
-[\|\-\-append\|] [\|\-\-no\-defines\|]
+[\|\-\-append\|] [\|\-\-no\-defines\|] [\|\-\-globals\|]
 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
-[\|\-\-no\-members\|] [\|\-\-output=\fItagfile\fP\|]
+[\|\-\-members\|] [\|\-\-no\-members\|] [\|\-\-output=\fItagfile\fP\|]
 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
@@ -32,11 +30,10 @@ etags, ctags \- generate tag file for Emacs, vi
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
 [\|\-\-append\|] [\|\-\-backward\-search\|]
-[\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
-[\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
-[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
+[\|\-\-cxref\|] [\|\-\-no\-defines\|]
+[\|\-\-globals\|] [\|\-\-no\-globals\|] [\|\-\-ignore\-indentation\|]
+[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] [\|\-\-no\-members\|]
 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
-[\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
 [\|\-\-update\|]
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
@@ -50,21 +47,22 @@ understood by
 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, HTML,
-LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, Pascal, Perl, PHP, Postscript,
-Python, Prolog, Scheme and
+the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
+Forth, 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
 table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
 \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.  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
+resides.  If the tag table is in /dev or is the standard output,
+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.
+Compressed files are supported using gzip and bzip2.
 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
@@ -91,28 +89,18 @@ Only \fBctags\fP accepts this option.
 In C and derived languages, create tags for function declarations,
 and create tags for extern variables unless \-\-no\-globals is used.
 .TP
-.B \-d, \-\-defines
-Create tag entries for C preprocessor constant definitions
-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.
-Since this is the default behavior of \fBctags\fP, only \fBetags\fP
-accepts this option.
 .TP
 .B \-\-globals
-Create tag entries for global variables in C, C++, Objective C, Java,
-and Perl.
-Since this is the default behavior of \fBetags\fP, only \fBctags\fP
-accepts this option.
+Create tag entries for global variables in Perl and Makefile.  This is
+the default in C and derived languages.
 .TP
 .B \-\-no\-globals
-Do not tag global variables.  Typically this reduces the file size by
-one fourth.  Since this is the default behavior of \fBctags\fP, only
-\fBetags\fP accepts this option.
+Do not tag global variables in C and derived languages.  Typically this
+reduces the file size by one fourth.
 .TP
 \fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP
 Include a note in the tag file indicating that, when searching for a
@@ -135,10 +123,10 @@ regexp matching is done in this case (see the \fB\-\-regex\fP option).
 .TP
 .B \-\-members
 Create tag entries for variables that are members of structure-like
-constructs in C++, Objective C, Java.  This is the default for etags.
+constructs in PHP.  This is the default for C and derived languages.
 .TP
 .B \-\-no\-members
-Do not tag member variables.  This is the default for ctags.
+Do not tag member variables.
 .TP
 .B \-\-packages\-only
 Only tag packages in Ada files.
@@ -149,8 +137,9 @@ May be used (only once) in place of a file name on the command line.
 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.)
+Explicit name of file for tag table; for \fBetags\fP only, a file name
+of \- means standard output; 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
 
@@ -225,7 +214,7 @@ Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
 .br
 A regexp can be preceded by {\fIlang\fP}, thus restricting it to match
 lines of files of the specified language.  Use \fBetags \-\-help\fP to obtain
-a list of the recognised languages.  This feature is particularly useful inside
+a list of the recognized languages.  This feature is particularly useful inside
 \fBregex files\fP.  A regex file contains one regex per line.  Empty lines,
 and those lines beginning with space or tab are ignored.  Lines beginning
 with @ are references to regex files whose name follows the @ sign.  Other
@@ -241,15 +230,6 @@ reads the regexes contained in the file regex.file.
 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
-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 behavior
-of \fBetags\fP, only \fBctags\fP accepts this option.
-.TP
 .B \-u, \-\-update
 Update tag entries for \fIfiles\fP specified on command line, leaving
 tag entries for other files in place.  Currently, this is implemented
@@ -286,8 +266,9 @@ Stallman.
 .SH COPYING
 Copyright
 .if t \(co
-.if n (c)
-1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
+.if n (C)
+1992, 1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
+2010  Free Software Foundation, Inc.
 .PP
 Permission is granted to make and distribute verbatim copies of this
 document provided the copyright notice and this permission notice are