/usr/share/doc/texinfo/html/Installing-Dir-Entries.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 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 | <html lang="en">
<head>
<title>Installing Dir Entries - 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="Installing-an-Info-File.html#Installing-an-Info-File" title="Installing an Info File">
<link rel="prev" href="Other-Info-Directories.html#Other-Info-Directories" title="Other Info Directories">
<link rel="next" href="Invoking-install_002dinfo.html#Invoking-install_002dinfo" title="Invoking install-info">
<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="Installing-Dir-Entries"></a>
<p>
Next: <a rel="next" accesskey="n" href="Invoking-install_002dinfo.html#Invoking-install_002dinfo">Invoking install-info</a>,
Previous: <a rel="previous" accesskey="p" href="Other-Info-Directories.html#Other-Info-Directories">Other Info Directories</a>,
Up: <a rel="up" accesskey="u" href="Installing-an-Info-File.html#Installing-an-Info-File">Installing an Info File</a>
<hr>
</div>
<h4 class="subsection">21.2.4 Installing Info Directory Files</h4>
<p>When you install an Info file onto your system, you can use the program
<code>install-info</code> to update the Info directory file <samp><span class="file">dir</span></samp>.
Normally the makefile for the package runs <code>install-info</code>, just
after copying the Info file into its proper installed location.
<p><a name="index-dircategory-1320"></a><a name="index-direntry-1321"></a>In order for the Info file to work with <code>install-info</code>, you include
the commands <code>@dircategory</code> and
<code>@direntry</code><small class="dots">...</small><code>@end direntry</code> in the Texinfo source
file. Use <code>@direntry</code> to specify the menu entries to add to the
Info directory file, and use <code>@dircategory</code> to specify which part
of the Info directory to put it in. Here is how these commands are used
in this manual:
<pre class="smallexample"> @dircategory Texinfo documentation system
@direntry
* Texinfo: (texinfo). The GNU documentation format.
* install-info: (texinfo)Invoking install-info. ...
...
@end direntry
</pre>
<p>Here's what this produces in the Info file:
<pre class="smallexample"> INFO-DIR-SECTION Texinfo documentation system
START-INFO-DIR-ENTRY
* Texinfo: (texinfo). The GNU documentation format.
* install-info: (texinfo)Invoking install-info. ...
...
END-INFO-DIR-ENTRY
</pre>
<p class="noindent">The <code>install-info</code> program sees these lines in the Info file, and
that is how it knows what to do.
<p>Always use the <code>@direntry</code> and <code>@dircategory</code> commands near
the beginning of the Texinfo input, before the first <code>@node</code>
command. If you use them later on in the input, <code>install-info</code>
will not notice them.
<p><code>install-info</code> will automatically reformat the description of the
menu entries it is adding. As a matter of convention, the description
of the main entry (above, ‘<samp><span class="samp">The GNU documentation format</span></samp>’) should
start at column 32, starting at zero (as in
<code>what-cursor-position</code> in Emacs). This will make it align with
most others. Description for individual utilities best start in
column 48, where possible. For more information about formatting see
the ‘<samp><span class="samp">--calign</span></samp>’, ‘<samp><span class="samp">--align</span></samp>’, and ‘<samp><span class="samp">--max-width</span></samp>’ options in
<a href="Invoking-install_002dinfo.html#Invoking-install_002dinfo">Invoking install-info</a>.
<p>If you use <code>@dircategory</code> more than once in the Texinfo source,
each usage specifies the `current' category; any subsequent
<code>@direntry</code> commands will add to that category.
<p><a name="index-Free-Software-Directory-1322"></a><a name="index-Dir-categories_002c-choosing-1323"></a><a name="index-Categories_002c-choosing-1324"></a>When choosing a category name for the <code>@dircategory</code> command, we
recommend consulting the <a href="http://www.gnu.org/directory">Free Software Directory</a>. If your program is not listed there,
or listed incorrectly or incompletely, please report the situation to
the directory maintainers (<a href="mailto:bug-directory@gnu.org">bug-directory@gnu.org</a>) so that the
category names can be kept in sync.
<p>Here are a few examples (see the <samp><span class="file">util/dir-example</span></samp> file in the
Texinfo distribution for large sample <code>dir</code> file):
<pre class="display"> Emacs
Localization
Printing
Software development
Software libraries
Text creation and manipulation
</pre>
<p><a name="index-Invoking-nodes_002c-including-in-dir-file-1325"></a>Each `Invoking' node for every program installed should have a
corresponding <code>@direntry</code>. This lets users easily find the
documentation for the different programs they can run, as with the
traditional <samp><span class="command">man</span></samp> system.
</body></html>
|