]> code.delx.au - gnu-emacs/blobdiff - etc/etags.1
*** empty log message ***
[gnu-emacs] / etc / etags.1
index 735b187744ed51ebb899e5ba0cc35e6da3a6e477..26a21d4cf4ecc1d122c57351b2698ac54cd2aed8 100644 (file)
@@ -1,6 +1,6 @@
-.\" Copyright (c) 1992 Free Software Foundation
+.\" Copyright (c) 1992, 2001 Free Software Foundation
 .\" See section COPYING for conditions for redistribution
-.TH etags 1 "02nov1999" "GNU Tools" "GNU Tools"
+.TH etags 1 "08apr2001" "GNU Tools" "GNU Tools"
 .de BP
 .sp
 .ti -.2i
@@ -12,11 +12,11 @@ etags, ctags \- generate tag file for Emacs, vi
 .SH SYNOPSIS
 .hy 0
 .na
-.B etags [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
+\fBetags\fP [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
 .if n .br
-.B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
+[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 .br
-[\|\-\-append\|] [\|\-\-c++\|] [\|\-\-no\-defines\|]
+[\|\-\-append\|] [\|\-\-no\-defines\|]
 [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
 [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
@@ -25,11 +25,11 @@ etags, ctags \- generate tag file for Emacs, vi
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 
-.B ctags [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
+\fBctags\fP [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
 .if n .br
-.B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
+[\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 .br
-[\|\-\-append\|] [\|\-\-backward\-search\|] [\|\-\-c++\|]
+[\|\-\-append\|] [\|\-\-backward\-search\|]
 [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
 [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
@@ -42,25 +42,26 @@ etags, ctags \- generate tag file for Emacs, vi
 .ad b
 .hy 1
 .SH DESCRIPTION
-The `\|\fBetags\fP\|' program is used to create a tag table file, in a format
+The \|\fBetags\fP\| program is used to create a tag table file, in a format
 understood by
 .BR emacs ( 1 )\c
-\&; the `\|\fBctags\fP\|' program is used to create a similar table in a
+\&; the \|\fBctags\fP\| program is used to create a similar table in a
 format understood by
 .BR vi ( 1 )\c
 \&.  Both forms of the program understand
-the syntax of C, Objective C, C++, Java, Fortran, Pascal, Cobol, Ada, Perl,
-LaTeX, Scheme, Emacs Lisp/Common Lisp, Postscript, Erlang, Python, Prolog and
+the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
+LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, 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: `\|TAGS\|' for \fBetags\fP, `\|tags\|' for
+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.  Files specified with absolute file names will be recorded
 with absolute file names.
 The programs recognize the language used in an input file based on its
-file name and contents.  The --language switch can be used to force
+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
 language, overriding guesses based on filename extensions.
 .SH OPTIONS
@@ -70,7 +71,7 @@ by ctags;
 The programs accept unambiguous abbreviations for long option names.
 .TP
 .B \-a, \-\-append
-Append to existing tag file.  (For vi-format tag files, see also
+Append to existing tag file.  (For \fBvi\fP-format tag files, see also
 \fB\-\-update\fP.)
 .TP
 .B \-B, \-\-backward\-search
@@ -81,11 +82,6 @@ The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP
 through files.
 Only \fBctags\fP accepts this option.
 .TP
-.B \-C, \-\-c++
-Treat files with `\|.c\|' and `\|.h\|' extensions as C++ code, not C
-code.  Files with `\|.C\|', `\|.H\|', `\|.cxx\|', `\|.hxx\|', or
-`\|.cc\|' extensions are always assumed to be C++ code.
-.TP
 .B \-\-declarations
 In C and derived languages, create tags for function declarations,
 and create tags for extern variables unless \-\-no\-globals is used.
@@ -125,7 +121,7 @@ Parse the following files according to the given language.  More than
 one such options may be intermixed with filenames.  Use \fB\-\-help\fP
 to get a list of the available languages and their default filename
 extensions.  The `auto' language can be used to restore automatic
-detection of language based on filename extension.  The `none'
+detection of language based on the file name.  The `none'
 language may be used to disable language parsing altogether; only
 regexp matching is done in this case (see the \fB\-\-regex\fP option).
 .TP
@@ -140,17 +136,19 @@ Do not tag member variables.  This is the default behavior.
 Only tag packages in Ada files.
 .TP
 \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP
-Explicit name of file for tag table; overrides default `\|TAGS\|' or
-`\|tags\|'.   (But ignored with \fB\-v\fP or \fB\-x\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
-\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 \-\-regex, case is significant, while it is not
-with \-\-ignore\-case\-regex. 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:
+.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:
 .br
        \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP
 .br
@@ -161,7 +159,8 @@ 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 ed or grep.
+augmented with intervals of the form \\{m,n\\}, as in \fBed\fP or
+\fBgrep\fP.
 .br
 Here are some examples.  All the regexps are quoted to protect them
 from shell interpretation.
@@ -186,17 +185,17 @@ Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP
 
 .br
-A regexp can be preceded by {lang}, thus restriciting it to match lines of
-files of the specified language.  Use \fBetags --help\bP to obtain a list
-of the recognised languages.  This feature is particularly useful inside
-\fBregex files\fB.  A regex file contains one regex per line.  Empty lines,
+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
+\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
-lines are considered regular expressions like those following \-\-regex.
+lines are considered regular expressions like those following \fB\-\-regex\fP.
 .br
 For example, the command
 .br
-etags \-\-regex=@regex.file *.c
+\fIetags \-\-regex=@regex.file *.c\fP
 .br
 reads the regexes contained in the file regex.file.
 .TP
@@ -251,19 +250,22 @@ Stallman.
 .BR vi ( 1 ).
 
 .SH COPYING
-Copyright (c) 1999 Free Software Foundation, Inc.
-.PP
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
+Copyright
+.if t \(co
+.if n (c)
+1999, 2001 Free Software Foundation, Inc.
 .PP
-Permission is granted to copy and distribute modified versions of this
-manual 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.
+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.
 .PP
-Permission is granted to copy and distribute translations of this
-manual into another language, under the above conditions for modified
-versions, except that this permission notice may be included in
-translations approved by the Free Software Foundation instead of in
-the original English.
+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.