NAME

ctags − create a tags file

SYNOPSIS

ctags [ −BFatuwvx ] file ...

DESCRIPTION

Ctags makes a tags file for ex(1) from the specified C, Pascal and FORTRAN 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.  Using the tags file, ex can quickly find these objects definitions. 

Files whose name ends in .c or .h are assumed to be C source files and are searched for C routine and macro definitions.  Others are first examined to see if they contain any Pascal or FORTRAN routine definitions; if not, they are processed again looking for C definitions. 

The tag main is treated specially in C programs.  The tag formed is created by prepending M to the name of the file, with a trailing .c removed, if any, and leading pathname components also removed.  This makes use of ctags practical in directories with more than one program. 

OPTIONS

−x produce 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. 

−F use forward searching patterns (/.../) (default). 

−B use backward searching patterns (?...?). 

−a append to tags file. 

−t create tags for typedefs. 

−w suppress warning diagnostics. 

−u update the specified files 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 tags file. 

FILES

tagsoutput tags file

SEE ALSO

ex(1), vi(1)

BUGS

Recognition of functions, subroutines and procedures 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. 

Does not know about #ifdefs. 

Sun Release 2.0  —  Last change: 6 March 1984