File Manager

Editing File: /usr/share/doc/texinfo/html/Predefined-Indices.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". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Predefined Indices (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<div class="header">

Next: <a href="Indexing-Commands.html" accesskey="n" rel="next">Indexing Commands</a>, Up: <a href="Indices.html" accesskey="u" rel="up">Indices</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>]
</div>
<hr>
<h3 class="section">11.1 Predefined Indices</h3>

Texinfo provides six predefined indices. Here are their nominal
meanings, abbreviations, and the corresponding index entry commands:

<dl compact="compact">
<dt>&lsquo;<samp>cp</samp>&rsquo;</dt>
<dd>

(<code>@cindex</code>) Concept index, for general concepts.
</dd>
<dt>&lsquo;<samp>fn</samp>&rsquo;</dt>
<dd>

(<code>@findex</code>) Function index, for function and function-like
names (such as entry points of libraries).
</dd>
<dt>&lsquo;<samp>ky</samp>&rsquo;</dt>
<dd>

(<code>@kindex</code>) Keystroke index, for keyboard commands.
</dd>
<dt>&lsquo;<samp>pg</samp>&rsquo;</dt>
<dd>

(<code>@pindex</code>) Program index, for names of programs.
</dd>
<dt>&lsquo;<samp>tp</samp>&rsquo;</dt>
<dd>

(<code>@tindex</code>) Data type index, for type names (such as structures
defined in header files).
</dd>
<dt>&lsquo;<samp>vr</samp>&rsquo;</dt>
<dd>

(<code>@vindex</code>) Variable index, for variable names (such as library global
variables).
</dd>
</dl>

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. (The latter is actually the function
index but is called a command index in the chapter heading.)

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 &ldquo;Function Index&rdquo; as an unnumbered
chapter, you could give it the title &lsquo;Function and Macro Index&rsquo; and
all will be consistent for the reader.

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</a>).

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 by using the <code>@synindex</code> or
<code>@syncodeindex</code> commands (see <a href="Combining-Indices.html">Combining Indices</a>).

<hr>
<div class="header">

Next: <a href="Indexing-Commands.html" accesskey="n" rel="next">Indexing Commands</a>, Up: <a href="Indices.html" accesskey="u" rel="up">Indices</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>]
</div>

</body>
</html>

Back to Directory File Manager