.\" Copyright (c) 1980 Regents of the University of California.
.\" All rights reserved. The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\" @(#)ctags.1 6.2 (Berkeley) %G%
ctags \- create a tags file
from the specified C, Pascal, Fortran, YACC, lex, and lisp sources.
A tags file gives the locations of specified objects (in this case
functions and typedefs) in a group of files. Each line of the tags
file contains the object name, the file in which it is defined, and
an address specification for the object definition. Functions are
searched with a pattern, typedefs with a line number. Specifiers are
given in separate fields on the line, separated by blanks or tabs.
can quickly find these objects definitions.
produces a list of object names, the line number and file
name on which each is defined, as well as the text of that line
and prints this on the standard output. This is a simple index
which can be printed out as an off-line readable function index.
an index of the form expected by
is produced on the standard output.
This listing contains the function name,
file name, and page number
(assuming 64 line pages).
Since the output will be sorted into lexicographic order,
it may be desired to run the output through
ctags \-v files | sort \-f > index
places the tag descriptions in a file called
this may be overridden with the
are assumed to be C source files and are searched for C routine and
are assumed to be YACC source files.
are assumed to be either lisp files
if their first non-blank character is `;', `(', or `[',
Other files are first examined to see if they contain any Pascal or
Fortran routine definitions; if not, they are processed again
looking for C definitions.
use forward searching patterns (/.../) (default).
use backward searching patterns (?...?).
create tags for typedefs.
suppressing warning diagnostics.
causing the specified files to be
in tags, that is, all references to them are deleted,
and the new values are appended to the file.
(Beware: this option is implemented in a way which is rather slow;
it is usually faster to simply rebuild the
is treated specially in C programs.
The tag formed is created by prepending
to the name of the file, with a trailing .c removed, if
any, and leading pathname components also removed.
practical in directories with more than one program.
Ken Arnold; FORTRAN added by Jim Kleckner; Bill Joy
C typedefs added by Ed Pelegri-Llopart.
Recognition of \fBfunctions\fR, \fBsubroutines\fR and \fBprocedures\fR
for FORTRAN and Pascal is done is a very simpleminded way.
No attempt is made to deal with block structure; if you have two
Pascal procedures in different blocks with the same name you lose.
The method of deciding whether to look for C or Pascal and FORTRAN
Does not know about #ifdefs.
Should know about Pascal types.
Relies on the input being well formed to detect typedefs.
Use of -tx shows only the last line of typedefs.