ctags.html

ctags的最新版5.7,可以比较5.6版看看,免费下载

<!-- INDENTATION -->
<p>This feature is useful when preprocessor macros are used
in such a way that they cause syntactic confusion due to
their presence. Indeed, this is the best way of working
around a number of problems caused by the presence of
syntax-busting macros in source files (see <b>CAVEATS</b>,
below). Some examples will illustrate this point.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="23%"></td>
<td width="77%">
<p>int foo ARGDECL4(void *, ptr, long int, nbytes)</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>In the above example, the macro &quot;ARGDECL4&quot;
would be mistakenly interpreted to be the name of the
function instead of the correct name of &quot;foo&quot;.
Specifying <b>&minus;I</b> <i>ARGDECL4</i> results in the
correct behavior.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="23%"></td>
<td width="77%">
<p>/* creates an RCS version string in module */</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>MODULE_VERSION(&quot;$Revision: 590 $&quot;)</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>In the above example the macro invocation looks too much
like a function definition because it is not followed by a
semicolon (indeed, it could even be followed by a global
variable definition that would look much like a K&amp;R
style function parameter declaration). In fact, this seeming
function definition could possibly even cause the rest of
the file to be skipped over while trying to complete the
definition. Specifying <b>&minus;I</b>
<i>MODULE_VERSION+</i> would avoid such a problem.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="23%"></td>
<td width="77%">
<p>CLASS Example {<br>
// your content here<br>
};</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>The example above uses &quot;CLASS&quot; as a
preprocessor macro which expands to something different for
each platform. For instance CLASS may be defined as
&quot;class __declspec(dllexport)&quot; on Win32 platforms
and simply &quot;class&quot; on UNIX. Normally, the absence
of the C++ keyword &quot;class&quot; would cause the source
file to be incorrectly parsed. Correct behavior can be
restored by specifying <b>&minus;I</b>
<i>CLASS=class</i>.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>&minus;L</b> <i>file</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Read from <i>file</i> a list of file names for which tags
should be generated. If <i>file</i> is specified as
&quot;&minus;&quot;, then file names are read from standard
input. File names read using this option are processed
following file names appearing on the command line. Options
are also accepted in this input. If this option is specified
more than once, only the last will apply. <b>Note:</b>
<i>file</i> is read in line-oriented mode, where a new line
is the only delimiter and non-trailing white space is
considered significant, in order that file names containing
spaces may be supplied (however, trailing white space is
stripped from lines); this can affect how options are parsed
if included in the input.</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="5" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;n</b></p>
</td>
<td width="4%"></td>
<td width="47%">

<p>Equivalent to
<b>&minus;&minus;excmd</b>=<i>number</i>.</p>
</td>
<td width="35%">
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;N</b></p>
</td>
<td width="4%"></td>
<td width="47%">

<p>Equivalent to
<b>&minus;&minus;excmd</b>=<i>pattern</i>.</p>
</td>
<td width="35%">
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>&minus;o</b> <i>tagfile</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Equivalent to <b>&minus;f</b> <i>tagfile</i>.</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;R</b></p>
</td>
<td width="4%"></td>
<td width="82%">

<p>Equivalent to <b>&minus;&minus;recurse</b>.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;u</b></p>
</td>
<td width="4%"></td>
<td width="82%">

<p>Equivalent to <b>&minus;&minus;sort</b>=<i>no</i> (i.e.
&quot;unsorted&quot;).</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;V</b></p>
</td>
<td width="4%"></td>
<td width="82%">

<p>Equivalent to <b>&minus;&minus;verbose</b>.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;w</b></p>
</td>
<td width="4%"></td>
<td width="82%">

<p>This option is silently ignored for
backward-compatibility with the ctags of SVR4 Unix.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>&minus;x</b></p>
</td>
<td width="4%"></td>
<td width="82%">

<p>Print a tabular, human-readable cross reference (xref)
file to standard output instead of generating a tag file.
The information contained in the output includes: the tag
name; the kind of tag; the line number, file name, and
source line (with extra white space condensed) of the file
which defines the tag. No tag file is written and all
options affecting tag file output will be ignored. Example
applications for this feature are generating a listing of
all functions located in a source file (e.g. <b>ctags
&minus;x &minus;&minus;c&minus;kinds</b>=<i>f file</i>), or
generating a list of all externally visible global variables
located in a source file (e.g. <b>ctags &minus;x
&minus;&minus;c&minus;kinds</b>=<i>v</i>
<b>&minus;&minus;file&minus;scope</b>=<i>no file</i>). This
option must appear before the first file name.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">

<p><b>&minus;&minus;append</b>[=<i>yes</i>|<i>no</i>]</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Indicates whether tags generated from the specified files
should be appended to those already present in the tag file
or should replace them. This option is off by default. This
option must appear before the first file name.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">

<p><b>&minus;&minus;etags&minus;include</b>=<i>file</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Include a reference to <i>file</i> in the tag file. This
option may be specified as many times as desired. This
supports Emacs&rsquo; capability to use a tag file which
&quot;includes&quot; other tag files. [Available only in
etags mode]</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>&minus;&minus;exclude</b>=[<i>pattern</i>]</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Add <i>pattern</i> to a list of excluded files and
directories. This option may be specified as many times as
desired. For each file name considered by <b>ctags</b>, each
<i>pattern</i> specified using this option will be compared
against both the complete path (e.g. some/path/base.ext) and
the base name (e.g. base.ext) of the file, thus allowing
patterns which match a given file name irrespective of its
path, or match only a specific path. If appropriate support
is available from the runtime library of your C compiler,
then <i>pattern</i> may contain the usual shell wildcards
(not regular expressions) common on Unix (be sure to quote
the option parameter to protect the wildcards from being
expanded by the shell before being passed to <b>ctags</b>;
also be aware that wildcards can match the slash character,
&rsquo;/&rsquo;). You can determine if shell wildcards are
available on your platform by examining the output of the
<b>&minus;&minus;version</b> option, which will include
&quot;+wildcards&quot; in the compiled feature list;
otherwise, <i>pattern</i> is matched against file names
using a simple textual comparison.</p>
<!-- INDENTATION -->
<p>If <i>pattern</i> begins with the character
&rsquo;@&rsquo;, then the rest of the string is interpreted
as a file name from which to read exclusion patterns, one
per line. If <i>pattern</i> is empty, the list of excluded
patterns is cleared. Note that at program startup, the
default exclude list contains &quot;EIFGEN&quot;,
&quot;SCCS&quot;, &quot;RCS&quot;, and &quot;CVS&quot;,
which are names of directories for which it is generally not
desirable to descend while processing the
<b>&minus;&minus;recurse</b> option.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p><b>&minus;&minus;excmd</b>=<i>type</i></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="82%">
<p>Determines the type of EX command used to locate tags in
the source file. [Ignored in etags mode]</p>
<!-- INDENTATION -->
<p>The valid values for <i>type</i> (either the entire word
or the first letter is accepted) are:</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="18%"></td>
<td width="10%">

<p><i>number</i></p>
</td>
<td width="4%"></td>
<td width="68%">

<p>Use only line numbers in the tag file for locating tags.
This has four advantages:</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="4" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="32%"></td>