Viewing File: /usr/share/doc/texinfo/html/Info-Format-Printindex.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Info Format Printindex (GNU Texinfo 6.7)</title>

<meta name="description" content="Info Format Printindex (GNU Texinfo 6.7)">
<meta name="keywords" content="Info Format Printindex (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<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="Info-Format-Text-Constructs.html" rel="up" title="Info Format Text Constructs">
<link href="Info-Format-Cross-Reference.html" rel="next" title="Info Format Cross Reference">
<link href="Info-Format-Image.html" rel="prev" title="Info Format Image">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Info-Format-Printindex"></span><div class="header">
<p>
Next: <a href="Info-Format-Cross-Reference.html" accesskey="n" rel="next">Info Format Cross Reference</a>, Previous: <a href="Info-Format-Image.html" accesskey="p" rel="prev">Info Format Image</a>, Up: <a href="Info-Format-Text-Constructs.html" accesskey="u" rel="up">Info Format Text Constructs</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>
<span id="Info-Format_003a-Printindex"></span><h4 class="subsection">G.2.3 Info Format: Printindex</h4>

<span id="index-Indices_002c-in-Info-format"></span>

<p>Indices in Info format are generally written as a menu
(see <a href="Indices.html">Indices</a>), but with an additional directive at the beginning
marking this as an index node:
</p>
<div class="example">
<pre class="example">    &lt;printindex&gt; =
^@^H[index^@^H]
* Menu:

&lt;index entry&gt;*
</pre></div>

<p>The <tt>&lt;index entry&gt;</tt> items are similar to normal menu entries, but
the free-format description is replaced by the line number of where
the entries occurs in the text:
</p>
<div class="example">
<pre class="example">    &lt;index entry&gt; =
* &lt;entry text&gt;: &lt;entry node&gt;. &lt;lparen&gt;line &lt;lineno&gt;&lt;rparen&gt;
</pre></div>

<p>The <tt>&lt;entry text&gt;</tt> is the index term.  The <tt>&lt;lineno&gt;</tt> is an
unsigned integer, given relative to the start of the <tt>&lt;entry node&gt;</tt>.
There may be arbitrary whitespace after the colon and period, as usual
in menus, and may be broken across lines.  Here is an example:
</p>
<div class="example">
<pre class="example">^@^H[index^@^H]
* Menu:

* thunder:           Weather Phenomena.             (line 5)
</pre></div>

<p>This means that an index entry for &lsquo;thunder&rsquo; appears at line 5 of the
node &lsquo;Weather Phenomena&rsquo;.
</p>




</body>
</html>
Back to Directory File Manager