blob: d2b532b2e0d5b40cca9e8af048c15274f4cdc773 [file]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>Details of texindex (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Details of texindex (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Details of texindex (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Format-with-tex_002ftexindex.html" rel="up" title="Format with tex/texindex">
<link href="Formatting-Partial-Documents.html" rel="prev" title="Formatting Partial Documents">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Details-of-texindex">
<div class="nav-panel">
<p>
Previous: <a href="Formatting-Partial-Documents.html" accesskey="p" rel="prev">Formatting Partial Documents</a>, Up: <a href="Format-with-tex_002ftexindex.html" accesskey="u" rel="up">Format with <code class="command">tex</code>/<code class="command">texindex</code></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Details-of-texindex-1">18.3.2 Details of <code class="command">texindex</code></h4>
<a class="index-entry-id" id="index-Braces_002c-in-index-entries"></a>
<p>In Texinfo version 6, released in 2015, the <code class="command">texindex</code> program
was completely reimplemented. The principal functional difference is
that index entries beginning with a left brace or right brace
(&lsquo;<samp class="samp">{</samp>&rsquo; resp. &lsquo;<samp class="samp">}</samp>&rsquo;) can work properly. For example, these
simple index entries are processed correctly, including the &ldquo;index
initial&rdquo; shown in the index:
</p>
<div class="example">
<pre class="example-preformatted">@cindex @{
@cindex @}
...
@printindex cp
</pre></div>
<a class="index-entry-id" id="index-Literate-programming_002c-with-Texinfo-and-awk"></a>
<a class="index-entry-id" id="index-Texinfo_002c-and-literate-programming"></a>
<a class="index-entry-id" id="index-Robbins_002c-Arnold"></a>
<a class="index-entry-id" id="index-texiwebjr"></a>
<a class="index-entry-id" id="index-ti_002etwjr"></a>
<p>Although not a matter of functionality, readers may be interested to
know that the new <code class="command">texindex</code> is a literate program
(<a class="url" href="http://en.wikipedia.org/wiki/Literate_programming">http://en.wikipedia.org/wiki/Literate_programming</a>) using
Texinfo for documentation and (portable) <code class="code">awk</code> for code. A
single source file, <samp class="file">texindex/ti.twjr</samp> in this case, produces the
runnable program, a printable document, and an online document.
</p>
<p>The system is called TexiWeb Jr. and was created by Arnold
Robbins, who also wrote the new <code class="command">texindex</code>. Not
coincidentally, he is also the long-time maintainer of <code class="command">gawk</code>
(GNU Awk, see <cite class="cite"><a data-manual="gawk" href="https://www.gnu.org/software/gawk/manual/html_node/index.html#Top">The GNU Awk User&rsquo;s Guide</a></cite>). The file
<samp class="file">texindex/Makefile.am</samp> shows example usage of the system.
</p>
</div>
</body>
</html>