4.4BSD/usr/share/man/cat1/ctags.0

CTAGS(1)                     BSD Reference Manual                     CTAGS(1)

NNAAMMEE
     ccttaaggss - create a tags file

SSYYNNOOPPSSIISS
     ccttaaggss [--BBFFaaddttuuwwvvxx] [--ff _t_a_g_s_f_i_l_e] _n_a_m_e _._._.

DDEESSCCRRIIPPTTIIOONN
     CCttaaggss makes a tags file for ex(1) from the specified C, Pascal, Fortran,
     YACC, lex, and lisp sources.  A tags file gives the locations of speci-
     fied objects in a group of files.  Each line of the tags file contains
     the object name, the file in which it is defined, and a search pattern
     for the object definition, separated by white-space.  Using the _t_a_g_s
     file, ex(1) can quickly locate these object definitions.  Depending upon
     the options provided to ccttaaggss, objects will consist of subroutines, type-
     defs, defines, structs, enums and unions.

     --BB      use backward searching patterns (?...?).

     --FF      use forward searching patterns (/.../) (the default).

     --aa      append to _t_a_g_s file.

     --dd      create tags for #defines that don't take arguments; #defines that
             take arguments are tagged automatically.

     --ff      Places the tag descriptions in a file called _t_a_g_s_f_i_l_e. The de-
             fault behaviour is to place them in a file called _t_a_g_s.

     --tt      create tags for typedefs, structs, unions, and enums.

     --uu      update the specified files in the _t_a_g_s file, that is, all refer-
             ences 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 _t_a_g_s
             file.)

     --vv      An index of the form expected by vgrind(1) is produced on the
             standard output.  This listing contains the object 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 sort(1).  Sample use:

                   ctags -v files | sort -f > index
                   vgrind -x index

     --ww      suppress warning diagnostics.

     --xx      ccttaaggss 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.

     Files whose names end in ..cc or ..hh are assumed to be C source files and
     are searched for C style routine and macro definitions.  Files whose
     names end in ..yy are assumed to be YACC source files.  Files whose names
     end in ..ll are assumed to be lisp files if their first non-blank character
     is `;', `(', or `[', otherwise, they are treated as lex files.  Other
     files are first examined to see if they contain any Pascal or Fortran
     routine definitions, and, if not, are searched for C style definitions.

     The tag main is treated specially in C programs.  The tag formed is cre-
     ated by prepending _M to the name of the file, with the trailing ..cc and
     any leading pathname components removed.  This makes use of ccttaaggss practi-
     cal in directories with more than one program.

     Yacc and lex files each have a special tag.  _Y_y_p_a_r_s_e is the start of the
     second section of the yacc file, and _y_y_l_e_x is the start of the second
     section of the lex file.

FFIILLEESS
     tags  default output tags file

DDIIAAGGNNOOSSTTIICCSS
     CCttaaggss exits with a value of 1 if an error occurred, 0 otherwise.  Dupli-
     cate objects are not considered errors.

SSEEEE AALLSSOO
     ex(1),  vi(1)

BBUUGGSS
     Recognition of ffuunnccttiioonnss, ssuubbrroouuttiinneess and pprroocceedduurreess for FORTRAN and Pas-
     cal 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.  CCttaaggss doesn't understand about Pascal
     types.

     The method of deciding whether to look for C, Pascal or FORTRAN functions
     is a hack.

     CCttaaggss relies on the input being well formed, and any syntactical errors
     will completely confuse it.  It also finds some legal syntax confusing;
     for example, since it doesn't understand #ifdef's (incidentally, that's a
     feature, not a bug), any code with unbalanced braces inside #ifdef's will
     cause it to become somewhat disoriented.  In a similar fashion, multiple
     line changes within a definition will cause it to enter the last line of
     the object, rather than the first, as the searching pattern.  The last
     line of multiple line typedef's will similarly be noted.

HHIISSTTOORRYY
     The ccttaaggss command appeared in 3.0BSD.

4th Berkeley Distribution        June 6, 1993                                2