aboutsummaryrefslogtreecommitdiff
path: root/ctags/man
diff options
context:
space:
mode:
authorIndrajith K L2022-12-03 17:00:20 +0530
committerIndrajith K L2022-12-03 17:00:20 +0530
commitf5c4671bfbad96bf346bd7e9a21fc4317b4959df (patch)
tree2764fc62da58f2ba8da7ed341643fc359873142f /ctags/man
downloadcli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.tar.gz
cli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.tar.bz2
cli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.zip
Adds most of the toolsHEADmaster
Diffstat (limited to 'ctags/man')
-rw-r--r--ctags/man/ctags-client-tools.7.html869
-rw-r--r--ctags/man/ctags-faq.7.html757
-rw-r--r--ctags/man/ctags-incompatibilities.7.html571
-rw-r--r--ctags/man/ctags-lang-iPythonCell.7.html449
-rw-r--r--ctags/man/ctags-lang-inko.7.html400
-rw-r--r--ctags/man/ctags-lang-julia.7.html600
-rw-r--r--ctags/man/ctags-lang-python.7.html804
-rw-r--r--ctags/man/ctags-lang-r.7.html482
-rw-r--r--ctags/man/ctags-lang-sql.7.html518
-rw-r--r--ctags/man/ctags-lang-verilog.7.html569
-rw-r--r--ctags/man/ctags-optlib.7.html785
-rw-r--r--ctags/man/ctags.1.html2273
-rw-r--r--ctags/man/readtags.1.html692
-rw-r--r--ctags/man/tags.5.html870
14 files changed, 10639 insertions, 0 deletions
diff --git a/ctags/man/ctags-client-tools.7.html b/ctags/man/ctags-client-tools.7.html
new file mode 100644
index 0000000..1ddb80c
--- /dev/null
+++ b/ctags/man/ctags-client-tools.7.html
@@ -0,0 +1,869 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-client-tools</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-client-tools">
+<span id="ctags-client-tools-7"></span>
+<h1 class="title">ctags-client-tools</h1>
+<h2 class="subtitle" id="hints-for-developing-a-tool-using-ctags-command-and-tags-output">Hints for developing a tool using ctags command and tags output</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> [options] [file(s)]</div>
+<div class="line"><strong>etags</strong> [options] [file(s)]</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p><strong>Client tool</strong> means a tool running the ctags command
+and/or reading a tags file generated by ctags command.
+This man page gathers hints for people who develop client tools.</p>
+</div>
+<div class="section" id="pseudo-tags">
+<h1>PSEUDO-TAGS</h1>
+<p><strong>Pseudo-tags</strong>, stored in a tag file, indicate how
+ctags generated the tags file: whether the
+tags file is sorted or not, which version of tags file format is used,
+the name of tags generator, and so on. The opposite term for
+pseudo-tags is <strong>regular-tags</strong>. A regular-tag is for a language
+object in an input file. A pseudo-tag is for the tags file
+itself. Client tools may use pseudo-tags as reference for processing
+regular-tags.</p>
+<p>A pseudo-tag is stored in a tags file in the same format as
+regular-tags as described in tags(5), except that pseudo-tag names
+are prefixed with &quot;!_&quot;. For the general information about
+pseudo-tags, see &quot;TAG FILE INFORMATION&quot; in tags(5).</p>
+<p>An example of a pseudo tag:</p>
+<pre class="literal-block">
+!_TAG_PROGRAM_NAME Universal Ctags /Derived from Exuberant Ctags/
+</pre>
+<p>The value, &quot;2&quot;, associated with the pseudo tag &quot;TAG_PROGRAM_NAME&quot;, is
+used in the field for input file. The description, &quot;Derived from
+Exuberant Ctags&quot;, is used in the field for pattern.</p>
+<p>Universal Ctags extends the naming scheme of the classical pseudo-tags
+available in Exuberant Ctags for emitting language specific
+information as pseudo tags:</p>
+<pre class="literal-block">
+!_{pseudo-tag-name}!{language-name} {associated-value} /{description}/
+</pre>
+<p>The language-name is appended to the pseudo-tag name with a separator, &quot;!&quot;.</p>
+<p>An example of pseudo tag with a language suffix:</p>
+<pre class="literal-block">
+!_TAG_KIND_DESCRIPTION!C f,function /function definitions/
+</pre>
+<p>This pseudo-tag says &quot;the function kind of C language is enabled
+when generating this tags file.&quot; <tt class="docutils literal"><span class="pre">--pseudo-tags</span></tt> is the option for
+enabling/disabling individual pseudo-tags. When enabling/disabling a
+pseudo tag with the option, specify the tag name only
+&quot;TAG_KIND_DESCRIPTION&quot;, without the prefix (&quot;!_&quot;) or the suffix (&quot;!C&quot;).</p>
+<div class="section" id="options-for-pseudo-tags">
+<h2>Options for Pseudo-tags</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--extras=+p</span></tt> (or <tt class="docutils literal"><span class="pre">--extras=+{pseudo}</span></tt>)</dt>
+<dd><p class="first">Forces writing pseudo-tags.</p>
+<p class="last">ctags emits pseudo-tags by default when writing tags
+to a regular file (e.g. &quot;tags'.) However, when specifying <tt class="docutils literal"><span class="pre">-o</span> -</tt>
+or <tt class="docutils literal"><span class="pre">-f</span> -</tt> for writing tags to standard output,
+ctags doesn't emit pseudo-tags. <tt class="docutils literal"><span class="pre">--extras=+p</span></tt> or
+<tt class="docutils literal"><span class="pre">--extras=+{pseudo}</span></tt> will force pseudo-tags to be written.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt></dt>
+<dd><p class="first">Lists available types of pseudo-tags and shows whether they are enabled or disabled.</p>
+<p class="last">Running ctags with <tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt> option
+lists available pseudo-tags. Some of pseudo-tags newly introduced
+in Universal Ctags project are disabled by default. Use
+<tt class="docutils literal"><span class="pre">--pseudo-tags=...</span></tt> to enable them.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--pseudo-tags=[+|-]names|*</span></tt></dt>
+<dd><p class="first">Specifies a list of pseudo-tag types to include in the output.</p>
+<p>The parameters are a set of pseudo tag names. Valid pseudo tag names
+can be listed with <tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt>. Surround each name in the set
+with braces, like &quot;{TAG_PROGRAM_AUTHOR}&quot;. You don't have to include the &quot;!_&quot;
+pseudo tag prefix when specifying a name in the option argument for <tt class="docutils literal"><span class="pre">--pseudo-tags=</span></tt>
+option.</p>
+<p>pseudo-tags don't have a notation using one-letter flags.</p>
+<p class="last">If a name is preceded by either the '+' or '-' characters, that
+tags's effect has been added or removed. Otherwise the names replace
+any current settings. All entries are included if '*' is given.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--fields=+E</span></tt> (or <tt class="docutils literal"><span class="pre">--fields=+{extras}</span></tt>)</dt>
+<dd><p class="first">Attach &quot;extras:pseudo&quot; field to pseudo-tags.</p>
+<p>An example of pseudo tags with the field:</p>
+<pre class="literal-block">
+!_TAG_PROGRAM_NAME Universal Ctags /Derived from Exuberant Ctags/ extras:pseudo
+</pre>
+<p class="last">If the name of a normal tag in a tag file starts with &quot;!_&quot;, a
+client tool cannot distinguish whether the tag is a regular-tag or
+pseudo-tag. The fields attached with this option help the tool
+distinguish them.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="list-of-notable-pseudo-tags">
+<h2>List of notable pseudo-tags</h2>
+<p>Running ctags with <tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt> option lists available types
+of pseudo-tags with short descriptions. This subsection shows hints
+for using notable ones.</p>
+<dl class="docutils">
+<dt><tt class="docutils literal">TAG_EXTRA_DESCRIPTION</tt> (new in Universal Ctags)</dt>
+<dd><p class="first">Indicates the names and descriptions of enabled extras:</p>
+<pre class="literal-block">
+!_TAG_EXTRA_DESCRIPTION {extra-name} /description/
+!_TAG_EXTRA_DESCRIPTION!{language-name} {extra-name} /description/
+</pre>
+<p>If your tool relies on some extra tags (extras), refer to
+the pseudo-tags of this type. A tool can reject the tags file that
+doesn't include expected extras, and raise an error in an early
+stage of processing.</p>
+<p>An example of the pseudo-tags:</p>
+<pre class="literal-block">
+$ ctags --extras=+p --pseudo-tags='{TAG_EXTRA_DESCRIPTION}' -o - input.c
+!_TAG_EXTRA_DESCRIPTION anonymous /Include tags for non-named objects like lambda/
+!_TAG_EXTRA_DESCRIPTION fileScope /Include tags of file scope/
+!_TAG_EXTRA_DESCRIPTION pseudo /Include pseudo tags/
+!_TAG_EXTRA_DESCRIPTION subparser /Include tags generated by subparsers/
+...
+</pre>
+<p class="last">A client tool can know &quot;{anonymous}&quot;, &quot;{fileScope}&quot;, &quot;{pseudo}&quot;,
+and &quot;{subparser}&quot; extras are enabled from the output.</p>
+</dd>
+<dt><tt class="docutils literal">TAG_FIELD_DESCRIPTION</tt> (new in Universal Ctags)</dt>
+<dd><p class="first">Indicates the names and descriptions of enabled fields:</p>
+<pre class="literal-block">
+!_TAG_FIELD_DESCRIPTION {field-name} /description/
+!_TAG_FIELD_DESCRIPTION!{language-name} {field-name} /description/
+</pre>
+<p>If your tool relies on some fields, refer to the pseudo-tags of
+this type. A tool can reject a tags file that doesn't include
+expected fields, and raise an error in an early stage of
+processing.</p>
+<p>An example of the pseudo-tags:</p>
+<pre class="literal-block">
+$ ctags --fields-C=+'{macrodef}' --extras=+p --pseudo-tags='{TAG_FIELD_DESCRIPTION}' -o - input.c
+!_TAG_FIELD_DESCRIPTION file /File-restricted scoping/
+!_TAG_FIELD_DESCRIPTION input /input file/
+!_TAG_FIELD_DESCRIPTION name /tag name/
+!_TAG_FIELD_DESCRIPTION pattern /pattern/
+!_TAG_FIELD_DESCRIPTION typeref /Type and name of a variable or typedef/
+!_TAG_FIELD_DESCRIPTION!C macrodef /macro definition/
+...
+</pre>
+<p class="last">A client tool can know &quot;{file}&quot;, &quot;{input}&quot;, &quot;{name}&quot;, &quot;{pattern}&quot;,
+and &quot;{typeref}&quot; fields are enabled from the output.
+The fields are common in languages. In addition to the common fields,
+the tool can known &quot;{macrodef}&quot; field of C language is also enabled.</p>
+</dd>
+<dt><tt class="docutils literal">TAG_FILE_ENCODING</tt> (new in Universal Ctags)</dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_FILE_FORMAT</tt></dt>
+<dd>See also tags(5).</dd>
+<dt><tt class="docutils literal">TAG_FILE_SORTED</tt></dt>
+<dd>See also tags(5).</dd>
+<dt><tt class="docutils literal">TAG_KIND_DESCRIPTION</tt> (new in Universal Ctags)</dt>
+<dd><p class="first">Indicates the names and descriptions of enabled kinds:</p>
+<pre class="literal-block">
+!_TAG_KIND_DESCRIPTION!{language-name} {kind-letter},{kind-name} /description/
+</pre>
+<p>If your tool relies on some kinds, refer to the pseudo-tags of
+this type. A tool can reject the tags file that doesn't include
+expected kinds, and raise an error in an early stage of
+processing.</p>
+<p>Kinds are language specific, so a language name is always
+appended to the tag name as suffix.</p>
+<p>An example of the pseudo-tags:</p>
+<pre class="literal-block">
+$ ctags --extras=+p --kinds-C=vfm --pseudo-tags='{TAG_KIND_DESCRIPTION}' -o - input.c
+!_TAG_KIND_DESCRIPTION!C f,function /function definitions/
+!_TAG_KIND_DESCRIPTION!C m,member /struct, and union members/
+!_TAG_KIND_DESCRIPTION!C v,variable /variable definitions/
+...
+</pre>
+<p class="last">A client tool can know &quot;{function}&quot;, &quot;{member}&quot;, and &quot;{variable}&quot;
+kinds of C language are enabled from the output.</p>
+</dd>
+<dt><tt class="docutils literal">TAG_KIND_SEPARATOR</tt> (new in Universal Ctags)</dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_OUTPUT_EXCMD</tt> (new in Universal Ctags)</dt>
+<dd>Indicates the specified type of EX command with <tt class="docutils literal"><span class="pre">--excmd</span></tt> option.</dd>
+<dt><tt class="docutils literal">TAG_OUTPUT_FILESEP</tt> (new in Universal Ctags)</dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_OUTPUT_MODE</tt> (new in Universal Ctags)</dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_PATTERN_LENGTH_LIMIT</tt> (new in Universal Ctags)</dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_PROC_CWD</tt> (new in Universal Ctags)</dt>
+<dd><p class="first">Indicates the working directory of ctags during processing.</p>
+<p>This pseudo-tag helps a client tool solve the absolute paths for
+the input files for tag entries even when they are tagged with
+relative paths.</p>
+<p>An example of the pseudo-tags:</p>
+<pre class="literal-block">
+$ cat tags
+!_TAG_PROC_CWD /tmp/ //
+main input.c /^int main (void) { return 0; }$/;&quot; f typeref:typename:int
+...
+</pre>
+<p class="last">From the regular tag for &quot;main&quot;, the client tool can know the
+&quot;main&quot; is at &quot;input.c&quot;. However, it is a relative path. So if the
+directory where ctags run and the directory
+where the client tool runs are different, the client tool cannot
+find &quot;input.c&quot; from the file system. In that case,
+<tt class="docutils literal">TAG_PROC_CWD</tt> gives the tool a hint; &quot;input.c&quot; may be at &quot;/tmp&quot;.</p>
+</dd>
+<dt><tt class="docutils literal">TAG_PROGRAM_NAME</tt></dt>
+<dd>TBW</dd>
+<dt><tt class="docutils literal">TAG_ROLE_DESCRIPTION</tt> (new in Universal Ctags)</dt>
+<dd><p class="first">Indicates the names and descriptions of enabled roles:</p>
+<pre class="literal-block">
+!_TAG_ROLE_DESCRIPTION!{language-name}!{kind-name} {role-name} /description/
+</pre>
+<p class="last">If your tool relies on some roles, refer to the pseudo-tags of
+this type. Note that a role owned by a disabled kind is not listed
+even if the role itself is enabled.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="redundant-kinds">
+<h1>REDUNDANT-KINDS</h1>
+<p>TBW</p>
+</div>
+<div class="section" id="multiple-languages-for-an-input-file">
+<h1>MULTIPLE-LANGUAGES FOR AN INPUT FILE</h1>
+<p>Universal ctags can run multiple parsers.
+That means a parser, which supports multiple parsers, may output tags for
+different languages. <tt class="docutils literal">language</tt>/<tt class="docutils literal">l</tt> field can be used to show the language
+for each tag.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>cat /tmp/foo.html
+<span class="generic output">&lt;html&gt;
+&lt;script&gt;var x = 1&lt;/script&gt;
+&lt;h1&gt;title&lt;/h1&gt;
+&lt;/html&gt;
+</span><span class="generic prompt">$ </span>./ctags -o - --extras<span class="operator">=</span>+g /tmp/foo.html
+<span class="generic output">title /tmp/foo.html /^ &lt;h1&gt;title&lt;\/h1&gt;$/;&quot; h
+x /tmp/foo.html /var x = 1/;&quot; v
+</span><span class="generic prompt">$ </span>./ctags -o - --extras<span class="operator">=</span>+g --fields<span class="operator">=</span>+l /tmp/foo.html
+<span class="generic output">title /tmp/foo.html /^ &lt;h1&gt;title&lt;\/h1&gt;$/;&quot; h language:HTML
+x /tmp/foo.html /var x = 1/;&quot; v language:JavaScript</span>
+</pre>
+</div>
+<div class="section" id="utilizing-readtags">
+<h1>UTILIZING READTAGS</h1>
+<p>See readtags(1) to know how to use readtags. This section is for discussing
+some notable topics for client tools.</p>
+<div class="section" id="build-filter-sorter-expressions">
+<h2>Build Filter/Sorter Expressions</h2>
+<p>Certain escape sequences in expressions are recognized by readtags. For
+example, when searching for a tag that matches <tt class="docutils literal"><span class="pre">a\?b</span></tt>, if using a filter
+expression like <tt class="docutils literal">'(eq? $name <span class="pre">&quot;a\?b&quot;)'</span></tt>, since <tt class="docutils literal">\?</tt> is translated into a
+single <tt class="docutils literal">?</tt> by readtags, it actually searches for <tt class="docutils literal"><span class="pre">a?b</span></tt>.</p>
+<p>Another problem is if a single quote appear in filter expressions (which is
+also wrapped by single quotes), it terminates the expression, producing broken
+expressions, and may even cause unintended shell injection. Single quotes can
+be escaped using <tt class="docutils literal"><span class="pre">'&quot;'&quot;'</span></tt>.</p>
+<p>So, client tools need to:</p>
+<ul class="simple">
+<li>Replace <tt class="docutils literal">\</tt> by <tt class="docutils literal">\\</tt></li>
+<li>Replace <tt class="docutils literal">'</tt> by <tt class="docutils literal"><span class="pre">'&quot;'&quot;'</span></tt></li>
+</ul>
+<p>inside the expressions. If the expression also contains strings, <tt class="docutils literal">&quot;</tt> in the
+strings needs to be replaced by <tt class="docutils literal">\&quot;</tt>.</p>
+<p>Client tools written in Lisp could build the expression using lists. <tt class="docutils literal">prin1</tt>
+(in Common Lisp style Lisps) and <tt class="docutils literal">write</tt> (in Scheme style Lisps) can
+translate the list into a string that can be directly used. For example, in
+EmacsLisp:</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-client-tools.7.rst</tt>, line 308)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;EmacsLisp&quot;.</p>
+<pre class="literal-block">
+.. code-block:: EmacsLisp
+
+ (let ((name &quot;hi&quot;))
+ (prin1 `(eq? $name ,name)))
+ =&gt; &quot;(eq\\? $name &quot;hi&quot;)&quot;
+
+</pre>
+</div>
+<p>The &quot;?&quot; is escaped, and readtags can handle it. Scheme style Lisps should do
+proper escaping so the expression readtags gets is just the expression passed
+into <tt class="docutils literal">write</tt>. Common Lisp style Lisps may produce unrecognized escape
+sequences by readtags, like <tt class="docutils literal">\#</tt>. Readtags provides some aliases for these
+Lisps:</p>
+<ul class="simple">
+<li>Use <tt class="docutils literal">true</tt> for <tt class="docutils literal">#t</tt>.</li>
+<li>Use <tt class="docutils literal">false</tt> for <tt class="docutils literal">#f</tt>.</li>
+<li>Use <tt class="docutils literal">nil</tt> or <tt class="docutils literal">()</tt> for <tt class="docutils literal">()</tt>.</li>
+<li>Use <tt class="docutils literal"><span class="pre">(string-&gt;regexp</span> &quot;PATTERN&quot;)</tt> for <tt class="docutils literal">#/PATTERN/</tt>. Use
+<tt class="docutils literal"><span class="pre">(string-&gt;regexp</span> &quot;PATTERN&quot; <span class="pre">:case-fold</span> true)</tt> for <tt class="docutils literal">#/PATTERN/i</tt>. Notice
+that <tt class="docutils literal"><span class="pre">string-&gt;regexp</span></tt> doesn't require escaping &quot;/&quot; in the pattern.</li>
+</ul>
+<p>Notice that even when the client tool uses this method, <tt class="docutils literal">'</tt> still needs to be
+replaced by <tt class="docutils literal"><span class="pre">'&quot;'&quot;'</span></tt> to prevent broken expressions and shell injection.</p>
+<p>Another thing to notice is that missing fields are represented by <tt class="docutils literal">#f</tt>, and
+applying string operators to them will produce an error. You should always
+check if a field is missing before applying string operators. See the
+&quot;Filtering&quot; section in readtags(1) to know how to do this. Run &quot;readtags -H
+filter&quot; to see which operators take string arguments.</p>
+</div>
+<div class="section" id="parse-readtags-output">
+<h2>Parse Readtags Output</h2>
+<p>In the output of readtags, tabs can appear in all field values (e.g., the tag
+name itself could contain tabs), which makes it hard to split the line into
+fields. Client tools should use the <tt class="docutils literal"><span class="pre">-E</span></tt> option, which keeps the escape
+sequences in the tags file, so the only field that could contain tabs is the
+pattern field.</p>
+<p>The pattern field could:</p>
+<ul class="simple">
+<li>Use a line number. It will look like <tt class="docutils literal">number;&quot;</tt> (e.g. <tt class="docutils literal">10;&quot;</tt>).</li>
+<li>Use a search pattern. It will look like <tt class="docutils literal"><span class="pre">/pattern/;&quot;</span></tt> or <tt class="docutils literal"><span class="pre">?pattern?;&quot;</span></tt>.
+Notice that the search pattern could contain tabs.</li>
+<li>Combine these two, like <tt class="docutils literal"><span class="pre">number;/pattern/;&quot;</span></tt> or <tt class="docutils literal"><span class="pre">number;?pattern?;&quot;</span></tt>.</li>
+</ul>
+<p>These are true for tags files using extended format, which is the default one.
+The legacy format (i.e. <tt class="docutils literal"><span class="pre">--format=1</span></tt>) doesn't include the semicolons. It's
+old and barely used, so we won't discuss it here.</p>
+<p>Client tools could split the line using the following steps:</p>
+<ul class="simple">
+<li>Find the first 2 tabs in the line, so we get the name and input field.</li>
+<li>From the 2nd tab:<ul>
+<li>If a <tt class="docutils literal">/</tt> follows, then the pattern delimiter is <tt class="docutils literal">/</tt>.</li>
+<li>If a <tt class="docutils literal">?</tt> follows, then the pattern delimiter is <tt class="docutils literal">?</tt>.</li>
+<li>If a number follows, then:<ul>
+<li>If a <tt class="docutils literal">;/</tt> follows the number, then the delimiter is <tt class="docutils literal">/</tt>.</li>
+<li>If a <tt class="docutils literal">;?</tt> follows the number, then the delimiter is <tt class="docutils literal">?</tt>.</li>
+<li>If a <tt class="docutils literal">;&quot;</tt> follows the number, then the field uses only line number, and
+there's no pattern delimiter (since there's no regex pattern). In this
+case the pattern field ends at the 3rd tab.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>After the opening delimiter, find the next unescaped pattern delimiter, and
+that's the closing delimiter. It will be followed by <tt class="docutils literal">;&quot;</tt> and then a tab.
+That's the end of the pattern field. By &quot;unescaped pattern delimiter&quot;, we
+mean there's an even number (including 0) of backslashes before it.</li>
+<li>From here, split the rest of the line into fields by tabs.</li>
+</ul>
+<p>Then, the escape sequences in fields other than the pattern field should be
+translated. See &quot;Proposal&quot; in tags(5) to know about all the escape sequences.</p>
+</div>
+<div class="section" id="make-use-of-the-pattern-field">
+<h2>Make Use of the Pattern Field</h2>
+<p>The pattern field specifies how to find a tag in its source file. The code
+generating this field seems to have a long history, so there are some pitfalls
+and it's a bit hard to handle. A client tool could simply require the <tt class="docutils literal">line:</tt>
+field and jump to the line it specifies, to avoid using the pattern field. But
+anyway, we'll discuss how to make the best use of it here.</p>
+<p>You should take the words here merely as suggestions, and not standards. A
+client tool could definitely develop better (or simpler) ways to use the
+pattern field.</p>
+<p>From the last section, we know the pattern field could contain a line number
+and a search pattern. When it only contains the line number, handling it is
+easy: you simply go to that line.</p>
+<p>The search pattern resembles an EX command, but as we'll see later, it's
+actually not a valid one, so some manual work are required to process it.</p>
+<p>The search pattern could look like <tt class="docutils literal">/pat/</tt>, called &quot;forward search pattern&quot;,
+or <tt class="docutils literal"><span class="pre">?pat?</span></tt>, called &quot;backward search pattern&quot;. Using a search pattern means
+even if the source file is updated, as long as the part containing the tag
+doesn't change, we could still locate the tag correctly by searching.</p>
+<p>When the pattern field only contains the search pattern, you just search for
+it. The search direction (forward/backward) doesn't matter, as it's decided
+solely by whether the <tt class="docutils literal"><span class="pre">-B</span></tt> option is enabled, and not the actual context. You
+could always start the search from say the beginning of the file.</p>
+<p>When both the search pattern and the line number are presented, you could make
+good use of the line number, by going to the line first, then searching for the
+nearest occurence of the pattern. A way to do this is to search both forward
+and backward for the pattern, and when there is a occurence on both sides, go
+to the nearer one.</p>
+<p>What's good about this is when there are multiple identical lines in the source
+file (e.g. the COMMON block in Fortran), this could help us find the correct
+one, even after the source file is updated and the tag position is shifted by a
+few lines.</p>
+<p>Now let's discuss how to search for the pattern. After you trim the <tt class="docutils literal">/</tt> or
+<tt class="docutils literal">?</tt> around it, the pattern resembles a regex pattern. It should be a regex
+pattern, as required by being a valid EX command, but it's actually not, as
+you'll see below.</p>
+<p>It could begin with a <tt class="docutils literal">^</tt>, which means the pattern starts from the beginning
+of a line. It could also end with an <em>unescaped</em> <tt class="docutils literal">$</tt> which means the pattern
+ends at the end of a line. Let's keep this information, and trim them too.</p>
+<p>Now the remaining part is the actual string containing the tag. Some characters
+are escaped:</p>
+<ul class="simple">
+<li><tt class="docutils literal">\</tt>.</li>
+<li><tt class="docutils literal">$</tt>, but only at the end of the string.</li>
+<li><tt class="docutils literal">/</tt>, but only in forward search patterns.</li>
+<li><tt class="docutils literal">?</tt>, but only in backward search patterns.</li>
+</ul>
+<p>You need to unescape these to get the literal string. Now you could convert
+this literal string to a regexp that matches it (by escaping, like
+<tt class="docutils literal">re.escape</tt> in Python or <tt class="docutils literal"><span class="pre">regexp-quote</span></tt> in Elisp), and assemble it with
+<tt class="docutils literal">^</tt> or <tt class="docutils literal">$</tt> if the pattern originally has it, and finally search for the tag
+using this regexp.</p>
+</div>
+<div class="section" id="remark-about-a-previous-format-of-the-pattern-field">
+<h2>Remark: About a Previous Format of the Pattern Field</h2>
+<p>In some earlier versions of Universal Ctags, the line number in the pattern
+field is the actual line number minus one, for forward search patterns; or plus
+one, for backward search patterns. The idea is to resemble an EX command: you
+go to the line, then search forward/backward for the pattern, and you can
+always find the correct one. But this denies the purpose of using a search
+pattern: to tolerate file updates. For example, the tag is at line 50,
+according to this scheme, the pattern field should be:</p>
+<pre class="literal-block">
+49;/pat/;&quot;
+</pre>
+<p>Then let's assume that some code above are removed, and the tag is now at
+line 45. Now you can't find it if you search forward from line 49.</p>
+<p>Due to this reason, Universal Ctags turns to use the actual line number. A
+client tool could distinguish them by the <tt class="docutils literal">TAG_OUTPUT_EXCMD</tt> pseudo tag, it's
+&quot;combine&quot; for the old scheme, and &quot;combineV2&quot; for the present scheme. But
+probably there's no need to treat them differently, since &quot;search for the
+nearest occurence from the line&quot; gives good result on both schemes.</p>
+</div>
+</div>
+<div class="section" id="json-output">
+<h1>JSON OUTPUT</h1>
+<p>Universal Ctags supports <a class="reference external" href="https://www.json.org/">JSON</a> (strictly
+speaking <a class="reference external" href="https://jsonlines.org/">JSON Lines</a>) output format if the
+ctags executable is built with <tt class="docutils literal">libjansson</tt>. JSON output goes to
+standard output by default.</p>
+<div class="section" id="format">
+<h2>Format</h2>
+<p>Each JSON line represents a tag.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --extras<span class="operator">=</span>+p --output-format<span class="operator">=</span>json --fields<span class="operator">=</span>-s input.py
+<span class="generic output">{&quot;_type&quot;: &quot;ptag&quot;, &quot;name&quot;: &quot;JSON_OUTPUT_VERSION&quot;, &quot;path&quot;: &quot;0.0&quot;, &quot;pattern&quot;: &quot;in development&quot;}
+{&quot;_type&quot;: &quot;ptag&quot;, &quot;name&quot;: &quot;TAG_FILE_SORTED&quot;, &quot;path&quot;: &quot;1&quot;, &quot;pattern&quot;: &quot;0=unsorted, 1=sorted, 2=foldcase&quot;}
+...
+{&quot;_type&quot;: &quot;tag&quot;, &quot;name&quot;: &quot;Klass&quot;, &quot;path&quot;: &quot;/tmp/input.py&quot;, &quot;pattern&quot;: &quot;/^class Klass:$/&quot;, &quot;language&quot;: &quot;Python&quot;, &quot;kind&quot;: &quot;class&quot;}
+{&quot;_type&quot;: &quot;tag&quot;, &quot;name&quot;: &quot;method&quot;, &quot;path&quot;: &quot;/tmp/input.py&quot;, &quot;pattern&quot;: &quot;/^ def method(self):$/&quot;, &quot;language&quot;: &quot;Python&quot;, &quot;kind&quot;: &quot;member&quot;, &quot;scope&quot;: &quot;Klass&quot;, &quot;scopeKind&quot;: &quot;class&quot;}
+...</span>
+</pre>
+<p>A key not starting with <tt class="docutils literal">_</tt> is mapped to a field of ctags.
+&quot;<tt class="docutils literal"><span class="pre">--output-format=json</span> <span class="pre">--list-fields</span></tt>&quot; options list the fields.</p>
+<p>A key starting with <tt class="docutils literal">_</tt> represents meta information of the JSON
+line. Currently only <tt class="docutils literal">_type</tt> key is used. If the value for the key
+is <tt class="docutils literal">tag</tt>, the JSON line represents a normal tag. If the value is
+<tt class="docutils literal">ptag</tt>, the line represents a pseudo-tag.</p>
+<p>The output format can be changed in the
+future. <tt class="docutils literal">JSON_OUTPUT_VERSION</tt> pseudo-tag provides a change
+client-tools to handle the changes. Current version is &quot;0.0&quot;. A
+client-tool can extract the version with <tt class="docutils literal">path</tt> key from the
+pseudo-tag.</p>
+<p>The JSON output format is newly designed and has no limitation found
+in the default tags file format.</p>
+<ul class="simple">
+<li>The values for <tt class="docutils literal">kind</tt> key are represented in long-name flags.
+No one-letter is here.</li>
+<li>Scope names and scope kinds have distinguished keys: <tt class="docutils literal">scope</tt> and <tt class="docutils literal">scopeKind</tt>.
+They are combined in the default tags file format.</li>
+</ul>
+</div>
+<div class="section" id="data-type-used-in-a-field">
+<h2>Data type used in a field</h2>
+<p>Values for the most of all keys are represented in JSON string type.
+However, some of them are represented in string, integer, and/or boolean type.</p>
+<p>&quot;<tt class="docutils literal"><span class="pre">--output-format=json</span> <span class="pre">--list-fields</span></tt>&quot; options show What kind of data type
+used in a field of JSON.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --output-format<span class="operator">=</span>json --list-fields
+<span class="generic prompt">#</span>LETTER NAME ENABLED LANGUAGE JSTYPE FIXED DESCRIPTION
+<span class="generic output">F input yes NONE s-- no input file
+...
+P pattern yes NONE s-b no pattern
+...
+f file yes NONE --b no File-restricted scoping
+...
+e end no NONE -i- no end lines of various items
+...</span>
+</pre>
+<p><tt class="docutils literal">JSTYPE</tt> column shows the data types.</p>
+<dl class="docutils">
+<dt>'<tt class="docutils literal">s</tt>'</dt>
+<dd>string</dd>
+<dt>'<tt class="docutils literal">i</tt>'</dt>
+<dd>integer</dd>
+<dt>'<tt class="docutils literal">b</tt>'</dt>
+<dd>boolean (true or false)</dd>
+</dl>
+<p>For an example, the value for <tt class="docutils literal">pattern</tt> field of ctags takes a string or a boolean value.</p>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-lang-python(7), ctags-incompatibilities(7), tags(5), readtags(1)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-faq.7.html b/ctags/man/ctags-faq.7.html
new file mode 100644
index 0000000..65d4f71
--- /dev/null
+++ b/ctags/man/ctags-faq.7.html
@@ -0,0 +1,757 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-faq</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-faq">
+<span id="ctags-faq-7"></span>
+<h1 class="title">ctags-faq</h1>
+<h2 class="subtitle" id="universal-ctags-faq">Universal Ctags FAQ</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<p>This is the Universal Ctags FAQ (Frequently-Asked Questions).
+It is based on <a class="reference external" href="http://ctags.sourceforge.net/faq.html">Exuberant Ctags FAQ</a></p>
+<div class="contents topic" id="contents">
+<p class="topic-title">Contents</p>
+<ul class="simple">
+<li><a class="reference internal" href="#description" id="id2">DESCRIPTION</a><ul>
+<li><a class="reference internal" href="#what-is-the-difference-between-universal-ctags-and-exuberant-ctags" id="id3">What is the difference between Universal Ctags and Exuberant Ctags?</a></li>
+<li><a class="reference internal" href="#how-can-i-avoid-having-to-specify-my-favorite-option-every-time" id="id4">How can I avoid having to specify my favorite option every time?</a></li>
+<li><a class="reference internal" href="#what-are-these-strange-bits-of-text-beginning-with-which-follow-many-of-the-lines-in-the-tag-file" id="id5">What are these strange bits of text beginning with <tt class="docutils literal">;&quot;</tt> which follow many of the lines in the tag file?</a></li>
+<li><a class="reference internal" href="#why-can-t-i-jump-to-class-member" id="id6">Why can't I jump to <tt class="docutils literal"><span class="pre">class::member</span></tt>?</a></li>
+<li><a class="reference internal" href="#why-do-i-end-up-on-the-wrong-line-when-i-jump-to-a-tag" id="id7">Why do I end up on the wrong line when I jump to a tag?</a></li>
+<li><a class="reference internal" href="#how-do-i-jump-to-the-tag-i-want-instead-of-the-wrong-one-by-the-same-name" id="id8">How do I jump to the tag I want instead of the wrong one by the same name?</a></li>
+<li><a class="reference internal" href="#how-can-i-locate-all-references-to-a-specific-function-or-variable" id="id9">How can I locate all references to a specific function or variable?</a></li>
+<li><a class="reference internal" href="#why-does-appending-tags-to-a-tag-file-tag-so-long" id="id10">Why does appending tags to a tag file tag so long?</a></li>
+<li><a class="reference internal" href="#how-should-i-set-up-tag-files-for-a-multi-level-directory-hierarchy" id="id11">How should I set up tag files for a multi-level directory hierarchy?</a></li>
+<li><a class="reference internal" href="#does-universal-ctags-support-unicode-file-names" id="id12">Does Universal Ctags support Unicode file names?</a></li>
+<li><a class="reference internal" href="#why-does-zsh-cause-zsh-no-matches-found-error" id="id13">Why does zsh cause &quot;zsh: no matches found&quot; error?</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#see-also" id="id14">SEE ALSO</a></li>
+<li><a class="reference internal" href="#author" id="id15">AUTHOR</a></li>
+</ul>
+</div>
+<div class="section" id="description">
+<h1><a class="toc-backref" href="#id2">DESCRIPTION</a></h1>
+<!-- TODO: https://github.com/universal-ctags/ctags/issues/2312
+#1421: feature: clean up stale tags when appending (`-a`)
+#2356: can't pre-process the macro but it works with Exuberant Ctags 5.8
+#2540: C/C++:conditional compilation like #ifdef will cause parse errror -->
+<div class="section" id="what-is-the-difference-between-universal-ctags-and-exuberant-ctags">
+<h2><a class="toc-backref" href="#id3">What is the difference between Universal Ctags and Exuberant Ctags?</a></h2>
+<p>Universal Ctags is an unofficial fork of Exuberant Ctags.
+The differences are summarized in ctags-incompatibilities(7) man page.</p>
+<p>The most notable one is that Universal Ctags doesn't read <tt class="docutils literal"><span class="pre">~/.ctags</span></tt> file.
+Instead, it reads <tt class="docutils literal">*.ctags</tt> under <tt class="docutils literal"><span class="pre">~/.ctags.d</span></tt> directory.</p>
+</div>
+<div class="section" id="how-can-i-avoid-having-to-specify-my-favorite-option-every-time">
+<h2><a class="toc-backref" href="#id4">How can I avoid having to specify my favorite option every time?</a></h2>
+<p>Either by setting the environment variable <tt class="docutils literal">CTAGS</tt> to your custom
+options, or putting them into a <tt class="docutils literal"><span class="pre">~/.ctags.d/anyname.ctags</span></tt> file in your home
+directory.</p>
+</div>
+<div class="section" id="what-are-these-strange-bits-of-text-beginning-with-which-follow-many-of-the-lines-in-the-tag-file">
+<h2><a class="toc-backref" href="#id5">What are these strange bits of text beginning with <tt class="docutils literal">;&quot;</tt> which follow many of the lines in the tag file?</a></h2>
+<p>These are <em>extension flags</em>. They are added in order to provide extra
+information about the tag that may be utilized by the editor in order to
+more intelligently handle tags. They are appended to the EX command part of
+the tag line in a manner that provides backwards compatibility with existing
+implementations of the Vi editor. The semicolon is an EX command separator
+and the double quote begins an EX comment. Thus, the extension flags appear
+as an EX comment and should be ignored by the editor when it processes the
+EX command.</p>
+<p>Some non-vi editors, however, implement only the bare minimum of EX commands
+in order to process the search command or line number in the third field of
+the tag file. If you encounter this problem, use the option <tt class="docutils literal"><span class="pre">--format=1</span></tt> to
+generate a tag file without these extensions (remember that you can set the
+CTAGS environment variable to any default arguments you wish to supply). Then
+ask the supplier of your editor to implement handling of this feature of EX
+commands.</p>
+</div>
+<div class="section" id="why-can-t-i-jump-to-class-member">
+<h2><a class="toc-backref" href="#id6">Why can't I jump to <tt class="docutils literal"><span class="pre">class::member</span></tt>?</a></h2>
+<p>Because, by default, ctags only generates tags for the separate identifiers
+found in the source files. If you specify the <tt class="docutils literal"><span class="pre">--extra=+q</span></tt> option, then
+ctags will also generate a second, class-qualified tag for each class member
+(data and function/method) in the form <tt class="docutils literal"><span class="pre">class::member</span></tt> for C++, and in the form
+<tt class="docutils literal">class.method</tt> for Eiffel and Java.</p>
+</div>
+<div class="section" id="why-do-i-end-up-on-the-wrong-line-when-i-jump-to-a-tag">
+<h2><a class="toc-backref" href="#id7">Why do I end up on the wrong line when I jump to a tag?</a></h2>
+<p>By default, ctags encodes the line number in the file where macro (<tt class="docutils literal">#define</tt>)
+tags are found. This was done to remain compatible with the original UNIX
+version of ctags. If you change the file containing the tag without
+rebuilding the tag file, the location of tag in the tag file may no longer
+match the current location.</p>
+<p>In order to avoid this problem, you can specify the option <tt class="docutils literal"><span class="pre">--excmd=p</span></tt>,
+which causes ctags to use a search pattern to locate macro tags. I have
+never uncovered the reason why the original UNIX ctags used line numbers
+exclusively for macro tags, but have so far resisted changing the default
+behavior of Exuberant (and Universal) Ctags to behave differently.</p>
+</div>
+<div class="section" id="how-do-i-jump-to-the-tag-i-want-instead-of-the-wrong-one-by-the-same-name">
+<h2><a class="toc-backref" href="#id8">How do I jump to the tag I want instead of the wrong one by the same name?</a></h2>
+<p>A tag file is simple a list of tag names and where to find them. If there
+are duplicate entries, you often end up going to the wrong one because the
+tag file is sorted and your editor locates the first one in the tag file.</p>
+<p>Standard Vi provides no facilities to alter this behavior. However, Vim
+has some nice features to minimize this problem, primarily by examining all
+matches and choosing the best one under the circumstances. Vim also provides
+commands which allow for selection of the desired matching tag.</p>
+</div>
+<div class="section" id="how-can-i-locate-all-references-to-a-specific-function-or-variable">
+<h2><a class="toc-backref" href="#id9">How can I locate all references to a specific function or variable?</a></h2>
+<p>There are several packages already available which provide this capability.
+Namely, these are: GLOBAL source code tag system, GNU id-utils, cscope,
+and cflow. As of this writing, they can be found in the following locations:</p>
+<ul class="simple">
+<li>GLOBAL: <a class="reference external" href="http://www.gnu.org/software/global">http://www.gnu.org/software/global</a></li>
+<li>id-utils: <a class="reference external" href="http://www.gnu.org/software/idutils/idutils.html">http://www.gnu.org/software/idutils/idutils.html</a></li>
+<li>cscope: <a class="reference external" href="http://cscope.sourceforge.net">http://cscope.sourceforge.net</a></li>
+<li>cflow: <a class="reference external" href="ftp://www.ibiblio.org/pub/Linux/devel/lang/c">ftp://www.ibiblio.org/pub/Linux/devel/lang/c</a></li>
+</ul>
+</div>
+<div class="section" id="why-does-appending-tags-to-a-tag-file-tag-so-long">
+<h2><a class="toc-backref" href="#id10">Why does appending tags to a tag file tag so long?</a></h2>
+<p>Sometimes, in an attempt to build a global tag file for all source files in
+a large source tree of many directories, someone will make an attempt to run
+ctags in append (<tt class="docutils literal"><span class="pre">-a</span></tt>) mode on every directory in the hierarchy. Each time
+ctags is invoked, its default behavior is to sort the tag file once the tags
+for that execution have been added. As the cumulative tag file grows, the sort
+time increases arithmetically.</p>
+<p>The best way to avoid this problem (and the most efficient) is to make
+use of the <tt class="docutils literal"><span class="pre">--recurse</span></tt> (or <tt class="docutils literal"><span class="pre">-R</span></tt>) option of ctags by executing the following
+command in the root of the directory hierarchy (thus running ctags only once):</p>
+<blockquote>
+<pre class="code sh literal-block">
+ctags -R
+</pre>
+</blockquote>
+<p>If you really insist on running ctags separately on each directory, you can
+avoid the sort pass each time by specifying the option <tt class="docutils literal"><span class="pre">--sort=no</span></tt>. Once the
+tag file is completely built, use the sort command to manually sort the
+final tag file, or let the final invocation of ctags sort the file.</p>
+</div>
+<div class="section" id="how-should-i-set-up-tag-files-for-a-multi-level-directory-hierarchy">
+<h2><a class="toc-backref" href="#id11">How should I set up tag files for a multi-level directory hierarchy?</a></h2>
+<p>There are a few ways of approaching this:</p>
+<ol class="arabic simple">
+<li>A local tag file in each directory containing only the tags for source
+files in that directory.</li>
+<li>One single big, global tag file present in the root directory of your
+hierarchy, containing all tags present in all source files in the
+hierarchy.</li>
+<li>A local tag file in each directory containing only the tags for source
+files in that directory, in addition to one single global tag file
+present in the root directory of your hierarchy, containing all
+non-static tags present in all source files in the hierarchy.</li>
+<li>A local tag file in each directory of the hierarchy, each one
+containing all tags present in source files in that directory and all
+non-static tags in every directory below it (note that this implies
+also having one big tag file in the root directory of the hierarchy).</li>
+</ol>
+<p>Each of these approaches has its own set of advantages and disadvantages,
+depending upon your particular conditions. Which approach is deemed best
+depends upon the following factors:</p>
+<ol class="upperalpha">
+<li><p class="first">The ability of your editor to use multiple tag files.</p>
+<p>If your editor cannot make use of multiple tag files (original vi
+implementations could not), then one large tag file is the only way to
+go if you ever desire to jump to tags located in other directories. If
+you never need to jump to tags in another directory (i.e. the source
+in each directory is entirely self-contained), then a local tag file
+in each directory will fit your needs.</p>
+</li>
+<li><p class="first">The time is takes for your editor to look up a tag in the tag file.</p>
+<p>The significance of this factor depends upon the size of your source
+tree and on whether the source files are located on a local or remote
+file system. For source and tag files located on a local file system,
+looking up a tag is not as big a hit as one might first imagine, since
+vi implementations typically perform a binary search on a sorted tag
+file. This may or may not be true for the editor you use. For files
+located on a remote file system, reading a large file is an expensive
+operation.</p>
+</li>
+<li><p class="first">Whether or not you expect the source code to change and the time it
+takes to rebuild a tag file to account for changes to the source code.</p>
+<p>While Universal Ctags is particularly fast in scanning source code
+(around 1-2 MB/sec), a large project may still result in objectionable
+delays if one wishes to keep their tag file(s) up to date on a
+frequent basis, or if the files are located on a remote file system.</p>
+</li>
+<li><p class="first">The presence of duplicate tags in the source code and the ability to
+handle them.</p>
+<p>The impact of this factor is influenced by the following three issues:</p>
+<ol class="arabic">
+<li><p class="first">How common are duplicate tags in your project?</p>
+</li>
+<li><p class="first">Does your editor provide any facilities for dealing with duplicate
+tags?</p>
+<p>While standard vi does not, many modern vi implementations, such
+as Vim have good facilities for selecting the desired match from
+the list of duplicates. If your editor does not support duplicate
+tags, then it will typically send you to only one of them, whether
+or not that is the one you wanted (and not even notifying you that
+there are other potential matches).</p>
+</li>
+<li><p class="first">What is the significance of duplicate tags?</p>
+<p>For example, if you have two tags of the same name from entirely
+isolated software components, jumping first to the match found
+in component B while working in component A may be entirely
+misleading, distracting or inconvenient (to keep having to choose
+which one if your editor provides you with a list of matches).
+However, if you have two tags of the same name for parallel builds
+(say two initialization routines for different hosts), you may
+always want to specify which one you want.</p>
+</li>
+</ol>
+</li>
+</ol>
+<p>Of the approaches listed above, I tend to favor Approach 3. My editor of
+choice is Vim, which provides a rich set of features for handling multiple
+tag files, which partly influences my choice. If you are working with
+source files on a remote file system, then I would recommend either
+Approach 3 or Approach 4, depending upon the hit when reading the global
+tag file.</p>
+<p>The advantages of Approach 3 are many (assuming that your editor has
+the ability to support both multiple tag files and duplicate tags). All
+lookups of tag located in the current directory are fast and the local
+tag file can be quickly and easily regenerated in one second or less
+(I have even mapped a keystroke to do this easily). A lookup of a
+(necessarily non-static) tag found in another directory fails a lookup in
+the local tag file, but is found in the global tag file, which satisfies
+all cross-directory lookups. The global tag file can be automatically
+regenerated periodically with a cron job (and perhaps the local tag files
+also).</p>
+<p>Now I give an example of how you would implement Approach 3. Means of
+implementing the other approaches can be performed in a similar manner.</p>
+<p>Here is a visual representation of an example directory hierarchy:</p>
+<pre class="literal-block">
+project
+`-----misccomp
+| `...
+`-----sysint
+ `-----client
+ | `-----hdrs
+ | `-----lib
+ | `-----src
+ | `-----test
+ `-----common
+ | `-----hdrs
+ | `-----lib
+ | `-----src
+ | `-----test
+ `-----server
+ `-----hdrs
+ `-----lib
+ `-----src
+ `-----test
+</pre>
+<p>Here is a recommended solution (conceptually) to build the tag files:</p>
+<ol class="arabic">
+<li><p class="first">Within each of the leaf nodes (i.e. <tt class="docutils literal">hdrs</tt>, <tt class="docutils literal">lib</tt>, <tt class="docutils literal">src</tt>, <tt class="docutils literal">test</tt>) build a tag
+file using &quot;<tt class="docutils literal">ctags <span class="pre">*.[ch]</span></tt>&quot;. This can be easily be done for the whole
+hierarchy by making a shell script, call it <tt class="docutils literal">dirtags</tt>, containing the
+following lines:</p>
+<blockquote>
+<pre class="code sh literal-block">
+<span class="comment hashbang">#!/bin/sh
+</span><span class="name builtin">cd</span> <span class="name variable">$1</span>
+ctags *
+</pre>
+</blockquote>
+<p>Now execute the following command:</p>
+<blockquote>
+<pre class="code sh literal-block">
+find * -type d -exec dirtags <span class="operator">{}</span> <span class="literal string escape">\;</span>
+</pre>
+</blockquote>
+<p>These tag files are trivial (and extremely quick) to rebuild while
+making changes within a directory. The following Vim key mapping is
+quite useful to rebuild the tag file in the directory of the current
+source file:</p>
+<blockquote>
+<pre class="code text literal-block">
+:nmap ,t :!(cd %:p:h;ctags *.[ch])&amp;&lt;CR&gt;&lt;CR&gt;
+</pre>
+</blockquote>
+</li>
+<li><p class="first">Build the global tag file:</p>
+<blockquote>
+<pre class="code sh literal-block">
+<span class="name builtin">cd</span> ~/project
+ctags --file-scope<span class="operator">=</span>no -R
+</pre>
+</blockquote>
+<p>thus constructing a tag file containing only non-static tags for all
+source files in all descendent directories.</p>
+</li>
+<li><p class="first">Configure your editor to read the local tag file first, then consult
+the global tag file when not found in the local tag file. In Vim,
+this is done as follows:</p>
+<blockquote>
+<pre class="code text literal-block">
+:set tags=./tags,tags,~/project/tags
+</pre>
+</blockquote>
+</li>
+</ol>
+<p>If you wish to implement Approach 4, you would need to replace the
+<tt class="docutils literal">dirtags</tt> script of step 1 with the following:</p>
+<blockquote>
+<pre class="code sh literal-block">
+<span class="comment hashbang">#!/bin/sh
+</span><span class="name builtin">cd</span> <span class="name variable">$1</span>
+ctags *
+<span class="comment single"># Now append the non-static tags from descendent directories
+</span>find * -type d -prune -print <span class="punctuation">|</span> ctags -aR --file-scope<span class="operator">=</span>no -L-
+</pre>
+</blockquote>
+<p>And replace the configuration of step 3 with this:</p>
+<blockquote>
+<pre class="code text literal-block">
+:set tags=./tags;$HOME,tags
+</pre>
+</blockquote>
+<p>As a caveat, it should be noted that step 2 builds a global tag file whose
+file names will be relative to the directory in which the global tag file
+is being built. This takes advantage of the Vim <tt class="docutils literal">tagrelative</tt> option,
+which causes the path to be interpreted a relative to the location of the
+tag file instead of the current directory. For standard vi, which always
+interprets the paths as relative to the current directory, we need to
+build the global tag file with absolute path names. This can be
+accomplished by replacing step 2 with the following:</p>
+<blockquote>
+<pre class="code sh literal-block">
+<span class="name builtin">cd</span> ~/project
+ctags --file-scope<span class="operator">=</span>no -R <span class="literal string backtick">`</span><span class="name builtin">pwd</span><span class="literal string backtick">`</span>
+</pre>
+</blockquote>
+</div>
+<div class="section" id="does-universal-ctags-support-unicode-file-names">
+<h2><a class="toc-backref" href="#id12">Does Universal Ctags support Unicode file names?</a></h2>
+<!-- MEMO: from https://github.com/universal-ctags/ctags/issues/1837 -->
+<p>Yes, Unicode file names are supported on unix-like platforms (Linux, macOS,
+Cygwin, etc.).</p>
+<p>However, on Windows, you need to use Windows 10 version 1903 or later to use
+Unicode file names. (This is an experimental feature, though.) On older versions
+on Windows, Universal Ctags only support file names represented in the current
+code page. If you still want to use Unicode file names on them, use Cygwin or
+MSYS2 version of Universal Ctags as a workaround.</p>
+</div>
+<div class="section" id="why-does-zsh-cause-zsh-no-matches-found-error">
+<h2><a class="toc-backref" href="#id13">Why does zsh cause &quot;zsh: no matches found&quot; error?</a></h2>
+<!-- MEMO: from https://github.com/universal-ctags/ctags/issues/2842 -->
+<p>zsh causes error on the following cases;</p>
+<blockquote>
+<pre class="code sh literal-block">
+ctags --extra<span class="operator">=</span>+* ...
+ctags --exclude<span class="operator">=</span>foo/* ...
+</pre>
+</blockquote>
+<p>This is the 2nd most significant incompatibility <em>feature</em> of zsh.</p>
+<p>Cited from &quot;Z-Shell Frequently-Asked Questions&quot;, &quot;<a class="reference external" href="http://zsh.sourceforge.net/FAQ/zshfaq02.html">2.1: Differences from sh and
+ksh</a>&quot;;</p>
+<blockquote>
+... The next most classic difference is that unmatched glob patterns cause
+the command to abort; set <tt class="docutils literal">NO_NOMATCH</tt> for those.</blockquote>
+<p>You may add &quot;<tt class="docutils literal">setopt nonomatch</tt>&quot; on your <tt class="docutils literal"><span class="pre">~/.zshrc</span></tt>. Or you can escape glob
+patterns with backslash;</p>
+<blockquote>
+<pre class="code sh literal-block">
+ctags --extra<span class="operator">=</span>+<span class="literal string escape">\*</span> ...
+ctags --exclude<span class="operator">=</span>foo/<span class="literal string escape">\*</span> ...
+</pre>
+</blockquote>
+<p>Or quote them;</p>
+<blockquote>
+<pre class="code sh literal-block">
+ctags <span class="literal string single">'--extra=+*'</span> ...
+ctags <span class="literal string single">'--exclude=foo/*'</span> ...
+</pre>
+</blockquote>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1><a class="toc-backref" href="#id14">SEE ALSO</a></h1>
+<p>The official Universal Ctags web site at:</p>
+<p><a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>ctags(1), tags(5)</p>
+</div>
+<div class="section" id="author">
+<h1><a class="toc-backref" href="#id15">AUTHOR</a></h1>
+<p>This FAQ is based on <a class="reference external" href="http://ctags.sourceforge.net/faq.html">Exuberant Ctags FAQ</a> by
+Darren Hiebert and <a class="reference external" href="mailto:vberthoux&#64;users.sourceforge.net">vberthoux&#64;users.sourceforge.net</a></p>
+<p>Universal Ctags project: <a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-incompatibilities.7.html b/ctags/man/ctags-incompatibilities.7.html
new file mode 100644
index 0000000..8e540e1
--- /dev/null
+++ b/ctags/man/ctags-incompatibilities.7.html
@@ -0,0 +1,571 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-incompatibilities</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-incompatibilities">
+<span id="ctags-incompatibilities-7"></span>
+<h1 class="title">ctags-incompatibilities</h1>
+<h2 class="subtitle" id="incompatibilities-between-universal-ctags-and-exuberant-ctags">Incompatibilities between Universal Ctags and Exuberant Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> [options] [file(s)]</div>
+<div class="line"><strong>etags</strong> [options] [file(s)]</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This page describes major incompatible changes introduced to
+Universal Ctags forked from Exuberant Ctags.</p>
+<div class="section" id="option-files-loading-at-starting-up-time-preload-files">
+<h2>Option files loading at starting up time (preload files)</h2>
+<p>Universal Ctags doesn't load <tt class="docutils literal"><span class="pre">~/.ctags</span></tt> at starting up time.
+File paths for preload files are changed.
+See &quot;FILES&quot; section of ctags(1).</p>
+</div>
+<div class="section" id="environment-variables-for-arranging-command-lines">
+<h2>Environment variables for arranging command lines</h2>
+<p>Universal Ctags doesn't read <tt class="docutils literal">CTAGS</tt> and/or <tt class="docutils literal">ETAGS</tt> environment
+variables.</p>
+</div>
+<div class="section" id="incompatibilities-in-command-line-interface">
+<h2>Incompatibilities in command line interface</h2>
+<div class="section" id="ordering-in-a-command-line">
+<h3>Ordering in a command line</h3>
+<!-- NOTE: #1889 -->
+<p>The command line format of Universal Ctags is &quot;<tt class="docutils literal">ctags [options]
+[source_file(s)]</tt>&quot; following the standard POSIX convention.</p>
+<p>Exuberant Ctags accepts a option following a source file.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags -o - foo.c --list-kinds<span class="operator">=</span>Sh
+<span class="generic output">f functions</span>
+</pre>
+<p>Universal Ctags warns and ignores the option <tt class="docutils literal"><span class="pre">--list-kinds=Sh</span></tt> as follows.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags -o - foo.c --list-kinds<span class="operator">=</span>Sh
+<span class="generic output">ctags: Warning: cannot open input file &quot;--list-kinds=Sh&quot; : No such file or directory
+a foo.c /^void a () {}$/;&quot; f typeref:typename:void
+b foo.c /^void b () {}$/;&quot; f typeref:typename:void</span>
+</pre>
+</div>
+<div class="section" id="the-order-of-application-of-patterns-and-extensions-in-langmap">
+<h3>The order of application of patterns and extensions in <tt class="docutils literal"><span class="pre">--langmap</span></tt></h3>
+<p>When applying mappings for a name of given source file,
+Exuberant Ctags tests file name patterns <em>AFTER</em> file extensions
+(<em>e-map-order</em>). Universal Ctags does this differently; it tests file
+name patterns <em>BEFORE</em> file extensions (<em>u-map-order</em>).</p>
+<p>This incompatible change is introduced to deal with the following
+situation:</p>
+<blockquote>
+<ul class="simple">
+<li><tt class="docutils literal">build.xml</tt> as a source file,</li>
+<li>The Ant parser declares it handles a file name pattern <tt class="docutils literal">build.xml</tt>, and</li>
+<li>The XML parser declares it handles a file extension <tt class="docutils literal">.xml</tt>.</li>
+</ul>
+</blockquote>
+<p>Which parser should be used for parsing <tt class="docutils literal">build.xml</tt>? The assumption
+of Universal Ctags is the user may want to use the Ant parser; the
+file name pattern it declares is more specific than the file extension
+that the XML parser declares. However, e-map-order chooses the XML
+parser.</p>
+<p>So Universal Ctags uses the u-map-order even though it introduces an
+incompatibility.</p>
+<p><tt class="docutils literal"><span class="pre">--list-map-extensions=&lt;language&gt;</span></tt> and <tt class="docutils literal"><span class="pre">--list-map-patterns=&lt;language&gt;</span></tt>
+options are helpful to verify and the file extensions and the file
+name patterns of given <em>&lt;language&gt;</em>.</p>
+</div>
+<div class="section" id="remove-file-tags-and-file-scope-options">
+<h3>Remove <tt class="docutils literal"><span class="pre">--file-tags</span></tt> and <tt class="docutils literal"><span class="pre">--file-scope</span></tt> options</h3>
+<p>Even in Exuberant Ctags, <tt class="docutils literal"><span class="pre">--file-tags</span></tt> is not documented in its man page.
+Instead of specifying <tt class="docutils literal"><span class="pre">--file-tags</span></tt> or <tt class="docutils literal"><span class="pre">--file-tags=yes</span></tt>, use
+<tt class="docutils literal"><span class="pre">--extras=+f</span></tt> or <tt class="docutils literal"><span class="pre">--extras=+{inputFile}</span></tt>.</p>
+<p>Instead of specifying <tt class="docutils literal"><span class="pre">--file-tags=no</span></tt>, use
+<tt class="docutils literal"><span class="pre">--extras=-f</span></tt> or <tt class="docutils literal"><span class="pre">--extras=-{inputFile}</span></tt>.</p>
+<p>Universal Ctags introduces <tt class="docutils literal">F/fileScope</tt> extra as the replacement for
+<tt class="docutils literal"><span class="pre">--file-scope</span></tt> option.</p>
+<p>Instead of specifying <tt class="docutils literal"><span class="pre">--file-tags</span></tt> or <tt class="docutils literal"><span class="pre">--file-tags=yes</span></tt>, use
+<tt class="docutils literal"><span class="pre">--extras=+F</span></tt> or <tt class="docutils literal"><span class="pre">--extras=+{fileScope}</span></tt>.</p>
+<p>Instead of specifying <tt class="docutils literal"><span class="pre">--file-tags=no</span></tt>, use
+<tt class="docutils literal"><span class="pre">--extras=-F</span></tt> or <tt class="docutils literal"><span class="pre">--extras=-{fileScope}</span></tt>.</p>
+</div>
+</div>
+<div class="section" id="incompatibilities-in-language-and-kind-definitions">
+<h2>Incompatibilities in language and kind definitions</h2>
+<div class="section" id="language-name-defined-with-langdef-name-option">
+<h3>Language name defined with <tt class="docutils literal"><span class="pre">--langdef=name</span></tt> option</h3>
+<p>The characters you can use are more restricted than Exuberant Ctags.
+For more details, see the description of <tt class="docutils literal"><span class="pre">--langdef=name</span></tt> in ctags-optlib(7).</p>
+</div>
+<div class="section" id="obsoleting-lang-kinds-option">
+<h3>Obsoleting <tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-kinds</span></tt> option</h3>
+<p>Some options have <em>&lt;LANG&gt;</em> as parameterized parts in their name like
+<tt class="docutils literal"><span class="pre">--foo-&lt;LANG&gt;=...</span></tt> or <tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-foo=...</span></tt>. The most of all such
+options in Exuberant Ctags have the former form, <tt class="docutils literal"><span class="pre">--foo-&lt;LANG&gt;=...</span></tt>.
+The exception is <tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-kinds</span></tt>.</p>
+<p>Universal Ctags uses the former form for all <em>&lt;LANG&gt;</em> parameterized
+option. Use <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt> instead of <tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-kinds</span></tt> in
+Universal Ctags. <tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-kinds</span></tt> still works but it will be
+removed in the future.</p>
+<p>The former form may be friendly to shell completion engines.</p>
+</div>
+<div class="section" id="disallowing-to-define-a-kind-with-file-as-name">
+<h3>Disallowing to define a kind with <tt class="docutils literal">file</tt> as name</h3>
+<p>The kind name <tt class="docutils literal">file</tt> is reserved. Using it as part of kind spec in
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option is now disallowed.</p>
+</div>
+<div class="section" id="disallowing-to-define-a-kind-with-f-as-letter">
+<h3>Disallowing to define a kind with '<tt class="docutils literal">F</tt>' as letter</h3>
+<p>The kind letter '<tt class="docutils literal">F</tt>' is reserved. Using it as part of a kind spec in
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option is now disallowed.</p>
+</div>
+<div class="section" id="disallowing-to-use-other-than-alphabetical-character-as-kind-letter">
+<h3>Disallowing to use other than alphabetical character as kind letter</h3>
+<p>Exuberant Ctags accepts a character other than alphabetical character
+as kind letter in <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=...</span></tt> option. Universal Ctags
+accepts only an alphabetical character.</p>
+</div>
+<div class="section" id="acceptable-characters-as-parts-of-a-kind-name">
+<h3>Acceptable characters as parts of a kind name</h3>
+<p>Exuberant Ctags accepts any character as a part of a kind name
+defined with <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=/regex/replacement/kind-spec/</span></tt>.</p>
+<p>Universal Ctags accepts only an alphabetical character as
+the initial letter of a kind name.
+Universal Ctags accepts only an alphabetical character or
+numerical character as the rest letters.</p>
+<p>An example:</p>
+<pre class="literal-block">
+--regex-Foo=/abstract +class +([a-z]+)/\1/a,abstract class/i
+</pre>
+<p>Universal Ctags rejects this because the kind name, <tt class="docutils literal">abstract class</tt>,
+includes a whitespace character.</p>
+<p>This requirement is for making the output of Universal Ctags follow
+the tags file format.</p>
+</div>
+<div class="section" id="a-combination-of-a-kind-letter-and-a-kind-name">
+<h3>A combination of a kind letter and a kind name</h3>
+<p>In Universal Ctags, the combination of
+a kind letter and a kind name must be unique in a language.</p>
+<p>You cannot define more than one kind reusing a kind letter with
+different kind names. You cannot define more than one kind reusing a
+kind name with different kind letters.</p>
+<p>An example:</p>
+<pre class="literal-block">
+--regex-Foo=/abstract +class +([a-z]+)/\1/a,abstractClass/i
+--regex-Foo=/attribute +([a-z]+)/\1/a,attribute/i
+</pre>
+<p>Universal Ctags rejects this because the kind letter, '<tt class="docutils literal">a</tt>', used twice
+for defining a kind <tt class="docutils literal">abstractClass</tt> and <tt class="docutils literal">attribute</tt>.</p>
+</div>
+</div>
+<div class="section" id="incompatibilities-in-tags-file-format">
+<h2>Incompatibilities in tags file format</h2>
+<div class="section" id="using-numerical-character-in-the-name-part-of-tag-tagfield">
+<h3>Using numerical character in the name part of tag tagfield</h3>
+<p>The version 2 tags file format, the default output format of
+Exuberant Ctags, accepts only alphabetical characters in the name part
+of tag tagfield.</p>
+<p>Universal Ctags introduces an exception to this specification; it may
+use numerical characters in addition to alphabetical characters as the
+letters other than initial letter of the name part.</p>
+<p>The kinds <tt class="docutils literal">heading1</tt>, <tt class="docutils literal">heading2</tt>, and <tt class="docutils literal">heading3</tt> in the HTML parser
+are the examples.</p>
+</div>
+<div class="section" id="truncating-the-pattern-for-long-input-lines">
+<h3>Truncating the pattern for long input lines</h3>
+<p>To prevent generating overly large tags files, a pattern field is
+truncated, by default, when its size exceeds 96 bytes. A different
+limit can be specified with <tt class="docutils literal"><span class="pre">--pattern-length-limit=N</span></tt>. Specifying
+0 as <em>N</em> results no truncation as Exuberant Ctags does not.</p>
+</div>
+<div class="section" id="kind-letters-and-names">
+<h3>Kind letters and names</h3>
+<p>A kind letter '<tt class="docutils literal">F</tt>' and a kind name <tt class="docutils literal">file</tt> are reserved in the
+main part. A parser cannot have a kind conflicting with
+these reserved ones. Some incompatible changes are introduced
+to follow the above rule.</p>
+<ul class="simple">
+<li>Cobol's <tt class="docutils literal">file</tt> kind is renamed to <tt class="docutils literal">fileDesc</tt> because the
+kind name <tt class="docutils literal">file</tt> is reserved.</li>
+<li>Ruby's '<tt class="docutils literal">F</tt>' (singletonMethod) is changed to '<tt class="docutils literal">S</tt>'.</li>
+<li>SQL's '<tt class="docutils literal">F</tt>' (field) is changed to '<tt class="docutils literal">E</tt>'.</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-optlib(7), and tags(5).</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-iPythonCell.7.html b/ctags/man/ctags-lang-iPythonCell.7.html
new file mode 100644
index 0000000..6147e70
--- /dev/null
+++ b/ctags/man/ctags-lang-iPythonCell.7.html
@@ -0,0 +1,449 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-iPythonCell</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-ipythoncell">
+<span id="ctags-lang-ipythoncell-7"></span>
+<h1 class="title">ctags-lang-iPythonCell</h1>
+<h2 class="subtitle" id="the-man-page-of-the-ipythoncell-parser-for-universal-ctags">The man page of the iPythonCell parser for Universal Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... --extras={subparser} --languages=+iPythonCell,Python \</div>
+<div class="line-block">
+<div class="line">[--extras-IPythonCell=+{doubleSharps}] \</div>
+<div class="line">[--regex-IPythonCell=/&lt;PATTERN&gt;/\n/c/] ...</div>
+</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>iPythonCell is a subparser stacked on top of the Python parser.
+It works when:</p>
+<ul class="simple">
+<li>The Python parser is enabled,</li>
+<li>the <tt class="docutils literal">subparser</tt> extra is enabeld, and</li>
+<li>the iPythonCell parser itself is enabled.</li>
+</ul>
+<p>iPythonCell extracts cells explained as in vim-ipython-cell
+(<a class="reference external" href="https://github.com/hanschen/vim-ipython-cell/blob/master/README.md">https://github.com/hanschen/vim-ipython-cell/blob/master/README.md</a>).</p>
+</div>
+<div class="section" id="kind-s">
+<h1>KIND(S)</h1>
+<p>The iPythonCell parser defines only a <tt class="docutils literal">cell</tt> kind.</p>
+</div>
+<div class="section" id="extra-s">
+<h1>EXTRA(S)</h1>
+<p>Tagging cells staring with <tt class="docutils literal"><span class="pre">##...</span></tt> is disabled by default because
+the pattern is too generic; with that pattern unwanted tags can be extracted.</p>
+<p>Enable <tt class="docutils literal">doubleSharps</tt> language specific extra for tagging cells
+staring with <tt class="docutils literal"><span class="pre">##...</span></tt>.</p>
+</div>
+<div class="section" id="customizing">
+<h1>CUSTOMIZING</h1>
+<p>If your favorite cell pattern is not supported in the parser, you can
+define the pattern in your <tt class="docutils literal">.ctagd.d/your.ctags</tt> or command lines.
+Here is an example how to support &quot;<tt class="docutils literal"># CTAGS: ...</tt>&quot;:</p>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="name">x</span><span class="operator">=</span><span class="literal number integer">1</span>
+<span class="comment single"># CTAGS: DEFINE F</span>
+<span class="keyword">def</span> <span class="name function">F</span><span class="punctuation">():</span>
+ <span class="comment single"># CTAGS: DO NOTING</span>
+ <span class="keyword">pass</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE --sort=no --extras=+{subparser} --regex-IPythonCell=/[ t]*# CTAGS:[ ]?(.*)$/1/c/ -o - input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-iPythonCell.7.rst</tt>, line 63)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ x input.py /^x=1$/;&quot; v
+ DEFINE F input.py /^# CTAGS: DEFINE F$/;&quot; c
+ F input.py /^def F():$/;&quot; f
+ DO NOTING input.py /^ # CTAGS: DO NOTING$/;&quot; c
+
+</pre>
+</div>
+<p>You can put &quot;<tt class="docutils literal"><span class="pre">--regex-IPythonCell=/[</span> <span class="pre">\t]*#</span> CTAGS:[ <span class="pre">]?(.*)$/\1/c/</span></tt>&quot; in <tt class="docutils literal">your.ctags</tt>
+to avoid specifying the pattern repeatedly.</p>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7), ctags-lang-python(7)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-inko.7.html b/ctags/man/ctags-lang-inko.7.html
new file mode 100644
index 0000000..a3546c5
--- /dev/null
+++ b/ctags/man/ctags-lang-inko.7.html
@@ -0,0 +1,400 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-inko</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-inko">
+<span id="ctags-lang-inko-7"></span>
+<h1 class="title">ctags-lang-inko</h1>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... --languages=+Inko ...</div>
+<div class="line"><strong>ctags</strong> ... --language-force=Inko ...</div>
+<div class="line"><strong>ctags</strong> ... --map-Inko=+.inko ...</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This man page describes the Inko parser for Universal Ctags.</p>
+<p>The input file is expected to be valid Inko source code, otherwise the output of
+ctags is undefined.</p>
+<p>Tags are generated for objects, traits, methods, attributes, and constants.
+String literals are ignored.</p>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-julia.7.html b/ctags/man/ctags-lang-julia.7.html
new file mode 100644
index 0000000..8787eb4
--- /dev/null
+++ b/ctags/man/ctags-lang-julia.7.html
@@ -0,0 +1,600 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-julia</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-julia">
+<span id="ctags-lang-julia-7"></span>
+<h1 class="title">ctags-lang-julia</h1>
+<h2 class="subtitle" id="random-notes-about-tagging-julia-source-code-with-universal-ctags">Random notes about tagging Julia source code with Universal-ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal-ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... --languages=+Julia ...</div>
+<div class="line"><strong>ctags</strong> ... --language-force=Julia ...</div>
+<div class="line"><strong>ctags</strong> ... --map-Julia=+.jl ...</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This man page gathers random notes about tagging Julia source code.</p>
+</div>
+<div class="section" id="tagging-import-and-using-expressions">
+<h1>TAGGING <tt class="docutils literal">import</tt> AND <tt class="docutils literal">using</tt> EXPRESSIONS</h1>
+<div class="section" id="summary">
+<h2>Summary</h2>
+<p><cite>using X</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>used</td>
+<td>N/A</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>using X: a, b</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+<tr><td>a, b</td>
+<td>unknown</td>
+<td>used</td>
+<td>scope:module:X</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>import X</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>imported</td>
+<td>N/A</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>import X.a, Y.b</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X, Y</td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+<tr><td>a</td>
+<td>unknown</td>
+<td>imported</td>
+<td>scope:module:X</td>
+</tr>
+<tr><td>b</td>
+<td>unknown</td>
+<td>imported</td>
+<td>scope:module:Y</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>import X: a, b</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+<tr><td>a,b</td>
+<td>unknown</td>
+<td>imported</td>
+<td>scope:module:X</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+</div>
+<div class="section" id="examples">
+<h2>Examples</h2>
+<p>&quot;input.jl&quot;</p>
+<pre class="code Julia literal-block">
+<span class="keyword">using</span> <span class="name">X0</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzK input.jl&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-julia.7.rst</tt>, line 84)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X0 input.jl /^using X0$/;&quot; kind:module roles:used
+
+</pre>
+</div>
+<p><tt class="docutils literal"><span class="pre">--extras=+r</span></tt> (or <tt class="docutils literal"><span class="pre">--extras=+{reference}</span></tt>) option is needed for this tag,
+since it's a reference tag. This is because module <tt class="docutils literal">X</tt> is not defined here.
+It is defined in another file. Enable <tt class="docutils literal">roles:</tt> field with <tt class="docutils literal"><span class="pre">--fields=+r</span></tt> is
+for recording that the module is &quot;used&quot;, i.e., loaded by <tt class="docutils literal">using</tt>.</p>
+<p>&quot;input.jl&quot;</p>
+<pre class="code Julia literal-block">
+<span class="keyword">import</span> <span class="name">X1</span><span class="operator">.</span><span class="name">a</span><span class="punctuation">,</span> <span class="name">X2</span><span class="operator">.</span><span class="name">b</span><span class="punctuation">,</span> <span class="name">X3</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzKZ input.jl&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-julia.7.rst</tt>, line 102)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X1 input.jl /^import X1.a, X2.b, X3$/;&quot; kind:module roles:namespace
+ X2 input.jl /^import X1.a, X2.b, X3$/;&quot; kind:module roles:namespace
+ X3 input.jl /^import X1.a, X2.b, X3$/;&quot; kind:module roles:imported
+ a input.jl /^import X1.a, X2.b, X3$/;&quot; kind:unknown scope:module:X1 roles:imported
+ b input.jl /^import X1.a, X2.b, X3$/;&quot; kind:unknown scope:module:X2 roles:imported
+
+</pre>
+</div>
+<p>Why <tt class="docutils literal">X1</tt> and <tt class="docutils literal">X2</tt> have role &quot;namespace&quot;, while <tt class="docutils literal">X3</tt> have role &quot;imported&quot;?
+It's because the symbol <tt class="docutils literal">a</tt> in module <tt class="docutils literal">X1</tt>, and <tt class="docutils literal">b</tt> in module <tt class="docutils literal">X2</tt> are
+brought to the current scope, but <tt class="docutils literal">X1</tt> and <tt class="docutils literal">X2</tt> themselves are not. We use
+&quot;namespace&quot; role for such modules.</p>
+<p><tt class="docutils literal">X3</tt> is different. The symbol <tt class="docutils literal">X3</tt>, together with all exported symbols in
+<tt class="docutils literal">X3</tt>, is brought to current scope. For such modules, we use &quot;imported&quot; or
+&quot;used&quot; role depending whether they are loaded by <tt class="docutils literal">import</tt> or <tt class="docutils literal">using</tt>.</p>
+<p>Also, notice that <tt class="docutils literal">a</tt> and <tt class="docutils literal">b</tt> have the &quot;unknown&quot; kind. This is because we
+cannot know whether it's a function, constant, or macro, etc.</p>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-python.7.html b/ctags/man/ctags-lang-python.7.html
new file mode 100644
index 0000000..9e0e3ed
--- /dev/null
+++ b/ctags/man/ctags-lang-python.7.html
@@ -0,0 +1,804 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-python</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-python">
+<span id="ctags-lang-python-7"></span>
+<h1 class="title">ctags-lang-python</h1>
+<h2 class="subtitle" id="random-notes-about-tagging-python-source-code-with-universal-ctags">Random notes about tagging python source code with Universal Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... --languages=+Python ...</div>
+<div class="line"><strong>ctags</strong> ... --language-force=Python ...</div>
+<div class="line"><strong>ctags</strong> ... --map-Python=+.py ...</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This man page gathers random notes about tagging python source code.</p>
+</div>
+<div class="section" id="tagging-import-statements">
+<h1>TAGGING <tt class="docutils literal">import</tt> STATEMENTS</h1>
+<div class="section" id="summary">
+<h2>Summary</h2>
+<p><cite>import X</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>imported</td>
+<td>N/A</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>import X as Y</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>X</td>
+<td>module</td>
+<td>indirectlyImported</td>
+<td>N/A</td>
+</tr>
+<tr><td>Y</td>
+<td>namespace</td>
+<td>definition</td>
+<td>nameref:module:X</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>from X import *</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><cite>X</cite></td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>from X import Y</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><cite>X</cite></td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+<tr><td><cite>Y</cite></td>
+<td>unknown</td>
+<td>imported</td>
+<td>scope:module:<cite>X</cite></td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>from X import Y as Z</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="18%" />
+<col width="33%" />
+<col width="42%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><cite>X</cite></td>
+<td>module</td>
+<td>namespace</td>
+<td>N/A</td>
+</tr>
+<tr><td><cite>Y</cite></td>
+<td>unknown</td>
+<td>indirectlyImported</td>
+<td>scope:module:<cite>X</cite></td>
+</tr>
+<tr><td><cite>Z</cite></td>
+<td>unknown</td>
+<td>definition</td>
+<td>nameref:unknown:<cite>X</cite></td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<!-- ===================== ==== ========== ================== ===================
+input code name kind role other noticeable fields
+===================== ==== ========== ================== ===================
+import X X module imported
+import X as Y X module indirectlyImported
+import X as Y Y namespace definition nameref:module:X
+from X import * X module namespace
+from X import Y X module namespace
+from X import Y Y unknown imported scope:module:X
+from X import Y as Z X module namespace
+from X import Y as Z Y unknown indirectlyImported scope:module:X
+from X import Y as Z Z unknown definition nameref:unknown:X
+===================== ==== ========== ================== =================== -->
+<!-- a table having merged cells cannot be converted to man page -->
+<!-- +- - - - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+
+|input code |output tags |
+| +- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+| |name| kind |role |other noticeable fields |
++====================+====+==========+==================+===================+
+|import X |X | module |imported | |
++- - - - - - - - - - - - - - - - - - - -+- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+|import X as Y |X | module |indirectlyImported| |
+| +- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+| |Y | namespace|definition |nameref:module:X |
++- - - - - - - - - - - - - - - - - - - -+- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+|from X import * |X | module |namespace | |
++- - - - - - - - - - - - - - - - - - - -+- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+|from X import Y |X | module |namespace | |
+| +- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+| |Y | unknown |imported |scope:module:X |
++- - - - - - - - - - - - - - - - - - - -+- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+|from X import Y as Z|X | module |namespace | |
+| +- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+| |Y | unknown |indirectlyImported|scope:module:X |
+| +- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+
+| |Z | unknown |definition |nameref:unknown:Y |
++- - - - - - - - - - - - - - - - - - - -+- - - -+- - - - - - - - - -+- - - - - - - - - - - - - - - - - -+- - - - - - - - - - - - - - - - - - -+ -->
+</div>
+<div class="section" id="examples">
+<h2>Examples</h2>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">import</span> <span class="name namespace">X0</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzK input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 125)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X0 input.py /^import X0$/;&quot; kind:module roles:imported
+
+</pre>
+</div>
+<p>A tag for an imported module has <tt class="docutils literal">module</tt> kind with <tt class="docutils literal">imported</tt> role. The
+module is not defined here; it is defined in another file. So the tag for the
+imported module is a reference tag; specify <tt class="docutils literal"><span class="pre">--extras=+r</span></tt> (or
+<tt class="docutils literal"><span class="pre">--extras=+{reference}</span></tt>) option for tagging it. &quot;roles:&quot; field enabled with
+<tt class="docutils literal"><span class="pre">--fields=+r</span></tt> is for recording the module is &quot;imported&quot; to the tag file.</p>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">import</span> <span class="name namespace">X1</span> <span class="keyword">as</span> <span class="name namespace">Y1</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzK --fields-Python=+{nameref} input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 144)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X1 input.py /^import X1 as Y1$/;&quot; kind:module roles:indirectlyImported
+ Y1 input.py /^import X1 as Y1$/;&quot; kind:namespace roles:def nameref:module:X1
+
+</pre>
+</div>
+<p>&quot;Y1&quot; introduces a new name and is defined here. So &quot;Y1&quot; is tagged as a
+definition tag. &quot;X1&quot; is imported in a way that its name cannot be used
+in this source file. For letting client tools know that the name cannot be used,
+<tt class="docutils literal">indirectlyImported</tt> role is assigned for &quot;X1&quot;. &quot;Y1&quot; is the name for
+accessing objects defined in the module imported via &quot;X1&quot;. For recording this
+relationship, <tt class="docutils literal">nameref:</tt> field is attached to the tag of &quot;Y1&quot;. Instead of
+<tt class="docutils literal">module</tt> kind, <tt class="docutils literal">namespace</tt> kind is assigned to &quot;Y1&quot; because &quot;Y1&quot; itself
+isn't a module.</p>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">from</span> <span class="name namespace">X2</span> <span class="keyword namespace">import</span> <span class="operator">*</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzK input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 167)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X2 input.py /^from X2 import *$/;&quot; kind:module roles:namespace
+
+</pre>
+</div>
+<p>The module is not defined here; it is defined in another file. So the tag for
+the imported module is a reference tag. Unlike &quot;X0&quot; in &quot;import X0&quot;, &quot;X2&quot; may not
+be used because the names defined in &quot;X2&quot; can be used in this source file. To represent
+the difference <tt class="docutils literal">namespace</tt> role is attached to &quot;X2&quot; instead of <tt class="docutils literal">imported</tt>.</p>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">from</span> <span class="name namespace">X3</span> <span class="keyword namespace">import</span> <span class="name">Y3</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzKZ input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 185)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X3 input.py /^from X3 import Y3$/;&quot; kind:module roles:namespace
+ Y3 input.py /^from X3 import Y3$/;&quot; kind:unknown scope:module:X3 roles:imported
+
+</pre>
+</div>
+<p>&quot;Y3&quot; is a name for a language object defined in &quot;X3&quot; module. &quot;scope:module:X3&quot;
+attached to &quot;Y3&quot; represents this relation between &quot;Y3&quot; and &quot;X3&quot;. ctags
+assigns <tt class="docutils literal">unknown</tt> kind to &quot;Y3&quot; because ctags cannot know whether &quot;Y3&quot; is a
+class, a variable, or a function from the input file.</p>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">from</span> <span class="name namespace">X4</span> <span class="keyword namespace">import</span> <span class="name">Y4</span> <span class="keyword">as</span> <span class="name">Z4</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --extras=+r --fields=+rzKZ input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 204)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ X4 input.py /^from X4 import Y4 as Z4$/;&quot; kind:module roles:namespace
+ Y4 input.py /^from X4 import Y4 as Z4$/;&quot; kind:unknown scope:module:X4 roles:indirectlyImported
+ Z4 input.py /^from X4 import Y4 as Z4$/;&quot; kind:unknown roles:def nameref:unknown:Y4
+
+</pre>
+</div>
+<p>&quot;Y4&quot; is similar to &quot;Y3&quot; of &quot;from X3 import Y3&quot; but the name cannot be used here.
+<tt class="docutils literal">indirectlyImported</tt> role assigned to &quot;Y4&quot; representing this. &quot;Z4&quot; is the name for
+accessing the language object named in &quot;Y4&quot; in &quot;X4&quot; module. &quot;nameref:unknown:Y4&quot;
+attached to &quot;Z4&quot; and &quot;scope:module:X4&quot; attached to &quot;Y4&quot; represent the relations.</p>
+</div>
+</div>
+<div class="section" id="lambda-expression-and-type-hint">
+<h1>LAMBDA EXPRESSION AND TYPE HINT</h1>
+<div class="section" id="id1">
+<h2>Summary</h2>
+<p><cite>id = lambda var0: var0</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="29%" />
+<col width="37%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><cite>id</cite></td>
+<td>function</td>
+<td>definition</td>
+<td>signature:(<cite>var0</cite>)</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p><cite>id_t: Callable[[int], int] = lambda var1: var1</cite></p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="10%" />
+<col width="10%" />
+<col width="17%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">name</th>
+<th class="head">kind</th>
+<th class="head">role</th>
+<th class="head">other noticeable fields</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><cite>id_t</cite></td>
+<td>variable</td>
+<td>definition</td>
+<td>typeref:typename:<cite>Callable[[int], int]</cite> nameref:function:anonFuncN</td>
+</tr>
+<tr><td>anonFuncN</td>
+<td>function</td>
+<td>definition</td>
+<td>signature:(<cite>var1</cite>)</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+</div>
+<div class="section" id="id2">
+<h2>Examples</h2>
+<p>&quot;input.py&quot;</p>
+<pre class="code Python literal-block">
+<span class="keyword namespace">from</span> <span class="name namespace">typing</span> <span class="keyword namespace">import</span> <span class="name">Callable</span>
+<span class="name builtin">id</span> <span class="operator">=</span> <span class="keyword">lambda</span> <span class="name">var0</span><span class="punctuation">:</span> <span class="name">var0</span>
+<span class="name">id_t</span><span class="punctuation">:</span> <span class="name">Callable</span><span class="punctuation">[[</span><span class="name builtin">int</span><span class="punctuation">],</span> <span class="name builtin">int</span><span class="punctuation">]</span> <span class="operator">=</span> <span class="keyword">lambda</span> <span class="name">var1</span><span class="punctuation">:</span> <span class="name">var1</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --sort=no --fields=+KS --fields-Python=+{nameref} --extras=+{anonymous} input.py&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-python.7.rst</tt>, line 251)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ id input.py /^id = lambda var0: var0$/;&quot; function signature:(var0)
+ id_t input.py /^id_t: Callable[[int], int] = lambda var1: var1$/;&quot;\
+ variable typeref:typename:Callable[[int], int] nameref:function:anonFunc84011d2c0101
+ anonFunc84011d2c0101 input.py /^id_t: Callable[[int], int] = lambda var1: var1$/;&quot;\
+ function signature:(var1)
+
+</pre>
+</div>
+<p>If a variable (&quot;id&quot;) with no type hint is initialized with a lambda expression,
+ctags assigns <tt class="docutils literal">function</tt> kind for the tag of &quot;id&quot;.</p>
+<p>If a variable (&quot;id_t&quot;) with a type hint is initialized with a lambda expression,
+ctags assigns <tt class="docutils literal">variable</tt> kind for the tag of &quot;id_t&quot; with <tt class="docutils literal">typeref:</tt> and
+<tt class="docutils literal">nameref:</tt> fields. ctags fills <tt class="docutils literal">typeref:</tt> field with the value of the type
+hint. The way of filling <tt class="docutils literal">nameref:</tt> is a bit complicated.</p>
+<p>For the lambda expression used in initializing the type-hint'ed variable, ctags
+creates <tt class="docutils literal">anonymous</tt> extra tag (&quot;anonFunc84011d2c0101&quot;). ctags fills the
+<tt class="docutils literal">nameref:</tt> field of &quot;id_t&quot; with the name of <tt class="docutils literal">anonymous</tt> extra tag:
+&quot;nameref:function:anonFunc84011d2c0101&quot;.</p>
+<p>You may think why ctags does so complicated, and why ctags doesn't emit
+following tags output for the input:</p>
+<pre class="literal-block">
+id input.py /^id = \\$/;&quot; function signature:(var0)
+id_t input.py /^id_t: \\$/;&quot; function typeref:typename:Callable[[int], int] signature:(var1)
+</pre>
+<p>There is a reason. The other languages of ctags obey the following rule: ctags fills
+<tt class="docutils literal">typeref:</tt> field for a tag of a callable object (like function) with the type
+of its return value. If we consider &quot;id_t&quot; is a function, its <tt class="docutils literal">typeref:</tt> field
+should have &quot;typename:int&quot;. However, for filling <tt class="docutils literal">typeref:</tt> with &quot;typename:int&quot;,
+ctags has to analyze &quot;Callable[[int], int]&quot; deeper. We don't want to do so.</p>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7), ctags-lang-iPythonCell(7)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-r.7.html b/ctags/man/ctags-lang-r.7.html
new file mode 100644
index 0000000..3ac7c5e
--- /dev/null
+++ b/ctags/man/ctags-lang-r.7.html
@@ -0,0 +1,482 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-r</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-r">
+<span id="ctags-lang-r-7"></span>
+<h1 class="title">ctags-lang-r</h1>
+<h2 class="subtitle" id="random-notes-about-tagging-r-source-code-with-universal-ctags">Random notes about tagging R source code with Universal Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... --languages=+R ...</div>
+<div class="line"><strong>ctags</strong> ... --language-force=R ...</div>
+<div class="line"><strong>ctags</strong> ... --map-Python=+.r ...</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This man page gathers random notes about tagging R source code
+with Universal Ctags.</p>
+</div>
+<div class="section" id="kinds">
+<h1>Kinds</h1>
+<p>If a variable gets a value returned from a <em>well-known constructor</em>
+and the variable appears for the first time in the current input file,
+the R parser makes a tag for the variable and attaches a kind
+associated with the constructor to the tag regardless of whether
+the variable appears in the top-level context or a function.</p>
+<p>Well-known constructor and kind mapping</p>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Constructor</th>
+<th class="head">kind</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>function()</td>
+<td>function</td>
+</tr>
+<tr><td>c()</td>
+<td>vector</td>
+</tr>
+<tr><td>list()</td>
+<td>list</td>
+</tr>
+<tr><td>data.frame()</td>
+<td>dataframe</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p>If a variable doesn't get a value returned from one of well-known
+constructors, the R parser attaches <tt class="docutils literal">globalVar</tt> or <tt class="docutils literal">functionVar</tt> kind
+to the tag for the variable depending on the context.</p>
+<p>Here is an example demonstrating the usage of the kinds:</p>
+<p>&quot;input.r&quot;</p>
+<pre class="code R literal-block">
+<span class="name">G</span> <span class="operator">&lt;-</span> <span class="literal number">1</span>
+<span class="name">v</span> <span class="operator">&lt;-</span> <span class="name function">c</span><span class="punctuation">(</span><span class="literal number">1</span><span class="punctuation">,</span> <span class="literal number">2</span><span class="punctuation">)</span>
+<span class="name">l</span> <span class="operator">&lt;-</span> <span class="name function">list</span><span class="punctuation">(</span><span class="literal number">3</span><span class="punctuation">,</span> <span class="literal number">4</span><span class="punctuation">)</span>
+<span class="name">d</span> <span class="operator">&lt;-</span> <span class="name function">data.frame</span><span class="punctuation">(</span><span class="name">n</span> <span class="operator">=</span> <span class="name">v</span><span class="punctuation">)</span>
+<span class="name">f</span> <span class="operator">&lt;-</span> <span class="name function">function</span><span class="punctuation">(</span><span class="name">a</span><span class="punctuation">)</span> <span class="punctuation">{</span>
+ <span class="name">g</span> <span class="operator">&lt;-</span> <span class="name function">function </span><span class="punctuation">(</span><span class="name">b</span><span class="punctuation">)</span> <span class="name">a</span> <span class="operator">+</span> <span class="name">b</span>
+ <span class="name">w</span> <span class="operator">&lt;-</span> <span class="name function">c</span><span class="punctuation">(</span><span class="literal number">1</span><span class="punctuation">,</span> <span class="literal number">2</span><span class="punctuation">)</span>
+ <span class="name">m</span> <span class="operator">&lt;-</span> <span class="name function">list </span><span class="punctuation">(</span><span class="literal number">3</span><span class="punctuation">,</span> <span class="literal number">4</span><span class="punctuation">)</span>
+ <span class="name">e</span> <span class="operator">&lt;-</span> <span class="name function">data.frame</span><span class="punctuation">(</span><span class="name">n</span> <span class="operator">=</span> <span class="name">w</span><span class="punctuation">)</span>
+ <span class="name">L</span> <span class="operator">&lt;-</span> <span class="literal number">2</span>
+<span class="punctuation">}</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE --sort=no --fields=+KZ -o - input.r&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-r.7.rst</tt>, line 68)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ G input.r /^G &lt;- 1$/;&quot; globalVar
+ v input.r /^v &lt;- c(1, 2)$/;&quot; vector
+ l input.r /^l &lt;- list(3, 4)$/;&quot; list
+ d input.r /^d &lt;- data.frame(n = v)$/;&quot; dataframe
+ n input.r /^d &lt;- data.frame(n = v)$/;&quot; nameattr scope:dataframe:d
+ f input.r /^f &lt;- function(a) {$/;&quot; function
+ g input.r /^ g &lt;- function (b) a + b$/;&quot; function scope:function:f
+ w input.r /^ w &lt;- c(1, 2)$/;&quot; vector scope:function:f
+ m input.r /^ m &lt;- list (3, 4)$/;&quot; list scope:function:f
+ e input.r /^ e &lt;- data.frame(n = w)$/;&quot; dataframe scope:function:f
+ n input.r /^ e &lt;- data.frame(n = w)$/;&quot; nameattr scope:dataframe:f.e
+ L input.r /^ L &lt;- 2$/;&quot; functionVar scope:function:f
+
+</pre>
+</div>
+<!-- TODO:
+
+- other kinds
+- operators for assignment, <-, <<-, ->>, ->, =
+- illuminating duplicated tags
+- fields (constructor, assignmentop)
+- sub parsers -->
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1)</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-sql.7.html b/ctags/man/ctags-lang-sql.7.html
new file mode 100644
index 0000000..c2245b5
--- /dev/null
+++ b/ctags/man/ctags-lang-sql.7.html
@@ -0,0 +1,518 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-sql</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-sql">
+<span id="ctags-lang-sql-7"></span>
+<h1 class="title">ctags-lang-sql</h1>
+<h2 class="subtitle" id="the-man-page-of-the-sql-parser-for-universal-ctags">The man page of the SQL parser for Universal Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... [--extras={guest}] --languages=+SQL ...</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>The SQL parser supports various SQL dialects. PostgreSQL is one of them.</p>
+<p>PostgreSQL allows user-defined functions to be written in other
+languages (<em>procedural languages</em>) besides SQL and C <a class="citation-reference" href="#pl" id="id1">[PL]</a>.</p>
+<p>The SQL parser makes tags for language objects in the user-defined
+functions written in the procedural languages if the <tt class="docutils literal">guest</tt> extra
+is enabled.</p>
+<p>The SQL parser looks for a token coming after <tt class="docutils literal">LANGUAGE</tt> keyword in
+the source code to choose a proper guest parser.</p>
+<pre class="code SQL literal-block">
+<span class="punctuation">...</span> <span class="keyword">LANGUAGE</span> <span class="name">plpythonu</span> <span class="keyword">AS</span> <span class="literal string single">'... user-defined function '</span> <span class="punctuation">...</span>
+<span class="punctuation">...</span> <span class="keyword">AS</span> <span class="error">$$</span> <span class="keyword">user</span><span class="operator">-</span><span class="keyword">defined</span> <span class="keyword">function</span> <span class="error">$$</span> <span class="keyword">LANGUAGE</span> <span class="name">plv8</span> <span class="punctuation">...</span>
+</pre>
+<p>In the above examples, <tt class="docutils literal">plpythonu</tt> and <tt class="docutils literal">plv8</tt> are the names of
+procedural languages. The SQL parser trims <cite>pl</cite> at the start and <cite>u</cite>
+at the end of the name before finding a parser ctags having. For
+<tt class="docutils literal">plpythonu</tt> and <tt class="docutils literal">`plv8</tt>, the SQL parser extracts <tt class="docutils literal">python</tt> and
+<tt class="docutils literal">v8</tt> as the candidates of guest parsers.</p>
+<p>For <tt class="docutils literal">plpythonu</tt>, ctags can run its Python parser. ctags doesn't
+have a parser named <tt class="docutils literal">v8</tt>. However, JavaScript parser of ctags has
+<tt class="docutils literal">v8</tt> as an alias. So ctags can run the JavaScript parser as the
+guest parser for <tt class="docutils literal">plv8</tt>.</p>
+</div>
+<div class="section" id="examples">
+<h1>EXAMPLES</h1>
+<p>tagging code including a user-defined function in a string literal <a class="citation-reference" href="#gh3006" id="id2">[GH3006]</a>:</p>
+<p>&quot;input.sql&quot;</p>
+<pre class="code SQL literal-block">
+<span class="keyword">CREATE</span> <span class="keyword">OR</span> <span class="keyword">REPLACE</span> <span class="keyword">FUNCTION</span> <span class="name">fun1</span><span class="punctuation">()</span> <span class="keyword">RETURNS</span> <span class="name builtin">VARCHAR</span> <span class="keyword">AS</span> <span class="literal string single">'
+DECLARE
+ test1_var1 VARCHAR(64) := $$ABC$$;
+ test1_var2 VARCHAR(64) := $xyz$XYZ$xyz$;
+ test1_var3 INTEGER := 1;
+BEGIN
+ RETURN TO_CHAR(test_var3, ''000'') || test1_var1 || test1_var2;
+END;
+'</span> <span class="keyword">LANGUAGE</span> <span class="name">plpgsql</span><span class="punctuation">;</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --sort=no --extras=+{guest} input.sql&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-sql.7.rst</tt>, line 70)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ fun1 input.sql /^CREATE OR REPLACE FUNCTION fun1() RETURNS VARCHAR AS '$/;&quot; f
+ test1_var1 input.sql /^ test1_var1 VARCHAR(64) := $$ABC$$;$/;&quot; v
+ test1_var2 input.sql /^ test1_var2 VARCHAR(64) := $xyz$XYZ$xyz$;$/;&quot; v
+ test1_var3 input.sql /^ test1_var3 INTEGER := 1;$/;&quot; v
+
+</pre>
+</div>
+<p>tagging code including a user-defined function in a dollar quote <a class="citation-reference" href="#gh3006" id="id3">[GH3006]</a>:</p>
+<p>&quot;input.sql&quot;</p>
+<pre class="code SQL literal-block">
+<span class="keyword">CREATE</span> <span class="keyword">OR</span> <span class="keyword">REPLACE</span> <span class="keyword">FUNCTION</span> <span class="name">fun2</span><span class="punctuation">()</span> <span class="keyword">RETURNS</span> <span class="name builtin">VARCHAR</span> <span class="keyword">LANGUAGE</span> <span class="name">plpgsql</span> <span class="keyword">AS</span> <span class="error">$$</span>
+<span class="keyword">DECLARE</span>
+ <span class="name">test2_var1</span> <span class="name builtin">VARCHAR</span><span class="punctuation">(</span><span class="literal number integer">64</span><span class="punctuation">)</span> <span class="punctuation">:</span><span class="operator">=</span> <span class="literal string single">'ABC2'</span><span class="punctuation">;</span>
+ <span class="name">test2_var2</span> <span class="name builtin">VARCHAR</span><span class="punctuation">(</span><span class="literal number integer">64</span><span class="punctuation">)</span> <span class="punctuation">:</span><span class="operator">=</span> <span class="literal string single">'XYZ2'</span><span class="punctuation">;</span>
+ <span class="name">test2_var3</span> <span class="name builtin">INTEGER</span> <span class="punctuation">:</span><span class="operator">=</span> <span class="literal number integer">2</span><span class="punctuation">;</span>
+<span class="keyword">BEGIN</span>
+ <span class="keyword">RETURN</span> <span class="name">TO_CHAR</span><span class="punctuation">(</span><span class="name">test2_var3</span><span class="punctuation">,</span> <span class="literal string single">'000'</span><span class="punctuation">)</span> <span class="operator">||</span> <span class="name">test2_var1</span> <span class="operator">||</span> <span class="name">test2_var2</span><span class="punctuation">;</span>
+<span class="keyword">END</span><span class="punctuation">;</span>
+<span class="error">$$</span><span class="punctuation">;</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --sort=no --extras=+{guest} input.sql&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-sql.7.rst</tt>, line 96)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ fun2 input.sql /^CREATE OR REPLACE FUNCTION fun2() RETURNS VARCHAR LANGUAGE plpgsql AS $\$$/;&quot; f
+ test2_var1 input.sql /^ test2_var1 VARCHAR(64) := 'ABC2';$/;&quot; v
+ test2_var2 input.sql /^ test2_var2 VARCHAR(64) := 'XYZ2';$/;&quot; v
+ test2_var3 input.sql /^ test2_var3 INTEGER := 2;$/;&quot; v
+
+</pre>
+</div>
+<p>tagging code including a user-defined written in JavaScript:</p>
+<pre class="code SQL literal-block">
+<span class="comment single">-- Derived from https://github.com/plv8/plv8/blob/r3.0alpha/sql/plv8.sql
+</span><span class="keyword">CREATE</span> <span class="keyword">FUNCTION</span> <span class="name">test</span><span class="punctuation">(</span><span class="name">keys</span> <span class="name builtin">text</span><span class="punctuation">[],</span> <span class="name">vals</span> <span class="name builtin">text</span><span class="punctuation">[])</span> <span class="keyword">RETURNS</span> <span class="name builtin">text</span> <span class="keyword">AS</span>
+<span class="error">$$</span>
+ <span class="name">var</span> <span class="name">o</span> <span class="operator">=</span> <span class="error">{}</span><span class="punctuation">;</span>
+ <span class="keyword">for</span> <span class="punctuation">(</span><span class="name">var</span> <span class="name">i</span> <span class="operator">=</span> <span class="literal number integer">0</span><span class="punctuation">;</span> <span class="name">i</span> <span class="operator">&lt;</span> <span class="name">keys</span><span class="punctuation">.</span><span class="keyword">length</span><span class="punctuation">;</span> <span class="name">i</span><span class="operator">++</span><span class="punctuation">)</span>
+ <span class="name">o</span><span class="punctuation">[</span><span class="name">keys</span><span class="punctuation">[</span><span class="name">i</span><span class="punctuation">]]</span> <span class="operator">=</span> <span class="name">vals</span><span class="punctuation">[</span><span class="name">i</span><span class="punctuation">];</span>
+ <span class="keyword">return</span> <span class="name">JSON</span><span class="punctuation">.</span><span class="name">stringify</span><span class="punctuation">(</span><span class="name">o</span><span class="punctuation">);</span>
+<span class="error">$$</span>
+<span class="keyword">LANGUAGE</span> <span class="name">plv8</span> <span class="keyword">IMMUTABLE</span> <span class="keyword">STRICT</span><span class="punctuation">;</span>
+</pre>
+<p>&quot;output.tags&quot;
+with &quot;--options=NONE -o - --sort=no --extras=+{guest} input.sql&quot;</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-sql.7.rst</tt>, line 120)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;tags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: tags
+
+ test input.sql /^CREATE FUNCTION test(keys text[], vals text[]) RETURNS text AS$/;&quot; f
+ o input.sql /^ var o = {};$/;&quot; v
+
+</pre>
+</div>
+</div>
+<div class="section" id="known-bugs">
+<h1>KNOWN BUGS</h1>
+<p>Escape sequences (<cite>''</cite>) in a string literal may make a guest parser confused.</p>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7)</p>
+</div>
+<div class="section" id="references">
+<h1>REFERENCES</h1>
+<table class="docutils citation" frame="void" id="pl" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id1">[PL]</a></td><td>PostgreSQL 9.5.25 Documentation, &quot;Chapter 39. Procedural Languages&quot;, <a class="reference external" href="https://www.postgresql.org/docs/9.5/xplang.html">https://www.postgresql.org/docs/9.5/xplang.html</a></td></tr>
+</tbody>
+</table>
+<table class="docutils citation" frame="void" id="gh3006" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label">[GH3006]</td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> &#64;bagl's comment submitted to <a class="reference external" href="https://github.com/universal-ctags/ctags/issues/3006">https://github.com/universal-ctags/ctags/issues/3006</a></td></tr>
+</tbody>
+</table>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-lang-verilog.7.html b/ctags/man/ctags-lang-verilog.7.html
new file mode 100644
index 0000000..45f5f66
--- /dev/null
+++ b/ctags/man/ctags-lang-verilog.7.html
@@ -0,0 +1,569 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-lang-verilog</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-lang-verilog">
+<span id="ctags-lang-verilog-7"></span>
+<h1 class="title">ctags-lang-verilog</h1>
+<h2 class="subtitle" id="the-man-page-about-systemverilog-verilog-parser-for-universal-ctags">The man page about SystemVerilog/Verilog parser for Universal Ctags</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> ... [--kinds-systemverilog=+Q] [--fields-SystemVerilog=+{parameter}] ...</div>
+<div class="line"><strong>ctags</strong> ... [--fields-Verilog=+{parameter}] ...</div>
+</div>
+<blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="31%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Language</th>
+<th class="head">Language ID</th>
+<th class="head">File Mapping</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>SystemVerilog</td>
+<td>SystemVerilog</td>
+<td>.sv, .svh, svi</td>
+</tr>
+<tr><td>Verilog</td>
+<td>Verilog</td>
+<td>.v</td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>This man page describes about the SystemVerilog/Verilog parser for Universal Ctags.
+SystemVerilog parser supports IEEE Std 1800-2017 keywords.
+Verilog parser supports IEEE Std 1364-2005 keywords.</p>
+<div class="section" id="supported-kinds">
+<h2>Supported Kinds</h2>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --list-kinds-full<span class="operator">=</span>SystemVerilog
+<span class="generic prompt">#</span>LETTER NAME ENABLED REFONLY NROLES MASTER DESCRIPTION
+<span class="generic output">A assert yes no 0 NONE assertions (assert, assume, cover, restrict)
+C class yes no 0 NONE classes
+E enum yes no 0 NONE enumerators
+H checker yes no 0 NONE checkers
+I interface yes no 0 NONE interfaces
+K package yes no 0 NONE packages
+L clocking yes no 0 NONE clocking
+M modport yes no 0 NONE modports
+N nettype yes no 0 NONE nettype declarations
+O constraint yes no 0 NONE constraints
+P program yes no 0 NONE programs
+Q prototype no no 0 NONE prototypes (extern, pure)
+R property yes no 0 NONE properties
+S struct yes no 0 NONE structs and unions
+T typedef yes no 0 NONE type declarations
+V covergroup yes no 0 NONE covergroups
+b block yes no 0 NONE blocks (begin, fork)
+c constant yes no 0 NONE constants (define, parameter, specparam, enum values)
+e event yes no 0 NONE events
+f function yes no 0 NONE functions
+i instance yes no 0 NONE instances of module or interface
+l ifclass yes no 0 NONE interface class
+m module yes no 0 NONE modules
+n net yes no 0 NONE net data types
+p port yes no 0 NONE ports
+q sequence yes no 0 NONE sequences
+r register yes no 0 NONE variable data types
+t task yes no 0 NONE tasks
+w member yes no 0 NONE struct and union members</span>
+</pre>
+<p>Note that <tt class="docutils literal">prototype</tt> (<tt class="docutils literal">Q</tt>) is disabled by default.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --list-kinds-full<span class="operator">=</span>Verilog
+<span class="generic prompt">#</span>LETTER NAME ENABLED REFONLY NROLES MASTER DESCRIPTION
+<span class="generic output">b block yes no 0 NONE blocks (begin, fork)
+c constant yes no 0 NONE constants (define, parameter, specparam)
+e event yes no 0 NONE events
+f function yes no 0 NONE functions
+i instance yes no 0 NONE instances of module
+m module yes no 0 NONE modules
+n net yes no 0 NONE net data types
+p port yes no 0 NONE ports
+r register yes no 0 NONE variable data types
+t task yes no 0 NONE tasks</span>
+</pre>
+</div>
+<div class="section" id="supported-language-specific-fields">
+<h2>Supported Language Specific Fields</h2>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --list-fields<span class="operator">=</span>Verilog
+<span class="generic prompt">#</span>LETTER NAME ENABLED LANGUAGE JSTYPE FIXED DESCRIPTION
+<span class="generic output">- parameter no Verilog --b no parameter whose value can be overridden.
+</span><span class="generic prompt">$ </span>ctags --list-fields<span class="operator">=</span>SystemVerilog
+<span class="generic prompt">#</span>LETTER NAME ENABLED LANGUAGE JSTYPE FIXED DESCRIPTION
+<span class="generic output">- parameter no SystemVerilog --b no parameter whose value can be overridden.</span>
+</pre>
+<div class="section" id="parameter-field">
+<h3><tt class="docutils literal">parameter</tt> field</h3>
+<p>If the field <tt class="docutils literal">parameter</tt> is enabled, a field <tt class="docutils literal">parameter:</tt> is added on a parameter whose
+value can be overridden on an instantiated module, interface, or program.
+This is useful for a editor plugin or extension to enable auto-instantiation of modules with
+parameters which can be overridden.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags ... --fields-Verilog<span class="operator">=</span>+<span class="operator">{</span>parameter<span class="operator">}</span> ...
+<span class="generic prompt">$ </span>ctags ... --fields-SystemVerilog<span class="operator">=</span>+<span class="operator">{</span>parameter<span class="operator">}</span> ...
+</pre>
+<p>On the following source code fields <tt class="docutils literal">parameter:</tt> are added on
+parameters <tt class="docutils literal">P*</tt>, not on ones <tt class="docutils literal">L*</tt>. Note that <tt class="docutils literal">L4</tt> and <tt class="docutils literal">L6</tt> is declared by
+<tt class="docutils literal">parameter</tt> statement, but fields <tt class="docutils literal">parameter:</tt> are not added,
+because they cannot be overridden.</p>
+<p>&quot;input.sv&quot;</p>
+<pre class="code systemverilog literal-block">
+<span class="comment single">// compilation unit scope
+</span><span class="keyword">parameter</span> <span class="name">L1</span> <span class="operator">=</span> <span class="literal string">&quot;synonym for the localparam&quot;</span><span class="punctuation">;</span>
+
+<span class="keyword">module</span> <span class="name">with_parameter_port_list</span> <span class="punctuation">#(</span>
+ <span class="name">P1</span><span class="punctuation">,</span>
+ <span class="keyword">localparam</span> <span class="name">L2</span> <span class="operator">=</span> <span class="name">P1</span><span class="operator">+</span><span class="literal number integer">1</span><span class="punctuation">,</span>
+ <span class="keyword">parameter</span> <span class="name">P2</span><span class="punctuation">)</span>
+ <span class="punctuation">(</span> <span class="comment multiline">/*port list...*/</span> <span class="punctuation">);</span>
+ <span class="keyword">parameter</span> <span class="name">L3</span> <span class="operator">=</span> <span class="literal string">&quot;synonym for the localparam&quot;</span><span class="punctuation">;</span>
+ <span class="keyword">localparam</span> <span class="name">L4</span> <span class="operator">=</span> <span class="literal string">&quot;localparam&quot;</span><span class="punctuation">;</span>
+ <span class="comment single">// ...
+</span><span class="keyword">endmodule</span>
+
+<span class="keyword">module</span> <span class="name">with_empty_parameter_port_list</span> <span class="punctuation">#()</span>
+ <span class="punctuation">(</span> <span class="comment multiline">/*port list...*/</span> <span class="punctuation">);</span>
+ <span class="keyword">parameter</span> <span class="name">L5</span> <span class="operator">=</span> <span class="literal string">&quot;synonym for the localparam&quot;</span><span class="punctuation">;</span>
+ <span class="keyword">localparam</span> <span class="name">L6</span> <span class="operator">=</span> <span class="literal string">&quot;localparam&quot;</span><span class="punctuation">;</span>
+ <span class="comment single">// ...
+</span><span class="keyword">endmodule</span>
+
+<span class="keyword">module</span> <span class="name">no_parameter_port_list</span>
+ <span class="punctuation">(</span> <span class="comment multiline">/*port list...*/</span> <span class="punctuation">);</span>
+ <span class="keyword">parameter</span> <span class="name">P3</span> <span class="operator">=</span> <span class="literal string">&quot;parameter&quot;</span><span class="punctuation">;</span>
+ <span class="keyword">localparam</span> <span class="name">L7</span> <span class="operator">=</span> <span class="literal string">&quot;localparam&quot;</span><span class="punctuation">;</span>
+ <span class="comment single">// ...
+</span><span class="keyword">endmodule</span>
+</pre>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags -uo - --fields-SystemVerilog<span class="operator">=</span>+<span class="operator">{</span>parameter<span class="operator">}</span> input.sv
+<span class="generic output">L1 input.sv /^parameter L1 = &quot;synonym for the localparam&quot;;$/;&quot; c parameter:
+with_parameter_port_list input.sv /^module with_parameter_port_list #($/;&quot; m
+P1 input.sv /^ P1,$/;&quot; c module:with_parameter_port_list parameter:
+L2 input.sv /^ localparam L2 = P1+1,$/;&quot; c module:with_parameter_port_list
+P2 input.sv /^ parameter P2)$/;&quot; c module:with_parameter_port_list parameter:
+L3 input.sv /^ parameter L3 = &quot;synonym for the localparam&quot;;$/;&quot; c module:with_parameter_port_list
+L4 input.sv /^ localparam L4 = &quot;localparam&quot;;$/;&quot; c module:with_parameter_port_list
+with_empty_parameter_port_list input.sv /^module with_empty_parameter_port_list #()$/;&quot; m
+L5 input.sv /^ parameter L5 = &quot;synonym for the localparam&quot;;$/;&quot; c module:with_empty_parameter_port_list
+L6 input.sv /^ localparam L6 = &quot;localparam&quot;;$/;&quot; c module:with_empty_parameter_port_list
+no_parameter_port_list input.sv /^module no_parameter_port_list$/;&quot; m
+P3 input.sv /^ parameter P3 = &quot;parameter&quot;;$/;&quot; c module:no_parameter_port_list parameter:
+L7 input.sv /^ localparam L7 = &quot;localparam&quot;;$/;&quot; c module:no_parameter_port_list</span>
+</pre>
+</div>
+</div>
+<div class="section" id="tips">
+<h2>TIPS</h2>
+<p>If you want to map files <tt class="docutils literal">*.v</tt> to SystemVerilog, add
+<tt class="docutils literal"><span class="pre">--langmap=SystemVerilog:.v</span></tt> option.</p>
+</div>
+</div>
+<div class="section" id="known-issues">
+<h1>KNOWN ISSUES</h1>
+<p>See <a class="reference external" href="https://github.com/universal-ctags/ctags/issues/2674">https://github.com/universal-ctags/ctags/issues/2674</a> for more information.</p>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<ul class="simple">
+<li>ctags(1)</li>
+<li>ctags-client-tools(7)</li>
+<li><dl class="first docutils">
+<dt>Language Reference Manuals (LRM)</dt>
+<dd><ul class="first last">
+<li>IEEE Standard for SystemVerilog — Unified Hardware Design, Specification, and
+Verification Language, IEEE Std 1800-2017,
+<a class="reference external" href="https://ieeexplore.ieee.org/document/8299595">https://ieeexplore.ieee.org/document/8299595</a></li>
+<li>IEEE Standard for Verilog Hardware Description Language, IEEE Std 1364-2005,
+<a class="reference external" href="https://ieeexplore.ieee.org/document/1620780">https://ieeexplore.ieee.org/document/1620780</a></li>
+</ul>
+</dd>
+</dl>
+</li>
+</ul>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags-optlib.7.html b/ctags/man/ctags-optlib.7.html
new file mode 100644
index 0000000..6c3e742
--- /dev/null
+++ b/ctags/man/ctags-optlib.7.html
@@ -0,0 +1,785 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags-optlib</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags-optlib">
+<span id="ctags-optlib-7"></span>
+<h1 class="title">ctags-optlib</h1>
+<h2 class="subtitle" id="universal-ctags-parser-definition-language">Universal Ctags parser definition language</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> [options] [file(s)]</div>
+<div class="line"><strong>etags</strong> [options] [file(s)]</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p><em>Exuberant Ctags</em>, the ancestor of <em>Universal Ctags</em>, has provided
+the way to define a new parser from command line. Universal Ctags
+extends and refines this feature. <em>optlib parser</em> is the name for such
+parser in Universal Ctags. &quot;opt&quot; intends a parser is defined with
+combination of command line options. &quot;lib&quot; intends an optlib parser
+can be more than ad-hoc personal configuration.</p>
+<p>This man page is for people who want to define an optlib parser. The
+readers should read ctags(1) of Universal Ctags first.</p>
+<p>Following options are for defining (or customizing) a parser:</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">--langdef=&lt;name&gt;</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;=[+|-]&lt;extension&gt;|&lt;pattern&gt;</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--mline-regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></li>
+</ul>
+<p>Following options are for controlling loading parser definition:</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">--options=&lt;pathname&gt;</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--options-maybe=&lt;pathname&gt;</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">--optlib-dir=[+]&lt;directory&gt;</span></tt></li>
+</ul>
+<p>The design of options and notations for defining a parser in
+Exuberant Ctags may focus on reducing the number of typing by user.
+Reducing the number of typing is important for users who want to
+define (or customize) a parser quickly.</p>
+<p>On the other hand, the design in Universal Ctags focuses on
+maintainability. The notation of Universal Ctags is redundant than
+that of Exuberant Ctags; the newly introduced kind should be declared
+explicitly, (long) names are approved than one-letter flags
+specifying kinds, and naming rules are stricter.</p>
+<p>This man page explains only stable options and flags. Universal Ctags
+also introduces experimental options and flags which have names starting
+with <tt class="docutils literal">_</tt>. For documentation on these options and flags, visit
+Universal Ctags web site at <a class="reference external" href="https://ctags.io/">https://ctags.io/</a>.</p>
+<div class="section" id="storing-a-parser-definition-to-a-file">
+<h2>Storing a parser definition to a file</h2>
+<p>Though it is possible to define a parser from command line, you don't
+want to type the same command line each time when you need the parser.
+You can store options for defining a parser into a file.</p>
+<p>ctags loads files (preload files) listed in &quot;FILES&quot;
+section of ctags(1) at program starting up. You can put your parser
+definition needed usually to the files.</p>
+<p><tt class="docutils literal"><span class="pre">--options=&lt;pathname&gt;</span></tt>, <tt class="docutils literal"><span class="pre">--options-maybe=&lt;pathname&gt;</span></tt>, and
+<tt class="docutils literal"><span class="pre">--optlib-dir=[+]&lt;directory&gt;</span></tt> are for loading optlib files you need
+occasionally. See &quot;Option File Options&quot; section of ctags(1) for
+these options.</p>
+<p>As explained in &quot;FILES&quot; section of ctags(1), options for defining a
+parser listed line by line in an optlib file. Prefixed white spaces are
+ignored. A line starting with '#' is treated as a comment. Escaping
+shell meta character is not needed.</p>
+<p>Use <tt class="docutils literal">.ctags</tt> as file extension for optlib file. You can define
+multiple parsers in an optlib file but it is better to make a file for
+each parser definition.</p>
+<p><tt class="docutils literal"><span class="pre">--_echo=&lt;msg&gt;</span></tt> and <tt class="docutils literal"><span class="pre">--_force-quit=&lt;num&gt;</span></tt> options are for debugging
+optlib parser.</p>
+</div>
+<div class="section" id="overview-for-defining-a-parser">
+<h2>Overview for defining a parser</h2>
+<ol class="arabic">
+<li><p class="first">Design the parser</p>
+<p>You need know both the target language and the ctags'
+concepts (definition, reference, kind, role, field, extra). About
+the concepts, ctags(1) of Universal Ctags may help you.</p>
+</li>
+<li><p class="first">Give a name to the parser</p>
+<p>Use <tt class="docutils literal"><span class="pre">--langdef=&lt;name&gt;</span></tt> option. <em>&lt;name&gt;</em> is referred as <em>&lt;LANG&gt;</em> in
+the later steps.</p>
+</li>
+<li><p class="first">Give a file pattern or file extension for activating the parser</p>
+<p>Use <tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;=[+|-]&lt;extension&gt;|&lt;pattern&gt;</span></tt>.</p>
+</li>
+<li><p class="first">Define kinds</p>
+<p>Use <tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt> option.
+Universal Ctags introduces this option. Exuberant Ctags doesn't
+have. In Exuberant Ctags, a kind is defined as a side effect of
+specifying <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=</span></tt> option. So user doesn't have a
+chance to recognize how important the definition of kind.</p>
+</li>
+<li><p class="first">Define patterns</p>
+<p>Use <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt>
+option for a single-line regular expression. You can also use
+<tt class="docutils literal"><span class="pre">--mline-regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt>
+option for a multi-line regular expression.</p>
+<p>As <em>&lt;kind-spec&gt;</em>, you can use the one-letter flag defined with
+<tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt> option.</p>
+</li>
+</ol>
+</div>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--langdef=&lt;name&gt;</span></tt></dt>
+<dd><p class="first">Defines a new user-defined language, <em>&lt;name&gt;</em>, to be parsed with regular
+expressions. Once defined, <em>&lt;name&gt;</em> may be used in other options taking
+language names.</p>
+<p><em>&lt;name&gt;</em> must consist of alphanumeric characters, '<tt class="docutils literal">#</tt>', or '<tt class="docutils literal">+</tt>'
+('[a-zA-Z0-9#+]+'). The graph characters other than '<tt class="docutils literal">#</tt>' and
+'<tt class="docutils literal">+</tt>' are disallowed (or reserved). Some of them (<tt class="docutils literal"><span class="pre">[-=:{.]</span></tt>) are
+disallowed because they can make the command line parser of
+ctags confused. The rest of them are just
+reserved for future extending ctags.</p>
+<p><tt class="docutils literal">all</tt> is an exception. <tt class="docutils literal">all</tt> as <em>&lt;name&gt;</em> is not acceptable. It is
+a reserved word. See the description of
+<tt class="docutils literal"><span class="pre">--kinds-(&lt;LANG&gt;|all)=[+|-](&lt;kinds&gt;|*)</span></tt> option in ctags(1) about how the
+reserved word is used.</p>
+<p class="last">The names of built-in parsers are capitalized. When
+ctags evaluates an option in a command line, and
+chooses a parser, ctags uses the names of
+parsers in a case-insensitive way. Therefore, giving a name
+started from a lowercase character doesn't help you to avoid the
+parser name confliction. However, in a tags file,
+ctags prints parser names in a case-sensitive
+way; it prints a parser name as specified in <tt class="docutils literal"><span class="pre">--langdef=&lt;name&gt;</span></tt>
+option. Therefore, we recommend you to give a name started from a
+lowercase character to your private optlib parser. With this
+convention, people can know where a tag entry in a tag file comes
+from a built-in parser or a private optlib parser.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt></dt>
+<dd><p class="first">Define a kind for <em>&lt;LANG&gt;</em>.
+Be not confused this with <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt>.</p>
+<p><em>&lt;letter&gt;</em> must be an alphabetical character ('[a-zA-EG-Z]')
+other than &quot;F&quot;. &quot;F&quot; has been reserved for representing a file
+since Exuberant Ctags.</p>
+<p><em>&lt;name&gt;</em> must start with an alphabetic character, and the rest
+must be alphanumeric ('[a-zA-Z][a-zA-Z0-9]*'). Do not use
+&quot;file&quot; as <em>&lt;name&gt;</em>. It has been reserved for representing a file
+since Exuberant Ctags.</p>
+<p>Note that using a number character in a <em>&lt;name&gt;</em> violates the
+version 2 of tags file format though ctags
+accepts it. For more detail, see tags(5).</p>
+<p><em>&lt;description&gt;</em> comes from any printable ASCII characters. The
+exception is <tt class="docutils literal">{</tt> and <tt class="docutils literal">\</tt>. <tt class="docutils literal">{</tt> is reserved for adding flags
+this option in the future. So put <tt class="docutils literal">\</tt> before <tt class="docutils literal">{</tt> to include
+<tt class="docutils literal">{</tt> to a description. To include <tt class="docutils literal">\</tt> itself to a description,
+put <tt class="docutils literal">\</tt> before <tt class="docutils literal">\</tt>.</p>
+<p>Both <em>&lt;letter&gt;</em>, <em>&lt;name&gt;</em> and their combination must be unique in
+a <em>&lt;LANG&gt;</em>.</p>
+<p>This option is newly introduced in Universal Ctags. This option
+reduces the typing defining a regex pattern with
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=</span></tt>, and keeps the consistency of kind
+definitions in a language.</p>
+<p>The <em>&lt;letter&gt;</em> can be used as an argument for <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt>
+option to enable or disable the kind. Unless <tt class="docutils literal">K</tt> field is
+enabled, the <em>&lt;letter&gt;</em> is used as value in the &quot;kind&quot; extension
+field in tags output.</p>
+<p>The <em>&lt;name&gt;</em> surrounded by braces can be used as an argument for
+<tt class="docutils literal"><span class="pre">--kind-&lt;LANG&gt;</span></tt> option. If <tt class="docutils literal">K</tt> field is enabled, the <em>&lt;name&gt;</em>
+is used as value in the &quot;kind&quot; extension field in tags output.</p>
+<p class="last">The <em>&lt;description&gt;</em> and <em>&lt;letter&gt;</em> are listed in <tt class="docutils literal"><span class="pre">--list-kinds</span></tt>
+output. All three elements of the kind-spec are listed in
+<tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt> output. Don't use braces in the
+<em>&lt;description&gt;</em>. They will be used meta characters in the future.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></dt>
+<dd><p class="first">Define a single-line regular expression.</p>
+<p>The <em>/&lt;line_pattern&gt;/&lt;name_pattern&gt;/</em> pair defines a regular expression
+replacement pattern, similar in style to <tt class="docutils literal">sed</tt> substitution
+commands, <tt class="docutils literal">s/regexp/replacement/</tt>, with which to generate tags from source files mapped to
+the named language, <em>&lt;LANG&gt;</em>, (case-insensitive; either a built-in
+or user-defined language).</p>
+<p>The regular expression, <em>&lt;line_pattern&gt;</em>, defines
+an extended regular expression (roughly that used by egrep(1)),
+which is used to locate a single source line containing a tag and
+may specify tab characters using <tt class="docutils literal">\t</tt>.</p>
+<p>When a matching line is
+found, a tag will be generated for the name defined by
+<em>&lt;name_pattern&gt;</em>, which generally will contain the special
+back-references <tt class="docutils literal">\1</tt> through <tt class="docutils literal">\9</tt> to refer to matching sub-expression
+groups within <em>&lt;line_pattern&gt;</em>.</p>
+<p>The '<tt class="docutils literal">/</tt>' separator characters shown in the
+parameter to the option can actually be replaced by any
+character. Note that whichever separator character is used will
+have to be escaped with a backslash ('<tt class="docutils literal">\</tt>') character wherever it is
+used in the parameter as something other than a separator. The
+regular expression defined by this option is added to the current
+list of regular expressions for the specified language unless the
+parameter is omitted, in which case the current list is cleared.</p>
+<p>Unless modified by <em>&lt;flags&gt;</em>, <em>&lt;line_pattern&gt;</em> is interpreted as a POSIX
+extended regular expression. The <em>&lt;name_pattern&gt;</em> should expand for all
+matching lines to a non-empty string of characters, or a warning
+message will be reported unless <tt class="docutils literal">{placeholder}</tt> regex flag is
+specified.</p>
+<p>A kind specifier (<em>&lt;kind-spec&gt;</em>) for tags matching regexp may
+follow <em>&lt;name_pattern&gt;</em>, which will determine what kind of tag is
+reported in the <tt class="docutils literal">kind</tt> extension field (see tags(5)).</p>
+<p><em>&lt;kind-spec&gt;</em> has two forms: <em>one-letter form</em> and <em>full form</em>.</p>
+<p>The one-letter form in the form of <tt class="docutils literal">&lt;letter&gt;</tt>. It just refers a kind
+<em>&lt;letter&gt;</em> defined with <tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;</span></tt>. This form is recommended in
+Universal Ctags.</p>
+<p>The full form of <em>&lt;kind-spec&gt;</em> is in the form of
+<tt class="docutils literal"><span class="pre">&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt>. Either the kind <em>&lt;name&gt;</em> and/or the
+<em>&lt;description&gt;</em> can be omitted. See the description of
+<tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt> option about the
+elements.</p>
+<p>The full form is supported only for keeping the compatibility with Exuberant
+Ctags which does not have <tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;</span></tt> option. Supporting the
+form will be removed from Universal Ctags in the future.</p>
+<!-- MEMO: the following line is commented out
+If *<kind-spec>* is omitted, it defaults to ``r,regex``. -->
+<p>About <em>&lt;flags&gt;</em>, see &quot;FLAGS FOR <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> OPTION&quot;.</p>
+<p class="last">For more information on the regular expressions used by
+ctags, see either the regex(5,7) man page, or
+the GNU info documentation for regex (e.g. &quot;<tt class="docutils literal">info regex</tt>&quot;).</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-regex-flags</span></tt></dt>
+<dd>Lists the flags that can be used in <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-mline-regex-flags</span></tt></dt>
+<dd>Lists the flags that can be used in <tt class="docutils literal"><span class="pre">--mline-regex-&lt;LANG&gt;</span></tt> option.</dd>
+<dt><tt class="docutils literal"><span class="pre">--mline-regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></dt>
+<dd><p class="first">Define a multi-line regular expression.</p>
+<p class="last">This option is similar to <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option except the pattern is
+applied to the whole file’s contents, not line by line.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--_echo=&lt;message&gt;</span></tt></dt>
+<dd>Print <em>&lt;message&gt;</em> to the standard error stream. This is helpful to
+understand (and debug) optlib loading feature of Universal Ctags.</dd>
+<dt><tt class="docutils literal"><span class="pre">--_force-quit[=&lt;num&gt;]</span></tt></dt>
+<dd>Exits immediately when this option is processed. If <em>&lt;num&gt;</em> is used
+as exit status. The default is 0. This is helpful to debug optlib
+loading feature of Universal Ctags.</dd>
+</dl>
+<div class="section" id="flags-for-regex-lang-option">
+<h2>FLAGS FOR <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> OPTION</h2>
+<p>You can specify more than one flag, <tt class="docutils literal"><span class="pre">&lt;letter&gt;|{&lt;name&gt;}</span></tt>, at the end of <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> to
+control how Universal Ctags uses the pattern.</p>
+<p>Exuberant Ctags uses a <em>&lt;letter&gt;</em> to represent a flag. In
+Universal Ctags, a <em>&lt;name&gt;</em> surrounded by braces (name form) can be used
+in addition to <em>&lt;letter&gt;</em>. The name form makes a user reading an optlib
+file easier.</p>
+<p>The most of all flags newly added in Universal Ctags
+don't have the one-letter representation. All of them have only the name
+representation. <tt class="docutils literal"><span class="pre">--list-regex-flags</span></tt> lists all the flags.</p>
+<dl class="docutils">
+<dt><tt class="docutils literal">basic</tt> (one-letter form <tt class="docutils literal">b</tt>)</dt>
+<dd>The pattern is interpreted as a POSIX basic regular expression.</dd>
+<dt><tt class="docutils literal">exclusive</tt> (one-letter form <tt class="docutils literal">x</tt>)</dt>
+<dd>Skip testing the other patterns if a line is matched to this
+pattern. This is useful to avoid using CPU to parse line comments.</dd>
+<dt><tt class="docutils literal">extend</tt> (one-letter form <tt class="docutils literal">e</tt>)</dt>
+<dd>The pattern is interpreted as a POSIX extended regular
+expression (default).</dd>
+<dt><tt class="docutils literal">icase</tt> (one-letter form <tt class="docutils literal">i</tt>)</dt>
+<dd>The regular expression is to be applied in a case-insensitive
+manner.</dd>
+<dt><tt class="docutils literal">placeholder</tt></dt>
+<dd>Don't emit a tag captured with a regex pattern. The replacement
+can be an empty string. See the following description of
+<tt class="docutils literal"><span class="pre">scope=...</span></tt> flag about how this is useful.</dd>
+</dl>
+<p><tt class="docutils literal"><span class="pre">scope=(ref|push|pop|clear|set)</span></tt></p>
+<blockquote>
+<p>Specify what to do with the internal scope stack.</p>
+<p>A parser programmed with <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> has a stack (scope
+stack) internally. You can use it for tracking scope
+information. The <tt class="docutils literal"><span class="pre">scope=...</span></tt> flag is for manipulating and
+utilizing the scope stack.</p>
+<p>If <tt class="docutils literal">{scope=push}</tt> is specified, a tag captured with
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> is pushed to the stack. <tt class="docutils literal">{scope=push}</tt>
+implies <tt class="docutils literal">{scope=ref}</tt>.</p>
+<p>You can fill the scope field of captured tag with
+<tt class="docutils literal">{scope=ref}</tt>. If <tt class="docutils literal">{scope=ref}</tt> flag is given,
+ctags attaches the tag at the top to the tag
+captured with <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> as the value for the <tt class="docutils literal">scope:</tt>
+field.</p>
+<p>ctags pops the tag at the top of the stack when
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> with <tt class="docutils literal">{scope=pop}</tt> is matched to the input
+line.</p>
+<p>Specifying <tt class="docutils literal">{scope=clear}</tt> removes all the tags in the scope.
+Specifying <tt class="docutils literal">{scope=set}</tt> removes all the tags in the scope, and
+then pushes the captured tag as <tt class="docutils literal">{scope=push}</tt> does.</p>
+<p>In some cases, you may want to use <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> only for its
+side effects: using it only to manipulate the stack but not for
+capturing a tag. In such a case, make <em>&lt;name_pattern&gt;</em> component of
+<tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option empty while specifying <tt class="docutils literal">{placeholder}</tt>
+as a regex flag. For example, a non-named tag can be put on
+the stack by giving a regex flag &quot;<tt class="docutils literal"><span class="pre">{scope=push}{placeholder}</span></tt>&quot;.</p>
+<p>You may wonder what happens if a regex pattern with
+<tt class="docutils literal">{scope=ref}</tt> flag matches an input line but the stack is empty,
+or a non-named tag is at the top. If the regex pattern contains a
+<tt class="docutils literal">{scope=ref}</tt> flag and the stack is empty, the <tt class="docutils literal">{scope=ref}</tt>
+flag is ignored and nothing is attached to the <tt class="docutils literal">scope:</tt> field.</p>
+<p>If the top of the stack contains an unnamed tag,
+ctags searches deeper into the stack to find the
+top-most named tag. If it reaches the bottom of the stack without
+finding a named tag, the <tt class="docutils literal">{scope=ref}</tt> flag is ignored and
+nothing is attached to the <tt class="docutils literal">scope:</tt> field.</p>
+<p>When a named tag on the stack is popped or cleared as the side
+effect of a pattern matching, ctags attaches the
+line number of the match to the <tt class="docutils literal">end:</tt> field of
+the named tag.</p>
+<p>ctags clears all of the tags on the stack when it
+reaches the end of the input source file. The line number of the
+end is attached to the <tt class="docutils literal">end:</tt> field of the cleared tags.</p>
+</blockquote>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">warning=&lt;message&gt;</span></tt></dt>
+<dd>print the given <em>&lt;message&gt;</em> at WARNING level</dd>
+<dt><tt class="docutils literal"><span class="pre">fatal=&lt;message&gt;</span></tt></dt>
+<dd>print the given <em>&lt;message&gt;</em> and exit</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="examples">
+<h1>EXAMPLES</h1>
+<div class="section" id="perl-pod">
+<h2>Perl Pod</h2>
+<p>This is the definition (pod.ctags) used in ctags for parsing Pod
+(<a class="reference external" href="https://perldoc.perl.org/perlpod.html">https://perldoc.perl.org/perlpod.html</a>) file.</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-optlib.7.rst</tt>, line 395)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;ctags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: ctags
+
+ --langdef=pod
+ --map-pod=+.pod
+
+ --kinddef-pod=c,chapter,chapters
+ --kinddef-pod=s,section,sections
+ --kinddef-pod=S,subsection,subsections
+ --kinddef-pod=t,subsubsection,subsubsections
+
+ --regex-pod=/^=head1[ \t]+(.+)/\1/c/
+ --regex-pod=/^=head2[ \t]+(.+)/\1/s/
+ --regex-pod=/^=head3[ \t]+(.+)/\1/S/
+ --regex-pod=/^=head4[ \t]+(.+)/\1/t/
+
+</pre>
+</div>
+</div>
+<div class="section" id="using-scope-regex-flags">
+<h2>Using scope regex flags</h2>
+<p>Let's think about writing a parser for a very small subset of the Ruby
+language.</p>
+<p>input source file (<tt class="docutils literal">input.srb</tt>):</p>
+<pre class="literal-block">
+class Example
+ def methodA
+ puts &quot;in class_method&quot;
+ end
+ def methodB
+ puts &quot;in class_method&quot;
+ end
+end
+</pre>
+<p>The parser for the input should capture <tt class="docutils literal">Example</tt> with <tt class="docutils literal">class</tt> kind,
+<tt class="docutils literal">methodA</tt>, and <tt class="docutils literal">methodB</tt> with <tt class="docutils literal">method</tt> kind. <tt class="docutils literal">methodA</tt> and <tt class="docutils literal">methodB</tt>
+should have <tt class="docutils literal">Example</tt> as their scope. <tt class="docutils literal">end:</tt> fields of each tag
+should have proper values.</p>
+<p>optlib file (<tt class="docutils literal"><span class="pre">sub-ruby.ctags</span></tt>):</p>
+<div class="system-message">
+<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-optlib.7.rst</tt>, line 434)</p>
+<p>Cannot analyze code. No Pygments lexer found for &quot;ctags&quot;.</p>
+<pre class="literal-block">
+.. code-block:: ctags
+
+ --langdef=subRuby
+ --map-subRuby=.srb
+ --kinddef-subRuby=c,class,classes
+ --kinddef-subRuby=m,method,methods
+ --regex-subRuby=/^class[ \t]+([a-zA-Z][a-zA-Z0-9]+)/\1/c/{scope=push}
+ --regex-subRuby=/^end///{scope=pop}{placeholder}
+ --regex-subRuby=/^[ \t]+def[ \t]+([a-zA-Z][a-zA-Z0-9_]+)/\1/m/{scope=push}
+ --regex-subRuby=/^[ \t]+end///{scope=pop}{placeholder}
+
+</pre>
+</div>
+<p>command line and output:</p>
+<pre class="literal-block">
+$ ctags --quiet --fields=+eK \
+--options=./sub-ruby.ctags -o - input.srb
+Example input.srb /^class Example$/;&quot; class end:8
+methodA input.srb /^ def methodA$/;&quot; method class:Example end:4
+methodB input.srb /^ def methodB$/;&quot; method class:Example end:7
+</pre>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>The official Universal Ctags web site at:</p>
+<p><a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>ctags(1), tags(5), regex(3), regex(7), egrep(1)</p>
+</div>
+<div class="section" id="author">
+<h1>AUTHOR</h1>
+<p>Universal Ctags project
+<a class="reference external" href="https://ctags.io/">https://ctags.io/</a>
+(This man page partially derived from ctags(1) of
+Executable-ctags)</p>
+<p>Darren Hiebert &lt;<a class="reference external" href="mailto:dhiebert&#64;users.sourceforge.net">dhiebert&#64;users.sourceforge.net</a>&gt;
+<a class="reference external" href="http://DarrenHiebert.com/">http://DarrenHiebert.com/</a></p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/ctags.1.html b/ctags/man/ctags.1.html
new file mode 100644
index 0000000..949814d
--- /dev/null
+++ b/ctags/man/ctags.1.html
@@ -0,0 +1,2273 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>ctags</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="ctags">
+<span id="ctags-1"></span>
+<h1 class="title">ctags</h1>
+<h2 class="subtitle" id="generate-tag-files-for-source-code">Generate tag files for source code</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>ctags</strong> [&lt;options&gt;] [&lt;source_file(s)&gt;]</div>
+<div class="line"><strong>etags</strong> [&lt;options&gt;] [&lt;source_file(s)&gt;]</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>The <em>ctags</em> and <em>etags</em> (see <tt class="docutils literal"><span class="pre">-e</span></tt> option) programs
+(hereinafter collectively referred to as ctags,
+except where distinguished) generate an index (or &quot;tag&quot;) file for a
+variety of <em>language objects</em> found in <em>source file(s)</em>. This tag file allows
+these items to be quickly and easily located by a text editor or other
+utilities (<em>client tools</em>). A <em>tag</em> signifies a language object for which an index entry is
+available (or, alternatively, the index entry created for that object).</p>
+<p>Alternatively, ctags can generate a cross reference
+file which lists, in human readable form, information about the various
+language objects found in a set of source files.</p>
+<p>Tag index files are supported by numerous editors, which allow the user to
+locate the object associated with a name appearing in a source file and
+jump to the file and line which defines the name. See the manual of your
+favorite editor about utilizing ctags command and
+the tag index files in the editor.</p>
+<p>ctags is capable of generating different <em>kinds</em> of tags
+for each of many different <em>languages</em>. For a complete list of supported
+languages, the names by which they are recognized, and the kinds of tags
+which are generated for each, see the <tt class="docutils literal"><span class="pre">--list-languages</span></tt> and <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt>
+options.</p>
+<p>This man page describes <em>Universal Ctags</em>, an implementation of ctags
+derived from <em>Exuberant Ctags</em>. The major incompatible changes between
+Universal Ctags and Exuberant Ctags are enumerated in
+ctags-incompatibilities(7).</p>
+<p>One of the advantages of Exuberant Ctags is that it allows a user to
+define a new parser from the command line. Extending this capability is one
+of the major features of Universal Ctags. ctags-optlib(7)
+describes how the capability is extended.</p>
+<p>Newly introduced experimental features are not explained here. If you
+are interested in such features and ctags internals,
+visit <a class="reference external" href="https://docs.ctags.io/">https://docs.ctags.io/</a>.</p>
+</div>
+<div class="section" id="command-line-interface">
+<h1>COMMAND LINE INTERFACE</h1>
+<p>Despite the wealth of available options, defaults are set so that
+ctags is most commonly executed without any options (e.g.
+&quot;<tt class="docutils literal">ctags *</tt>&quot;, or &quot;<tt class="docutils literal">ctags <span class="pre">-R</span></tt>&quot;), which will
+create a tag file in the current directory for all recognized source
+files. The options described below are provided merely to allow custom
+tailoring to meet special needs.</p>
+<p>Note that spaces separating the single-letter options from their parameters
+are optional.</p>
+<p>Note also that the boolean parameters to the long form options (those
+beginning with <tt class="docutils literal"><span class="pre">--</span></tt> and that take a <tt class="docutils literal"><span class="pre">[=(yes|no)]</span></tt> parameter) may be omitted,
+in which case <tt class="docutils literal">=yes</tt> is implied. (e.g. <tt class="docutils literal"><span class="pre">--sort</span></tt> is equivalent to <tt class="docutils literal"><span class="pre">--sort=yes</span></tt>).
+Note further that <tt class="docutils literal">=1</tt>, <tt class="docutils literal">=on</tt>, and <tt class="docutils literal">=true</tt> are considered synonyms for <tt class="docutils literal">=yes</tt>,
+and that <tt class="docutils literal">=0</tt>, <tt class="docutils literal">=off</tt>, and <tt class="docutils literal">=false</tt> are considered synonyms for <tt class="docutils literal">=no</tt>.</p>
+<p>Some options are either ignored or useful only when used while running in
+etags mode (see <tt class="docutils literal"><span class="pre">-e</span></tt> option). Such options will be noted.</p>
+<p><em>&lt;options&gt;</em> must precede the <em>&lt;source_file(s)&gt;</em> following the standard POSIX
+convention.</p>
+<p>Options taking language names will accept those names in either upper or
+lower case. See the <tt class="docutils literal"><span class="pre">--list-languages</span></tt> option for a complete list of the
+built-in language names.</p>
+<div class="section" id="letters-and-names">
+<h2>Letters and names</h2>
+<p>Some options take one-letter flags as parameters (e.g. <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt> option).
+Specifying just letters help a user create a complicated command line
+quickly. However, a command line including sequences of one-letter flags
+becomes difficult to understand.</p>
+<p>Universal Ctags accepts long-name flags in
+addition to such one-letter flags. The long-name and one-letter flags can be mixed in an
+option parameter by surrounding each long-name by braces. Thus, for an
+example, the following three notations for <tt class="docutils literal"><span class="pre">--kinds-C</span></tt> option have
+the same meaning:</p>
+<pre class="literal-block">
+--kinds-C=+pLl
+--kinds-C=+{prototype}{label}{local}
+--kinds-C=+{prototype}L{local}
+</pre>
+<p>Note that braces may be meta characters in your shell. Put
+single quotes in such case.</p>
+<p><tt class="docutils literal"><span class="pre">--list-...</span></tt> options shows one-letter flags and associated long-name flags.</p>
+</div>
+<div class="section" id="list-options">
+<h2>List options</h2>
+<p>Universal Ctags introduces many <tt class="docutils literal"><span class="pre">--list-...</span></tt> options that provide
+the internal data of Universal Ctags (See &quot;<a class="reference internal" href="#listing-options">Listing Options</a>&quot;). Both users and client tools may
+use the data. <tt class="docutils literal"><span class="pre">--with-list-header</span></tt> and <tt class="docutils literal"><span class="pre">--machinable</span></tt> options
+adjust the output of the most of <tt class="docutils literal"><span class="pre">--list-...</span></tt> options.</p>
+<p>The default setting (<tt class="docutils literal"><span class="pre">--with-list-header=yes</span></tt> and <tt class="docutils literal"><span class="pre">--machinable=no</span></tt>)
+is for using interactively from a terminal. The header that explains
+the meaning of columns is simply added to the output, and each column is
+aligned in all lines. The header line starts with a hash ('<tt class="docutils literal">#</tt>') character.</p>
+<p>For scripting in a client tool, <tt class="docutils literal"><span class="pre">--with-list-header=no</span></tt> and
+<tt class="docutils literal"><span class="pre">--machinable=yes</span></tt> may be useful. The header is not added to the
+output, and each column is separated by tab characters.</p>
+<p>Note the order of columns will change in the future release.
+However, labels in the header will not change. So by scanning
+the header, a client tool can find the index for the target
+column.</p>
+<!-- options that should be explained and revised here
+``- -list-features`` (done)
+``- -machinable`` (done)
+``- -with-list-header`` (done) -->
+</div>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<p>ctags has more options than listed here.
+Options starting with an underscore character, such as <tt class="docutils literal"><span class="pre">--_echo=&lt;msg&gt;</span></tt>,
+are not listed here. They are experimental or for debugging purpose.</p>
+<p>Notation: <tt class="docutils literal">&lt;foo&gt;</tt> is for a variable string <tt class="docutils literal">foo</tt>, <tt class="docutils literal">[ ... ]</tt> for optional,
+<tt class="docutils literal">|</tt> for selection, and <tt class="docutils literal">( ... )</tt> for grouping. For example
+<tt class="docutils literal"><span class="pre">--foo[=(yes|no)]''</span> means <span class="pre">``--foo</span></tt>, <tt class="docutils literal"><span class="pre">-foo=yes</span></tt>, or <tt class="docutils literal"><span class="pre">-foo=no</span></tt>.</p>
+<div class="section" id="input-output-file-options">
+<span id="option-input-output-file"></span><h2>Input/Output File Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--exclude=&lt;pattern&gt;</span></tt></dt>
+<dd><p class="first">Add <em>&lt;pattern&gt;</em> to a list of excluded files and directories. This option may
+be specified as many times as desired. For each file name considered
+by ctags, each pattern specified using this option
+will be compared against both the complete path (e.g.
+<tt class="docutils literal">some/path/base.ext</tt>) and the base name (e.g. <tt class="docutils literal">base.ext</tt>) of the file, thus
+allowing patterns which match a given file name irrespective of its
+path, or match only a specific path.</p>
+<p>If appropriate support is available
+from the runtime library of your C compiler, then pattern 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 ctags;
+also be aware that wildcards can match the slash character, '<tt class="docutils literal">/</tt>').
+You can determine if shell wildcards are available on your platform by
+examining the output of the <tt class="docutils literal"><span class="pre">--list-features</span></tt> option, which will include
+<tt class="docutils literal">wildcards</tt> in the compiled feature list; otherwise, pattern is matched
+against file names using a simple textual comparison.</p>
+<p>If <em>&lt;pattern&gt;</em> begins with the character '<tt class="docutils literal">&#64;</tt>', then the rest of the string
+is interpreted as a file name from which to read exclusion patterns,
+one per line. If pattern is empty, the list of excluded patterns is
+cleared.</p>
+<p>Note that at program startup, the default exclude list contains names of
+common hidden and system files, patterns for binary files, and directories
+for which it is generally not desirable to descend while processing the
+<tt class="docutils literal"><span class="pre">--recurse</span></tt> option. To see the list of built-in exclude patterns, use
+<tt class="docutils literal"><span class="pre">--list-excludes</span></tt>.</p>
+<p class="last">See also the description for <tt class="docutils literal"><span class="pre">--exclude-exception=</span></tt> option.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--exclude-exception=&lt;pattern&gt;</span></tt></dt>
+<dd><p class="first">Add <em>&lt;pattern&gt;</em> to a list of included files and directories. The pattern
+affects the files and directories that are excluded by the pattern
+specified with <tt class="docutils literal"><span class="pre">--exclude=</span></tt> option.</p>
+<p class="last">For an example, you want ctags to ignore all files
+under <tt class="docutils literal">foo</tt> directory except <tt class="docutils literal">foo/main.c</tt>, use the following command
+line: <tt class="docutils literal"><span class="pre">--exclude=foo/*</span> <span class="pre">--exclude-exception=foo/main.c</span></tt>.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--filter[=(yes|no)]</span></tt></dt>
+<dd>Makes ctags behave as a filter, reading source
+file names from standard input and printing their tags to standard
+output on a file-by-file basis. If <tt class="docutils literal"><span class="pre">--sort</span></tt> is enabled, tags are sorted
+only within the source file in which they are defined. File names are
+read from standard input in line-oriented input mode (see note for <tt class="docutils literal"><span class="pre">-L</span></tt>
+option) and only after file names listed on the command line or from
+any file supplied using the <tt class="docutils literal"><span class="pre">-L</span></tt> option. When this option is enabled,
+the options <tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">-o</span></tt>, and <tt class="docutils literal"><span class="pre">--totals</span></tt> are ignored. This option is quite
+esoteric and is disabled by default.</dd>
+<dt><tt class="docutils literal"><span class="pre">--filter-terminator=&lt;string&gt;</span></tt></dt>
+<dd><p class="first">Specifies a <em>&lt;string&gt;</em> to print to standard output following the tags for
+each file name parsed when the <tt class="docutils literal"><span class="pre">--filter</span></tt> option is enabled. This may
+permit an application reading the output of ctags
+to determine when the output for each file is finished.</p>
+<p>Note that if the
+file name read is a directory and <tt class="docutils literal"><span class="pre">--recurse</span></tt> is enabled, this string will
+be printed only once at the end of all tags found for by descending
+the directory. This string will always be separated from the last tag
+line for the file by its terminating newline.</p>
+<p class="last">This option is quite esoteric and is empty by default.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--links[=(yes|no)]</span></tt></dt>
+<dd>Indicates whether symbolic links (if supported) should be followed.
+When disabled, symbolic links are ignored. This option is on by default.</dd>
+<dt><tt class="docutils literal"><span class="pre">--maxdepth=&lt;N&gt;</span></tt></dt>
+<dd>Limits the depth of directory recursion enabled with the <tt class="docutils literal"><span class="pre">--recurse</span></tt>
+(<tt class="docutils literal"><span class="pre">-R</span></tt>) option.</dd>
+<dt><tt class="docutils literal"><span class="pre">--recurse[=(yes|no)]</span></tt></dt>
+<dd><p class="first">Recurse into directories encountered in the list of supplied files.</p>
+<p>If the list of supplied files is empty and no file list is specified with
+the <tt class="docutils literal"><span class="pre">-L</span></tt> option, then the current directory (i.e. '<tt class="docutils literal">.</tt>') is assumed.
+Symbolic links are followed by default (See <tt class="docutils literal"><span class="pre">--links</span></tt> option). If you don't like these behaviors, either
+explicitly specify the files or pipe the output of <tt class="docutils literal">find(1)</tt> into
+&quot;<tt class="docutils literal">ctags <span class="pre">-L</span> -</tt>&quot; instead. See, also, the <tt class="docutils literal"><span class="pre">--exclude</span></tt> and
+<tt class="docutils literal"><span class="pre">--maxdepth</span></tt> to limit recursion.</p>
+<p class="last">Note: This option is not supported on
+all platforms at present. It is available if the output of the <tt class="docutils literal"><span class="pre">--help</span></tt>
+option includes this option.</p>
+</dd>
+</dl>
+<!-- TODO(code): - -list-features option should support this. -->
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-R</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--recurse</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">-L</span> &lt;file&gt;</tt></dt>
+<dd><p class="first">Read from <em>&lt;file&gt;</em> a list of file names for which tags should be generated.</p>
+<p>If file is specified as '<tt class="docutils literal">-</tt>', 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.</p>
+<p class="last">Note: file 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>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--append[=(yes|no)]</span></tt></dt>
+<dd>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 <tt class="docutils literal">no</tt> by default.</dd>
+<dt><tt class="docutils literal"><span class="pre">-a</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--append</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">-f</span> &lt;tagfile&gt;</tt></dt>
+<dd><p class="first">Use the name specified by <em>&lt;tagfile&gt;</em> for the tag file (default is &quot;<tt class="docutils literal">tags</tt>&quot;,
+or &quot;<tt class="docutils literal">TAGS</tt>&quot; when running in etags mode). If <em>&lt;tagfile&gt;</em> is specified as '<tt class="docutils literal">-</tt>',
+then the tags are written to standard output instead.</p>
+<p>ctags
+will stubbornly refuse to take orders if tagfile exists and
+its first line contains something other than a valid tags line. This
+will save your neck if you mistakenly type &quot;<tt class="docutils literal">ctags <span class="pre">-f</span>
+*.c</tt>&quot;, which would otherwise overwrite your first C file with the tags
+generated by the rest! It will also refuse to accept a multi-character
+file name which begins with a '<tt class="docutils literal">-</tt>' (dash) character, since this most
+likely means that you left out the tag file name and this option tried to
+grab the next option as the file name. If you really want to name your
+output tag file <tt class="docutils literal"><span class="pre">-ugly</span></tt>, specify it as &quot;<tt class="docutils literal"><span class="pre">-f</span> <span class="pre">./-ugly</span></tt>&quot;.</p>
+<p class="last">This option must
+appear before the first file name. If this option is specified more
+than once, only the last will apply.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">-o</span> &lt;tagfile&gt;</tt></dt>
+<dd>Equivalent to &quot;<tt class="docutils literal"><span class="pre">-f</span> tagfile</tt>&quot;.</dd>
+</dl>
+</div>
+<div class="section" id="output-format-options">
+<span id="option-output-format"></span><h2>Output Format Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--format=(1|2)</span></tt></dt>
+<dd>Change the format of the output tag file. Currently the only valid
+values for level are 1 or 2. Level 1 specifies the original tag file
+format and level 2 specifies a new extended format containing extension
+fields (but in a manner which retains backward-compatibility with
+original <tt class="docutils literal">vi(1)</tt> implementations). The default level is 2.
+[Ignored in etags mode]</dd>
+<dt><tt class="docutils literal"><span class="pre">--output-format=(u-ctags|e-ctags|etags|xref|json)</span></tt></dt>
+<dd>Specify the output format. The default is <tt class="docutils literal"><span class="pre">u-ctags</span></tt>.
+See tags(5) for <tt class="docutils literal"><span class="pre">u-ctags</span></tt> and <tt class="docutils literal"><span class="pre">e-ctags</span></tt>.
+See <tt class="docutils literal"><span class="pre">-e</span></tt> for <tt class="docutils literal">etags</tt>, and <tt class="docutils literal"><span class="pre">-x</span></tt> for <tt class="docutils literal">xref</tt>.
+<tt class="docutils literal">json</tt> format is available only if
+the ctags executable is built with <tt class="docutils literal">libjansson</tt>.
+See ctags-client-tools(7) for more about <tt class="docutils literal">json</tt> format.</dd>
+<dt><tt class="docutils literal"><span class="pre">-e</span></tt></dt>
+<dd>Same as <tt class="docutils literal"><span class="pre">--output-format=etags</span></tt>.
+Enable etags mode, which will create a tag file for use with the Emacs
+editor. Alternatively, if ctags is invoked by a
+name containing the string &quot;etags&quot; (either by renaming,
+or creating a link to, the executable), etags mode will be enabled.</dd>
+<dt><tt class="docutils literal"><span class="pre">-x</span></tt></dt>
+<dd><p class="first">Same as <tt class="docutils literal"><span class="pre">--output-format=xref</span></tt>.
+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.</p>
+<p class="last">Example applications for this
+feature are generating a listing of all functions located in a source
+file (e.g. &quot;<tt class="docutils literal">ctags <span class="pre">-x</span> <span class="pre">--kinds-c=f</span> file</tt>&quot;), or generating
+a list of all externally visible global variables located in a source
+file (e.g. &quot;<tt class="docutils literal">ctags <span class="pre">-x</span> <span class="pre">--kinds-c=v</span> <span class="pre">--extras=-F</span> file</tt>&quot;).</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--sort=(yes|no|foldcase)</span></tt></dt>
+<dd>Indicates whether the tag file should be sorted on the tag name
+(default is <tt class="docutils literal">yes</tt>). Note that the original <tt class="docutils literal">vi(1)</tt> required sorted tags.
+The <tt class="docutils literal">foldcase</tt> value specifies case insensitive (or case-folded) sorting.
+Fast binary searches of tag files sorted with case-folding will require
+special support from tools using tag files, such as that found in the
+ctags readtags library, or Vim version 6.2 or higher
+(using &quot;<tt class="docutils literal">set ignorecase</tt>&quot;).
+[Ignored in etags mode]</dd>
+<dt><tt class="docutils literal"><span class="pre">-u</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--sort=no</span></tt> (i.e. &quot;unsorted&quot;).</dd>
+<dt><tt class="docutils literal"><span class="pre">--etags-include=&lt;file&gt;</span></tt></dt>
+<dd>Include a reference to <em>&lt;file&gt;</em> in the tag file. This option may be specified
+as many times as desired. This supports Emacs' capability to use a
+tag file which <em>includes</em> other tag files. [Available only in etags mode]</dd>
+<dt><tt class="docutils literal"><span class="pre">--input-encoding=&lt;encoding&gt;</span></tt></dt>
+<dd>Specifies the <em>&lt;encoding&gt;</em> of the input files.
+If this option is specified, Universal Ctags converts the input from this
+encoding to the encoding specified by <tt class="docutils literal"><span class="pre">--output-encoding=encoding</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--input-encoding-&lt;LANG&gt;=&lt;encoding&gt;</span></tt></dt>
+<dd>Specifies a specific input <em>&lt;encoding&gt;</em> for <em>&lt;LANG&gt;</em>. It overrides the global
+default value given with <tt class="docutils literal"><span class="pre">--input-encoding</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--output-encoding=&lt;encoding&gt;</span></tt></dt>
+<dd><p class="first">Specifies the <em>&lt;encoding&gt;</em> of the tags file.
+Universal Ctags converts the encoding of input files from the encoding
+specified by <tt class="docutils literal"><span class="pre">--input-encoding=&lt;encoding&gt;</span></tt> to this encoding.</p>
+<p class="last">In addition <em>&lt;encoding&gt;</em> is specified at the top the tags file as the
+value for the <tt class="docutils literal">TAG_FILE_ENCODING</tt> pseudo-tag. The default value of
+<em>&lt;encoding&gt;</em> is <tt class="docutils literal"><span class="pre">UTF-8</span></tt>.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="language-selection-and-mapping-options">
+<span id="option-lang-mapping"></span><h2>Language Selection and Mapping Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--language-force=(&lt;language&gt;|auto)</span></tt></dt>
+<dd><p class="first">By default, ctags automatically selects the language
+of a source file, ignoring those files whose language cannot be
+determined (see &quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot;). This option forces the specified
+<em>language</em> (case-insensitive; either built-in or user-defined) to be used
+for every supplied file instead of automatically selecting the language
+based upon its extension.</p>
+<p class="last">In addition, the special value <tt class="docutils literal">auto</tt> indicates
+that the language should be automatically selected (which effectively
+disables this option).</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--languages=[+|-](&lt;list&gt;|all)</span></tt></dt>
+<dd><p class="first">Specifies the languages for which tag generation is enabled, with <em>&lt;list&gt;</em>
+containing a comma-separated list of language names (case-insensitive;
+either built-in or user-defined).</p>
+<p>If the first language of <em>&lt;list&gt;</em> is not
+preceded by either a '<tt class="docutils literal">+</tt>' or '<tt class="docutils literal">-</tt>', the current list (the current settings
+of enabled/disabled languages managed in ctags internally)
+will be cleared before adding or removing the languages in <em>&lt;list&gt;</em>. Until a '<tt class="docutils literal">-</tt>' is
+encountered, each language in the <em>&lt;list&gt;</em> will be added to the current list.</p>
+<p>As either the '<tt class="docutils literal">+</tt>' or '<tt class="docutils literal">-</tt>' is encountered in the <em>&lt;list&gt;</em>, the languages
+following it are added or removed from the current list, respectively.
+Thus, it becomes simple to replace the current list with a new one, or
+to add or remove languages from the current list.</p>
+<p>The actual list of
+files for which tags will be generated depends upon the language
+extension mapping in effect (see the <tt class="docutils literal"><span class="pre">--langmap</span></tt> option). Note that the most of
+languages, including user-defined languages, are enabled unless explicitly
+disabled using this option. Language names included in list may be any
+built-in language or one previously defined with <tt class="docutils literal"><span class="pre">--langdef</span></tt>.</p>
+<p>The default
+is <tt class="docutils literal">all</tt>, which is also accepted as a valid argument. See the
+<tt class="docutils literal"><span class="pre">--list-languages</span></tt> option for a list of the all (built-in and user-defined)
+language names.</p>
+<p class="last">Note <tt class="docutils literal"><span class="pre">--languages=</span></tt> option works cumulative way; the option can be
+specified with different arguments multiple times in a command line.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--alias-&lt;LANG&gt;=[+|-](&lt;pattern&gt;|default)</span></tt></dt>
+<dd><p class="first">Adds ('<tt class="docutils literal">+</tt>') or removes ('<tt class="docutils literal">-</tt>') an alias <em>&lt;pattern&gt;</em> to a language specified
+with <em>&lt;LANG&gt;</em>. ctags refers to the alias pattern in
+&quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot; stage.</p>
+<p>The parameter <em>&lt;pattern&gt;</em> is not a list. Use this option multiple
+times in a command line to add or remove multiple alias
+patterns.</p>
+<p>To restore the default language aliases, specify <tt class="docutils literal">default</tt>.</p>
+<p>Using <tt class="docutils literal">all</tt> for <em>&lt;LANG&gt;</em> has meaning in following two cases:</p>
+<dl class="last docutils">
+<dt><tt class="docutils literal"><span class="pre">--alias-all=</span></tt></dt>
+<dd>This clears aliases setting of all languages.</dd>
+<dt><tt class="docutils literal"><span class="pre">--alias-all=default</span></tt></dt>
+<dd>This restores the default languages aliases for all languages.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--guess-language-eagerly</span></tt></dt>
+<dd>Looks into the file contents for heuristically guessing the proper language parser.
+See &quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot;.</dd>
+<dt><tt class="docutils literal"><span class="pre">-G</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--guess-language-eagerly</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--langmap=&lt;map&gt;[,&lt;map&gt;[...]]</span></tt></dt>
+<dd><p class="first">Controls how file names are mapped to languages (see the <tt class="docutils literal"><span class="pre">--list-maps</span></tt>
+option). Each comma-separated <em>&lt;map&gt;</em> consists of the language name (either
+a built-in or user-defined language), a colon, and a list of <em>file
+extensions</em> and/or <em>file name patterns</em>. A file extension is specified by
+preceding the extension with a period (e.g. <tt class="docutils literal">.c</tt>). A file name pattern
+is specified by enclosing the pattern in parentheses (e.g.
+<tt class="docutils literal">([Mm]akefile)</tt>).</p>
+<p>If appropriate support is available from the runtime
+library of your C compiler, then the file name pattern may contain the usual
+shell wildcards common on Unix (be sure to quote the option parameter to
+protect the wildcards from being expanded by the shell before being
+passed to ctags). You can determine if shell wildcards
+are available on your platform by examining the output of the
+<tt class="docutils literal"><span class="pre">--list-features</span></tt> option, which will include <tt class="docutils literal">wildcards</tt> in the compiled
+feature list; otherwise, the file name patterns are matched against
+file names using a simple textual comparison.</p>
+<p>When mapping a file extension with <tt class="docutils literal"><span class="pre">--langmap</span></tt> option,
+it will first be unmapped from any other languages. (<tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;</span></tt>
+option provides more fine-grained control.)</p>
+<p>If the first character in a <em>&lt;map&gt;</em> is a plus sign ('<tt class="docutils literal">+</tt>'), then the extensions and
+file name patterns in that map will be appended to the current map
+for that language; otherwise, the map will replace the current map.
+For example, to specify that only files with extensions of <tt class="docutils literal">.c</tt> and <tt class="docutils literal">.x</tt> are
+to be treated as C language files, use <tt class="docutils literal"><span class="pre">--langmap=c:.c.x</span></tt>; to also add
+files with extensions of <tt class="docutils literal">.j</tt> as Java language files, specify
+<tt class="docutils literal"><span class="pre">--langmap=c:.c.x,java:+.j</span></tt>. To map makefiles (e.g. files named either
+<tt class="docutils literal">Makefile</tt>, <tt class="docutils literal">makefile</tt>, or having the extension <tt class="docutils literal">.mak</tt>) to a language
+called <tt class="docutils literal">make</tt>, specify <tt class="docutils literal"><span class="pre">--langmap=make:([Mm]akefile).mak</span></tt>. To map files
+having no extension, specify a period not followed by a non-period
+character (e.g. '<tt class="docutils literal">.</tt>', <tt class="docutils literal">..x</tt>, <tt class="docutils literal">.x.</tt>).</p>
+<p>To clear the mapping for a
+particular language (thus inhibiting automatic generation of tags for
+that language), specify an empty extension list (e.g. <tt class="docutils literal"><span class="pre">--langmap=fortran:</span></tt>).
+To restore the default language mappings for a particular language,
+supply the keyword <tt class="docutils literal">default</tt> for the mapping. To specify restore the
+default language mappings for all languages, specify <tt class="docutils literal"><span class="pre">--langmap=default</span></tt>.</p>
+<p class="last">Note that file name patterns are tested before file extensions when inferring
+the language of a file. This order of Universal Ctags is different from
+Exuberant Ctags. See ctags-incompatibilities(7) for the background of
+this incompatible change.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;=[+|-]&lt;extension&gt;|&lt;pattern&gt;</span></tt></dt>
+<dd><p class="first">This option provides the way to control mapping(s) of file names to
+languages in a more fine-grained way than <tt class="docutils literal"><span class="pre">--langmap</span></tt> option.</p>
+<p>In ctags, more than one language can map to a
+file name <em>&lt;pattern&gt;</em> or file <em>&lt;extension&gt;</em> (<em>N:1 map</em>). Alternatively,
+<tt class="docutils literal"><span class="pre">--langmap</span></tt> option handle only <em>1:1 map</em>, only one language
+mapping to one file name <em>&lt;pattern&gt;</em> or file <em>&lt;extension&gt;</em>. A typical N:1
+map is seen in C++ and ObjectiveC language; both languages have
+a map to <tt class="docutils literal">.h</tt> as a file extension.</p>
+<p>A file extension is specified by preceding the extension with a period (e.g. <tt class="docutils literal">.c</tt>).
+A file name pattern is specified by enclosing the pattern in parentheses (e.g.
+<tt class="docutils literal">([Mm]akefile)</tt>). A prefixed plus ('<tt class="docutils literal">+</tt>') sign is for adding, and
+minus ('<tt class="docutils literal">-</tt>') is for removing. No prefix means replacing the map of <em>&lt;LANG&gt;</em>.</p>
+<p class="last">Unlike <tt class="docutils literal"><span class="pre">--langmap</span></tt>, <em>&lt;extension&gt;</em> (or <em>&lt;pattern&gt;</em>) is not a list.
+<tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;</span></tt> takes one extension (or pattern). However,
+the option can be specified with different arguments multiple times
+in a command line.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="tags-file-contents-options">
+<span id="option-tags-file-contents"></span><h2>Tags File Contents Options</h2>
+<p>See &quot;<a class="reference internal" href="#id1">TAG ENTRIES</a>&quot; about fields, kinds, roles, and extras.</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--excmd=(number|pattern|mix|combine)</span></tt></dt>
+<dd><p class="first">Determines the type of <tt class="docutils literal">EX</tt> command used to locate tags in the source
+file. [Ignored in etags mode]</p>
+<p>The valid values for type (either the entire word or the first letter
+is accepted) are:</p>
+<dl class="last docutils">
+<dt><tt class="docutils literal">number</tt></dt>
+<dd><p class="first">Use only line numbers in the tag file for locating tags. This has
+four advantages:</p>
+<ol class="arabic simple">
+<li>Significantly reduces the size of the resulting tag file.</li>
+<li>Eliminates failures to find tags because the line defining the
+tag has changed, causing the pattern match to fail (note that
+some editors, such as <tt class="docutils literal">vim</tt>, are able to recover in many such
+instances).</li>
+<li>Eliminates finding identical matching, but incorrect, source
+lines (see &quot;<a class="reference internal" href="#bugs">BUGS</a>&quot;).</li>
+<li>Retains separate entries in the tag file for lines which are
+identical in content. In pattern mode, duplicate entries are
+dropped because the search patterns they generate are identical,
+making the duplicate entries useless.</li>
+</ol>
+<p>However, this option has one significant drawback: changes to the
+source files can cause the line numbers recorded in the tag file
+to no longer correspond to the lines in the source file, causing
+jumps to some tags to miss the target definition by one or more
+lines. Basically, this option is best used when the source code
+to which it is applied is not subject to change. Selecting this
+option type causes the following options to be ignored: <tt class="docutils literal"><span class="pre">-B</span></tt>, <tt class="docutils literal"><span class="pre">-F</span></tt>.</p>
+<p class="last"><tt class="docutils literal">number</tt> type is ignored in Xref and JSON output formats. Use
+<tt class="docutils literal"><span class="pre">--_xformat=&quot;...%n&quot;</span></tt> for Xref output format, or <tt class="docutils literal"><span class="pre">--fields=+n-P</span></tt> for
+JSON output format.</p>
+<!-- NOTE: #2792 -->
+</dd>
+<dt><tt class="docutils literal">pattern</tt></dt>
+<dd>Use only search patterns for all tags, rather than the line numbers
+usually used for macro definitions. This has the advantage of
+not referencing obsolete line numbers when lines have been added or
+removed since the tag file was generated.</dd>
+<dt><tt class="docutils literal">mixed</tt></dt>
+<dd><p class="first">In this mode, patterns are generally used with a few exceptions.
+For C, line numbers are used for macro definition tags. For Fortran, line numbers
+are used for common blocks because their corresponding source lines
+are generally identical, making pattern searches useless
+for finding all matches.</p>
+<p class="last">This was the default format generated by the original ctags and is,
+therefore, retained as the default for this option.</p>
+</dd>
+<dt><tt class="docutils literal">combine</tt></dt>
+<dd>Concatenate the line number and pattern with a semicolon in between.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">-n</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--excmd=number</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">-N</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--excmd=pattern</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--extras=[+|-][&lt;flags&gt;|*]</span></tt></dt>
+<dd><p class="first">Specifies whether to include extra tag entries for certain kinds of
+information. See also &quot;<a class="reference internal" href="#extras">Extras</a>&quot; subsection to know what are extras.</p>
+<p>The parameter <em>&lt;flags&gt;</em> is a set of one-letter flags (and/or long-name flags), each
+representing one kind of extra tag entry to include in the tag file.
+If flags is preceded by either the '<tt class="docutils literal">+</tt>' or '<tt class="docutils literal">-</tt>' character, the effect of
+each flag is added to, or removed from, those currently enabled;
+otherwise the flags replace any current settings. All entries are
+included if '<tt class="docutils literal">*</tt>' is given.</p>
+<p class="last">This <tt class="docutils literal"><span class="pre">--extras=</span></tt> option is for controlling extras common in all
+languages (or language-independent extras). Universal Ctags also
+supports language-specific extras. (See &quot;<a class="reference internal" href="#language-specific-fields-and-extras">Language-specific fields and
+extras</a>&quot; about the concept). Use <tt class="docutils literal"><span class="pre">--extras-&lt;LANG&gt;=</span></tt> option for
+controlling them.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--extras-(&lt;LANG&gt;|all)=[+|-][&lt;flags&gt;|*]</span></tt></dt>
+<dd><p class="first">Specifies whether to include extra tag entries for certain kinds of
+information for language <em>&lt;LANG&gt;</em>. Universal Ctags
+introduces language-specific extras. See &quot;<a class="reference internal" href="#language-specific-fields-and-extras">Language-specific fields and
+extras</a>&quot; about the concept. This option is for controlling them.</p>
+<p>Specifies <tt class="docutils literal">all</tt> as <em>&lt;LANG&gt;</em> to apply the parameter <em>&lt;flags&gt;</em> to all
+languages; all extras are enabled with specifying '<tt class="docutils literal">*</tt>' as the
+parameter flags. If specifying nothing as the parameter flags
+(<tt class="docutils literal"><span class="pre">--extras-all=</span></tt>), all extras are disabled. These two combinations
+are useful for testing.</p>
+<p class="last">Check the output of the <tt class="docutils literal"><span class="pre">--list-extras=&lt;LANG&gt;</span></tt> option for the
+extras of specific language <em>&lt;LANG&gt;</em>.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--fields=[+|-][&lt;flags&gt;|*]</span></tt></dt>
+<dd><p class="first">Specifies which language-independent fields are to be included in the tag
+entries. Language-independent fields are extension fields which are common
+in all languages. See &quot;<a class="reference internal" href="#tag-file-format">TAG FILE FORMAT</a>&quot; section, and &quot;<a class="reference internal" href="#extension-fields">Extension fields</a>&quot;
+subsection, for details of extension fields.</p>
+<p>The parameter <em>&lt;flags&gt;</em> is a set of one-letter or long-name flags,
+each representing one type of extension field to include.
+Each flag or group of flags may be preceded by either '<tt class="docutils literal">+</tt>' to add it
+to the default set, or '<tt class="docutils literal">-</tt>' to exclude it. In the absence of any
+preceding '<tt class="docutils literal">+</tt>' or '<tt class="docutils literal">-</tt>' sign, only those fields explicitly listed in flags
+will be included in the output (i.e. overriding the default set). All
+fields are included if '<tt class="docutils literal">*</tt>' is given.</p>
+<p>This option is ignored if the
+option <tt class="docutils literal"><span class="pre">--format=1</span></tt> (legacy tag file format) has been specified.</p>
+<p class="last">Use <tt class="docutils literal"><span class="pre">--fields-&lt;LANG&gt;=</span></tt> option for controlling language-specific fields.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--fields-(&lt;LANG&gt;|all)=[+|-][&lt;flags&gt;|*]</span></tt></dt>
+<dd><p class="first">Specifies which language-specific fields are to be included in
+the tag entries. Universal Ctags
+supports language-specific fields. (See &quot;<a class="reference internal" href="#language-specific-fields-and-extras">Language-specific fields and
+extras</a>&quot; about the concept).</p>
+<p>Specify <tt class="docutils literal">all</tt> as <em>&lt;LANG&gt;</em> to apply the parameter <em>&lt;flags&gt;</em> to all
+languages; all fields are enabled with specifying '<tt class="docutils literal">*</tt>' as the
+parameter flags. If specifying nothing as the parameter <em>&lt;flags&gt;</em>
+(i.e. <tt class="docutils literal"><span class="pre">--fields-all=</span></tt>), all fields are disabled. These two combinations
+are useful for testing.</p>
+<p>See the description of <tt class="docutils literal"><span class="pre">--fields=[+|-][&lt;flags&gt;|*]</span></tt> about <em>&lt;flags&gt;</em>.</p>
+<p class="last">Use <tt class="docutils literal"><span class="pre">--fields=</span></tt> option for controlling language-independent fields.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--kinds-(&lt;LANG&gt;|all)=[+|-](&lt;kinds&gt;|*)</span></tt></dt>
+<dd><p class="first">Specifies a list of language-specific <em>&lt;kinds&gt;</em> of tags (or kinds) to
+include in the output file for a particular language, where <em>&lt;LANG&gt;</em> is
+case-insensitive and is one of the built-in language names (see the
+<tt class="docutils literal"><span class="pre">--list-languages</span></tt> option for a complete list).</p>
+<p>The parameter <em>&lt;kinds&gt;</em> is a group
+of one-letter or long-name flags designating kinds of tags (particular to the language)
+to either include or exclude from the output. The specific sets of
+flags recognized for each language, their meanings and defaults may be
+list using the <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt> option.</p>
+<p>Each letter or group of letters
+may be preceded by either '<tt class="docutils literal">+</tt>' to add it to, or '<tt class="docutils literal">-</tt>' to remove it from,
+the default set. In the absence of any preceding '<tt class="docutils literal">+</tt>' or '<tt class="docutils literal">-</tt>' sign, only
+those kinds explicitly listed in kinds will be included in the output
+(i.e. overriding the default for the specified language).</p>
+<p>Specify '<tt class="docutils literal">*</tt>' as the parameter to include all kinds implemented
+in <em>&lt;LANG&gt;</em> in the output. Furthermore if <tt class="docutils literal">all</tt> is given as <em>&lt;LANG&gt;</em>,
+specification of the parameter <tt class="docutils literal">kinds</tt> affects all languages defined
+in ctags. Giving <tt class="docutils literal">all</tt> makes sense only when '<tt class="docutils literal">*</tt>' or
+'<tt class="docutils literal">F</tt>' is given as the parameter <tt class="docutils literal">kinds</tt>.</p>
+<p>As an example for the C language, in order to add prototypes and
+external variable declarations to the default set of tag kinds,
+but exclude macros, use <tt class="docutils literal"><span class="pre">--kinds-c=+px-d</span></tt>; to include only tags for
+functions, use <tt class="docutils literal"><span class="pre">--kinds-c=f</span></tt>.</p>
+<p class="last">Some kinds of C and C++ languages are synchronized; enabling
+(or disabling) a kind in one language enables the kind having
+the same one-letter and long-name in the other language. See also the
+description of <tt class="docutils literal">MASTER</tt> column of <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt>.</p>
+</dd>
+</dl>
+<!-- COMMENT:
+``- -param-<LANG>:name=argument`` is moved to "Language Specific Options" -->
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--pattern-length-limit=&lt;N&gt;</span></tt></dt>
+<dd><p class="first">Truncate patterns of tag entries after <em>&lt;N&gt;</em> characters. Disable by setting to 0
+(default is 96).</p>
+<p>An input source file with long lines and multiple tag matches per
+line can generate an excessively large tags file with an
+unconstrained pattern length. For example, running ctags on a
+minified JavaScript source file often exhibits this behavior.</p>
+<p class="last">The truncation avoids cutting in the middle of a UTF-8 code point
+spanning multiple bytes to prevent writing invalid byte sequences from
+valid input files. This handling allows for an extra 3 bytes above the
+configured limit in the worse case of a 4 byte code point starting
+right before the limit. Please also note that this handling is fairly
+naive and fast, and although it is resistant against any input, it
+requires a valid input to work properly; it is not guaranteed to work
+as the user expects when dealing with partially invalid UTF-8 input.
+This also partially affect non-UTF-8 input, if the byte sequence at
+the truncation length looks like a multibyte UTF-8 sequence. This
+should however be rare, and in the worse case will lead to including
+up to an extra 3 bytes above the limit.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--pseudo-tags=[+|-](&lt;pseudo-tag&gt;|*)</span></tt></dt>
+<dd>Enable/disable emitting pseudo-tag named <em>&lt;pseudo-tag&gt;</em>.
+If '<tt class="docutils literal">*</tt>' is given, enable/disable emitting all pseudo-tags.</dd>
+<dt><tt class="docutils literal"><span class="pre">--put-field-prefix</span></tt></dt>
+<dd><p class="first">Put <tt class="docutils literal">UCTAGS</tt> as prefix for the name of fields newly introduced in
+Universal Ctags.</p>
+<p>Some fields are newly introduced in Universal Ctags and more will
+be introduced in the future. Other tags generators may also
+introduce their specific fields.</p>
+<p>In such a situation, there is a concern about conflicting field
+names; mixing tags files generated by multiple tags generators
+including Universal Ctags is difficult. This option provides a
+workaround for such station.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span><span class="literal string single">'{line}{end}'</span> -o - hello.c
+<span class="generic output">main hello.c /^main(int argc, char **argv)$/;&quot; f line:3 end:6
+</span><span class="generic prompt">$ </span>ctags --put-field-prefix --fields<span class="operator">=</span><span class="literal string single">'{line}{end}'</span> -o - hello.c
+<span class="generic output">main hello.c /^main(int argc, char **argv)$/;&quot; f line:3 UCTAGSend:6</span>
+</pre>
+<p class="last">In the above example, the prefix is put to <tt class="docutils literal">end</tt> field which is
+newly introduced in Universal Ctags.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--roles-(&lt;LANG&gt;|all).(&lt;kind&gt;|all)=[+|-][&lt;roles&gt;|*]</span></tt></dt>
+<dd><p class="first">Specifies a list of kind-specific roles of tags to include in the
+output file for a particular language.
+<em>&lt;kind&gt;</em> specifies the kind where the <em>&lt;roles&gt;</em> are defined.
+<em>&lt;LANG&gt;</em> specifies the language where the kind is defined.
+Each role in <em>&lt;roles&gt;</em> must be surrounded by braces (e.g. <tt class="docutils literal">{system}</tt>
+for a role named &quot;system&quot;).</p>
+<p>Like <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt> option, '<tt class="docutils literal">+</tt>' is for adding the role to the
+list, and '<tt class="docutils literal">-</tt>' is for removing from the list. '<tt class="docutils literal">*</tt>' is for including
+all roles of the kind to the list. The option with no argument
+makes the list empty.</p>
+<p>Both a one-letter flag or a long name flag surrounded by braces are
+acceptable for specifying a kind (e.g. <tt class="docutils literal"><span class="pre">--roles-C.h=+{system}{local}</span></tt>
+or <tt class="docutils literal"><span class="pre">--roles-C.{header}=+{system}{local}</span></tt>). '<tt class="docutils literal">*</tt>' can be used for <em>&lt;KIND&gt;</em>
+only for adding/removing all roles of all kinds in a language to/from
+the list (e.g. <tt class="docutils literal"><span class="pre">--roles-C.*=*</span></tt> or <tt class="docutils literal"><span class="pre">--roles-C.*=</span></tt>).</p>
+<p class="last"><tt class="docutils literal">all</tt> can be used for <em>&lt;LANG&gt;</em> only for adding/removing all roles of
+all kinds in all languages to/from the list
+(e.g. <tt class="docutils literal"><span class="pre">--roles-all.*=*</span></tt> or <tt class="docutils literal"><span class="pre">--roles-all.*=</span></tt>).</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--tag-relative=(yes|no|always|never)</span></tt></dt>
+<dd><p class="first">Specifies how the file paths recorded in the tag file.
+The default is <tt class="docutils literal">yes</tt> when running in etags mode (see
+the <tt class="docutils literal"><span class="pre">-e</span></tt> option), <tt class="docutils literal">no</tt> otherwise.</p>
+<dl class="last docutils">
+<dt><tt class="docutils literal">yes</tt></dt>
+<dd>indicates that the file paths recorded in the tag file should be
+<em>relative to the directory containing the tag file</em>
+unless the files supplied on the command line
+are specified with absolute paths.</dd>
+<dt><tt class="docutils literal">no</tt></dt>
+<dd>indicates that the file paths recorded in the tag file should be
+<em>relative to the current directory</em>
+unless the files supplied on the command line
+are specified with absolute paths.</dd>
+<dt><tt class="docutils literal">always</tt></dt>
+<dd>indicates the recorded file paths should be relative
+even if source file names are passed in with absolute paths.</dd>
+<dt><tt class="docutils literal">never</tt></dt>
+<dd>indicates the recorded file paths should be absolute
+even if source file names are passed in with relative paths.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--use-slash-as-filename-separator[=(yes|no)]</span></tt></dt>
+<dd><p class="first">Uses slash ('<tt class="docutils literal">/</tt>') character as filename separators instead of backslash
+('<tt class="docutils literal">\</tt>') character when printing <tt class="docutils literal">input:</tt> field.
+The default is <tt class="docutils literal">yes</tt> for the default &quot;u-ctags&quot; output format, and
+<tt class="docutils literal">no</tt> for the other formats.</p>
+<p class="last">This option is available on MS Windows only.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">-B</span></tt></dt>
+<dd>Use backward searching patterns (e.g. <tt class="docutils literal"><span class="pre">?pattern?</span></tt>). [Ignored in etags mode]</dd>
+<dt><tt class="docutils literal"><span class="pre">-F</span></tt></dt>
+<dd>Use forward searching patterns (e.g. <tt class="docutils literal">/pattern/</tt>) (default). [Ignored
+in etags mode]</dd>
+</dl>
+</div>
+<div class="section" id="option-file-options">
+<h2>Option File Options</h2>
+<!-- TODO: merge some of description in option-file.rst into FILE or a dedicated
+section -->
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--options=&lt;pathname&gt;</span></tt></dt>
+<dd><p class="first">Read additional options from file or directory.</p>
+<p>ctags searches <em>&lt;pathname&gt;</em> in the optlib path list
+first. If ctags cannot find a file or directory
+in the list, ctags reads a file or directory
+at the specified <em>&lt;pathname&gt;</em>.</p>
+<p>If a file is specified, it should contain one option per line. If
+a directory is specified, files suffixed with <tt class="docutils literal">.ctags</tt> under it
+are read in alphabetical order.</p>
+<p class="last">As a special case, if <tt class="docutils literal"><span class="pre">--options=NONE</span></tt> is specified as the first
+option on the command line, preloading is disabled; the option
+will disable the automatic reading of any configuration options
+from a file (see &quot;<a class="reference internal" href="#files">FILES</a>&quot;).</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--options-maybe=&lt;pathname&gt;</span></tt></dt>
+<dd>Same as <tt class="docutils literal"><span class="pre">--options</span></tt> but doesn't cause an error if file
+(or directory) specified with <em>&lt;pathname&gt;</em> doesn't exist.</dd>
+<dt><tt class="docutils literal"><span class="pre">--optlib-dir=[+]&lt;directory&gt;</span></tt></dt>
+<dd>Add an optlib <em>&lt;directory&gt;</em> to or reset the optlib path list.
+By default, the optlib path list is empty.</dd>
+</dl>
+</div>
+<div class="section" id="optlib-options">
+<h2>optlib Options</h2>
+<p>See ctags-optlib(7) for details of each option.</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--kinddef-&lt;LANG&gt;=&lt;letter&gt;,&lt;name&gt;,&lt;description&gt;</span></tt></dt>
+<dd>Define a kind for <em>&lt;LANG&gt;</em>.
+Don't be confused this with <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--langdef=&lt;name&gt;</span></tt></dt>
+<dd>Defines a new user-defined language, <em>&lt;name&gt;</em>, to be parsed with regular
+expressions.</dd>
+<dt><tt class="docutils literal"><span class="pre">--mline-regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></dt>
+<dd>Define multi-line regular expression for locating tags in specific language.</dd>
+<dt><tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;=/&lt;line_pattern&gt;/&lt;name_pattern&gt;/&lt;kind-spec&gt;/[&lt;flags&gt;]</span></tt></dt>
+<dd>Define single-line regular expression for locating tags in specific language.</dd>
+</dl>
+</div>
+<div class="section" id="language-specific-options">
+<span id="option-lang-specific"></span><h2>Language Specific Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--if0[=(yes|no)]</span></tt></dt>
+<dd><p class="first">Indicates a preference as to whether code within an &quot;<tt class="docutils literal">#if 0</tt>&quot; branch of a
+preprocessor conditional should be examined for non-macro tags (macro
+tags are always included). Because the intent of this construct is to
+disable code, the default value of this option is <tt class="docutils literal">no</tt> (disabled).</p>
+<p class="last">Note that this
+indicates a preference only and does not guarantee skipping code within
+an &quot;<tt class="docutils literal">#if 0</tt>&quot; branch, since the fall-back algorithm used to generate
+tags when preprocessor conditionals are too complex follows all branches
+of a conditional.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--line-directives[=(yes|no)]</span></tt></dt>
+<dd><p class="first">Specifies whether <tt class="docutils literal">#line</tt> directives should be recognized. These are
+present in the output of a preprocessor and contain the line number, and
+possibly the file name, of the original source file(s) from which the
+preprocessor output file was generated. This option is off by default.</p>
+<p>When enabled, this option will
+cause ctags to generate tag entries marked with the
+file names and line numbers of their locations original source file(s),
+instead of their actual locations in the preprocessor output. The actual
+file names placed into the tag file will have the same leading path
+components as the preprocessor output file, since it is assumed that
+the original source files are located relative to the preprocessor
+output file (unless, of course, the <tt class="docutils literal">#line</tt> directive specifies an
+absolute path).</p>
+<p class="last">Note: This option is generally
+only useful when used together with the <tt class="docutils literal"><span class="pre">--excmd=number</span></tt> (<tt class="docutils literal"><span class="pre">-n</span></tt>) option.
+Also, you may have to use either the <tt class="docutils literal"><span class="pre">--langmap</span></tt> or <tt class="docutils literal"><span class="pre">--language-force</span></tt> option
+if the extension of the preprocessor output file is not known to
+ctags.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">-D</span> <span class="pre">&lt;macro&gt;=&lt;definition&gt;</span></tt></dt>
+<dd>Defines a C preprocessor <em>&lt;macro&gt;</em>. This emulates the behavior of the
+corresponding gcc option. All types of macros are supported,
+including the ones with parameters and variable arguments.
+Stringification, token pasting and recursive macro expansion are also
+supported.
+This extends the function provided by <tt class="docutils literal"><span class="pre">-I</span></tt> option.</dd>
+<dt><tt class="docutils literal"><span class="pre">-h</span> <span class="pre">(&lt;list&gt;|default)</span></tt></dt>
+<dd><p class="first">Specifies a <em>&lt;list&gt;</em> of file extensions, separated by periods, which are
+to be interpreted as include (or header) files. To indicate files having
+no extension, use a period not followed by a non-period character
+(e.g. '<tt class="docutils literal">.</tt>', <tt class="docutils literal">..x</tt>, <tt class="docutils literal">.x.</tt>).</p>
+<p>This option only affects how the scoping of
+particular kinds of tags are interpreted (i.e. whether or not they are
+considered as globally visible or visible only within the file in which
+they are defined); it does not map the extension to any particular
+language. Any tag which is located in a non-include file and cannot be
+seen (e.g. linked to) from another file is considered to have file-limited
+(e.g. static) scope. No kind of tag appearing in an include file
+will be considered to have file-limited scope.</p>
+<p>If the first character in the list is '<tt class="docutils literal">+</tt>', then the extensions in the list will be
+appended to the current list; otherwise, the list will replace the
+current list. See, also, the <tt class="docutils literal">fileScope</tt>/<tt class="docutils literal">F</tt> flag of <tt class="docutils literal"><span class="pre">--extras</span></tt> option.</p>
+<p>The default list is
+<tt class="docutils literal"><span class="pre">.h.H.hh.hpp.hxx.h++.inc.def</span></tt>. To restore the default list, specify &quot;<tt class="docutils literal"><span class="pre">-h</span>
+default</tt>&quot;.</p>
+<p class="last">Note that if an extension supplied to this option is not
+already mapped to a particular language (see &quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot;, above),
+you will also need to use either the <tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;</span></tt>, <tt class="docutils literal"><span class="pre">--langmap</span></tt> or
+<tt class="docutils literal"><span class="pre">--language-force</span></tt> option.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">-I</span> <span class="pre">&lt;identifier-list&gt;</span></tt></dt>
+<dd><p class="first">Specifies a <em>&lt;identifier-list&gt;</em> of identifiers which are to be specially handled while
+parsing C and C++ source files. This option is specifically provided
+to handle special cases arising through the use of preprocessor macros.
+When the identifiers listed are simple identifiers, these identifiers
+will be ignored during parsing of the source files.</p>
+<p>If an identifier is
+suffixed with a '<tt class="docutils literal">+</tt>' character (i.e. &quot;<tt class="docutils literal"><span class="pre">-I</span> FOO+</tt>&quot;), ctags will also
+ignore any parenthesis-enclosed argument list which may immediately
+follow the identifier in the source files. See the example of &quot;<tt class="docutils literal"><span class="pre">-I</span>
+MODULE_VERSION+</tt>&quot; below.</p>
+<p>If two identifiers are
+separated with the '<tt class="docutils literal">=</tt>' character (i.e. <tt class="docutils literal"><span class="pre">-I</span> FOO=BAR</tt>), the first identifiers is replaced by
+the second identifiers for parsing purposes. The list of identifiers may
+be supplied directly on the command line or read in from a separate file.
+See the example of &quot;<tt class="docutils literal"><span class="pre">-I</span> CLASS=class</tt>&quot; below.</p>
+<p>If the first character of <em>&lt;identifier-list&gt;</em> is '<tt class="docutils literal">&#64;</tt>', '<tt class="docutils literal">.</tt>' or a pathname
+separator ('<tt class="docutils literal">/</tt>' or '<tt class="docutils literal">\</tt>'), or the first two characters specify a drive
+letter (e.g. <tt class="docutils literal">C:</tt>), the parameter <em>&lt;identifier-list&gt;</em> will be interpreted as
+a filename from which to read a list of identifiers, one per input line.</p>
+<p>Otherwise, <em>&lt;identifier-list&gt;</em> is a list of identifiers (or identifier
+pairs) to be specially handled, each delimited by either a comma or
+by white space (in which case the list should be quoted to keep the
+entire list as one command line argument).</p>
+<p>Multiple <tt class="docutils literal"><span class="pre">-I</span></tt> options may be
+supplied. To clear the list of ignore identifiers, supply a single
+dash ('<tt class="docutils literal">-</tt>') for <em>&lt;identifier-list&gt;</em>.</p>
+<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 &quot;<a class="reference internal" href="#caveats">CAVEATS</a>&quot;).
+Some examples will illustrate this point.</p>
+<pre class="code C literal-block">
+<span class="keyword type">int</span> <span class="name">foo</span> <span class="name">ARGDECL4</span><span class="punctuation">(</span><span class="keyword type">void</span> <span class="operator">*</span><span class="punctuation">,</span> <span class="name">ptr</span><span class="punctuation">,</span> <span class="keyword type">long</span> <span class="keyword type">int</span><span class="punctuation">,</span> <span class="name">nbytes</span><span class="punctuation">)</span>
+</pre>
+<p>In the above example, the macro <tt class="docutils literal">ARGDECL4</tt> would be mistakenly
+interpreted to be the name of the function instead of the correct name
+of <tt class="docutils literal">foo</tt>. Specifying &quot;<tt class="docutils literal"><span class="pre">-I</span> ARGDECL4</tt>&quot; results in the correct behavior.</p>
+<pre class="code C literal-block">
+<span class="comment multiline">/* creates an RCS version string in module */</span>
+<span class="name">MODULE_VERSION</span><span class="punctuation">(</span><span class="literal string">&quot;$Revision$&quot;</span><span class="punctuation">)</span>
+</pre>
+<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 &quot;<tt class="docutils literal"><span class="pre">-I</span> MODULE_VERSION+</tt>&quot; would avoid such a problem.</p>
+<pre class="code C literal-block">
+<span class="name">CLASS</span> <span class="name">Example</span> <span class="punctuation">{</span>
+ <span class="comment single">// your content here
+</span><span class="punctuation">};</span>
+</pre>
+<p class="last">The example above uses <tt class="docutils literal">CLASS</tt> as a preprocessor macro which expands to
+something different for each platform. For instance <tt class="docutils literal">CLASS</tt> may be
+defined as <tt class="docutils literal">class __declspec(dllexport)</tt> on Win32 platforms and simply
+<tt class="docutils literal">class</tt> on UNIX. Normally, the absence of the C++ keyword <tt class="docutils literal">class</tt>
+would cause the source file to be incorrectly parsed. Correct behavior
+can be restored by specifying &quot;<tt class="docutils literal"><span class="pre">-I</span> CLASS=class</tt>&quot;.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--param-&lt;LANG&gt;:&lt;name&gt;=&lt;argument&gt;</span></tt></dt>
+<dd><p class="first">Set a <em>&lt;LANG&gt;</em> specific parameter, a parameter specific to the <em>&lt;LANG&gt;</em>.</p>
+<p class="last">Available parameters can be listed with <tt class="docutils literal"><span class="pre">--list-params</span></tt>.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="listing-options">
+<span id="option-listing"></span><h2>Listing Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--list-aliases[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd>Lists the aliases for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt>
+languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.
+The aliases are used when heuristically testing a language parser for a
+source file.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-excludes</span></tt></dt>
+<dd>Lists the current exclusion patterns used to exclude files.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-extras[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd><p class="first">Lists the extras recognized for either the specified <em>&lt;language&gt;</em> or
+<tt class="docutils literal">all</tt> languages. See &quot;<a class="reference internal" href="#extras">Extras</a>&quot; subsection to know what are extras.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</p>
+<p>An extra can be enabled or disabled with <tt class="docutils literal"><span class="pre">--extras=</span></tt> for common
+extras in all languages, or <tt class="docutils literal"><span class="pre">--extras-&lt;LANG&gt;=</span></tt> for the specified
+language. These option takes one-letter flag or long-name flag as a parameter
+for specifying an extra.</p>
+<p>The meaning of columns in output are as follows:</p>
+<dl class="last docutils">
+<dt>LETTER</dt>
+<dd>One-letter flag. '<tt class="docutils literal">-</tt>' means the extra does not have one-letter flag.</dd>
+<dt>NAME</dt>
+<dd>Long-name flag. The long-name is used in <tt class="docutils literal">extras</tt> field.</dd>
+<dt>ENABLED</dt>
+<dd>Whether the extra is enabled or not. It takes <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>.</dd>
+<dt>LANGUAGE</dt>
+<dd>The name of language if the extra is owned by a parser.
+<tt class="docutils literal">NONE</tt> means the extra is common in parsers.</dd>
+<dt>DESCRIPTION</dt>
+<dd>Human readable description for the extra.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-features</span></tt></dt>
+<dd>Lists the compiled features.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-fields[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd><p class="first">Lists the fields recognized for either the specified <em>&lt;language&gt;</em> or
+<tt class="docutils literal">all</tt> languages. See &quot;<a class="reference internal" href="#extension-fields">Extension fields</a>&quot; subsection to know what are fields.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</p>
+<p>The meaning of columns are as follows:</p>
+<dl class="last docutils">
+<dt>LETTER</dt>
+<dd>One-letter flag. '<tt class="docutils literal">-</tt>' means the field does not have one-letter flag.</dd>
+<dt>NAME</dt>
+<dd>Long-name of field.</dd>
+<dt>ENABLED</dt>
+<dd>Whether the field is enabled or not. It takes <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>.</dd>
+<dt>LANGUAGE</dt>
+<dd>The name of language if the field is owned by a parser.
+<tt class="docutils literal">NONE</tt> means that the field is a language-independent field which is
+common in all languages.</dd>
+<dt>JSTYPE</dt>
+<dd>JSON type used in printing the value of field when <tt class="docutils literal"><span class="pre">--output-format=json</span></tt>
+is specified. See ctags-client-tools(7).</dd>
+<dt>FIXED</dt>
+<dd><p class="first">Whether this field can be disabled or not in tags output.</p>
+<p>Some fields are printed always in tags output.
+They have <tt class="docutils literal">yes</tt> as the value for this column.</p>
+<p class="last">Unlike the tag output mode, JSON output mode allows disabling
+any fields.</p>
+</dd>
+<dt>OP</dt>
+<dd>How this field can be accessed from optscript code.
+This field is for Universal Ctags developers.</dd>
+<dt>DESCRIPTION</dt>
+<dd>Human readable description for the field.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-kinds[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd><p class="first">Subset of <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt>. This option is kept for
+backward-compatibility with Exuberant Ctags.</p>
+<p>This option prints only LETTER, DESCRIPTION, and ENABLED fields
+of <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt> output. However, the presentation of
+ENABLED column is different from that of <tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt>
+option; <tt class="docutils literal">[off]</tt> follows after description if the kind is disabled,
+and nothing follows if enabled. The most of all kinds are enabled
+by default.</p>
+<p>The critical weakness of this option is that this option does not
+print the name of kind. Universal Ctags introduces
+<tt class="docutils literal"><span class="pre">--list-kinds-full</span></tt> because it considers that names are
+important.</p>
+<p class="last">This option does not work with <tt class="docutils literal"><span class="pre">--machinable</span></tt> nor
+<tt class="docutils literal"><span class="pre">--with-list-header</span></tt>.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-kinds-full[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd><p class="first">Lists the tag kinds recognized for either the specified <em>&lt;language&gt;</em>
+or <tt class="docutils literal">all</tt> languages, and then exits. See &quot;<a class="reference internal" href="#kinds">Kinds</a>&quot; subsection to
+learn what kinds are.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</p>
+<p>Each kind of tag recorded in the tag file is represented by a
+one-letter flag, or a long-name flag. They are also used to filter the tags
+placed into the output through use of the <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt>
+option.</p>
+<p>The meaning of columns are as follows:</p>
+<dl class="last docutils">
+<dt>LANGUAGE</dt>
+<dd>The name of language having the kind.</dd>
+<dt>LETTER</dt>
+<dd>One-letter flag. This must be unique in a language.</dd>
+<dt>NAME</dt>
+<dd>The long-name flag of the kind. This can be used as the alternative
+to the one-letter flag described above. If enabling <tt class="docutils literal">K</tt> field with
+<tt class="docutils literal"><span class="pre">--fields=+K</span></tt>, ctags uses long-names instead of
+one-letters in tags output. To enable/disable a kind with
+<tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt> option, long-name surrounded by braces instead
+of one-letter. See &quot;<a class="reference internal" href="#letters-and-names">Letters and names</a>&quot; for details. This must be
+unique in a language.</dd>
+<dt>ENABLED</dt>
+<dd>Whether the kind is enabled or not. It takes <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>.</dd>
+<dt>REFONLY</dt>
+<dd>Whether the kind is specialized for reference tagging or not.
+If the column is <tt class="docutils literal">yes</tt>, the kind is for reference tagging, and
+it is never used for definition tagging. See also &quot;<a class="reference internal" href="#id1">TAG ENTRIES</a>&quot;.</dd>
+<dt>NROLES</dt>
+<dd>The number of roles this kind has. See also &quot;<a class="reference internal" href="#roles">Roles</a>&quot;.</dd>
+<dt>MASTER</dt>
+<dd><p class="first">The master parser controlling enablement of the kind.
+A kind belongs to a language (owner) in Universal Ctags;
+enabling and disabling a kind in a language has no effect on
+a kind in another language even if both kinds has the
+same one-letter flag and/or the same long-name flag. In other words,
+the namespace of kinds are separated by language.</p>
+<p>However, Exuberant Ctags does not separate the kinds of C and
+C++. Enabling/disabling kindX in C language enables/disables a
+kind in C++ language having the same long-name flag with kindX. To
+emulate this behavior in Universal Ctags, a concept named
+<em>master parser</em> is introduced. Enabling/disabling some kinds
+are synchronized under the control of a master language.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --kinds-C<span class="operator">=</span>+<span class="literal string single">'{local}'</span> --list-kinds-full <span class="literal string escape">\
+</span><span class="generic output"> | grep -E '^(#|C\+\+ .* local)'
+</span><span class="generic prompt">#</span>LANGUAGE LETTER NAME ENABLED REFONLY NROLES MASTER DESCRIPTION
+<span class="generic output">C++ l local yes no 0 C local variables
+</span><span class="generic prompt">$ </span>ctags --kinds-C<span class="operator">=</span>-<span class="literal string single">'{local}'</span> --list-kinds-full <span class="literal string escape">\
+</span><span class="generic output"> | grep -E '^(#|C\+\+ .* local)'
+</span><span class="generic prompt">#</span>LANGUAGE LETTER NAME ENABLED REFONLY NROLES MASTER DESCRIPTION
+<span class="generic output">C++ l local no no 0 C local variables</span>
+</pre>
+<p class="last">You see <tt class="docutils literal">ENABLED</tt> field of <tt class="docutils literal">local</tt> kind of C++ language is changed
+Though <tt class="docutils literal">local</tt> kind of C language is enabled/disabled. If you swap the languages, you
+see the same result.</p>
+<!-- TODO: need a reference to "master parser" -->
+</dd>
+<dt>DESCRIPTION</dt>
+<dd>Human readable description for the kind.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-languages</span></tt></dt>
+<dd><p class="first">Lists the names of the languages understood by ctags,
+and then exits. These language names are case insensitive and may be
+used in many other options like <tt class="docutils literal"><span class="pre">--language-force</span></tt>,
+<tt class="docutils literal"><span class="pre">--languages</span></tt>, <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;</span></tt>, <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt>, and so on.</p>
+<p>Each language listed is disabled if followed by <tt class="docutils literal">[disabled]</tt>.
+To use the parser for such a language, specify the language as an
+argument of <tt class="docutils literal"><span class="pre">--languages=+</span></tt> option.</p>
+<p class="last"><tt class="docutils literal"><span class="pre">--machinable</span></tt> and <tt class="docutils literal"><span class="pre">--with-list-header</span></tt> options are ignored if they are
+specified with this option.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-map-extensions[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd>Lists the file extensions which associate a file
+name with a language for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt>
+languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-map-patterns[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd>Lists the file name patterns which associate a file
+name with a language for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt>
+languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-maps[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd><p class="first">Lists file name patterns and the file extensions which associate a file
+name with a language for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt>
+languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</p>
+<p>To list the file extensions or file name patterns individually, use
+<tt class="docutils literal"><span class="pre">--list-map-extensions</span></tt> or <tt class="docutils literal"><span class="pre">--list-map-patterns</span></tt> option.
+See the <tt class="docutils literal"><span class="pre">--langmap</span></tt> option, and &quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot;, above.</p>
+<p class="last">This option does not work with <tt class="docutils literal"><span class="pre">--machinable</span></tt> nor
+<tt class="docutils literal"><span class="pre">--with-list-header</span></tt>.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-mline-regex-flags</span></tt></dt>
+<dd>Output list of flags which can be used in a multiline regex parser
+definition.
+See ctags-optlib(7).</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-params[=(&lt;language&gt;|all)]</span></tt></dt>
+<dd>Lists the parameters for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt>
+languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt></dt>
+<dd>Output list of pseudo-tags.</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-regex-flags</span></tt></dt>
+<dd>Lists the flags that can be used in <tt class="docutils literal"><span class="pre">--regex-&lt;LANG&gt;</span></tt> option.
+See ctags-optlib(7).</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-roles[=(&lt;language&gt;|all)[.(&lt;kind-specs&gt;|*)]]</span></tt></dt>
+<dd><p class="first">List the roles for either the specified <em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt> languages.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</p>
+<p>If the parameter <em>&lt;kindspecs&gt;</em> is given after the parameter
+<em>&lt;language&gt;</em> or <tt class="docutils literal">all</tt> with concatenating with '<tt class="docutils literal">.</tt>', list only roles
+defined in the kinds. Both one-letter flags and long name flags surrounded
+by braces are acceptable as the parameter <em>&lt;kindspecs&gt;</em>.</p>
+<p>The meaning of columns are as follows:</p>
+<dl class="last docutils">
+<dt>LANGUAGE</dt>
+<dd>The name of language having the role.</dd>
+<dt>KIND(L/N)</dt>
+<dd>The one-letter flag and the long-name flag of kind having the role.</dd>
+<dt>NAME</dt>
+<dd>The long-name flag of the role.</dd>
+<dt>ENABLED</dt>
+<dd>Whether the kind is enabled or not. It takes <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>.</dd>
+<dt>DESCRIPTION</dt>
+<dd>Human readable description for the role.</dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--list-subparsers[=(&lt;baselang&gt;|all)]</span></tt></dt>
+<dd>Lists the subparsers for a base language for either the specified
+<em>&lt;baselang&gt;</em> or <tt class="docutils literal">all</tt> languages, and then exits.
+<tt class="docutils literal">all</tt> is used as default value if the option argument is omitted.</dd>
+<dt><tt class="docutils literal"><span class="pre">--machinable[=(yes|no)]</span></tt></dt>
+<dd>Use tab character as separators for <tt class="docutils literal"><span class="pre">--list-</span></tt> option output. It
+may be suitable for scripting. See &quot;<a class="reference internal" href="#list-options">List options</a>&quot; for considered
+use cases. Disabled by default.</dd>
+<dt><tt class="docutils literal"><span class="pre">--with-list-header[=(yes|no)]</span></tt></dt>
+<dd>Print headers describing columns in <tt class="docutils literal"><span class="pre">--list-</span></tt> option output.
+See also &quot;<a class="reference internal" href="#list-options">List options</a>&quot;.</dd>
+</dl>
+</div>
+<div class="section" id="miscellaneous-options">
+<span id="option-misc"></span><h2>Miscellaneous Options</h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">--help</span></tt></dt>
+<dd>Prints to standard output a detailed usage description, and then exits.</dd>
+<dt><tt class="docutils literal"><span class="pre">-?</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--help</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--help-full</span></tt></dt>
+<dd>Prints to standard output a detailed usage description including experimental
+features, and then exits. Visit <a class="reference external" href="https://docs.ctags.io/">https://docs.ctags.io/</a> for information
+about the latest exciting experimental features.</dd>
+<dt><tt class="docutils literal"><span class="pre">--license</span></tt></dt>
+<dd>Prints a summary of the software license to standard output, and then exits.</dd>
+<dt><tt class="docutils literal"><span class="pre">--print-language</span></tt></dt>
+<dd>Just prints the language parsers for specified source files, and then exits.</dd>
+<dt><tt class="docutils literal"><span class="pre">--quiet[=(yes|no)]</span></tt></dt>
+<dd>Write fewer messages (default is <tt class="docutils literal">no</tt>).</dd>
+<dt><tt class="docutils literal"><span class="pre">--totals[=(yes|no|extra)]</span></tt></dt>
+<dd><p class="first">Prints statistics about the source files read and the tag file written
+during the current invocation of ctags. This option
+is <tt class="docutils literal">no</tt> by default.</p>
+<p class="last">The <tt class="docutils literal">extra</tt> value prints parser specific statistics for parsers
+gathering such information.</p>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">--verbose[=(yes|no)]</span></tt></dt>
+<dd>Enable verbose mode. This prints out information on option processing
+and a brief message describing what action is being taken for each file
+considered by ctags. Normally, ctags
+does not read command line arguments until after options are read
+from the configuration files (see &quot;<a class="reference internal" href="#files">FILES</a>&quot;, below).
+However, if this option is the first argument on
+the command line, it will take effect before any options are read from
+these sources. The default is <tt class="docutils literal">no</tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">-V</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--verbose</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--version</span></tt></dt>
+<dd>Prints a version identifier for ctags to standard
+output, and then exits. This is guaranteed to always contain the string
+&quot;Universal Ctags&quot;.</dd>
+</dl>
+</div>
+<div class="section" id="obsoleted-options">
+<h2>Obsoleted Options</h2>
+<p>These options are kept for backward-compatibility with Exuberant Ctags.</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-w</span></tt></dt>
+<dd>This option is silently ignored for backward-compatibility with the
+ctags of SVR4 Unix.</dd>
+<dt><tt class="docutils literal"><span class="pre">--file-scope[=(yes|no)]</span></tt></dt>
+<dd>This options is removed. Use <tt class="docutils literal"><span class="pre">--extras=[+|-]F</span></tt> or
+<tt class="docutils literal"><span class="pre">--extras=[+|-]{fileScope}</span></tt> instead.</dd>
+<dt><tt class="docutils literal"><span class="pre">--extra=[+|-][&lt;flags&gt;|*]</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--extras=[+|-][&lt;flags&gt;|*]</span></tt>, which was introduced to make
+the option naming convention align to the other options like
+<tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;=</span></tt> and <tt class="docutils literal"><span class="pre">--fields=</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">--&lt;LANG&gt;-kinds=[+|-](&lt;kinds&gt;|*)</span></tt></dt>
+<dd>This option is obsolete. Use <tt class="docutils literal"><span class="pre">--kinds-&lt;LANG&gt;=...</span></tt> instead.</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="operational-details">
+<h1>OPERATIONAL DETAILS</h1>
+<p>As ctags considers each source file name in turn, it tries to
+determine the language of the file by applying tests described in
+&quot;<a class="reference internal" href="#determining-file-language">Determining file language</a>&quot;.</p>
+<p>If a language was identified, the file is opened and then the appropriate
+language parser is called to operate on the currently open file. The parser
+parses through the file and adds an entry to the tag file for each
+language object it is written to handle. See &quot;<a class="reference internal" href="#tag-file-format">TAG FILE FORMAT</a>&quot;, below,
+for details on these entries.</p>
+<div class="section" id="notes-for-c-c-parser">
+<h2>Notes for C/C++ Parser</h2>
+<!-- TODO: move the following description to parser-cxx.rst. -->
+<p>This implementation of ctags imposes no formatting
+requirements on C code as do legacy implementations. Older implementations
+of ctags tended to rely upon certain formatting assumptions in order to
+help it resolve coding dilemmas caused by preprocessor conditionals.</p>
+<p>In general, ctags tries to be smart about conditional
+preprocessor directives. If a preprocessor conditional is encountered
+within a statement which defines a tag, ctags follows
+only the first branch of that conditional (except in the special case of
+<tt class="docutils literal">#if 0</tt>, in which case it follows only the last branch). The reason for
+this is that failing to pursue only one branch can result in ambiguous
+syntax, as in the following example:</p>
+<pre class="code C literal-block">
+<span class="comment preproc">#ifdef TWO_ALTERNATIVES
+</span><span class="keyword">struct</span> <span class="punctuation">{</span>
+<span class="comment preproc">#else
+</span><span class="keyword">union</span> <span class="punctuation">{</span>
+<span class="comment preproc">#endif
+</span> <span class="keyword type">short</span> <span class="name">a</span><span class="punctuation">;</span>
+ <span class="keyword type">long</span> <span class="name">b</span><span class="punctuation">;</span>
+<span class="punctuation">}</span>
+</pre>
+<p>Both branches cannot be followed, or braces become unbalanced and
+ctags would be unable to make sense of the syntax.</p>
+<p>If the application of this heuristic fails to properly parse a file,
+generally due to complicated and inconsistent pairing within the
+conditionals, ctags will retry the file using a
+different heuristic which does not selectively follow conditional
+preprocessor branches, but instead falls back to relying upon a closing
+brace ('<tt class="docutils literal">}</tt>') in column 1 as indicating the end of a block once any brace
+imbalance results from following a <tt class="docutils literal">#if</tt> conditional branch.</p>
+<p>ctags will also try to specially handle arguments lists
+enclosed in double sets of parentheses in order to accept the following
+conditional construct:</p>
+<pre class="literal-block">
+extern void foo __ARGS((int one, char two));
+</pre>
+<p>Any name immediately preceding the '<tt class="docutils literal">((</tt>' will be automatically ignored and
+the previous name will be used.</p>
+<p>C++ operator definitions are specially handled. In order for consistency
+with all types of operators (overloaded and conversion), the operator
+name in the tag file will always be preceded by the string &quot;operator &quot;
+(i.e. even if the actual operator definition was written as &quot;operator&lt;&lt;&quot;).</p>
+<p>After creating or appending to the tag file, it is sorted by the tag name,
+removing identical tag lines.</p>
+</div>
+<div class="section" id="determining-file-language">
+<span id="guessing"></span><h2>Determining file language</h2>
+<div class="section" id="file-name-mapping">
+<h3>File name mapping</h3>
+<p>Unless the <tt class="docutils literal"><span class="pre">--language-force</span></tt> option is specified, the language of each source
+file is automatically selected based upon a <em>mapping</em> of file names to
+languages. The mappings in effect for each language may be displayed using
+the <tt class="docutils literal"><span class="pre">--list-maps</span></tt> option and may be changed using the <tt class="docutils literal"><span class="pre">--langmap</span></tt> or
+<tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;</span></tt> options.</p>
+<p>If the name of a file is not mapped to a language, ctags tries
+to heuristically guess the language for the file by inspecting its content.</p>
+<p>All files that have no file name mapping and no guessed parser are
+ignored. This permits running ctags on all files in
+either a single directory (e.g. &quot;<tt class="docutils literal">ctags *</tt>&quot;), or on
+all files in an entire source directory tree
+(e.g. &quot;<tt class="docutils literal">ctags <span class="pre">-R</span></tt>&quot;), since only those files whose
+names are mapped to languages will be scanned.</p>
+<p>An extension may be mapped to multiple parsers. For example, <tt class="docutils literal">.h</tt>
+are mapped to C++, C and ObjectiveC. These mappings can cause
+issues. ctags tries to select the proper parser
+for the source file by applying heuristics to its content, however
+it is not perfect. In case of issues one can use <tt class="docutils literal"><span class="pre">--language-force=&lt;language&gt;</span></tt>,
+<tt class="docutils literal"><span class="pre">--langmap=&lt;map&gt;[,&lt;map&gt;[...]]</span></tt>, or the <tt class="docutils literal"><span class="pre">--map-&lt;LANG&gt;=[+|-]&lt;extension&gt;|&lt;pattern&gt;</span></tt>
+options. (Some of the heuristics are applied whether <tt class="docutils literal"><span class="pre">--guess-language-eagerly</span></tt>
+is given or not.)</p>
+<!-- TODO: all heuristics??? To be confirmed. -->
+</div>
+<div class="section" id="heuristically-guessing">
+<h3>Heuristically guessing</h3>
+<p>If ctags cannot select a parser from the mapping of file names,
+various heuristic tests are conducted to determine the language:</p>
+<dl class="docutils">
+<dt>template file name testing</dt>
+<dd>If the file name has an <tt class="docutils literal">.in</tt> extension, ctags applies
+the mapping to the file name without the extension. For example,
+<tt class="docutils literal">config.h</tt> is tested for a file named <tt class="docutils literal">config.h.in</tt>.</dd>
+<dt>&quot;interpreter&quot; testing</dt>
+<dd><p class="first">The first line of the file is checked to see if the file is a <tt class="docutils literal">#!</tt>
+script for a recognized language. ctags looks for
+a parser having the same name.</p>
+<p>If ctags finds no such parser,
+ctags looks for the name in alias lists. For
+example, consider if the first line is <tt class="docutils literal"><span class="pre">#!/bin/sh</span></tt>. Though
+ctags has a &quot;shell&quot; parser, it doesn't have a &quot;sh&quot;
+parser. However, <tt class="docutils literal">sh</tt> is listed as an alias for <tt class="docutils literal">shell</tt>, therefore
+ctags selects the &quot;shell&quot; parser for the file.</p>
+<p>An exception is <tt class="docutils literal">env</tt>. If <tt class="docutils literal">env</tt> is specified (for example
+&quot;<tt class="docutils literal"><span class="pre">#!/usr/bin/env</span> python</tt>&quot;), ctags
+reads more lines to find real interpreter specification.</p>
+<p class="last">To display the list of aliases, use <tt class="docutils literal"><span class="pre">--list-aliases</span></tt> option.
+To add an item to the list or to remove an item from the list, use the
+<tt class="docutils literal"><span class="pre">--alias-&lt;LANG&gt;=+&lt;pattern&gt;</span></tt> or <tt class="docutils literal"><span class="pre">--alias-&lt;LANG&gt;=-&lt;pattern&gt;</span></tt> option
+respectively.</p>
+</dd>
+<dt>&quot;zsh autoload tag&quot; testing</dt>
+<dd>If the first line starts with <tt class="docutils literal">#compdef</tt> or <tt class="docutils literal">#autoload</tt>,
+ctags regards the line as &quot;zsh&quot;.</dd>
+<dt>&quot;emacs mode at the first line&quot; testing</dt>
+<dd><p class="first">The Emacs editor has multiple editing modes specialized for programming
+languages. Emacs can recognize a marker called modeline in a file
+and utilize the marker for the mode selection. This heuristic test does
+the same as what Emacs does.</p>
+<p>ctags treats <tt class="docutils literal">MODE</tt> as a name of interpreter and applies the same
+rule of &quot;interpreter&quot; testing if the first line has one of
+the following patterns:</p>
+<pre class="literal-block">
+-*- mode: MODE -*-
+</pre>
+<p>or</p>
+<pre class="last literal-block">
+-*- MODE -*-
+</pre>
+</dd>
+<dt>&quot;emacs mode at the EOF&quot; testing</dt>
+<dd><p class="first">Emacs editor recognizes another marker at the end of file as a
+mode specifier. This heuristic test does the same as what Emacs does.</p>
+<p>ctags treats <tt class="docutils literal">MODE</tt> as a name of an interpreter and applies the same
+rule of &quot;interpreter&quot; heuristic testing, if the lines at the tail of the file
+have the following pattern:</p>
+<pre class="literal-block">
+Local Variables:
+...
+mode: MODE
+...
+End:
+</pre>
+<p class="last">3000 characters are sought from the end of file to find the pattern.</p>
+</dd>
+<dt>&quot;vim modeline&quot; testing</dt>
+<dd><p class="first">Like the modeline of the Emacs editor, Vim editor has the same concept.
+ctags treats <tt class="docutils literal">TYPE</tt> as a name of interpreter and applies the same
+rule of &quot;interpreter&quot; heuristic testing if the last 5 lines of the file
+have one of the following patterns:</p>
+<pre class="literal-block">
+filetype=TYPE
+</pre>
+<p>or</p>
+<pre class="last literal-block">
+ft=TYPE
+</pre>
+</dd>
+<dt>&quot;PHP marker&quot; testing</dt>
+<dd>If the first line is started with <tt class="docutils literal"><span class="pre">&lt;?php</span></tt>,
+ctags regards the line as &quot;php&quot;.</dd>
+</dl>
+<p>Looking into the file contents is a more expensive operation than file
+name matching. So ctags runs the testings in limited
+conditions. &quot;interpreter&quot; testing is enabled only when a file is an
+executable or the <tt class="docutils literal"><span class="pre">--guess-language-eagerly</span></tt> (<tt class="docutils literal"><span class="pre">-G</span></tt> in short) option is
+given. The other heuristic tests are enabled only when <tt class="docutils literal"><span class="pre">-G</span></tt> option is
+given.</p>
+<p>The <tt class="docutils literal"><span class="pre">--print-language</span></tt> option can be used just to print the results of
+parser selections for given files instead of generating a tags file.</p>
+<p>Examples:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --print-language config.h.in input.m input.unknown
+<span class="generic output">config.h.in: C++
+input.m: MatLab
+input.unknown: NONE</span>
+</pre>
+<p><tt class="docutils literal">NONE</tt> means that ctags does not select any parser for the file.</p>
+</div>
+</div>
+</div>
+<div class="section" id="tag-file-format">
+<h1>TAG FILE FORMAT</h1>
+<p>This section describes the tag file format briefly. See tags(5) and
+ctags-client-tools(7) for more details.</p>
+<p>When not running in etags mode, each entry in the tag file consists of a
+separate line, each looking like this, called <em>regular tags</em>, in the most general case:</p>
+<pre class="literal-block">
+&lt;tag_name&gt;&lt;TAB&gt;&lt;file_name&gt;&lt;TAB&gt;&lt;ex_cmd&gt;;&quot;&lt;TAB&gt;&lt;extension_fields&gt;
+</pre>
+<p>The fields and separators of these lines are specified as follows:</p>
+<blockquote>
+<ol class="arabic">
+<li><p class="first"><tt class="docutils literal">&lt;tag_name&gt;</tt>: tag name</p>
+</li>
+<li><p class="first"><tt class="docutils literal">&lt;TAB&gt;</tt>: single tab character</p>
+</li>
+<li><p class="first"><tt class="docutils literal">&lt;file_name&gt;</tt>: name of the file in which the object associated with the tag is located</p>
+</li>
+<li><p class="first"><tt class="docutils literal">&lt;TAB&gt;</tt>: single tab character</p>
+</li>
+<li><p class="first"><tt class="docutils literal">&lt;ex_cmd&gt;</tt>: EX command used to locate the tag within the file; generally a
+search pattern (either <tt class="docutils literal">/pattern/</tt> or <tt class="docutils literal"><span class="pre">?pattern?</span></tt>) or line number (see
+<tt class="docutils literal"><span class="pre">--excmd=&lt;type&gt;</span></tt> option).</p>
+</li>
+<li><p class="first"><tt class="docutils literal"><span class="pre">;&quot;&lt;TAB&gt;&lt;extension_fields&gt;</span></tt>: a set of extension fields. See
+&quot;<a class="reference internal" href="#extension-fields">Extension fields</a>&quot; for more details.</p>
+<p>Tag file format 2 (see <tt class="docutils literal"><span class="pre">--format</span></tt>) extends the EX command
+to include the extension fields embedded in an EX comment immediately appended
+to the EX command, which leaves it backward-compatible with original
+<tt class="docutils literal">vi(1)</tt> implementations.</p>
+</li>
+</ol>
+</blockquote>
+<p>A few special tags, called <em>pseudo tags</em>, are written into the tag file for internal purposes.</p>
+<pre class="literal-block">
+!_TAG_FILE_FORMAT 2 /extended format; --format=1 will not append ;&quot; to lines/
+!_TAG_FILE_SORTED 1 /0=unsorted, 1=sorted, 2=foldcase/
+...
+</pre>
+<p><tt class="docutils literal"><span class="pre">--pseudo-tags=[+|-](&lt;pseudo-tag&gt;|*)</span></tt> option enables or disables emitting pseudo-tags.</p>
+<p>See the output of &quot;<tt class="docutils literal">ctags <span class="pre">--list-pseudo-tags</span></tt>&quot; for the list of
+the kinds.
+See also tags(5) and ctags-client-tools(7) for more details of the pseudo tags.</p>
+<p>These tags are composed in such a way that they always sort to the top of
+the file. Therefore, the first two characters of these tags are used a magic
+number to detect a tag file for purposes of determining whether a
+valid tag file is being overwritten rather than a source file.</p>
+<p>Note that the name of each source file will be recorded in the tag file
+exactly as it appears on the command line. Therefore, if the path you
+specified on the command line was relative to the current directory, then
+it will be recorded in that same manner in the tag file. See, however,
+the <tt class="docutils literal"><span class="pre">--tag-relative=(yes|no|always|never)</span></tt> option for how this behavior can be
+modified.</p>
+</div>
+<div class="section" id="id1">
+<span id="tag-entries"></span><h1>TAG ENTRIES</h1>
+<p>A tag is an index for a language object. The concept of a tag and related
+items in Exuberant Ctags are refined and extended in Universal Ctags.</p>
+<p>A tag is categorized into <em>definition tags</em> or <em>reference tags</em>.
+In general, Exuberant Ctags only tags <em>definitions</em> of
+language objects: places where newly named language objects <em>are introduced</em>.
+Universal Ctags, on the other hand, can also tag <em>references</em> of language
+objects: places where named language objects <em>are used</em>. However, support
+for generating reference tags is new and limited to specific areas of
+specific languages in the current version.</p>
+<div class="section" id="extension-fields">
+<h2>Extension fields</h2>
+<p>A tag can record various information, called <em>extension fields</em>.</p>
+<p>Extension fields are tab-separated key-value pairs appended to the end of
+the EX command as a comment, as described above. These key value pairs
+appear in the general form <tt class="docutils literal">key:value</tt>.</p>
+<p>In addition, information on the scope of the tag definition may be
+available, with the key portion equal to some language-dependent construct
+name and its value the name declared for that construct in the program.
+This scope entry indicates the scope in which the tag was found.
+For example, a tag generated for a C structure member would have a scope
+looking like <tt class="docutils literal">struct:myStruct</tt>.</p>
+<p><tt class="docutils literal"><span class="pre">--fields=[+|-][&lt;flags&gt;|*]</span></tt> and <tt class="docutils literal"><span class="pre">--fields-(&lt;LANG&gt;|all)=[+|-][&lt;flags&gt;|*]</span></tt> options specifies
+which available extension fields are to be included in the tag entries.</p>
+<p>See the output of &quot;<tt class="docutils literal">ctags <span class="pre">--list-fields</span></tt>&quot; for the list of
+extension fields.
+The essential fields are <tt class="docutils literal">name</tt>, <tt class="docutils literal">input</tt>, <tt class="docutils literal">pattern</tt>, and <tt class="docutils literal">line</tt>.
+The meaning of major fields is as follows (long-name flag/one-letter flag):</p>
+<dl class="docutils">
+<dt><tt class="docutils literal">access</tt>/<tt class="docutils literal">a</tt></dt>
+<dd>Indicates the visibility of this class member, where value is specific
+to the language.</dd>
+<dt><tt class="docutils literal">end</tt>/<tt class="docutils literal">e</tt></dt>
+<dd>Indicates the line number of the end lines of the language object.</dd>
+<dt><tt class="docutils literal">extras</tt>/<tt class="docutils literal">E</tt></dt>
+<dd>Extra tag type information. See &quot;<a class="reference internal" href="#extras">Extras</a>&quot; for details.</dd>
+<dt><tt class="docutils literal">file</tt>/<tt class="docutils literal">f</tt></dt>
+<dd>Indicates that the tag has file-limited visibility. This key has no
+corresponding value. Enabled by default.</dd>
+<dt><tt class="docutils literal">implementation</tt>/<tt class="docutils literal">m</tt></dt>
+<dd>When present, this indicates a limited implementation (abstract vs.
+concrete) of a routine or class, where value is specific to the
+language (<tt class="docutils literal">virtual</tt> or <tt class="docutils literal">pure virtual</tt> for C++; <tt class="docutils literal">abstract</tt> for Java).</dd>
+<dt><tt class="docutils literal">inherits</tt>/<tt class="docutils literal">i</tt></dt>
+<dd>When present, value is a comma-separated list of classes from which
+this class is derived (i.e. inherits from).</dd>
+<dt><tt class="docutils literal">input</tt>/<tt class="docutils literal">F</tt></dt>
+<dd>The name of source file where <tt class="docutils literal">name</tt> is defined or referenced.</dd>
+<dt><tt class="docutils literal">k</tt></dt>
+<dd><a class="reference external" href="Kinds">Kind</a> of tag as one-letter. Enabled by default.
+This field has no long-name.
+See also <tt class="docutils literal">kind</tt>/<tt class="docutils literal">z</tt> flag.</dd>
+<dt><tt class="docutils literal">K</tt></dt>
+<dd><a class="reference external" href="Kinds">Kind</a> of tag as long-name.
+This field has no long-name.
+See also <tt class="docutils literal">kind</tt>/<tt class="docutils literal">z</tt> flag.</dd>
+<dt><tt class="docutils literal">kind</tt>/<tt class="docutils literal">z</tt></dt>
+<dd>Include the <tt class="docutils literal">kind:</tt> key in <a class="reference external" href="Kinds">kind field</a>. See also <tt class="docutils literal">k</tt> and <tt class="docutils literal">K</tt> flags.</dd>
+<dt><tt class="docutils literal">language</tt>/<tt class="docutils literal">l</tt></dt>
+<dd>Language of source file containing tag</dd>
+<dt><tt class="docutils literal">line</tt>/<tt class="docutils literal">n</tt></dt>
+<dd>The line number where <tt class="docutils literal">name</tt> is defined or referenced in <tt class="docutils literal">input</tt>.</dd>
+<dt><tt class="docutils literal">name</tt>/<tt class="docutils literal">N</tt></dt>
+<dd>The name of language objects.</dd>
+<dt><tt class="docutils literal">pattern</tt>/<tt class="docutils literal">P</tt></dt>
+<dd>Can be used to search the <tt class="docutils literal">name</tt> in <tt class="docutils literal">input</tt></dd>
+<dt><tt class="docutils literal">roles</tt>/<tt class="docutils literal">r</tt></dt>
+<dd>Roles assigned to the tag. See &quot;<a class="reference internal" href="#roles">Roles</a>&quot; for more details.</dd>
+<dt><tt class="docutils literal">s</tt></dt>
+<dd>Scope of tag definition. Enabled by default.
+This field has no long-name.
+See also <tt class="docutils literal">scope</tt>/<tt class="docutils literal">Z</tt> flag.</dd>
+<dt><tt class="docutils literal">scope</tt>/<tt class="docutils literal">Z</tt></dt>
+<dd>Prepend the <tt class="docutils literal">scope:</tt> key to scope (<tt class="docutils literal">s</tt>) field.
+See also <tt class="docutils literal">s</tt> flag.</dd>
+<dt><tt class="docutils literal">scopeKind</tt>/<tt class="docutils literal">p</tt></dt>
+<dd>Kind of scope as long-name</dd>
+<dt><tt class="docutils literal">signature</tt>/<tt class="docutils literal">S</tt></dt>
+<dd>When present, value is a language-dependent representation of the
+signature of a routine (e.g. prototype or parameter list). A routine signature in its complete form
+specifies the return type of a routine and its formal argument list.
+This extension field is presently supported only for C-based
+languages and does not include the return type.</dd>
+<dt><tt class="docutils literal">typeref</tt>/<tt class="docutils literal">t</tt></dt>
+<dd>Type and name of a variable, typedef, or return type of
+callable like function as <tt class="docutils literal">typeref:</tt> field.
+Enabled by default.</dd>
+</dl>
+<div class="section" id="kinds">
+<h3>Kinds</h3>
+<p><tt class="docutils literal">kind</tt> is a field which represents the <em>kind</em> of language object
+specified by a tag. Kinds used and defined are very different between
+parsers. For example, C language defines <tt class="docutils literal">macro</tt>, <tt class="docutils literal">function</tt>,
+<tt class="docutils literal">variable</tt>, <tt class="docutils literal">typedef</tt>, etc.</p>
+<p><tt class="docutils literal"><span class="pre">--kinds-(&lt;LANG&gt;|all)=[+|-](&lt;kinds&gt;|*)</span></tt> option specifies a list of language-specific
+kinds of tags (or kinds) to include in the output file for a particular
+language.</p>
+<p>See the output of &quot;<tt class="docutils literal">ctags <span class="pre">--list-kinds-full</span></tt>&quot; for the complete
+list of the kinds.</p>
+<p>Its value is either one of the
+corresponding one-letter flags or a long-name flag. It is permitted
+(and is, in fact, the default) for the key portion of this field to be
+omitted. The optional behaviors are controlled with the <tt class="docutils literal"><span class="pre">--fields</span></tt> option as follows.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags -o - kinds.c
+<span class="generic output">foo kinds.c /^int foo() {$/;&quot; f typeref:typename:int
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+k -o - kinds.c
+<span class="generic output">foo kinds.c /^int foo() {$/;&quot; f typeref:typename:int
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+K -o - kinds.c
+<span class="generic output">foo kinds.c /^int foo() {$/;&quot; function typeref:typename:int
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+z -o - kinds.c
+<span class="generic output">foo kinds.c /^int foo() {$/;&quot; kind:f typeref:typename:int
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+zK -o - kinds.c
+<span class="generic output">foo kinds.c /^int foo() {$/;&quot; kind:function typeref:typename:int</span>
+</pre>
+</div>
+<div class="section" id="roles">
+<h3>Roles</h3>
+<p><em>Role</em> is a newly introduced concept in Universal Ctags. Role is a
+concept associated with reference tags, and is not implemented widely yet.</p>
+<p>As described previously in &quot;<a class="reference internal" href="#kinds">Kinds</a>&quot;, the <tt class="docutils literal">kind</tt> field represents the type
+of language object specified with a tag, such as a function vs. a variable.
+Specific kinds are defined for reference tags, such as the C++ kind <tt class="docutils literal">header</tt> for
+header file, or Java kind <tt class="docutils literal">package</tt> for package statements. For such reference
+kinds, a <tt class="docutils literal">roles</tt> field can be added to distinguish the role of the reference
+kind. In other words, the <tt class="docutils literal">kind</tt> field identifies the <em>what</em> of the language
+object, whereas the <tt class="docutils literal">roles</tt> field identifies the <em>how</em> of a referenced language
+object. Roles are only used with specific kinds.</p>
+<p>For a definition tag, this field takes <tt class="docutils literal">def</tt> as a value.</p>
+<p>For example, <tt class="docutils literal">Baz</tt> is tagged as a reference tag with kind <tt class="docutils literal">package</tt> and with
+role <tt class="docutils literal">imported</tt> with the following code.</p>
+<pre class="code java literal-block">
+<span class="keyword namespace">package</span> <span class="name namespace">Bar</span><span class="punctuation">;</span>
+<span class="keyword namespace">import</span> <span class="name namespace">Baz</span><span class="punctuation">;</span>
+
+<span class="keyword declaration">class</span> <span class="name class">Foo</span> <span class="punctuation">{</span>
+ <span class="comment single">// ...
+</span><span class="punctuation">}</span>
+</pre>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+KEr -uo - roles.java
+<span class="generic output">Bar roles.java /^package Bar;$/;&quot; package roles:def
+Foo roles.java /^class Foo {$/;&quot; class roles:def
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+EKr --extras<span class="operator">=</span>+r -uo - roles.java
+<span class="generic output">Bar roles.java /^package Bar;$/;&quot; package roles:def
+Baz roles.java /^import Baz;$/;&quot; package roles:imported extras:reference
+Foo roles.java /^class Foo {$/;&quot; class roles:def</span>
+</pre>
+<p><tt class="docutils literal"><span class="pre">--roles-(&lt;LANG&gt;|all).(&lt;kind&gt;|all)=[+|-][&lt;roles&gt;|*]</span></tt> option specifies a list of kind-specific
+roles of tags to include in the output file for a particular language.</p>
+<p>Inquire the output of &quot;<tt class="docutils literal">ctags <span class="pre">--list-roles</span></tt>&quot; for the list of
+roles.</p>
+</div>
+</div>
+<div class="section" id="extras">
+<h2>Extras</h2>
+<p>Generally, ctags tags only language objects appearing
+in source files, as is. In other words, a value for a <tt class="docutils literal">name:</tt> field
+should be found on the source file associated with the <tt class="docutils literal">name:</tt>. An
+<tt class="docutils literal">extra</tt> type tag (<em>extra</em>) is for tagging a language object with a processed
+name, or for tagging something not associated with a language object. A typical
+extra tag is <tt class="docutils literal">qualified</tt>, which tags a language object with a
+class-qualified or scope-qualified name.</p>
+<p><tt class="docutils literal"><span class="pre">--extras-(&lt;LANG&gt;|all)=[+|-][&lt;flags&gt;|*]</span></tt> option specifies
+whether to include extra tag entries for certain kinds of information.</p>
+<p>Inquire the output of <tt class="docutils literal">ctags <span class="pre">--list-extras</span></tt> for the list of extras.
+The meaning of major extras is as follows (long-name flag/one-letter flag):</p>
+<dl class="docutils">
+<dt><tt class="docutils literal">anonymous</tt>/none</dt>
+<dd><p class="first">Include an entry for the language object that has no name like lambda
+function. This extra has no one-letter flag and is enabled by
+default.</p>
+<p>The extra tag is useful as a placeholder to fill scope fields
+for language objects defined in a language object with no name.</p>
+<pre class="code C literal-block">
+<span class="keyword">struct</span> <span class="punctuation">{</span>
+ <span class="keyword type">double</span> <span class="name">x</span><span class="punctuation">,</span> <span class="name">y</span><span class="punctuation">;</span>
+<span class="punctuation">}</span> <span class="name">p</span> <span class="operator">=</span> <span class="punctuation">{</span> <span class="punctuation">.</span><span class="name">x</span> <span class="operator">=</span> <span class="literal number float">0.0</span><span class="punctuation">,</span> <span class="punctuation">.</span><span class="name">y</span> <span class="operator">=</span> <span class="literal number float">0.0</span> <span class="punctuation">};</span>
+</pre>
+<p>'<tt class="docutils literal">x</tt>' and '<tt class="docutils literal">y</tt>' are the members of a structure. When filling the scope
+fields for them, ctags has trouble because the struct
+where '<tt class="docutils literal">x</tt>' and '<tt class="docutils literal">y</tt>' belong to has no name. For overcoming the trouble,
+ctags generates an anonymous extra tag for the struct
+and fills the scope fields with the name of the extra tag.</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>-f -uo - input.c
+<span class="generic output">__anon9f26d2460108 input.c /^struct {$/;&quot; s
+x input.c /^ double x, y;$/;&quot; m struct:__anon9f26d2460108
+y input.c /^ double x, y;$/;&quot; m struct:__anon9f26d2460108
+p input.c /^} p = { .x = 0.0, .y = 0.0 };$/;&quot; v typeref:struct:__anon9f26d2460108</span>
+</pre>
+<p class="last">The above tag output has <tt class="docutils literal">__anon9f26d2460108</tt> as an anonymous extra tag.
+The typeref field of '<tt class="docutils literal">p</tt>' also receives the benefit of it.</p>
+</dd>
+<dt><tt class="docutils literal">fileScope</tt>/<tt class="docutils literal">F</tt></dt>
+<dd><p class="first">Indicates whether tags scoped only for a single file (i.e. tags which
+cannot be seen outside of the file in which they are defined, such as
+language objects with <tt class="docutils literal">static</tt> modifier of C language) should be included
+in the output. See also the <tt class="docutils literal"><span class="pre">-h</span></tt> option.</p>
+<p>This extra tag is enabled by default. Add <tt class="docutils literal"><span class="pre">--extras=-F</span></tt> option not to
+output tags scoped only for a single-file. This is the replacement for
+<tt class="docutils literal"><span class="pre">--file-scope</span></tt> option of Exuberant Ctags.</p>
+<pre class="code c literal-block">
+<span class="keyword">static</span> <span class="keyword type">int</span> <span class="name function">f</span><span class="punctuation">()</span> <span class="punctuation">{</span>
+ <span class="keyword">return</span> <span class="literal number integer">0</span><span class="punctuation">;</span>
+<span class="punctuation">}</span>
+<span class="keyword type">int</span> <span class="name function">g</span><span class="punctuation">()</span> <span class="punctuation">{</span>
+ <span class="keyword">return</span> <span class="literal number integer">0</span><span class="punctuation">;</span>
+<span class="punctuation">}</span>
+</pre>
+<pre class="code console last literal-block">
+<span class="generic prompt">$ </span>ctags -uo - filescope.c
+<span class="generic output">f filescope.c /^static int f() {$/;&quot; f typeref:typename:int file:
+g filescope.c /^int g() {$/;&quot; f typeref:typename:int
+</span><span class="generic prompt">$ </span>ctags --extras<span class="operator">=</span>-F -uo - filescope.c
+<span class="generic output">g filescope.c /^int g() {$/;&quot; f typeref:typename:int</span>
+</pre>
+</dd>
+<dt><tt class="docutils literal">inputFile</tt>/<tt class="docutils literal">f</tt></dt>
+<dd><p class="first">Include an entry for the base file name of every source file
+(e.g. <tt class="docutils literal">example.c</tt>), which addresses the first line of the file.
+This flag is the replacement for <tt class="docutils literal"><span class="pre">--file-tags</span></tt> hidden option of
+Exuberant Ctags.</p>
+<p>If the <tt class="docutils literal">end:</tt> field is enabled, the end line number of the file can be
+attached to the tag. (However, ctags omits the <tt class="docutils literal">end:</tt> field
+if no newline is in the file like an empty file.)</p>
+<p>By default, ctags doesn't create the <tt class="docutils literal">inputFile</tt>/<tt class="docutils literal">f</tt> extra
+tag for the source file when ctags doesn't find a parser
+for it. Enabling <tt class="docutils literal">Unknown</tt> parser with <tt class="docutils literal"><span class="pre">--languages=+Unknown</span></tt> forces
+ctags to create the extra tags for any source files.</p>
+<p class="last">The etags mode enables the <tt class="docutils literal">Unknown</tt> parser implicitly.</p>
+</dd>
+<dt><tt class="docutils literal">pseudo</tt>/<tt class="docutils literal">p</tt></dt>
+<dd>Include pseudo-tags. Enabled by default unless the tag file is
+written to standard output. See ctags-client-tools(7) about
+the detail of pseudo-tags.</dd>
+<dt><tt class="docutils literal">qualified</tt>/<tt class="docutils literal">q</tt></dt>
+<dd><p class="first">Include an extra class-qualified or namespace-qualified tag entry
+for each tag which is a member of a class or a namespace.</p>
+<p>This may allow easier location of a specific tags when
+multiple occurrences of a tag name occur in the tag file.
+Note, however, that this could potentially more than double
+the size of the tag file.</p>
+<p>The actual form of the qualified tag depends upon the language
+from which the tag was derived (using a form that is most
+natural for how qualified calls are specified in the
+language). For C++ and Perl, it is in the form
+<tt class="docutils literal"><span class="pre">class::member</span></tt>; for Eiffel and Java, it is in the form
+<tt class="docutils literal">class.member</tt>.</p>
+<p>Note: Using backslash characters as separators forming
+qualified name in PHP. However, in tags output of
+Universal Ctags, a backslash character in a name is escaped
+with a backslash character. See tags(5) about the escaping.</p>
+<p>The following example demonstrates the <tt class="docutils literal">qualified</tt> extra tag.</p>
+<pre class="code Java literal-block">
+<span class="keyword declaration">class</span> <span class="name class">point</span> <span class="punctuation">{</span>
+ <span class="keyword type">double</span> <span class="name">x</span><span class="punctuation">;</span>
+<span class="punctuation">};</span>
+</pre>
+<p>For the above source file, ctags tags <tt class="docutils literal">point</tt> and <tt class="docutils literal">x</tt> by
+default. If the <tt class="docutils literal">qualified</tt> extra is enabled from the command line
+(<tt class="docutils literal"><span class="pre">--extras=+q</span></tt>), then <tt class="docutils literal">point.x</tt> is also tagged even though the string
+&quot;<tt class="docutils literal">point.x</tt>&quot; is not in the source code.</p>
+<pre class="code console last literal-block">
+<span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+K -uo - qualified.java
+<span class="generic output">point qualified.java /^class point {$/;&quot; class
+x qualified.java /^ double x;$/;&quot; field class:point
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+K --extras<span class="operator">=</span>+q -uo - qualified.java
+<span class="generic output">point qualified.java /^class point {$/;&quot; class
+x qualified.java /^ double x;$/;&quot; field class:point
+point.x qualified.java /^ double x;$/;&quot; field class:point</span>
+</pre>
+</dd>
+<dt><tt class="docutils literal">reference</tt>/<tt class="docutils literal">r</tt></dt>
+<dd><p class="first">Include reference tags. See &quot;<a class="reference internal" href="#id1">TAG ENTRIES</a>&quot; about reference tags.</p>
+<p>The following example demonstrates the <tt class="docutils literal">reference</tt> extra tag.</p>
+<pre class="code c literal-block">
+<span class="comment preproc">#include</span> <span class="comment preprocfile">&lt;stdio.h&gt;</span><span class="comment preproc">
+#include</span> <span class="comment preprocfile">&quot;utils.h&quot;</span><span class="comment preproc">
+#define X
+#undef X</span>
+</pre>
+<p>The <tt class="docutils literal">roles:system</tt> or <tt class="docutils literal">roles:local</tt> fields will be
+added depending on whether the include file name begins with '<tt class="docutils literal">&lt;</tt>' or not.</p>
+<p>&quot;<tt class="docutils literal">#define X</tt>&quot; emits a definition tag. On the other hand &quot;<tt class="docutils literal">#undef X</tt>&quot; emits a
+reference tag.</p>
+<pre class="code console last literal-block">
+<span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+EKr -uo - inc.c
+<span class="generic output">X inc.c /^#define X$/;&quot; macro file: roles:def extras:fileScope
+</span><span class="generic prompt">$ </span>ctags --fields<span class="operator">=</span>+EKr --extras<span class="operator">=</span>+r -uo - inc.c
+<span class="generic output">stdio.h inc.c /^#include &lt;stdio.h&gt;/;&quot; header roles:system extras:reference
+utils.h inc.c /^#include &quot;utils.h&quot;/;&quot; header roles:local extras:reference
+X inc.c /^#define X$/;&quot; macro file: roles:def extras:fileScope
+X inc.c /^#undef X$/;&quot; macro file: roles:undef extras:fileScope,reference</span>
+</pre>
+</dd>
+</dl>
+</div>
+<div class="section" id="language-specific-fields-and-extras">
+<h2>Language-specific fields and extras</h2>
+<p>Exuberant Ctags has the concept of <em>fields</em> and <em>extras</em>. They are common
+between parsers of different languages. Universal Ctags extends this concept
+by providing language-specific fields and extras.</p>
+<!-- Note: kinds are language-specific since e-ctags. roles are new to u-ctags. -->
+<!-- TODO: move the following "Hot to ..." sections to FAQ man page when available -->
+</div>
+</div>
+<div class="section" id="how-to-use-with-vi">
+<h1>HOW TO USE WITH VI</h1>
+<p><tt class="docutils literal">vi(1)</tt> will, by default, expect a tag file by the name <tt class="docutils literal">tags</tt> in the current
+directory. Once the tag file is built, the following commands exercise
+the tag indexing feature:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal">vi <span class="pre">-t</span> tag</tt></dt>
+<dd>Start vi and position the cursor at the file and line where <tt class="docutils literal">tag</tt>
+is defined.</dd>
+<dt><tt class="docutils literal">:ta tag</tt></dt>
+<dd>Find a tag.</dd>
+<dt><tt class="docutils literal"><span class="pre">Ctrl-]</span></tt></dt>
+<dd>Find the tag under the cursor.</dd>
+<dt><tt class="docutils literal"><span class="pre">Ctrl-T</span></tt></dt>
+<dd>Return to previous location before jump to tag (not widely implemented).</dd>
+</dl>
+</div>
+<div class="section" id="how-to-use-with-gnu-emacs">
+<h1>HOW TO USE WITH GNU EMACS</h1>
+<p><tt class="docutils literal">emacs(1)</tt> will, by default, expect a tag file by the name <tt class="docutils literal">TAGS</tt> in the
+current directory. Once the tag file is built, the following commands
+exercise the tag indexing feature:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">visit-tags-table</span> &lt;RET&gt; FILE &lt;RET&gt;</tt></dt>
+<dd>Select the tag file, <tt class="docutils literal">FILE</tt>, to use.</dd>
+<dt><tt class="docutils literal"><span class="pre">M-.</span> [TAG] &lt;RET&gt;</tt></dt>
+<dd>Find the first definition of TAG. The default tag is the identifier
+under the cursor.</dd>
+<dt><tt class="docutils literal"><span class="pre">M-*</span></tt></dt>
+<dd>Pop back to where you previously invoked <tt class="docutils literal"><span class="pre">M-.</span></tt>.</dd>
+<dt><tt class="docutils literal"><span class="pre">C-u</span> <span class="pre">M-.</span></tt></dt>
+<dd>Find the next definition for the last tag.</dd>
+</dl>
+<p>For more commands, see the Tags topic in the Emacs info document.</p>
+</div>
+<div class="section" id="how-to-use-with-nedit">
+<h1>HOW TO USE WITH NEDIT</h1>
+<p>NEdit version 5.1 and later can handle the new extended tag file format
+(see <tt class="docutils literal"><span class="pre">--format</span></tt>).</p>
+<ul class="simple">
+<li>To make NEdit use the tag file, select &quot;File-&gt;Load Tags File&quot;.</li>
+<li>To jump to the definition for a tag, highlight the word, then press <tt class="docutils literal"><span class="pre">Ctrl-D</span></tt>.</li>
+</ul>
+<p>NEdit 5.1 can read multiple tag files from different
+directories. Setting the X resource <tt class="docutils literal">nedit.tagFile</tt> to the name of a tag
+file instructs NEdit to automatically load that tag file at startup time.</p>
+</div>
+<div class="section" id="caveats">
+<h1>CAVEATS</h1>
+<p>Because ctags is neither a preprocessor nor a compiler,
+use of preprocessor macros can fool ctags into either
+missing tags or improperly generating inappropriate tags. Although
+ctags has been designed to handle certain common cases,
+this is the single biggest cause of reported problems. In particular,
+the use of preprocessor constructs which alter the textual syntax of C
+can fool ctags. You can work around many such problems
+by using the <tt class="docutils literal"><span class="pre">-I</span></tt> option.</p>
+<p>Note that since ctags generates patterns for locating
+tags (see the <tt class="docutils literal"><span class="pre">--excmd</span></tt> option), it is entirely possible that the wrong line
+may be found by your editor if there exists another source line which is
+identical to the line containing the tag. The following example
+demonstrates this condition:</p>
+<pre class="code C literal-block">
+<span class="keyword type">int</span> <span class="name">variable</span><span class="punctuation">;</span>
+
+<span class="comment multiline">/* ... */</span>
+<span class="keyword type">void</span> <span class="name function">foo</span><span class="punctuation">(</span><span class="name">variable</span><span class="punctuation">)</span>
+<span class="keyword type">int</span> <span class="name">variable</span><span class="punctuation">;</span>
+<span class="punctuation">{</span>
+ <span class="comment multiline">/* ... */</span>
+<span class="punctuation">}</span>
+</pre>
+<p>Depending upon which editor you use and where in the code you happen to be,
+it is possible that the search pattern may locate the local parameter
+declaration before it finds the actual global variable definition,
+since the lines (and therefore their search patterns) are
+identical.</p>
+<p>This can be avoided by use of the <tt class="docutils literal"><span class="pre">--excmd=n</span></tt> option.</p>
+</div>
+<div class="section" id="bugs">
+<h1>BUGS</h1>
+<p>ctags has more options than <tt class="docutils literal">ls(1)</tt>.</p>
+<p>ctags assumes the input file is written in the correct
+grammar. Otherwise output of ctags is undefined. In other words it has garbage
+in, garbage out (GIGO) feature.</p>
+<!-- TODO: move the following paragraph to parser-cxx.rst. -->
+<p>When parsing a C++ member function definition (e.g. <tt class="docutils literal"><span class="pre">className::function</span></tt>),
+ctags cannot determine whether the scope specifier
+is a class name or a namespace specifier and always lists it as a class name
+in the scope portion of the extension fields. Also, if a C++ function
+is defined outside of the class declaration (the usual case), the access
+specification (i.e. public, protected, or private) and implementation
+information (e.g. virtual, pure virtual) contained in the function
+declaration are not known when the tag is generated for the function
+definition. It will, however be available for prototypes (e.g. <tt class="docutils literal"><span class="pre">--kinds-c++=+p</span></tt>).</p>
+<p>No qualified tags are generated for language objects inherited into a class.</p>
+</div>
+<div class="section" id="environment-variables">
+<h1>ENVIRONMENT VARIABLES</h1>
+<dl class="docutils">
+<dt><tt class="docutils literal">TMPDIR</tt></dt>
+<dd><p class="first">On Unix-like hosts where <tt class="docutils literal">mkstemp(3)</tt> is available, the value of this
+variable specifies the directory in which to place temporary files.
+This can be useful if the size of a temporary file becomes too large
+to fit on the partition holding the default temporary directory
+defined at compilation time.</p>
+<p>ctags creates temporary
+files only if either (1) an emacs-style tag file is being
+generated, (2) the tag file is being sent to standard output, or
+(3) the program was compiled to use an internal sort algorithm to sort
+the tag files instead of the <tt class="docutils literal">sort(1)</tt> utility of the operating system.
+If the <tt class="docutils literal">sort(1)</tt> utility of the operating system is being used, it will
+generally observe this variable also.</p>
+<p class="last">Note that if ctags
+is setuid, the value of <tt class="docutils literal">TMPDIR</tt> will be ignored.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="files">
+<h1>FILES</h1>
+<dl class="docutils">
+<dt><tt class="docutils literal">tags</tt></dt>
+<dd>The default tag file created by ctags.</dd>
+<dt><tt class="docutils literal">TAGS</tt></dt>
+<dd>The default tag file created by etags.</dd>
+</dl>
+<p><tt class="docutils literal"><span class="pre">$XDG_CONFIG_HOME/ctags/*.ctags</span></tt>, or <tt class="docutils literal"><span class="pre">$HOME/.config/ctags/*.ctags</span></tt> if
+<tt class="docutils literal">$XDG_CONFIG_HOME</tt> is not defined
+(on other than MS Windows)</p>
+<p><tt class="docutils literal"><span class="pre">$HOME/.ctags.d/*.ctags</span></tt></p>
+<p><tt class="docutils literal"><span class="pre">$HOMEDRIVE$HOMEPATH/ctags.d/*.ctags</span></tt> (on MS Windows only)</p>
+<p><tt class="docutils literal"><span class="pre">.ctags.d/*.ctags</span></tt></p>
+<p><tt class="docutils literal"><span class="pre">ctags.d/*.ctags</span></tt></p>
+<blockquote>
+<p>If any of these configuration files exist, each will be expected to
+contain a set of default options which are read in the order listed
+when ctags starts, but before any command line options
+are read. This makes it possible to set up personal or project-level defaults.</p>
+<p>It
+is possible to compile ctags to read an additional
+configuration file before any of those shown above, which will be
+indicated if the output produced by the <tt class="docutils literal"><span class="pre">--version</span></tt> option lists the
+<tt class="docutils literal"><span class="pre">custom-conf</span></tt> feature.</p>
+<p>Options appearing on the command line will override options
+specified in these files. Only options will be read from these
+files.</p>
+<p>Note that the option
+files are read in line-oriented mode in which spaces are significant
+(since shell quoting is not possible) but spaces at the beginning
+of a line are ignored. Each line of the file is read as
+one command line parameter (as if it were quoted with single quotes).
+Therefore, use new lines to indicate separate command-line arguments.</p>
+<p>A line starting with '<tt class="docutils literal">#</tt>' is treated as a comment.</p>
+<p><tt class="docutils literal">*.ctags</tt> files in a directory are loaded in alphabetical order.</p>
+</blockquote>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>See ctags-optlib(7) for defining (or extending) a parser
+in a configuration file.</p>
+<p>See tags(5) for the format of tag files.</p>
+<p>See ctags-incompatibilities(7) about known incompatible changes
+with Exuberant Ctags.</p>
+<p>See ctags-client-tools(7) if you are interested in writing
+a tool for processing tags files.</p>
+<p>See ctags-lang-python(7) about python input specific notes.</p>
+<p>See readtags(1) about a client tool for binary searching a
+name in a sorted tags file.</p>
+<p>The official Universal Ctags web site at: <a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>Also <tt class="docutils literal">ex(1)</tt>, <tt class="docutils literal">vi(1)</tt>, <tt class="docutils literal">elvis(1)</tt>, or, better yet, <tt class="docutils literal">vim(1)</tt>, the official editor of ctags.
+For more information on <tt class="docutils literal">vim(1)</tt>, see the Vim web site at: <a class="reference external" href="https://www.vim.org/">https://www.vim.org/</a></p>
+</div>
+<div class="section" id="author">
+<h1>AUTHOR</h1>
+<p>Universal Ctags project
+<a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>Darren Hiebert &lt;<a class="reference external" href="mailto:dhiebert&#64;users.sourceforge.net">dhiebert&#64;users.sourceforge.net</a>&gt;
+<a class="reference external" href="http://DarrenHiebert.com/">http://DarrenHiebert.com/</a></p>
+</div>
+<div class="section" id="motivation">
+<h1>MOTIVATION</h1>
+<p>&quot;Think ye at all times of rendering some service to every member of the
+human race.&quot;</p>
+<p>&quot;All effort and exertion put forth by man from the fullness of his heart is
+worship, if it is prompted by the highest motives and the will to do
+service to humanity.&quot;</p>
+<p>-- From the Baha'i Writings</p>
+</div>
+<div class="section" id="credits">
+<h1>CREDITS</h1>
+<p>This version of ctags (Universal Ctags) derived from
+the repository, known as fishman-ctags, started by Reza Jelveh.</p>
+<p>The fishman-ctags was derived from Exuberant Ctags.</p>
+<p>Some parsers are taken from <tt class="docutils literal">tagmanager</tt> of the Geany (<a class="reference external" href="https://www.geany.org/">https://www.geany.org/</a>)
+project.</p>
+<p>Exuberant Ctags was originally derived from and
+inspired by the ctags program by Steve Kirkendall &lt;<a class="reference external" href="mailto:kirkenda&#64;cs.pdx.edu">kirkenda&#64;cs.pdx.edu</a>&gt;
+that comes with the Elvis vi clone (though virtually none of the original
+code remains).</p>
+<p>Credit is also due Bram Moolenaar &lt;<a class="reference external" href="mailto:Bram&#64;vim.org">Bram&#64;vim.org</a>&gt;, the author of vim,
+who has devoted so much of his time and energy both to developing the editor
+as a service to others, and to helping the orphans of Uganda.</p>
+<p>The section entitled &quot;<a class="reference internal" href="#how-to-use-with-gnu-emacs">HOW TO USE WITH GNU EMACS</a>&quot; was shamelessly stolen
+from the info page for GNU etags.</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/readtags.1.html b/ctags/man/readtags.1.html
new file mode 100644
index 0000000..ba2034d
--- /dev/null
+++ b/ctags/man/readtags.1.html
@@ -0,0 +1,692 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>readtags</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="readtags">
+<span id="readtags-1"></span>
+<h1 class="title">readtags</h1>
+<h2 class="subtitle" id="find-tag-file-entries-matching-specified-names">Find tag file entries matching specified names</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>5.9.0</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<div class="line-block">
+<div class="line"><strong>readtags</strong> -h | --help</div>
+<div class="line"><strong>readtags</strong> (-H | --help-expression) (filter|sorter)</div>
+<div class="line"><strong>readtags</strong> [OPTION]... ACTION</div>
+</div>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>The <strong>readtags</strong> program filters, sorts and prints tag entries in a tags file.
+The basic filtering is done using <strong>actions</strong>, by which you can list all
+regular tags, pseudo tags or regular tags matching specific name. Then, further
+filtering and sorting can be done using <strong>post processors</strong>, namely <strong>filter
+expressions</strong> and <strong>sorter expressions</strong>.</p>
+</div>
+<div class="section" id="actions">
+<h1>ACTIONS</h1>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-l</span></tt>, <tt class="docutils literal"><span class="pre">--list</span></tt></dt>
+<dd>List regular tags.</dd>
+<dt><tt class="docutils literal"><span class="pre">[-]</span> NAME</tt></dt>
+<dd>List regular tags matching NAME.
+&quot;-&quot; as NAME indicates arguments after this as NAME even if they start with -.</dd>
+<dt><tt class="docutils literal"><span class="pre">-D</span></tt>, <tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt></dt>
+<dd>Equivalent to <tt class="docutils literal"><span class="pre">--list-pseudo-tags</span></tt>.</dd>
+</dl>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<div class="section" id="controlling-the-tags-reading-behavior">
+<h2>Controlling the Tags Reading Behavior</h2>
+<p>The behavior of reading tags can be controlled using these options:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-t</span> TAGFILE</tt>, <tt class="docutils literal"><span class="pre">--tag-file</span> TAGFILE</tt></dt>
+<dd>Use specified tag file (default: &quot;tags&quot;).</dd>
+<dt><tt class="docutils literal"><span class="pre">-s[0|1|2]</span></tt>, <tt class="docutils literal"><span class="pre">--override-sort-detection</span> METHOD</tt></dt>
+<dd>Override sort detection of tag file.
+METHOD: unsorted|sorted|foldcase</dd>
+</dl>
+<p>The NAME action will perform binary search on sorted (including &quot;foldcase&quot;)
+tags files, which is much faster then on unsorted tags files.</p>
+</div>
+<div class="section" id="controlling-the-name-action-behavior">
+<h2>Controlling the NAME Action Behavior</h2>
+<p>The behavior of the NAME action can be controlled using these options:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-i</span></tt>, <tt class="docutils literal"><span class="pre">--icase-match</span></tt></dt>
+<dd>Perform case-insensitive matching in the NAME action.</dd>
+<dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--prefix-match</span></tt></dt>
+<dd>Perform prefix matching in the NAME action.</dd>
+</dl>
+</div>
+<div class="section" id="controlling-the-output">
+<h2>Controlling the Output</h2>
+<p>By default, the output of readtags contains only the name, input and pattern
+field. The Output can be tweaked using these options:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--debug</span></tt></dt>
+<dd>Turn on debugging output.</dd>
+<dt><tt class="docutils literal"><span class="pre">-E</span></tt>, <tt class="docutils literal"><span class="pre">--escape-output</span></tt></dt>
+<dd>Escape characters like tabs in output as described in tags(5).</dd>
+<dt><tt class="docutils literal"><span class="pre">-e</span></tt>, <tt class="docutils literal"><span class="pre">--extension-fields</span></tt></dt>
+<dd>Include extension fields in output.</dd>
+<dt><tt class="docutils literal"><span class="pre">-n</span></tt>, <tt class="docutils literal"><span class="pre">--line-number</span></tt></dt>
+<dd>Also include the line number field when <tt class="docutils literal"><span class="pre">-e</span></tt> option is give.</dd>
+</dl>
+<p>About the <tt class="docutils literal"><span class="pre">-E</span></tt> option: certain characters are escaped in a tags file, to make
+it machine-readable. e.g., ensuring no tabs character appear in fields other
+than the pattern field. By default, readtags translates them to make it
+human-readable, but when utilizing readtags output in a script or a client
+tool, <tt class="docutils literal"><span class="pre">-E</span></tt> option should be used. See ctags-client-tools(7) for more
+discussion on this.</p>
+</div>
+<div class="section" id="filtering-and-sorting">
+<h2>Filtering and Sorting</h2>
+<p>Further filtering and sorting on the tags listed by actions are performed using:</p>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">-Q</span> EXP</tt>, <tt class="docutils literal"><span class="pre">--filter</span> EXP</tt></dt>
+<dd>Filter the tags listed by ACTION with EXP before printing.</dd>
+<dt><tt class="docutils literal"><span class="pre">-S</span> EXP</tt>, <tt class="docutils literal"><span class="pre">--sorter</span> EXP</tt></dt>
+<dd>Sort the tags listed by ACTION with EXP before printing.</dd>
+</dl>
+<p>These are discussed in the <a class="reference internal" href="#expression">EXPRESSION</a> section.</p>
+</div>
+<div class="section" id="examples">
+<h2>Examples</h2>
+<ul>
+<li><p class="first">List all tags in &quot;/path/to/tags&quot;:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -t /path/to/tags -l
+</pre>
+</li>
+<li><p class="first">List all tags in &quot;tags&quot; that start with &quot;mymethod&quot;:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -p - mymethod
+</pre>
+</li>
+<li><p class="first">List all tags matching &quot;mymethod&quot;, case insensitively:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -i - mymethod
+</pre>
+</li>
+<li><p class="first">List all tags start with &quot;myvar&quot;, and printing all fields (i.e., the whole line):</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -p -ne - myvar
+</pre>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="expression">
+<h1>EXPRESSION</h1>
+<p>Scheme-style expressions are used for the <tt class="docutils literal"><span class="pre">-Q</span></tt> and <tt class="docutils literal"><span class="pre">-S</span></tt> options. For those
+who doesn't know Scheme or Lisp, just remember:</p>
+<ul class="simple">
+<li>A function call is wrapped in a pair of parenthesis. The first item in it is
+the function/operator name, the others are arguments.</li>
+<li>Function calls can be nested.</li>
+<li>Missing values and boolean false are represented by <tt class="docutils literal">#f</tt>. <tt class="docutils literal">#t</tt> and all
+other values are considered to be true.</li>
+</ul>
+<p>So, <tt class="docutils literal">(+ 1 (+ 2 3))</tt> means add 2 and 3 first, then add the result with 1.
+<tt class="docutils literal">(and &quot;string&quot; 1 #t)</tt> means logical AND on <tt class="docutils literal">&quot;string&quot;</tt>, <tt class="docutils literal">1</tt> and <tt class="docutils literal">#t</tt>,
+and the result is true since there is no <tt class="docutils literal">#f</tt>.</p>
+<div class="section" id="filtering">
+<h2>Filtering</h2>
+<p>The tag entries that make the filter expression produces true value are printed
+by readtags.</p>
+<p>The basic operators for filtering are <tt class="docutils literal">eq?</tt>, <tt class="docutils literal">prefix?</tt>, <tt class="docutils literal">suffix?</tt>,
+<tt class="docutils literal">substr?</tt>, and <tt class="docutils literal">#/PATTERN/</tt>. Language common fields can be accessed using
+variables starting with <tt class="docutils literal">$</tt>, e.g., <tt class="docutils literal">$language</tt> represents the language field.
+For example:</p>
+<ul>
+<li><p class="first">List all tags start with &quot;myfunc&quot; in Python code files:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -p -Q <span class="literal string single">'(eq? $language &quot;Python&quot;)'</span> - myfunc
+</pre>
+</li>
+</ul>
+<p><tt class="docutils literal">downcase</tt> or <tt class="docutils literal">upcase</tt> operators can be used to perform case-insensitive
+matching:</p>
+<ul>
+<li><p class="first">List all tags containing &quot;my&quot;, case insensitively:</p>
+<blockquote>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(substr? (downcase $name) &quot;my&quot;)'</span> -l
+</pre>
+</blockquote>
+</li>
+</ul>
+<p>We have logical operators like <tt class="docutils literal">and</tt>, <tt class="docutils literal">or</tt> and <tt class="docutils literal">not</tt>. The value of a
+missing field is #f, so we could deal with missing fields:</p>
+<ul>
+<li><p class="first">List all tags containing &quot;impl&quot; in Python code files, but allow the
+<tt class="docutils literal">language:</tt> field to be missing:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="error">'</span><span class="operator">(</span>and <span class="operator">(</span>substr? <span class="name variable">$name</span> <span class="literal string double">&quot;impl&quot;</span><span class="operator">)</span><span class="literal string escape">\
+</span><span class="generic output"> (or (not $language)\
+ (eq? $language &quot;Python&quot;)))' -l</span>
+</pre>
+</li>
+</ul>
+<p><tt class="docutils literal">#/PATTERN/</tt> is for the case when string predicates (<tt class="docutils literal">prefix?</tt>, <tt class="docutils literal">suffix?</tt>,
+and <tt class="docutils literal">substr?</tt>) are not enough. You can use &quot;Posix extended regular expression&quot;
+as PATTERN.</p>
+<ul>
+<li><p class="first">List all tags inherits from the class &quot;A&quot;:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(#/(^|,) ?A(,|$)/ $inherits)'</span> -l
+</pre>
+</li>
+</ul>
+<p>Here <tt class="docutils literal">$inherits</tt> is a comma-separated class list like &quot;A,B,C&quot;, &quot;P, A, Q&quot;, or
+just &quot;A&quot;. Notice that this filter works on both situations where there's a
+space after each comma or there's not.</p>
+<p>Case-insensitive matching can be performed by <tt class="docutils literal">#/PATTERN/i</tt>:</p>
+<ul>
+<li><p class="first">List all tags inherits from the class &quot;A&quot; or &quot;a&quot;:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(#/(^|,) ?A(,|$)/i $inherits)'</span> -l
+</pre>
+</li>
+</ul>
+<p>To include &quot;/&quot; in a pattern, prefix <tt class="docutils literal">\</tt> to the &quot;/&quot;.</p>
+<p>NOTE: The above regular expression pattern for inspecting inheritances is just
+an example to show how to use <tt class="docutils literal">#/PATTERN/</tt> expression. Tags file generators
+have no consensus about the format of <tt class="docutils literal">inherits:</tt>, e.g., whether there should
+be a space after a comma. Even parsers in ctags have no consensus. Noticing the
+format of the <tt class="docutils literal">inherits:</tt> field of specific languages is needed for such
+queries.</p>
+<p>The expressions <tt class="docutils literal">#/PATTERN/</tt> and <tt class="docutils literal">#/PATTERN/i</tt> are for interactive use.
+Readtags also offers an alias <tt class="docutils literal"><span class="pre">string-&gt;regexp</span></tt>, so <tt class="docutils literal">#/PATTERN/</tt> is equal to
+<tt class="docutils literal"><span class="pre">(string-&gt;regexp</span> &quot;PATTERN&quot;)</tt>, and <tt class="docutils literal">#/PATTERN/i</tt> is equal to
+<tt class="docutils literal"><span class="pre">(string-&gt;regexp</span> &quot;PATTERN&quot; <span class="pre">:case-fold</span> #t)</tt>. <tt class="docutils literal"><span class="pre">string-&gt;regexp</span></tt> doesn't need
+to prefix <tt class="docutils literal">\</tt> for including &quot;/&quot; in a pattern. <tt class="docutils literal"><span class="pre">string-&gt;regexp</span></tt> may simplify
+a client tool building an expression. See also ctags-client-tools(7) for
+building expressions in your tool.</p>
+<p>Let's now consider missing fields. The tags file may have tag entries that has
+no <tt class="docutils literal">inherits:</tt> field. In that case <tt class="docutils literal">$inherits</tt> is #f, and the regular
+expression matching raises an error, since string operators only work for
+strings. To avoid this problem:</p>
+<ul>
+<li><p class="first">Safely list all tags inherits from the class &quot;A&quot;:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(and $inherits (#/(^|,) ?A(,|$)/ $inherits))'</span> -l
+</pre>
+</li>
+</ul>
+<p>This makes sure <tt class="docutils literal">$inherits</tt> is not missing first, then match it by regexp.</p>
+<p>Sometimes you want to keep tags where the field <em>is</em> missing. For example, your
+want to exclude reference tags, which is marked by the <tt class="docutils literal">extras:</tt> field, then
+you want to keep tags who doesn't have <tt class="docutils literal">extras:</tt> field since they are also
+not reference tags. Here's how to do it:</p>
+<ul>
+<li><p class="first">List all tags but the reference tags:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(or (not $extras) (#/(^|,) ?reference(,|$)/ $extras))'</span> -l
+</pre>
+</li>
+</ul>
+<p>Notice that <tt class="docutils literal">(not $extras)</tt> produces <tt class="docutils literal">#t</tt> when <tt class="docutils literal">$extras</tt> is missing, so
+the whole <tt class="docutils literal">or</tt> expression produces <tt class="docutils literal">#t</tt>.</p>
+<p>Run &quot;readtags -H filter&quot; to know about all valid functions and variables.</p>
+</div>
+<div class="section" id="sorting">
+<h2>Sorting</h2>
+<p>When sorting, the sorter expression is evaluated on two tag entries to decide
+which should sort before the other one, until the order of all tag entries is
+decided.</p>
+<p>In a sorter expression, <tt class="docutils literal">$</tt> and <tt class="docutils literal">&amp;</tt> are used to access the fields in the
+two tag entries, and let's call them $-entry and &amp;-entry. The sorter expression
+should have a value of -1, 0 or 1. The value -1 means the $-entry should be put
+above the &amp;-entry, 1 means the contrary, and 0 makes their order in the output
+uncertain.</p>
+<p>The core operator of sorting is <tt class="docutils literal">&lt;&gt;</tt>. It's used to compare two strings or two
+numbers (numbers are for the <tt class="docutils literal">line:</tt> or <tt class="docutils literal">end:</tt> fields). In <tt class="docutils literal">(&lt;&gt; a b)</tt>, if
+<tt class="docutils literal">a</tt> &lt; <tt class="docutils literal">b</tt>, the result is -1; <tt class="docutils literal">a</tt> &gt; <tt class="docutils literal">b</tt> produces 1, and <tt class="docutils literal">a</tt> = <tt class="docutils literal">b</tt>
+produces 0. Strings are compared using the <tt class="docutils literal">strcmp</tt> function, see strcmp(3).</p>
+<p>For example, sort by names, and make those shorter or alphabetically smaller
+ones appear before the others:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -S <span class="literal string single">'(&lt;&gt; $name &amp;name)'</span> -l
+</pre>
+<p>This reads &quot;If the tag name in the $-entry is smaller, it goes before the
+&amp;-entry&quot;.</p>
+<p>The <tt class="docutils literal">&lt;or&gt;</tt> operator is used to chain multiple expressions until one returns
+-1 or 1. For example, sort by input file names, then line numbers if in the
+same file:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -S <span class="literal string single">'(&lt;or&gt; (&lt;&gt; $input &amp;input) (&lt;&gt; $line &amp;line))'</span> -l
+</pre>
+<p>The <tt class="docutils literal">*-</tt> operator is used to flip the compare result. i.e., <tt class="docutils literal">(*- (&lt;&gt; a b))</tt>
+is the same as <tt class="docutils literal">(&lt;&gt; b a)</tt>.</p>
+<p>Filter expressions can be used in sorter expressions. The technique is use
+<tt class="docutils literal">if</tt> to produce integers that can be compared based on the filter, like:</p>
+<pre class="code lisp literal-block">
+<span class="punctuation">(</span><span class="name variable">&lt;&gt;</span> <span class="punctuation">(</span><span class="keyword">if</span> <span class="name variable">filter-expr-on-$-entry</span> <span class="literal number integer">-1</span> <span class="literal number integer">1</span><span class="punctuation">)</span>
+ <span class="punctuation">(</span><span class="keyword">if</span> <span class="name variable">filter-expr-on-&amp;-entry</span> <span class="literal number integer">-1</span> <span class="literal number integer">1</span><span class="punctuation">))</span>
+</pre>
+<p>So if $-entry satisfies the filter, while &amp;-entry doesn't, it's the same as
+<tt class="docutils literal">(&lt;&gt; <span class="pre">-1</span> 1)</tt>, which produces <tt class="docutils literal"><span class="pre">-1</span></tt>.</p>
+<p>For example, we want to put tags with &quot;file&quot; kind below other tags, then the
+sorter would look like:</p>
+<pre class="code lisp literal-block">
+<span class="punctuation">(</span><span class="name variable">&lt;&gt;</span> <span class="punctuation">(</span><span class="keyword">if</span> <span class="punctuation">(</span><span class="name variable">eq?</span> <span class="name variable">$kind</span> <span class="literal string">&quot;file&quot;</span><span class="punctuation">)</span> <span class="literal number integer">1</span> <span class="literal number integer">-1</span><span class="punctuation">)</span>
+ <span class="punctuation">(</span><span class="keyword">if</span> <span class="punctuation">(</span><span class="name variable">eq?</span> <span class="name variable">&amp;kind</span> <span class="literal string">&quot;file&quot;</span><span class="punctuation">)</span> <span class="literal number integer">1</span> <span class="literal number integer">-1</span><span class="punctuation">))</span>
+</pre>
+<p>A quick read tells us: If $-entry has &quot;file&quot; kind, and &amp;-entry doesn't, the
+sorter becomes <tt class="docutils literal">(&lt;&gt; 1 <span class="pre">-1)</span></tt>, which produces <tt class="docutils literal">1</tt>, so the $-entry is put below
+the &amp;-entry, exactly what we want.</p>
+</div>
+<div class="section" id="inspecting-the-behavior-of-expressions">
+<h2>Inspecting the Behavior of Expressions</h2>
+<p>The <cite>print</cite> operator can be used to print the value of an expression. For
+example:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(print $name)'</span> -l
+</pre>
+<p>prints the name of each tag entry before it. Since the return value of
+<tt class="docutils literal">print</tt> is not #f, all the tag entries are printed. We could control this
+using the <tt class="docutils literal">begin</tt> or <tt class="docutils literal">begin0</tt> operator. <tt class="docutils literal">begin</tt> returns the value of its
+last argument, and <tt class="docutils literal">begin0</tt> returns the value of its first argument. For
+example:</p>
+<pre class="code console literal-block">
+<span class="generic prompt">$ </span>readtags -Q <span class="literal string single">'(begin0 #f (print (prefix? &quot;ctags&quot; &quot;ct&quot;)))'</span> -l
+</pre>
+<p>prints a bunch of &quot;#t&quot; (depending on how many lines are in the tags file), and
+the actual tag entries are not printed.</p>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>See tags(5) for the details of tags file format.</p>
+<p>See ctags-client-tools(7) for the tips writing a
+tool utilizing tags file.</p>
+<p>The official Universal Ctags web site at:</p>
+<p><a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>The git repository for the library used in readtags command:</p>
+<p><a class="reference external" href="https://github.com/universal-ctags/libreadtags">https://github.com/universal-ctags/libreadtags</a></p>
+</div>
+<div class="section" id="credits">
+<h1>CREDITS</h1>
+<p>Universal Ctags project
+<a class="reference external" href="https://ctags.io/">https://ctags.io/</a></p>
+<p>Darren Hiebert &lt;<a class="reference external" href="mailto:dhiebert&#64;users.sourceforge.net">dhiebert&#64;users.sourceforge.net</a>&gt;
+<a class="reference external" href="http://DarrenHiebert.com/">http://DarrenHiebert.com/</a></p>
+<p>The readtags command and libreadtags maintained at Universal Ctags
+are derived from readtags.c and readtags.h developd at
+<a class="reference external" href="http://ctags.sourceforge.net">http://ctags.sourceforge.net</a>.</p>
+</div>
+</div>
+</body>
+</html>
diff --git a/ctags/man/tags.5.html b/ctags/man/tags.5.html
new file mode 100644
index 0000000..2d312eb
--- /dev/null
+++ b/ctags/man/tags.5.html
@@ -0,0 +1,870 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+<title>tags</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+ border: 0 }
+
+table.borderless td, table.borderless th {
+ /* Override padding for "table.docutils td" with "! important".
+ The right padding separates the table cells. */
+ padding: 0 0.5em 0 0 ! important }
+
+.first {
+ /* Override more specific margin styles with "! important". */
+ margin-top: 0 ! important }
+
+.last, .with-subtitle {
+ margin-bottom: 0 ! important }
+
+.hidden {
+ display: none }
+
+.subscript {
+ vertical-align: sub;
+ font-size: smaller }
+
+.superscript {
+ vertical-align: super;
+ font-size: smaller }
+
+a.toc-backref {
+ text-decoration: none ;
+ color: black }
+
+blockquote.epigraph {
+ margin: 2em 5em ; }
+
+dl.docutils dd {
+ margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+ overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+ font-weight: bold }
+*/
+
+div.abstract {
+ margin: 2em 5em }
+
+div.abstract p.topic-title {
+ font-weight: bold ;
+ text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+ margin: 2em ;
+ border: medium outset ;
+ padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+ font-weight: bold ;
+ font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+ color: red ;
+ font-weight: bold ;
+ font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+ compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+ margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+ margin-top: 0.5em }
+*/
+
+div.dedication {
+ margin: 2em 5em ;
+ text-align: center ;
+ font-style: italic }
+
+div.dedication p.topic-title {
+ font-weight: bold ;
+ font-style: normal }
+
+div.figure {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+div.footer, div.header {
+ clear: both;
+ font-size: smaller }
+
+div.line-block {
+ display: block ;
+ margin-top: 1em ;
+ margin-bottom: 1em }
+
+div.line-block div.line-block {
+ margin-top: 0 ;
+ margin-bottom: 0 ;
+ margin-left: 1.5em }
+
+div.sidebar {
+ margin: 0 0 0.5em 1em ;
+ border: medium outset ;
+ padding: 1em ;
+ background-color: #ffffee ;
+ width: 40% ;
+ float: right ;
+ clear: right }
+
+div.sidebar p.rubric {
+ font-family: sans-serif ;
+ font-size: medium }
+
+div.system-messages {
+ margin: 5em }
+
+div.system-messages h1 {
+ color: red }
+
+div.system-message {
+ border: medium outset ;
+ padding: 1em }
+
+div.system-message p.system-message-title {
+ color: red ;
+ font-weight: bold }
+
+div.topic {
+ margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+ margin-top: 0.4em }
+
+h1.title {
+ text-align: center }
+
+h2.subtitle {
+ text-align: center }
+
+hr.docutils {
+ width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+ clear: left ;
+ float: left ;
+ margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+ clear: right ;
+ float: right ;
+ margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left }
+
+.align-center {
+ clear: both ;
+ text-align: center }
+
+.align-right {
+ text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+ text-align: inherit }
+
+/* div.align-center * { */
+/* text-align: left } */
+
+.align-top {
+ vertical-align: top }
+
+.align-middle {
+ vertical-align: middle }
+
+.align-bottom {
+ vertical-align: bottom }
+
+ol.simple, ul.simple {
+ margin-bottom: 1em }
+
+ol.arabic {
+ list-style: decimal }
+
+ol.loweralpha {
+ list-style: lower-alpha }
+
+ol.upperalpha {
+ list-style: upper-alpha }
+
+ol.lowerroman {
+ list-style: lower-roman }
+
+ol.upperroman {
+ list-style: upper-roman }
+
+p.attribution {
+ text-align: right ;
+ margin-left: 50% }
+
+p.caption {
+ font-style: italic }
+
+p.credits {
+ font-style: italic ;
+ font-size: smaller }
+
+p.label {
+ white-space: nowrap }
+
+p.rubric {
+ font-weight: bold ;
+ font-size: larger ;
+ color: maroon ;
+ text-align: center }
+
+p.sidebar-title {
+ font-family: sans-serif ;
+ font-weight: bold ;
+ font-size: larger }
+
+p.sidebar-subtitle {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+p.topic-title {
+ font-weight: bold }
+
+pre.address {
+ margin-bottom: 0 ;
+ margin-top: 0 ;
+ font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+ margin-left: 2em ;
+ margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+ font-family: sans-serif ;
+ font-style: oblique }
+
+span.classifier-delimiter {
+ font-family: sans-serif ;
+ font-weight: bold }
+
+span.interpreted {
+ font-family: sans-serif }
+
+span.option {
+ white-space: nowrap }
+
+span.pre {
+ white-space: pre }
+
+span.problematic {
+ color: red }
+
+span.section-subtitle {
+ /* font-size relative to parent (h1..h6 element) */
+ font-size: 80% }
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px }
+
+table.docinfo {
+ margin: 2em 4em }
+
+table.docutils {
+ margin-top: 0.5em ;
+ margin-bottom: 0.5em }
+
+table.footnote {
+ border-left: solid 1px black;
+ margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+ padding-left: 0.5em ;
+ padding-right: 0.5em ;
+ vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+ font-weight: bold ;
+ text-align: left ;
+ white-space: nowrap ;
+ padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+ border: 0px;
+ border-top: 2px solid;
+ border-bottom: 2px solid;
+ border-collapse: collapse;
+}
+table.docutils.booktabs * {
+ border: 0px;
+}
+table.docutils.booktabs th {
+ border-bottom: thin solid;
+ text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+ font-size: 100% }
+
+ul.auto-toc {
+ list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="tags">
+<span id="tags-5"></span>
+<h1 class="title">tags</h1>
+<h2 class="subtitle" id="vi-tags-file-format-extended-in-ctags-projects">Vi tags file format extended in ctags projects</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Version:</th>
+<td>2+</td></tr>
+<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td>
+</tr>
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">5</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>The contents of next section is a copy of FORMAT file in Exuberant
+Ctags source code in its subversion repository at sourceforge.net.</p>
+<p>Exceptions introduced in Universal Ctags are explained inline with
+&quot;EXCEPTION&quot; marker.</p>
+</div>
+<hr class="docutils" />
+<div class="section" id="proposal-for-extended-vi-tags-file-format">
+<h1>Proposal for extended Vi tags file format</h1>
+<div class="line-block">
+<div class="line">Version: 0.06 DRAFT</div>
+<div class="line">Date: 1998 Feb 8</div>
+<div class="line">Author: Bram Moolenaar &lt;Bram at vim.org&gt; and Darren Hiebert &lt;dhiebert at users.sourceforge.net&gt;</div>
+</div>
+<div class="section" id="introduction">
+<h2>Introduction</h2>
+<p>The file format for the &quot;tags&quot; file, as used by Vi and many of its
+descendants, has limited capabilities.</p>
+<p>This additional functionality is desired:</p>
+<ol class="arabic simple">
+<li>Static or local tags.
+The scope of these tags is the file where they are defined. The same tag
+can appear in several files, without really being a duplicate.</li>
+<li>Duplicate tags.
+Allow the same tag to occur more then once. They can be located in
+a different file and/or have a different command.</li>
+<li>Support for C++.
+A tag is not only specified by its name, but also by the context (the
+class name).</li>
+<li>Future extension.
+When even more additional functionality is desired, it must be possible to
+add this later, without breaking programs that don't support it.</li>
+</ol>
+</div>
+<div class="section" id="from-proposal-to-standard">
+<h2>From proposal to standard</h2>
+<p>To make this proposal into a standard for tags files, it needs to be supported
+by most people working on versions of Vi, ctags, etc.. Currently this
+standard is supported by:</p>
+<dl class="docutils">
+<dt>Darren Hiebert &lt;dhiebert at users.sourceforge.net&gt;</dt>
+<dd>Exuberant Ctags</dd>
+<dt>Bram Moolenaar &lt;Bram at vim.org&gt;</dt>
+<dd>Vim (Vi IMproved)</dd>
+</dl>
+<p>These have been or will be asked to support this standard:</p>
+<dl class="docutils">
+<dt>Nvi</dt>
+<dd>Keith Bostic &lt;bostic at bsdi.com&gt;</dd>
+<dt>Vile</dt>
+<dd>Tom E. Dickey &lt;dickey at clark.net&gt;</dd>
+<dt>NEdit</dt>
+<dd>Mark Edel &lt;edel at ltx.com&gt;</dd>
+<dt>CRiSP</dt>
+<dd>Paul Fox &lt;fox at crisp.demon.co.uk&gt;</dd>
+<dt>Lemmy</dt>
+<dd>James Iuliano &lt;jai at accessone.com&gt;</dd>
+<dt>Zeus</dt>
+<dd>Jussi Jumppanen &lt;jussij at ca.com.au&gt;</dd>
+<dt>Elvis</dt>
+<dd>Steve Kirkendall &lt;kirkenda at cs.pdx.edu&gt;</dd>
+<dt>FTE</dt>
+<dd>Marko Macek &lt;Marko.Macek at snet.fri.uni-lj.si&gt;</dd>
+</dl>
+</div>
+<div class="section" id="backwards-compatibility">
+<h2>Backwards compatibility</h2>
+<p>A tags file that is generated in the new format should still be usable by Vi.
+This makes it possible to distribute tags files that are usable by all
+versions and descendants of Vi.</p>
+<p>This restricts the format to what Vi can handle. The format is:</p>
+<ol class="arabic">
+<li><p class="first">The tags file is a list of lines, each line in the format:</p>
+<pre class="literal-block">
+{tagname}&lt;Tab&gt;{tagfile}&lt;Tab&gt;{tagaddress}
+</pre>
+<dl class="docutils">
+<dt>{tagname}</dt>
+<dd><p class="first">Any identifier, not containing white space..</p>
+<p class="last">EXCEPTION: Universal Ctags violates this item of the proposal;
+tagname may contain spaces. However, tabs are not allowed.</p>
+</dd>
+<dt>&lt;Tab&gt;</dt>
+<dd><p class="first last">Exactly one TAB character (although many versions of Vi can
+handle any amount of white space).</p>
+</dd>
+<dt>{tagfile}</dt>
+<dd><p class="first last">The name of the file where {tagname} is defined, relative to
+the current directory (or location of the tags file?).</p>
+</dd>
+<dt>{tagaddress}</dt>
+<dd><p class="first last">Any Ex command. When executed, it behaves like 'magic' was
+not set.</p>
+</dd>
+</dl>
+</li>
+<li><p class="first">The tags file is sorted on {tagname}. This allows for a binary search in
+the file.</p>
+</li>
+<li><p class="first">Duplicate tags are allowed, but which one is actually used is
+unpredictable (because of the binary search).</p>
+</li>
+</ol>
+<p>The best way to add extra text to the line for the new functionality, without
+breaking it for Vi, is to put a comment in the {tagaddress}. This gives the
+freedom to use any text, and should work in any traditional Vi implementation.</p>
+<p>For example, when the old tags file contains:</p>
+<pre class="literal-block">
+main main.c /^main(argc, argv)$/
+DEBUG defines.c 89
+</pre>
+<p>The new lines can be:</p>
+<pre class="literal-block">
+main main.c /^main(argc, argv)$/;&quot;any additional text
+DEBUG defines.c 89;&quot;any additional text
+</pre>
+<p>Note that the ';' is required to put the cursor in the right line, and then
+the '&quot;' is recognized as the start of a comment.</p>
+<p>For Posix compliant Vi versions this will NOT work, since only a line number
+or a search command is recognized. I hope Posix can be adjusted. Nvi suffers
+from this.</p>
+</div>
+<div class="section" id="security">
+<h2>Security</h2>
+<p>Vi allows the use of any Ex command in a tags file. This has the potential of
+a trojan horse security leak.</p>
+<p>The proposal is to allow only Ex commands that position the cursor in a single
+file. Other commands, like editing another file, quitting the editor,
+changing a file or writing a file, are not allowed. It is therefore logical
+to call the command a tagaddress.</p>
+<p>Specifically, these two Ex commands are allowed:</p>
+<ul>
+<li><p class="first">A decimal line number:</p>
+<pre class="literal-block">
+89
+</pre>
+</li>
+<li><p class="first">A search command. It is a regular expression pattern, as used by Vi,
+enclosed in // or ??:</p>
+<pre class="literal-block">
+/^int c;$/
+?main()?
+</pre>
+</li>
+</ul>
+<p>There are two combinations possible:</p>
+<ul>
+<li><p class="first">Concatenation of the above, with ';' in between. The meaning is that the
+first line number or search command is used, the cursor is positioned in
+that line, and then the second search command is used (a line number would
+not be useful). This can be done multiple times. This is useful when the
+information in a single line is not unique, and the search needs to start
+in a specified line.</p>
+<pre class="literal-block">
+/struct xyz {/;/int count;/
+389;/struct foo/;/char *s;/
+</pre>
+</li>
+<li><p class="first">A trailing comment can be added, starting with ';&quot;' (two characters:
+semi-colon and double-quote). This is used below.</p>
+<pre class="literal-block">
+89;&quot; foo bar
+</pre>
+</li>
+</ul>
+<p>This might be extended in the future. What is currently missing is a way to
+position the cursor in a certain column.</p>
+</div>
+<div class="section" id="goals">
+<h2>Goals</h2>
+<p>Now the usage of the comment text has to be defined. The following is aimed
+at:</p>
+<ol class="arabic simple">
+<li>Keep the text short, because:<ul>
+<li>The line length that Vi can handle is limited to 512 characters.</li>
+<li>Tags files can contain thousands of tags. I have seen tags files of
+several Mbytes.</li>
+<li>More text makes searching slower.</li>
+</ul>
+</li>
+<li>Keep the text readable, because:<ul>
+<li>It is often necessary to check the output of a new ctags program.</li>
+<li>Be able to edit the file by hand.</li>
+<li>Make it easier to write a program to produce or parse the file.</li>
+</ul>
+</li>
+<li>Don't use special characters, because:<ul>
+<li>It should be possible to treat a tags file like any normal text file.</li>
+</ul>
+</li>
+</ol>
+</div>
+<div class="section" id="proposal">
+<h2>Proposal</h2>
+<p>Use a comment after the {tagaddress} field. The format would be:</p>
+<pre class="literal-block">
+{tagname}&lt;Tab&gt;{tagfile}&lt;Tab&gt;{tagaddress}[;&quot;&lt;Tab&gt;{tagfield}..]
+</pre>
+<dl class="docutils">
+<dt>{tagname}</dt>
+<dd><p class="first">Any identifier, not containing white space..</p>
+<p class="last">EXCEPTION: Universal Ctags violates this item of the proposal;
+name may contain spaces. However, tabs are not allowed.
+Conversion, for some characters including &lt;Tab&gt; in the &quot;value&quot;,
+explained in the last of this section is applied.</p>
+</dd>
+<dt>&lt;Tab&gt;</dt>
+<dd>Exactly one TAB character (although many versions of Vi can
+handle any amount of white space).</dd>
+<dt>{tagfile}</dt>
+<dd>The name of the file where {tagname} is defined, relative to
+the current directory (or location of the tags file?).</dd>
+<dt>{tagaddress}</dt>
+<dd>Any Ex command. When executed, it behaves like 'magic' was
+not set. It may be restricted to a line number or a search
+pattern (Posix).</dd>
+</dl>
+<p>Optionally:</p>
+<dl class="docutils">
+<dt>;&quot;</dt>
+<dd>semicolon + doublequote: Ends the tagaddress in way that looks
+like the start of a comment to Vi.</dd>
+<dt>{tagfield}</dt>
+<dd>See below.</dd>
+</dl>
+<p>A tagfield has a name, a colon, and a value: &quot;name:value&quot;.</p>
+<ul>
+<li><p class="first">The name consist only out of alphabetical characters. Upper and lower case
+are allowed. Lower case is recommended. Case matters (&quot;kind:&quot; and &quot;Kind:
+are different tagfields).</p>
+<p>EXCEPTION: Universal Ctags allows users to use a numerical character
+in the name other than its initial letter.</p>
+</li>
+<li><p class="first">The value may be empty.
+It cannot contain a &lt;Tab&gt;.</p>
+<ul class="simple">
+<li>When a value contains a <tt class="docutils literal">\t</tt>, this stands for a &lt;Tab&gt;.</li>
+<li>When a value contains a <tt class="docutils literal">\r</tt>, this stands for a &lt;CR&gt;.</li>
+<li>When a value contains a <tt class="docutils literal">\n</tt>, this stands for a &lt;NL&gt;.</li>
+<li>When a value contains a <tt class="docutils literal">\\</tt>, this stands for a single <tt class="docutils literal">\</tt> character.</li>
+</ul>
+<p>Other use of the backslash character is reserved for future expansion.
+Warning: When a tagfield value holds an MS-DOS file name, the backslashes
+must be doubled!</p>
+<p>EXCEPTION: Universal Ctags introduces more conversion rules.</p>
+<ul class="simple">
+<li>When a value contains a <tt class="docutils literal">\a</tt>, this stands for a &lt;BEL&gt; (0x07).</li>
+<li>When a value contains a <tt class="docutils literal">\b</tt>, this stands for a &lt;BS&gt; (0x08).</li>
+<li>When a value contains a <tt class="docutils literal">\v</tt>, this stands for a &lt;VT&gt; (0x0b).</li>
+<li>When a value contains a <tt class="docutils literal">\f</tt>, this stands for a &lt;FF&gt; (0x0c).</li>
+<li>The characters in range 0x01 to 0x1F included, and 0x7F are
+converted to <tt class="docutils literal">\x</tt> prefixed hexadecimal number if the characters are
+not handled in the above &quot;value&quot; rules.</li>
+<li>The leading space (0x20) and <tt class="docutils literal">!</tt> (0x21) in {tagname} are converted
+to <tt class="docutils literal">\x</tt> prefixed hexadecimal number (<tt class="docutils literal">\x20</tt> and <tt class="docutils literal">\x21</tt>) if the
+tag is not a pseudo-tag. As described later, a pseudo-tag starts with
+<tt class="docutils literal">!</tt>. These rules are for distinguishing pseudo-tags and non pseudo-tags
+(regular tags) when tags lines in a tag file are sorted.</li>
+</ul>
+</li>
+</ul>
+<p>Proposed tagfield names:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="84%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">FIELD-NAME</th>
+<th class="head">DESCRIPTION</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>arity</td>
+<td>Number of arguments for a function tag.</td>
+</tr>
+<tr><td>class</td>
+<td>Name of the class for which this tag is a member or method.</td>
+</tr>
+<tr><td>enum</td>
+<td>Name of the enumeration in which this tag is an enumerator.</td>
+</tr>
+<tr><td>file</td>
+<td>Static (local) tag, with a scope of the specified file. When
+the value is empty, {tagfile} is used.</td>
+</tr>
+<tr><td>function</td>
+<td>Function in which this tag is defined. Useful for local
+variables (and functions). When functions nest (e.g., in
+Pascal), the function names are concatenated, separated with
+'/', so it looks like a path.</td>
+</tr>
+<tr><td>kind</td>
+<td><p class="first">Kind of tag. The value depends on the language. For C and
+C++ these kinds are recommended:</p>
+<dl class="docutils">
+<dt>c</dt>
+<dd>class name</dd>
+<dt>d</dt>
+<dd>define (from #define XXX)</dd>
+<dt>e</dt>
+<dd>enumerator</dd>
+<dt>f</dt>
+<dd>function or method name</dd>
+<dt>F</dt>
+<dd>file name</dd>
+<dt>g</dt>
+<dd>enumeration name</dd>
+<dt>m</dt>
+<dd>member (of structure or class data)</dd>
+<dt>p</dt>
+<dd>function prototype</dd>
+<dt>s</dt>
+<dd>structure name</dd>
+<dt>t</dt>
+<dd>typedef</dd>
+<dt>u</dt>
+<dd>union name</dd>
+<dt>v</dt>
+<dd>variable</dd>
+</dl>
+<p class="last">When this field is omitted, the kind of tag is undefined.</p>
+</td>
+</tr>
+<tr><td>struct</td>
+<td>Name of the struct in which this tag is a member.</td>
+</tr>
+<tr><td>union</td>
+<td>Name of the union in which this tag is a member.</td>
+</tr>
+</tbody>
+</table>
+<p>Note that these are mostly for C and C++. When tags programs are written for
+other languages, this list should be extended to include the used field names.
+This will help users to be independent of the tags program used.</p>
+<p>Examples:</p>
+<pre class="literal-block">
+asdf sub.cc /^asdf()$/;&quot; new_field:some\svalue file:
+foo_t sub.h /^typedef foo_t$/;&quot; kind:t
+func3 sub.p /^func3()$/;&quot; function:/func1/func2 file:
+getflag sub.c /^getflag(arg)$/;&quot; kind:f file:
+inc sub.cc /^inc()$/;&quot; file: class:PipeBuf
+</pre>
+<p>The name of the &quot;kind:&quot; field can be omitted. This is to reduce the size of
+the tags file by about 15%. A program reading the tags file can recognize the
+&quot;kind:&quot; field by the missing ':'. Examples:</p>
+<pre class="literal-block">
+foo_t sub.h /^typedef foo_t$/;&quot; t
+getflag sub.c /^getflag(arg)$/;&quot; f file:
+</pre>
+<p>Additional remarks:</p>
+<ul class="simple">
+<li>When a tagfield appears twice in a tag line, only the last one is used.</li>
+</ul>
+<p>Note about line separators:</p>
+<p>Vi traditionally runs on Unix systems, where the line separator is a single
+linefeed character &lt;NL&gt;. On MS-DOS and compatible systems &lt;CR&gt;&lt;NL&gt; is the
+standard line separator. To increase portability, this line separator is also
+supported.</p>
+<p>On the Macintosh a single &lt;CR&gt; is used for line separator. Supporting this on
+Unix systems causes problems, because most fgets() implementation don't see
+the &lt;CR&gt; as a line separator. Therefore the support for a &lt;CR&gt; as line
+separator is limited to the Macintosh.</p>
+<p>Summary:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="36%" />
+<col width="41%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">line separator</th>
+<th class="head">generated on</th>
+<th class="head">accepted on</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>&lt;LF&gt;</td>
+<td>Unix</td>
+<td>Unix, MS-DOS, Macintosh</td>
+</tr>
+<tr><td>&lt;CR&gt;</td>
+<td>Macintosh</td>
+<td>Macintosh</td>
+</tr>
+<tr><td>&lt;CR&gt;&lt;LF&gt;</td>
+<td>MS-DOS</td>
+<td>Unix, MS-DOS, Macintosh</td>
+</tr>
+</tbody>
+</table>
+<p>The characters &lt;CR&gt; and &lt;LF&gt; cannot be used inside a tag line. This is not
+mentioned elsewhere (because it's obvious).</p>
+<p>Note about white space:</p>
+<p>Vi allowed any white space to separate the tagname from the tagfile, and the
+filename from the tagaddress. This would need to be allowed for backwards
+compatibility. However, all known programs that generate tags use a single
+&lt;Tab&gt; to separate fields.</p>
+<p>There is a problem for using file names with embedded white space in the
+tagfile field. To work around this, the same special characters could be used
+as in the new fields, for example <tt class="docutils literal">\s</tt>. But, unfortunately, in MS-DOS the
+backslash character is used to separate file names. The file name
+<tt class="docutils literal"><span class="pre">c:\vim\sap</span></tt> contains <tt class="docutils literal">\s</tt>, but this is not a &lt;Space&gt;. The number of
+backslashes could be doubled, but that will add a lot of characters, and make
+parsing the tags file slower and clumsy.</p>
+<p>To avoid these problems, we will only allow a &lt;Tab&gt; to separate fields, and
+not support a file name or tagname that contains a &lt;Tab&gt; character. This
+means that we are not 100% Vi compatible. However, there is no known tags
+program that uses something else than a &lt;Tab&gt; to separate the fields. Only
+when a user typed the tags file himself, or made his own program to generate a
+tags file, we could run into problems. To solve this, the tags file should be
+filtered, to replace the arbitrary white space with a single &lt;Tab&gt;. This Vi
+command can be used:</p>
+<pre class="literal-block">
+:%s/^\([^ ^I]*\)[ ^I]*\([^ ^I]*\)[ ^I]*/\1^I\2^I/
+</pre>
+<p>(replace ^I with a real &lt;Tab&gt;).</p>
+<p>TAG FILE INFORMATION:</p>
+<p>Pseudo-tag lines can be used to encode information into the tag file regarding
+details about its content (e.g. have the tags been sorted?, are the optional
+tagfields present?), and regarding the program used to generate the tag file.
+This information can be used both to optimize use of the tag file (e.g.
+enable/disable binary searching) and provide general information (what version
+of the generator was used).</p>
+<p>The names of the tags used in these lines may be suitably chosen to ensure
+that when sorted, they will always be located near the first lines of the tag
+file. The use of &quot;!_TAG_&quot; is recommended. Note that a rare tag like &quot;!&quot;
+can sort to before these lines. The program reading the tags file should be
+smart enough to skip over these tags.</p>
+<p>The lines described below have been chosen to convey a select set of
+information.</p>
+<p>Tag lines providing information about the content of the tag file:</p>
+<pre class="literal-block">
+!_TAG_FILE_FORMAT {version-number} /optional comment/
+!_TAG_FILE_SORTED {0|1} /0=unsorted, 1=sorted/
+</pre>
+<p>The {version-number} used in the tag file format line reserves the value of
+&quot;1&quot; for tag files complying with the original UNIX vi/ctags format, and
+reserves the value &quot;2&quot; for tag files complying with this proposal. This value
+may be used to determine if the extended features described in this proposal
+are present.</p>
+<p>Tag lines providing information about the program used to generate the tag
+file, and provided solely for documentation purposes:</p>
+<pre class="literal-block">
+!_TAG_PROGRAM_AUTHOR {author-name} /{email-address}/
+!_TAG_PROGRAM_NAME {program-name} /optional comment/
+!_TAG_PROGRAM_URL {URL} /optional comment/
+!_TAG_PROGRAM_VERSION {version-id} /optional comment/
+</pre>
+<p>EXCEPTION: Universal Ctags introduces more kinds of pseudo-tags.
+See ctags-client-tools(7) about them.</p>
+</div>
+</div>
+<hr class="docutils" />
+<div class="section" id="exceptions-in-universal-ctags">
+<h1>Exceptions in Universal Ctags</h1>
+<p>Universal Ctags supports this proposal with some
+exceptions.</p>
+<div class="section" id="exceptions">
+<h2>Exceptions</h2>
+<ol class="arabic simple">
+<li>{tagname} in tags file generated by Universal Ctags may contain
+spaces and several escape sequences. Parsers for documents like Tex and
+reStructuredText, or liberal languages such as JavaScript need these
+exceptions. See {tagname} of Proposal section for more detail about the
+conversion.</li>
+<li>&quot;name&quot; part of {tagfield} in a tag generated by Universal Ctags may
+contain numeric characters, but the first character of the &quot;name&quot;
+must be alphabetic.<!-- NOT REVIEWED YET (above item) -->
+</li>
+</ol>
+</div>
+<div class="section" id="compatible-output-and-weakness">
+<span id="compat-output"></span><h2>Compatible output and weakness</h2>
+<!-- NOT REVIEWED YET -->
+<p>Default behavior (<tt class="docutils literal"><span class="pre">--output-format=u-ctags</span></tt> option) has the
+exceptions. In other hand, with <tt class="docutils literal"><span class="pre">--output-format=e-ctags</span></tt> option
+ctags has no exception; Universal Ctags command may use the same file
+format as Exuberant Ctags. However, <tt class="docutils literal"><span class="pre">--output-format=e-ctags</span></tt> throws
+away a tag entry which name includes a space or a tab
+character. <tt class="docutils literal">TAG_OUTPUT_MODE</tt> pseudo-tag tells which format is
+used when ctags generating tags file.</p>
+</div>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>ctags(1), ctags-client-tools(7), ctags-incompatibilities(7), readtags(1)</p>
+</div>
+</div>
+</body>
+</html>