home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / etags.1 < prev    next >
Encoding:
Text File  |  1995-07-26  |  10.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      eeeettttaaaaggggssss((((1111))))              GGGGNNNNUUUU TTTToooooooollllssss ((((11110000ffffeeeebbbb1111999999992222))))              eeeettttaaaaggggssss((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           etags -- generate tag file for Emacs
  10.           ctags -- generate tag file for vi
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           eeeettttaaaaggggssss [[[[----CCCCDDDDSSSSTTTTVVVVHHHHaaaaddddtttt]]]] [[[[----iiii _f_i_l_e]]]] [[[[----oooo _o_u_t_f_i_l_e]]]]
  14.           [--defines] [--no-defines] [--c++] [--typedefs]
  15.           [--typedefs-and-c++] [--ignore-indentation]
  16.           [--help] [--version]
  17.           [--include=_f_i_l_e] [--output=_o_u_t_f_i_l_e] [--append] _f_i_l_e ...
  18.  
  19.           ccccttttaaaaggggssss [[[[----CCCCDDDDSSSSTTTTVVVVHHHHaaaaddddtttt]]]] [[[[----BBBBFFFFuuuuvvvvwwwwxxxx]]]] [[[[----oooo _o_u_t_f_i_l_e]]]]
  20.           [--defines] [--no-defines] [--c++] [--typedefs]
  21.           [--typedefs-and-c++] [--ignore-indentation] [--no-warn]
  22.           [--backward-search] [--forward-search] [--vgrind] [--cxref]
  23.           [--help] [--version]
  24.           [--output=_o_u_t_f_i_l_e] [--append] [--update] _f_i_l_e ...
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           The `eeeettttaaaaggggssss' program is used to create a tag table file, in a
  28.           format  understood  by eeeemmmmaaaaccccssss(1111); the `ccccttttaaaaggggssss' program is used
  29.           to create a similar table in a format understood  by  vvvviiii(1111).
  30.           Both  forms  of the program understand the syntax of C, For-
  31.           tran, LaTeX, Scheme and Emacs Lisp/Common Lisp.  Both  forms
  32.           read  the  files  specified on the command line, and write a
  33.           tag table (defaults: `TAGS' for eeeettttaaaaggggssss, `tags' for ccccttttaaaaggggssss)  in
  34.           the  current  working  directory. The programs recognize the
  35.           language used in an input file based on its  file  name  and
  36.           contents; there are no switches for specifying the language.
  37.  
  38.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  39.           Some options make sense only for vvvviiii style tag  files;  eeeettttaaaaggggssss
  40.           does  not  recognize  them.  The programs accept unambiguous
  41.           abbreviations for long option names.
  42.  
  43.           ----dddd,,,, --------ddddeeeeffffiiiinnnneeeessss
  44.                Create tag entries for C preprocessor definitions, too.
  45.                This is the default behavior for -Betags.
  46.  
  47.           ----DDDD,,,, --------nnnnoooo----ddddeeeeffffiiiinnnneeeessss
  48.                Do not create tag entries for  C  preprocessor  defini-
  49.                tions.  This is the default behavior for -Bctags.
  50.  
  51.           ----CCCC,,,, --------cccc++++++++
  52.                Treat files with `.c' and `.h' extensions as C++  code,
  53.                not  C code.  Files with `.C', `.H', `.cxx', `.hxx', or
  54.                `.cc' extensions are always assumed to be C++ code.
  55.  
  56.           ----tttt,,,, --------ttttyyyyppppeeeeddddeeeeffffssss
  57.                Record typedefs in C code as tags.
  58.  
  59.           ----TTTT,,,, --------ttttyyyyppppeeeeddddeeeeffffssss----aaaannnndddd----cccc++++++++
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 7/7/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      eeeettttaaaaggggssss((((1111))))              GGGGNNNNUUUU TTTToooooooollllssss ((((11110000ffffeeeebbbb1111999999992222))))              eeeettttaaaaggggssss((((1111))))
  71.  
  72.  
  73.  
  74.                Generate tag entries for typedefs,  struct,  enum,  and
  75.                union tags, and C++ member functions.
  76.  
  77.           ----SSSS,,,, --------iiiiggggnnnnoooorrrreeee----iiiinnnnddddeeeennnnttttaaaattttiiiioooonnnn
  78.                Don't rely on indentation as much as  we  normally  do.
  79.                Currently,  this  means  not  to  assume that a closing
  80.                brace in the first column is the final brace of a func-
  81.                tion or structure definition.
  82.  
  83.           ----wwww,,,, --------nnnnoooo----wwwwaaaarrrrnnnn
  84.                Suppress warning messages about duplicate entries.  The
  85.                eeeettttaaaaggggssss  program does not check for duplicate entries, so
  86.                this option has no effect on it.
  87.  
  88.           ----BBBB,,,, --------bbbbaaaacccckkkkwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh
  89.                Tag files written in the format expected by vvvviiii  contain
  90.                regular  expression  search instructions; the ----BBBB option
  91.                writes them using the delimiter `????',  to  search  _b_a_c_k_-
  92.                _w_a_r_d_s through files.  Only ccccttttaaaaggggssss accepts this option.
  93.  
  94.           ----FFFF,,,, --------ffffoooorrrrwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh
  95.                Tag files written in the format expected by vvvviiii  contain
  96.                regular  expression  search instructions; the ----FFFF option
  97.                writes them using the delimiter `////', to search _f_o_r_w_a_r_d_s
  98.                through  files.   Only ccccttttaaaaggggssss accepts this option; it is
  99.                the default behavior.
  100.  
  101.           ----vvvv,,,, --------vvvvggggrrrriiiinnnndddd
  102.                Instead of generating  a  tag  file,  write  index  (in
  103.                vvvvggggrrrriiiinnnndddd  format) to standard output.  Only ccccttttaaaaggggssss accepts
  104.                this option.
  105.  
  106.           ----xxxx,,,, --------ccccxxxxrrrreeeeffff
  107.                Instead of generating a tag file, write a cross  refer-
  108.                ence  (in ccccxxxxrrrreeeeffff format) to standard output.  Only ccccttttaaaaggggssss
  109.                accepts this option.
  110.  
  111.           ----HHHH,,,, --------hhhheeeellllpppp
  112.                Print usage information.
  113.  
  114.           ----VVVV,,,, --------vvvveeeerrrrssssiiiioooonnnn
  115.                Print the current version of the program.
  116.  
  117.           ----iiii _f_i_l_e, --------iiiinnnncccclllluuuuddddeeee====_f_i_l_e
  118.                Include a  note  in  tag  file  indicating  that,  when
  119.                searching  for  a tag, one should also consult the tags
  120.                file _f_i_l_e after checking the current file.  Only  eeeettttaaaaggggssss
  121.                accepts this option.
  122.  
  123.           ----oooo _o_u_t_f_i_l_e, --------oooouuuuttttppppuuuutttt====_o_u_t_f_i_l_e
  124.                Explicit name of file for tag table; overrides  default
  125.                `TAGS' or `tags'.   (But ignored with ----vvvv or ----xxxx.)
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 7/7/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      eeeettttaaaaggggssss((((1111))))              GGGGNNNNUUUU TTTToooooooollllssss ((((11110000ffffeeeebbbb1111999999992222))))              eeeettttaaaaggggssss((((1111))))
  137.  
  138.  
  139.  
  140.           ----aaaa,,,, --------aaaappppppppeeeennnndddd
  141.                Append to existing tag file.  (For vi-format tag files,
  142.                see also --------uuuuppppddddaaaatttteeee.)
  143.  
  144.           ----uuuu,,,, --------uuuuppppddddaaaatttteeee
  145.                Update tag entries for _f_i_l_e_s specified on command line,
  146.                leaving tag entries for other files in place.  Current-
  147.                ly, this is implemented by deleting  the  existing  en-
  148.                tries  for  the  given files and then rewriting the new
  149.                entries at the end of the tags file.  It is often  fas-
  150.                ter  to  simply rebuild the entire tag file than to use
  151.                this.  (Implies vi-format tag file.)
  152.  
  153.  
  154.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  155.           `eeeemmmmaaaaccccssss' entry in iiiinnnnffffoooo; _G_N_U _E_m_a_c_s _M_a_n_u_a_l, Richard Stallman.
  156.           ccccxxxxrrrreeeeffff(1111), eeeemmmmaaaaccccssss(1111), vvvvggggrrrriiiinnnndddd(1111), vvvviiii(1111).
  157.  
  158.  
  159.      CCCCOOOOPPPPYYYYIIIINNNNGGGG
  160.           Copyright (c) 1992 Free Software Foundation, Inc.
  161.  
  162.           Permission is granted to make and distribute verbatim copies
  163.           of  this  manual provided the copyright notice and this per-
  164.           mission notice are preserved on all copies.
  165.  
  166.           Permission is granted to copy and distribute  modified  ver-
  167.           sions of this manual under the conditions for verbatim copy-
  168.           ing, provided that the entire resulting derived work is dis-
  169.           tributed under the terms of a permission notice identical to
  170.           this one.
  171.  
  172.           Permission is granted to copy and distribute translations of
  173.           this  manual  into  another language, under the above condi-
  174.           tions for modified versions, except that this permission no-
  175.           tice  may  be  included in translations approved by the Free
  176.           Software Foundation instead of in the original English.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 7/7/94)
  196.  
  197.  
  198.  
  199.