Support Go language in 'etags'

[gnu-emacs] / doc / man / etags.1

diff --git a/doc/man/etags.1 b/doc/man/etags.1
index 5ccf528868bc8b7797cdc8ff066ef004de710578..fc247f758a30b6ac859d6000cc6f4330e0c60b9e 100644 (file)
--- a/doc/man/etags.1
+++ b/doc/man/etags.1
@@ -11,28 +11,30 @@ etags, ctags \- generate tag file for Emacs, vi
 .SH SYNOPSIS
 .hy 0
 .na
 .SH SYNOPSIS
 .hy 0
 .na

-\fBetags\fP [\|\-aCDGIRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]
+\fBetags\fP [\|\-aCDGIQRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|]

 .if n .br
 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
 [\|\-\-append\|] [\|\-\-no\-defines\|] [\|\-\-globals\|]
 .if n .br
 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
 [\|\-\-append\|] [\|\-\-no\-defines\|] [\|\-\-globals\|]

-[\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
+[\|\-\-no\-globals\|] [\|\-\-no\-line\-directive\|] [\|\-\-include=\fIfile\fP\|]

 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
 [\|\-\-members\|] [\|\-\-no\-members\|] [\|\-\-output=\fItagfile\fP\|]
 [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
 [\|\-\-members\|] [\|\-\-no\-members\|] [\|\-\-output=\fItagfile\fP\|]

+[\|\-\-class\-qualify\|]

 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 
 [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
 [\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 

-\fBctags\fP [\|\-aCdgIRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]
+\fBctags\fP [\|\-aCdgIQRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|]

 .if n .br
 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
 [\|\-\-append\|] [\|\-\-backward\-search\|]
 .if n .br
 [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|]
 [\|\-\-parse\-stdin=\fIfile\fP\|]
 .br
 [\|\-\-append\|] [\|\-\-backward\-search\|]

-[\|\-\-cxref\|] [\|\-\-no\-defines\|]
-[\|\-\-globals\|] [\|\-\-no\-globals\|] [\|\-\-ignore\-indentation\|]
+[\|\-\-cxref\|] [\|\-\-no\-defines\|] [\|\-\-globals\|]
+[\|\-\-no\-globals\|] [\|\-\-no\-line\-directive\|] [\|\-\-ignore\-indentation\|]

 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] [\|\-\-no\-members\|]
 [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] [\|\-\-no\-members\|]

+[\|\-\-class\-qualify\|]

 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
 [\|\-\-update\|]
 [\|\-\-help\|] [\|\-\-version\|]
 [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
 [\|\-\-update\|]
 [\|\-\-help\|] [\|\-\-version\|]


@@ -48,8 +50,8 @@ 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,
 .BR vi ( 1 )\c
 \&.  Both forms of the program understand
 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
+Forth, Go, HTML, LaTeX, Emacs Lisp/Common Lisp, Lua, Makefile, Pascal, Perl,
+Ruby, 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
 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


@@ -80,8 +82,8 @@ Append to existing tag file.  (For \fBvi\fP-format tag files, see also
 .B \-B, \-\-backward\-search
 Tag files written in the format expected by \fBvi\fP contain regular
 expression search instructions; the \fB\-B\fP option writes them using
 .B \-B, \-\-backward\-search
 Tag files written in the format expected by \fBvi\fP contain regular
 expression search instructions; the \fB\-B\fP option writes them using

-the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files.
-The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP
+the delimiter "\|\fB?\fP\|", to search \fIbackwards\fP through files.
+The default is to use the delimiter "\|\fB/\fP\|", to search \fIforwards\fP

 through files.
 Only \fBctags\fP accepts this option.
 .TP
 through files.
 Only \fBctags\fP accepts this option.
 .TP


@@ -103,6 +105,12 @@ the default in C and derived languages.
 Do not tag global variables in C and derived languages.  Typically this
 reduces the file size by one fourth.
 .TP
 Do not tag global variables in C and derived languages.  Typically this
 reduces the file size by one fourth.
 .TP

+.B \-\-no\-line\-directive
+Ignore \fB#line\fP preprocessor directives in C and derived languages.  The
+default is to honor those directives, and record the tags as if the
+file scanned was the one named in the \fB#line\fP directive.  This switch is
+useful when the original file named by \fB#line\fP is no longer available.
+.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
 \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


@@ -117,8 +125,8 @@ final brace of a function or structure definition in C and C++.
 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
 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 the file name.  The `none'
+extensions.  The "auto" language can be used to restore automatic
+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
 language may be used to disable language parsing altogether; only
 regexp matching is done in this case (see the \fB\-\-regex\fP option).
 .TP


@@ -137,6 +145,14 @@ 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
 \fBetags\fP will read from standard input and mark the produced tags
 as belonging to the file \fBFILE\fP.
 .TP

+\fB\-\-class\-qualify\fP
+Qualify tag names with their class name in C++, ObjC, and Java.
+This produces tag names of the form \fIclass\fP\fB::\fP\fImember\fP
+for C++,
+\fIclass\fP\fB(\fP\fIcategory\fP\fB)\fP for Objective C, and \fIclass\fP\fB.\fP\fImember\fP for Java.
+For Objective C, this also produces class methods qualified with
+their arguments, as in \fIfoo\fP\fB:\fP\fIbar\fP\fB:\fP\fIbaz\fP\fB:\fP\fImore\fP.
+.TP

 \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\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.
 \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\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.


@@ -256,7 +272,7 @@ Print the current version of the program (same as the version of the
 emacs \fBetags\fP is shipped with).
 
 .SH "SEE ALSO"
 emacs \fBetags\fP is shipped with).
 
 .SH "SEE ALSO"

-`\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard
+"\|\fBemacs\fP\|" entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard

 Stallman.
 .br
 .BR cxref ( 1 ),
 Stallman.
 .br
 .BR cxref ( 1 ),


@@ -268,7 +284,7 @@ Stallman.
 Copyright
 .if t \(co
 .if n (C)
 Copyright
 .if t \(co
 .if n (C)

-1992, 1999, 2001-2013 Free Software Foundation, Inc.
+1992, 1999, 2001-2016 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
 .PP
 Permission is granted to make and distribute verbatim copies of this
 document provided the copyright notice and this permission notice are