X-Git-Url: http://git.chise.org/gitweb/?p=chise%2Fxemacs-chise.git.1;a=blobdiff_plain;f=etc%2Fetags.1;h=735b187744ed51ebb899e5ba0cc35e6da3a6e477;hp=2a6c37592dae50053b31746f0393280030de1e18;hb=afa9772e3fcbb4e80e3e4cfd1a40b4fccc6d08b8;hpb=7de03d6d03b52f49036eed2b6bb488112dc6ab05 diff --git a/etc/etags.1 b/etc/etags.1 index 2a6c375..735b187 100644 --- a/etc/etags.1 +++ b/etc/etags.1 @@ -1,6 +1,6 @@ .\" Copyright (c) 1992 Free Software Foundation .\" See section COPYING for conditions for redistribution -.TH etags 1 "19apr1994" "GNU Tools" "GNU Tools" +.TH etags 1 "02nov1999" "GNU Tools" "GNU Tools" .de BP .sp .ti -.2i @@ -12,24 +12,33 @@ etags, ctags \- generate tag file for Emacs, vi .SH SYNOPSIS .hy 0 .na -.B etags [\|\-aCDRSVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|] [\|\-i \fIregexp\fP\|] [\|\-o \fItagfile\fP\|] +.B etags [\|\-aCDGImRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|] +.if n .br +.B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] .br -[\|\-\-c++\|] [\|\-\-no\-defines\|] [\|\-\-ignore\-indentation\|] -[\|\-\-language=\fIlanguage\fP\|] [\|\-\-regex=\fIregexp\fP\|] -[\|\-\-no\-regexp\|] [\|\-\-help\|] [\|\-\-version\|] -[\|\-\-include=\fIfile\fP\|] [\|\-\-output=\fItagfile\fP\|] -[\|\-\-append\|] \fIfile\fP .\|.\|. +[\|\-\-append\|] [\|\-\-c++\|] [\|\-\-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 .\|.\|. -.B ctags [\|\-aCdRSVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|] +.B ctags [\|\-aCdgImRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|] +.if n .br +.B [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] .br -[\|\-i \fIregexp\fP\|] [\|\-o \fItagfile\fP\|] -[\|\-\-c++\|] [\|\-\-defines\|] [\|\-\-ignore\-indentation\|] -[\|\-\-no\-warn\|] [\|\-\-cxref\|] [\|\-\-backward\-search\|] -[\|\-\-forward\-search\|] [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|] -[\|\-\-language=\fIlanguage\fP\|] [\|\-\-regex=\fIregexp\fP\|] +[\|\-\-append\|] [\|\-\-backward\-search\|] [\|\-\-c++\|] +[\|\-\-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\|] -.br -[\|\-\-output=\fItagfile\fP\|] [\|\-\-append\|] [\|\-\-update\|] \fIfile\fP .\|.\|. +\fIfile\fP .\|.\|. .ad b .hy 1 .SH DESCRIPTION @@ -40,8 +49,8 @@ understood by format understood by .BR vi ( 1 )\c \&. Both forms of the program understand -the syntax of C, Objective C, C++, Java, Fortran, Pascal, Cobol, -LaTeX, Scheme, Emacs Lisp/Common Lisp, Postscript, Erlang, Prolog and +the syntax of C, Objective C, C++, Java, Fortran, Pascal, Cobol, Ada, Perl, +LaTeX, Scheme, Emacs Lisp/Common Lisp, Postscript, Erlang, Python, Prolog 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 @@ -77,18 +86,39 @@ 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. +.TP .B \-d, \-\-defines -Create tag entries for C preprocessor constant definitions +Create tag entries for C preprocessor constant definitions and enum constants, too. This is the -default behavior for \fBetags\fP, so this option is only accepted -by \fBctags\fP. +default behavior for \fBetags\fP. .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, so this option is only -accepted by \fBetags\fP. +This is the default behavior for \fBctags\fP. +.TP +.B \-g, \-\-globals +Create tag entries for global variables in C, C++, Objective C, Java, +and Perl. +This is the default behavior for \fBetags\fP. +.TP +.B \-G, \-\-no\-globals +Do not tag global variables. Typically this reduces the file size by +one fourth. This is the default behavior for \fBctags\fP. +.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. +.TP +.B \-I, \-\-ignore\-indentation +Don't rely on indentation as much as we normally do. Currently, this +means not to assume that a closing brace in the first column is the +final brace of a function or structure definition in C and C++. .TP \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP Parse the following files according to the given language. More than @@ -99,27 +129,30 @@ detection of language based on filename extension. 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 -\fB\-\-no_globals\fP -Do not tag global variables in C, C++, Objective C, Java. Typically -this reduces the file size by one fourth. +.B \-m, \-\-members +Create tag entries for variables that are members of structure-like +constructs in C++, Objective C, Java. .TP -\fB\-\-members\fP -Tag variables that are members of strucure-like constructs in C++, -Objective C, Java. +.B \-M, \-\-no\-members +Do not tag member variables. This is the default behavior. +.TP +.B \-\-packages\-only +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.) .TP \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 on language. 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: +\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: .br - - \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP + \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP .br where \fItagregexp\fP is used to match the lines that must be tagged. @@ -127,8 +160,8 @@ 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 id ed or grep. +\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. .br Here are some examples. All the regexps are quoted to protect them from shell interpretation. @@ -152,16 +185,25 @@ 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 +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, +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. +.br +For example, the command +.br +etags \-\-regex=@regex.file *.c +.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 \-S, \-\-ignore\-indentation -Don't rely on indentation as much as we normally do. Currently, this -means not to assume that a closing brace in the first column is the -final brace of a function or structure definition in C and C++. -.TP .B \-t, \-\-typedefs Record typedefs in C code as tags. Since this is the default behaviour of \fBetags\fP, only \fBctags\fP accepts this option. @@ -192,7 +234,7 @@ allowed with it. 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, \-\-help +.B \-h, \-H, \-\-help Print usage information. .TP .B \-V, \-\-version @@ -209,7 +251,7 @@ Stallman. .BR vi ( 1 ). .SH COPYING -Copyright (c) 1992 Free Software Foundation, Inc. +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