.\" Copyright (c) 1992 Free Software Foundation.\" See section COPYING for conditions for redistribution.TH etags 1 "19apr1994" "GNU Tools" "GNU Tools".de BP.sp.ti -.2i\(**...SH NAMEetags, 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\|].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 .\|.\|..B ctags [\|\-aCdRSVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\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\|][\|\-\-help\|] [\|\-\-version\|].br[\|\-\-output=\fItagfile\fP\|] [\|\-\-append\|] [\|\-\-update\|] \fIfile\fP .\|.\|..ad b.hy 1.SH DESCRIPTIONThe `\|\fBetags\fP\|' program is used to create a tag table file, in a formatunderstood by.BR emacs ( 1 )\c\&; the `\|\fBctags\fP\|' program is used to create a similar table in aformat understood by.BR vi ( 1 )\c\&. Both forms of the program understandthe syntax of C, Objective C, C++, Java, Fortran, Pascal, Cobol,LaTeX, Scheme, Emacs Lisp/Common Lisp, Postscript, Erlang, Prolog andmost assembler\-like syntaxes.Both forms read the files specified on the command line, and write a tagtable (defaults: `\|TAGS\|' for \fBetags\fP, `\|tags\|' for\fBctags\fP) in the current working directory.Files specified with relative file names will be recorded in the tagtable with file names relative to the directory where the tag tableresides. Files specified with absolute file names will be recordedwith absolute file names.The programs recognize the language used in an input file based on itsfile name and contents. The --language switch can be used to forceparsing of the file names following the switch according to the givenlanguage, overriding guesses based on filename extensions..SH OPTIONSSome options make sense only for the \fBvi\fP style tag files producedby ctags;\fBetags\fP does not recognize them.The programs accept unambiguous abbreviations for long option names..TP.B \-a, \-\-appendAppend to existing tag file. (For vi-format tag files, see also\fB\-\-update\fP.).TP.B \-B, \-\-backward\-searchTag files written in the format expected by \fBvi\fP contain regularexpression search instructions; the \fB\-B\fP option writes them usingthe delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files.The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fPthrough files.Only \fBctags\fP accepts this option..TP.B \-C, \-\-c++Treat files with `\|.c\|' and `\|.h\|' extensions as C++ code, not Ccode. Files with `\|.C\|', `\|.H\|', `\|.cxx\|', `\|.hxx\|', or`\|.cc\|' extensions are always assumed to be C++ code..TP.B \-d, \-\-definesCreate tag entries for C preprocessor constant definitions and enum constants, too. This is thedefault behavior for \fBetags\fP, so this option is only acceptedby \fBctags\fP..TP.B \-D, \-\-no\-definesDo not create tag entries for C preprocessor constant definitionsand 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 onlyaccepted by \fBetags\fP..TP\fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fPParse the following files according to the given language. More thanone such options may be intermixed with filenames. Use \fB\-\-help\fPto get a list of the available languages and their default filenameextensions. The `auto' language can be used to restore automaticdetection of language based on filename extension. The `none'language may be used to disable language parsing altogether; onlyregexp matching is done in this case (see the \fB\-\-regex\fP option)..TP\fB\-\-no_globals\fPDo not tag global variables in C, C++, Objective C, Java. Typicallythis reduces the file size by one fourth..TP\fB\-\-members\fPTag variables that are members of strucure-like constructs in C++,Objective C, Java. .TP\fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fPExplicit 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\fPMake tags based on regexp matching for each line of the filesfollowing this option, in addition to the tags made with the standardparsing based on language. May be freely intermixed with filenamesand the \fB\-R\fP option. The regexps are cumulative, i.e. eachoption will add to the previous ones. The regexps are of the form:.br \fB/\fP\fItagregexp\fP[\fB/\fP\fInameregexp\fP]\fB/\fP.brwhere \fItagregexp\fP is used to match the lines that must be tagged.It should not match useless characters. If the match issuch that more characters than needed are unavoidably matched by\fItagregexp\fP, it may be useful to add a \fInameregexp\fP, tonarrow 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..brHere are some examples. All the regexps are quoted to protect themfrom shell interpretation..brTag the DEFVAR macros in the emacs source files:.br\fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"\/'\fP.brTag VHDL files (this example is a single long line, broken here forformatting reasons):.br\fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\\\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\\\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP.brTag TCL files (this last example shows the usage of a \fItagregexp\fP):.br\fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP.TP.B \-R, \-\-no\-regexDon't do any more regexp matching on the following files. May befreely intermixed with filenames and the \fB\-\-regex\fP option..TP.B \-S, \-\-ignore\-indentationDon't rely on indentation as much as we normally do. Currently, thismeans not to assume that a closing brace in the first column is thefinal brace of a function or structure definition in C and C++..TP.B \-t, \-\-typedefsRecord typedefs in C code as tags. Since this is the default behaviourof \fBetags\fP, only \fBctags\fP accepts this option..TP.B \-T, \-\-typedefs\-and\-c++Generate tag entries for typedefs, struct, enum, and union tags, andC++ member functions. Since this is the default behaviourof \fBetags\fP, only \fBctags\fP accepts this option..TP.B \-u, \-\-updateUpdate tag entries for \fIfiles\fP specified on command line, leavingtag entries for other files in place. Currently, this is implementedby deleting the existing entries for the given files and thenrewriting the new entries at the end of the tags file. It is oftenfaster to simply rebuild the entire tag file than to use this.Only \fBctags\fP accepts this option..TP.B \-v, \-\-vgrindInstead of generating a tag file, write index (in \fBvgrind\fP format)to standard output. Only \fBctags\fP accepts this option..TP.B \-w, \-\-no\-warnSuppress warning messages about duplicate entries. The \fBetags\fPprogram does not check for duplicate entries, so this option is notallowed with it..TP.B \-x, \-\-cxrefInstead 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, \-\-helpPrint usage information..TP.B \-V, \-\-versionPrint the current version of the program (same as the version of theemacs \fBetags\fP is shipped with)..SH "SEE ALSO"`\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, RichardStallman..br.BR cxref ( 1 ),.BR emacs ( 1 ),.BR vgrind ( 1 ),.BR vi ( 1 )..SH COPYINGCopyright (c) 1992 Free Software Foundation, Inc..PPPermission is granted to make and distribute verbatim copies ofthis manual provided the copyright notice and this permission noticeare preserved on all copies..PPPermission is granted to copy and distribute modified versions of thismanual under the conditions for verbatim copying, provided that theentire resulting derived work is distributed under the terms of apermission notice identical to this one..PPPermission is granted to copy and distribute translations of thismanual into another language, under the above conditions for modifiedversions, except that this permission notice may be included intranslations approved by the Free Software Foundation instead of inthe original English.