/usr/share/doc/texinfo/html/syncodeindex.html is in texinfo-doc-nonfree 4.13a-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 | <html lang="en">
<head>
<title>syncodeindex - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Combining-Indices.html#Combining-Indices" title="Combining Indices">
<link rel="next" href="synindex.html#synindex" title="synindex">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 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 are free to copy and modify
this GNU Manual. Buying copies from GNU Press supports the FSF in
developing GNU and promoting software freedom.''
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="syncodeindex"></a>
<p>
Next: <a rel="next" accesskey="n" href="synindex.html#synindex">synindex</a>,
Up: <a rel="up" accesskey="u" href="Combining-Indices.html#Combining-Indices">Combining Indices</a>
<hr>
</div>
<h4 class="subsection">13.4.1 <code>@syncodeindex</code></h4>
<p><a name="index-syncodeindex-635"></a>
When you want to combine functions and concepts into one index, you
should index the functions with <code>@findex</code> and index the concepts
with <code>@cindex</code>, and use the <code>@syncodeindex</code> command to
redirect the function index entries into the concept index.
<p>The <code>@syncodeindex</code> command takes two arguments; they are the name
of the index to redirect, and the name of the index to redirect it to.
The template looks like this:
<pre class="example"> @syncodeindex <var>from</var> <var>to</var>
</pre>
<p><a name="index-Predefined-names-for-indices-636"></a><a name="index-Two-letter-names-for-indices-637"></a><a name="index-Indices_002c-two-letter-names-638"></a><a name="index-Names-for-indices-639"></a>For this purpose, the indices are given two-letter names:
<dl>
<dt>‘<samp><span class="samp">cp</span></samp>’<dd>concept index
<br><dt>‘<samp><span class="samp">fn</span></samp>’<dd>function index
<br><dt>‘<samp><span class="samp">vr</span></samp>’<dd>variable index
<br><dt>‘<samp><span class="samp">ky</span></samp>’<dd>key index
<br><dt>‘<samp><span class="samp">pg</span></samp>’<dd>program index
<br><dt>‘<samp><span class="samp">tp</span></samp>’<dd>data type index
</dl>
<p>Write an <code>@syncodeindex</code> command before or shortly after the
end-of-header line at the beginning of a Texinfo file. For example,
to merge a function index with a concept index, write the
following:
<pre class="example"> @syncodeindex fn cp
</pre>
<p class="noindent">This will cause all entries designated for the function index to merge
in with the concept index instead.
<p>To merge both a variables index and a function index into a concept
index, write the following:
<pre class="example"> @syncodeindex vr cp
@syncodeindex fn cp
</pre>
<p><a name="index-Fonts-for-indices-640"></a>The <code>@syncodeindex</code> command puts all the entries from the `from'
index (the redirected index) into the <code>@code</code> font, overriding
whatever default font is used by the index to which the entries are
now directed. This way, if you direct function names from a function
index into a concept index, all the function names are printed in the
<code>@code</code> font as you would expect.
</body></html>
|