Manual Pages for UNIX Darwin command on man etags

etags(1) GNU Tools etags(1)

NAME

etags, ctags - generate tag file for Emacs, vi

SYNOPSIS

eettaaggss [-aCDGImRVh] [-i file] [-l language]

[-o tagfile] [-r regexp]

[-append] [-no-defines] [-no-globals] [-include=file]

[-ignore-indentation] [-language=language] [-members]

[-output=tagfile] [-regex=regexp] [-no-regex]

[-ignore-case-regex=regexp] [-help] [-version] file ...

ccttaaggss [-aCdgImRVh] [-BtTuvwx] [-l language]

[-o tagfile] [-r regexp]

[-append] [-backward-search] [-cxref] [-defines] [-forward-search]

[-globals] [-ignore-indentation] [-language=language] [-members]

[-output=tagfile] [-regex=regexp] [-ignore-case-regex=regexp]

[-typedefs] [-typedefs-and-c++] [-update] [-no-warn] [-help]

[-version] file ...

DESCRIPTION

The eettaaggss program is used to create a tag table file, in a format un-

derstood by eemmaaccss(11); the ccttaaggss program is used to create a similar ta-

ble in a format understood by vvii(11). Both forms of the program under-

stand the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Er-

lang, LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, Post-

script, Python, Prolog, Scheme and most assembler-like syntaxes. Both

forms read the files specified on the command line, and write a tag ta-

ble (defaults: TTAAGGSS for eettaaggss, ttaaggss for ccttaaggss) 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 --llaann-

gguuaaggee 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. OOPPTTIIOONNSS Some options make sense only for the vvii style tag files produced by ctags; eettaaggss does not recognize them. The programs accept unambiguous abbreviations for long option names.

-aa,, --aappppeenndd

Append to existing tag file. (For vvii-format tag files, see also

--uuppddaattee.)

-BB,, --bbaacckkwwaarrdd-sseeaarrcchh

Tag files written in the format expected by vvii contain regular

expression search instructions; the -BB option writes them using

the delimiter `??', to search backwards through files. The de-

fault is to use the delimiter `//', to search forwards through files. Only ccttaaggss accepts this option.

--ddeeccllaarraattiioonnss

In C and derived languages, create tags for function declara-

tions, and create tags for extern variables unless -no-globals

is used.

-dd,, --ddeeffiinneess

Create tag entries for C preprocessor constant definitions and enum constants, too. This is the default behavior for eettaaggss.

-DD,, --nnoo-ddeeffiinneess

Do not create tag entries for C preprocessor constant defini-

tions and enum constants. This may make the tags file much smaller if many header files are tagged. This is the default behavior for ccttaaggss.

-gg,, --gglloobbaallss

Create tag entries for global variables in C, C++, Objective C, Java, and Perl. This is the default behavior for eettaaggss.

-GG,, --nnoo-gglloobbaallss

Do not tag global variables. Typically this reduces the file size by one fourth. This is the default behavior for ccttaaggss.

-ii file, --iinncclluuddee==file

Include a note in the tag file indicating that, when searching for a tag, one should also consult the tags file file after checking the current file. This options is only accepted by eettaaggss.

-II,, --iiggnnoorree-iinnddeennttaattiioonn

Don't rely on indentation as much as we normally do. Currently,

this means not to assume that a closing brace in the first col-

umn is the final brace of a function or structure definition in C and C++.

-ll language, --llaanngguuaaggee==language

Parse the following files according to the given language. More than one such options may be intermixed with filenames. Use

--hheellpp to get a list of the available languages and their de-

fault filename 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 al-

together; only regexp matching is done in this case (see the

--rreeggeexx option).

-mm,, --mmeemmbbeerrss

Create tag entries for variables that are members of structure-

like constructs in C++, Objective C, Java.

-MM,, --nnoo-mmeemmbbeerrss

Do not tag member variables. This is the default behavior.

--ppaacckkaaggeess-oonnllyy

Only tag packages in Ada files.

-oo tagfile, --oouuttppuutt==tagfile

Explicit name of file for tag table; overrides default TTAAGGSS or

ttaaggss. (But ignored with -vv or -xx.)

-rr regexp, --rreeggeexx==regexp

--iiggnnoorree-ccaassee-rreeggeexx==regexp

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 --rreeggeexx, case is

significant, while it is not with --iiggnnoorree-ccaassee-rreeggeexx. May be

freely intermixed with filenames and the -RR option. The regexps

are cumulative, i.e. each option will add to the previous ones. The regexps are of the form: //tagregexp[//nameregexp]// where tagregexp is used to match the lines that must be tagged. It should not match useless characters. If the match is such that more characters than needed are unavoidably matched by tagregexp, it may be useful to add a nameregexp, to narrow down the tag scope. ccttaaggss ignores regexps without a nameregexp. The

syntax of regexps is the same as in emacs, augmented with inter-

vals of the form \{m,n\}, as in eedd or ggrreepp. Here are some examples. All the regexps are quoted to protect them from shell interpretation. Tag the DEFVAR macros in the emacs source files:

-regex='/[ \t]*DEFVAR[A-Z \t(]+"\([^"]+\)"'

Tag VHDL files (this example is a single long line, broken here for formatting reasons):

-language=none -regex='/[ \t]*\(ARCHITECTURE\|\ CONFIGURA-

TION\) +[^ ]* +OF/' -regex='/[ \t]*\ \(ATTRIBUTE\|ENTITY\|FUNC-

TION\|PACKAGE\( BODY\)?\ \|PROCE-

DURE\|PROCESS\|TYPE\)[ \t]+\([^ \t(]+\)/\3/'

Tag TCL files (this last example shows the usage of a tagreg-

exp):

-lang=none -regex='/proc[ \t]+\([^ \t]+\)/\1/'

A regexp can be preceded by {lang}, thus restricting it to match

lines of files of the specified language. Use eettaaggss --hheellpp to

obtain a list of the recognised languages. This feature is par-

ticularly useful inside rreeggeexx ffiilleess. 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 --rreeggeexx.

For example, the command

etags -regex=@regex.file *.c

reads the regexes contained in the file regex.file.

-RR,, --nnoo-rreeggeexx

Don't do any more regexp matching on the following files. May

be freely intermixed with filenames and the --rreeggeexx option.

-tt,, --ttyyppeeddeeffss

Record typedefs in C code as tags. Since this is the default behaviour of eettaaggss, only ccttaaggss accepts this option.

-TT,, --ttyyppeeddeeffss-aanndd-cc++++

Generate tag entries for typedefs, struct, enum, and union tags, and C++ member functions. Since this is the default behaviour of eettaaggss, only ccttaaggss accepts this option.

-uu,, --uuppddaattee

Update tag entries for files specified on command line, leaving

tag entries for other files in place. Currently, this is imple-

mented by deleting the existing entries for the given files and then rewriting the new entries at the end of the tags file. It is often faster to simply rebuild the entire tag file than to use this. Only ccttaaggss accepts this option.

-vv,, --vvggrriinndd

Instead of generating a tag file, write index (in vvggrriinndd format) to standard output. Only ccttaaggss accepts this option.

-ww,, --nnoo-wwaarrnn

Suppress warning messages about duplicate entries. The eettaaggss program does not check for duplicate entries, so this option is not allowed with it.

-xx,, --ccxxrreeff

Instead of generating a tag file, write a cross reference (in

ccxxrreeff format) to standard output. Only ccttaaggss accepts this op-

tion.

-hh,, -HH,, --hheellpp

Print usage information.

-VV,, --vveerrssiioonn

Print the current version of the program (same as the version of the emacs eettaaggss is shipped with).