/usr/share/doc/texinfo/html/Predefined-Indices.html is in texinfo-doc-nonfree 5.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | <!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 5.2, 26 September 2013),
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 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 the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below. A copy of the license
is included in the section entitled "GNU Free Documentation
License".
(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual. Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Predefined Indices</title>
<meta name="description" content="GNU Texinfo 5.2: Predefined Indices">
<meta name="keywords" content="GNU Texinfo 5.2: Predefined Indices">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Indices.html#Indices" rel="up" title="Indices">
<link href="Indexing-Commands.html#Indexing-Commands" rel="next" title="Indexing Commands">
<link href="Index-Entries.html#Index-Entries" rel="previous" title="Index Entries">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Predefined-Indices"></a>
<div class="header">
<p>
Next: <a href="Indexing-Commands.html#Indexing-Commands" accesskey="n" rel="next">Indexing Commands</a>, Previous: <a href="Index-Entries.html#Index-Entries" accesskey="p" rel="previous">Index Entries</a>, Up: <a href="Indices.html#Indices" accesskey="u" rel="up">Indices</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Predefined-Indices-1"></a>
<h3 class="section">13.2 Predefined Indices</h3>
<p>Texinfo provides six predefined indices. Here are their nominal
meanings, abbreviations, and the corresponding index entry commands:
</p>
<dl compact="compact">
<dt>‘<samp>cp</samp>’</dt>
<dd><a name="index-cp-_0028concept_0029-index"></a>
<a name="index-cindex"></a>
<p>(<code>@cindex</code>) concept index, for general concepts.
</p></dd>
<dt>‘<samp>fn</samp>’</dt>
<dd><a name="index-fn-_0028function_0029-index"></a>
<a name="index-findex"></a>
<p>(<code>@findex</code>) function index, for function and function-like
names (such as entry points of libraries).
</p></dd>
<dt>‘<samp>ky</samp>’</dt>
<dd><a name="index-ky-_0028keystroke_0029-index"></a>
<a name="index-kindex"></a>
<p>(<code>@kindex</code>) keystroke index, for keyboard commands.
</p></dd>
<dt>‘<samp>pg</samp>’</dt>
<dd><a name="index-pg-_0028program_0029-index"></a>
<a name="index-pindex"></a>
<p>(<code>@pindex</code>) program index, for names of programs.
</p></dd>
<dt>‘<samp>tp</samp>’</dt>
<dd><a name="index-tp-_0028data-type_0029-index"></a>
<a name="index-tindex"></a>
<p>(<code>@tindex</code>) data type index, for type names (such as structures
defined in header files).
</p></dd>
<dt>‘<samp>vr</samp>’</dt>
<dd><a name="index-vr-_0028variable_0029-index"></a>
<a name="index-vindex"></a>
<p>(<code>@vindex</code>) variable index, for variable names (such as global
variables of libraries).
</p></dd>
</dl>
<p>Not every manual needs all of these, and most manuals use only two or
three at most. The present manual, for example, has two indices: a
concept index and an @-command index (that is actually the function
index but is called a command index in the chapter heading).
</p>
<p>You are not required to use the predefined indices strictly for their
canonical purposes. For example, suppose you wish to index some C
preprocessor macros. You could put them in the function index along
with actual functions, just by writing <code>@findex</code> commands for
them; then, when you print the “Function Index” as an unnumbered
chapter, you could give it the title ‘Function and Macro Index’ and
all will be consistent for the reader.
</p>
<p>On the other hand, it is best not to stray too far from the meaning of
the predefined indices. Otherwise, in the event that your text is
combined with other text from other manuals, the index entries will
not match up. Instead, define your own new index (see <a href="New-Indices.html#New-Indices">New Indices</a>).
</p>
<p>We recommend having a single index in the final document whenever
possible, however many source indices you use, since then readers have
only one place to look. Two or more source indices can be combined
into one output index using the <code>@synindex</code> or
<code>@syncodeindex</code> commands (see <a href="Combining-Indices.html#Combining-Indices">Combining Indices</a>).
</p>
<hr>
<div class="header">
<p>
Next: <a href="Indexing-Commands.html#Indexing-Commands" accesskey="n" rel="next">Indexing Commands</a>, Previous: <a href="Index-Entries.html#Index-Entries" accesskey="p" rel="previous">Index Entries</a>, Up: <a href="Indices.html#Indices" accesskey="u" rel="up">Indices</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|