📄 ctags.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><html><head><!-- Copyright 1997 The Open Group, All Rights Reserved --><title>ctags</title></head><body bgcolor=white><center><font size=2>The Single UNIX ® Specification, Version 2<br>Copyright © 1997 The Open Group</font></center><hr size=2 noshade><h4><a name = "tag_001_014_263"> </a>NAME</h4><blockquote>ctags - create a tags file (<b>DEVELOPMENT</b>, <b>FORTRAN</b>)</blockquote><h4><a name = "tag_001_014_264"> </a>SYNOPSIS</h4><blockquote><pre><code>ctags <b>[</b>-a<b>][</b>-f <i>tagsfile</i><b>] </b><i>pathname</i> ...ctags -x <i>pathname</i> ...</code></pre></blockquote><h4><a name = "tag_001_014_265"> </a>DESCRIPTION</h4><blockquote>The<i>ctags</i>utility creates a<i>tags</i>file or an index of objectsfrom C-language or FORTRAN source files specified by the<i>pathname</i>operands.(FORTRAN source is processed only on systems supporting theFORTRAN option.)The tags file lists thelocators of language-specific objectswithin the source files.A locator consists of a name,pathname and either basic regular expressionor a line numberthat can be used in searching for the object definition.The objects that will be recognised are specified in theEXTENDED DESCRIPTION section.</blockquote><h4><a name = "tag_001_014_266"> </a>OPTIONS</h4><blockquote>The<i>ctags</i>utility supports the <b>XBD</b> specification, <a href="../xbd/utilconv.html#usg"><b>Utility Syntax Guidelines</b> </a> .<p>The following options are supported:<dl compact><dt><b>-a</b><dd>Append to tags file.<dt><b>-f </b><i>tagsfile</i><dd>Write the object locator lists into<i>tagsfile</i>instead of the default file named<b>tags</b>in the current directory.<dt><b>-x</b><dd>Produce a list of object names, the line number and filenamein which each is defined, as well as the text of that line,and write this to the standard output.A<b>tags</b>file is not created when<b>-x</b>is specified.</dl></blockquote><h4><a name = "tag_001_014_267"> </a>OPERANDS</h4><blockquote>The following<i>pathname</i>operands are supported:<dl compact><dt><i>file</i><b>.c</b><dd>Files with basenames ending with the<b>.c</b>suffix are treated as C-language source code.Such files that are not valid input to<i><a href="c89.html">c89</a></i>produce unspecified results.<dt><i>file</i><b>.h</b><dd>Files with basenames ending with the<b>.h</b>suffix are treated as C-language source code.Such files that are not valid input to<i><a href="c89.html">c89</a></i>produce unspecified results.<dt><i>file</i><b>.f</b><dd>Files with basenames ending with the<b>.f</b>suffix are treated as FORTRAN-language source code.Such files that are not valid input to<i><a href="fort77.html">fort77</a></i>produce unspecified results.</dl><p>The handling of other files is implementation-dependent.</blockquote><h4><a name = "tag_001_014_268"> </a>STDIN</h4><blockquote>See the INPUT FILES section.</blockquote><h4><a name = "tag_001_014_269"> </a>INPUT FILES</h4><blockquote>The input files must be text filescontaining source code in the language indicated by theoperand filename suffixes.</blockquote><h4><a name = "tag_001_014_270"> </a>ENVIRONMENT VARIABLES</h4><blockquote>The following environment variables affect the execution of<i>ctags</i>:<dl compact><dt><i>LANG</i><dd>Provide a default value for the internationalisation variablesthat are unset or null.If<i>LANG</i>is unset or null, the corresponding value from theimplementation-dependent default locale will be used.If any of the internationalisation variables containsan invalid setting, theutility will behave as if none of the variables had been defined.<dt><i>LC_ALL</i><dd>If set to a non-empty string value,override the values of all the other internationalisation variables.<dt><i>LC_COLLATE</i><dd>Determine theorder in which output is sortedfor the<b>-x</b>option.The POSIX locale determinesthe order in which the tags file is written.<dt><i>LC_CTYPE</i><dd>Determine thelocale for the interpretation of sequences of bytes of text data ascharacters (for example, single- as opposed to multi-byte charactersin arguments and input files).When processing C-language source code,if the locale is not compatible with theC locale described by the ISO C standard,the results are unspecified.<dt><i>LC_MESSAGES</i><dd>Determine the locale that should be used to affectthe format and contents of diagnosticmessages written to standard error.<dt><i>NLSPATH</i><dd>Determine the location of message cataloguesfor the processing of<i>LC_MESSAGES .</i></dl></blockquote><h4><a name = "tag_001_014_271"> </a>ASYNCHRONOUS EVENTS</h4><blockquote>Default.</blockquote><h4><a name = "tag_001_014_272"> </a>STDOUT</h4><blockquote>The list of object name information produced by the<b>-x</b>option is written to standard outputin the following format:<p><code><pre><tt>"%s %d %s %s"</tt>, <<i>object-name</i>>,<<i>line-number</i>>,<<i>filename</i>>,<<i>text</i>><br></pre></code>where<<i>text</i>>is the text of line<<i>line-number</i>>of file<<i>filename</i>>.</blockquote><h4><a name = "tag_001_014_273"> </a>STDERR</h4><blockquote>Used only for diagnostic messages.</blockquote><h4><a name = "tag_001_014_274"> </a>OUTPUT FILES</h4><blockquote>When the<b>-x</b>option is not specified, the format of the output file is:<p><code><tt>"%s\t%s\t/%s/\n"</tt>, <<i>identifier</i>>,<<i>filename</i>>,<<i>rexp</i>></code>where<<i>rexp</i>>is a basic regular expression(seethe <b>XBD</b> specification, <a href="../xbd/re.html#tag_007_003"><b>Basic Regular Expressions</b> </a> )that could be used by an editor to findthe defining instance of<<i>identifier</i>>in<<i>filename</i>>(where "defining instance" is indicated by the declarations listed inthe EXTENDED DESCRIPTION section).<p>An alternative format is:<p><code><tt>"%s\t%s\t%d\n"</tt>, <<i>identifier</i>>,<<i>filename</i>>,<<i>lineno</i>></code>where<<i>lineno</i>>is a decimal line numberthat could be used by an editor to find<<i>identifier</i>>in<<i>filename</i>>.This alternative format is not produced by<i>ctags</i>when it is used as described by this specification,but the standard utilities that process tags filesare able to process this format as wellas the preceding one.<p>In either format, the file will be sorted by identifier, based on thecollation sequence in the POSIX locale.<br></blockquote><h4><a name = "tag_001_014_275"> </a>EXTENDED DESCRIPTION</h4><blockquote>If the operand identifies C-language source, the<i>ctags</i>utility will attempt to produce an output linefor each of the following objects:<ul><p><li>function definitions<p><li>type definitions<p><li>macros with arguments.<p></ul><p>It may also produce output for any of the following objects:<ul><p><li>function prototypes<p><li>structures<p><li>unions<p><li>global variable definitions<p><li>enumeration types<p><li>macros without arguments<p><li><b>#define</b>statements<p><li><b>#line</b>statements.<p></ul><p>Any<b>#if</b>and<b>#ifdef</b>statements will produce no output.The tag<b>main</b>is treated specially in C programs.The tag formedis created by prefixing<b>M</b>to the name of the file, with the trailing<b>.c</b>,and leading pathname components (if any) removed.This special treatment of<b>main</b>makes the use of<i>ctags</i>practical in directories with more than one program.<p>If the operand identifies FORTRAN source, the<i>ctags</i>utility will produce an output line for eachfunction definition.It may also produce output for any of the following objects:<ul><p><li>subroutine definitions<p><li>COMMON statements<p><li>PARAMETER statements<p><li>DATA and BLOCK DATA statements<p><li>statement numbers.<p></ul><p>On systems that do not support the FORTRAN option,<i>ctags</i>produces unspecified results for FORTRAN source code files.It writes to standard error a message identifying this conditionand causes a non-zero exit status to be produced.<p>It is implementation-dependentwhat other objects (including duplicate identifiers)produce output.</blockquote><h4><a name = "tag_001_014_276"> </a>EXIT STATUS</h4><blockquote>The following exit values are returned:<dl compact><dt>0<dd>Successful completion.<dt>>0<dd>An error occurred.</dl></blockquote><h4><a name = "tag_001_014_277"> </a>CONSEQUENCES OF ERRORS</h4><blockquote>Default.<br></blockquote><h4><a name = "tag_001_014_278"> </a>APPLICATION USAGE</h4><blockquote>The output with<b>-x</b>is meant to be a simple indexthat can be written out as an off-line readable function index.If the input files to<i>ctags</i>(such as<b>.c</b>files) were not created usingthe same locales as those in effect when<i>ctags</i><b>-x</b>is run,results might not be as expected.<p>The description of C-language processing says "will attempt to"because the C language can be greatly confused, especiallythrough the use of<b>#defines</b>,and this utility would be ofno use if the real C preprocessor were run to identify them.The output from<i>ctags</i>may be fooled and incorrect for various constructs.</blockquote><h4><a name = "tag_001_014_279"> </a>EXAMPLES</h4><blockquote>None.</blockquote><h4><a name = "tag_001_014_280"> </a>FUTURE DIRECTIONS</h4><blockquote>The IEEE PASC 1003.2 Interpretations Committee has forwarded concerns about parts of this interface definition to the IEEE PASC Shell and Utilities Working Groupwhich is identifying the corrections.A future revision of this specification will align withIEEE Std. 1003.2b when finalised.</blockquote><h4><a name = "tag_001_014_281"> </a>SEE ALSO</h4><blockquote><i><a href="c89.html">c89</a></i>,<i><a href="fort77.html">fort77</a></i>,<i><a href="vi.html">vi</a></i>.</blockquote><hr size=2 noshade><center><font size=2>UNIX ® is a registered Trademark of The Open Group.<br>Copyright © 1997 The Open Group<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]</font></center><hr size=2 noshade></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -