xemacs-beta: etc/etags.1 comparison

comparison etc/etags.1 @ 2325:9d8bfee6e672

[xemacs-hg @ 2004-10-07 14:51:11 by james] Update to author version 17.6.

author	james
date	Thu, 07 Oct 2004 14:51:19 +0000
parents	c33ae14dd6d0
children	10ee8fade35d

comparison

equal deleted inserted replaced

-:df2fafa399a1
+:9d8bfee6e672
-.\" Copyright (c) 1992 Free Software Foundation
+.\" Copyright (c) 1992, 2001 Free Software Foundation
 .\" See section COPYING for conditions for redistribution
-.TH etags 1 "14gen2001" "GNU Tools" "GNU Tools"
+.TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
 .de BP
 .sp
 .ti -.2i
 \(**
 ..
 .SH NAME
 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
+[\|\-\-parse\-stdin=\fIfile\fP\|]
-.B [\|\-\-append\|] [\|\-\-no\-defines\|]
+.br
-.B [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
+[\|\-\-append\|] [\|\-\-no\-defines\|]
-.B [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
+[\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|]
-.B [\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
+[\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|]
-.B [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
+[\|\-\-members\|] [\|\-\-output=\fItagfile\fP\|]
-.B [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
+[\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|]
-.B [\|\-\-help\|] [\|\-\-version\|]
+[\|\-\-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
+[\|\-\-parse\-stdin=\fIfile\fP\|]
-.B [\|\-\-append\|] [\|\-\-backward\-search\|]
+.br
-.B [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
+[\|\-\-append\|] [\|\-\-backward\-search\|]
-.B [\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
+[\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|]
-.B [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
+[\|\-\-globals\|] [\|\-\-ignore\-indentation\|]
-.B [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
+[\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|]
-.B [\|\-\-ignore\-case\-regex=\fIregexp\fP\|]
+[\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|]
-.B [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
+[\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|]
-.B [\|\-\-update\|] [\|\-\-no\-warn\|]
+[\|\-\-update\|] [\|\-\-no\-warn\|]
-.B [\|\-\-help\|] [\|\-\-version\|]
+[\|\-\-help\|] [\|\-\-version\|]
 \fIfile\fP .\|.\|.
 .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,
+\&.  Both forms of the program understand
-C++, Java, Fortran, Ada, Cobol, Erlang, LaTeX, Emacs Lisp/Common Lisp,
+the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML,
-makefiles, Pascal, Perl, Postscript, Python, Prolog, Scheme and most
+LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, Pascal, Perl, PHP, Postscript,
-assembler\-like syntaxes.
+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
+resides.  If the tag table is in /dev, however, the file names are made
-with absolute file names.
+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 --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
 Some options make sense only for the \fBvi\fP style tag files produced
 by ctags;
 \fBetags\fP does not recognize them.
 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
 Tag files written in the format expected by \fBvi\fP contain regular
 expression search instructions; the \fB\-B\fP option writes them using
 Do not tag member variables.  This is the default behavior.
 .TP
 .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 `\|TAGS\|' or
+Explicit name of file for tag table; overrides default \fBTAGS\fP or
-`\|tags\|'.   (But ignored with \fB\-v\fP or \fB\-x\fP.)
+\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
+\fB\-r\fP \fIregexp\fP, \fB\-\-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
+Make tags based on regexp matching for the files following this option,
-on language.  When using \-\-regex, case is significant, while it is not
+in addition to the tags made with the standard parsing based on
-with \-\-ignore\-case\-regex. May be freely intermixed with filenames and
+language. May be freely intermixed with filenames and the \fB\-R\fP
-the \fB\-R\fP option.  The regexps are cumulative, i.e. each option will
+option.  The regexps are cumulative, i.e. each such option will add to
-add to the previous ones.  The regexps are of the form:
+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
-where \fItagregexp\fP is used to match the lines that must be tagged.
+.br
-It should not match useless characters.  If the match is
-such that more characters than needed are unavoidably matched by
+where \fItagregexp\fP is used to match the tag.  It should not match
-\fItagregexp\fP, it may be useful to add a \fInameregexp\fP, to
+useless characters.  If the match is such that more characters than
-narrow down the tag scope.  \fBctags\fP ignores regexps without a
+needed are unavoidably matched by \fItagregexp\fP, it may be useful to
-\fInameregexp\fP.  The syntax of regexps is the same as in emacs,
+add a \fInameregexp\fP, to narrow down the tag scope.  \fBctags\fP
-augmented with intervals of the form \\{m,n\\}, as in ed or grep.
+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
 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
 formatting reasons):
 .br
 Tag TCL files (this last example shows the usage of a \fItagregexp\fP):
 .br
 \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP
 .br
-A regexp can be preceded by {lang}, thus restriciting it to match lines of
+A regexp can be preceded by {\fIlang\fP}, thus restricting it to match
-files of the specified language.  Use \fBetags --help\fP to obtain a list
+lines of files of the specified language.  Use \fBetags --help\fP to obtain
-of the recognised languages.  This feature is particularly useful inside
+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
 .B \-R, \-\-no\-regex
 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 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
 Update tag entries for \fIfiles\fP specified on command line, leaving
 tag entries for other files in place.  Currently, this is implemented
 .B \-x, \-\-cxref
 Instead of generating a tag file, write a cross reference (in
 \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
 emacs \fBetags\fP is shipped with).
 .BR emacs ( 1 ),
 .BR vgrind ( 1 ),
 .BR vi ( 1 ).
 .SH COPYING
-Copyright (c) 1999 Free Software Foundation, Inc.
+Copyright
+.if t \(co
+.if n (c)
+1999, 2001 Free Software Foundation, Inc.
 .PP
-Permission is granted to make and distribute verbatim copies of
+Permission is granted to make and distribute verbatim copies of this
-this manual provided the copyright notice and this permission notice
+document provided the copyright notice and this permission notice are
-are preserved on all copies.
+preserved on all copies.
 .PP
-Permission is granted to copy and distribute modified versions of this
+Permission is granted to copy and distribute modified versions of
-manual under the conditions for verbatim copying, provided that the
+this document under the conditions for verbatim copying, provided that
-entire resulting derived work is distributed under the terms of a
+the entire resulting derived work is distributed under the terms of
-permission notice identical to this one.
+a permission notice identical to this one.
 .PP
 Permission is granted to copy and distribute translations of this
-manual into another language, under the above conditions for modified
+document into another language, under the above conditions for
-versions, except that this permission notice may be included in
+modified versions, except that this permission notice may be stated
-translations approved by the Free Software Foundation instead of in
+in a translation approved by the Free Software Foundation.
-the original English.
+.\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573

Mercurial > hg > xemacs-beta

comparison etc/etags.1 @ 2325:9d8bfee6e672