Viewing File: /usr/share/doc/texinfo/html/Directory-File.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>Directory File (GNU Texinfo 6.7)</title>

<meta name="description" content="Directory File (GNU Texinfo 6.7)">
<meta name="keywords" content="Directory File (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="Installing-an-Info-File.html" rel="up" title="Installing an Info File">
<link href="New-Info-File.html" rel="next" title="New Info File">
<link href="Installing-an-Info-File.html" rel="prev" title="Installing an Info File">
<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="Directory-File"></span><div class="header">
<p>
Next: <a href="New-Info-File.html" accesskey="n" rel="next">New Info File</a>, Up: <a href="Installing-an-Info-File.html" accesskey="u" rel="up">Installing an Info File</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="The-Directory-File-dir"></span><h4 class="subsection">21.2.1 The Directory File <samp>dir</samp></h4>

<p>For Info to work, the <samp>info</samp> directory must contain a file that
serves as a top level directory for the Info system.  By convention,
this file is called <samp>dir</samp>.  (You can find the location of this file
within Emacs by typing <kbd>C-h i</kbd> to enter Info and then typing
<kbd>C-x C-f</kbd> to see the pathname to the <samp>info</samp> directory.)
</p>
<p>The <samp>dir</samp> file is itself an Info file.  It contains the top level
menu for all the Info files in the system.  The menu looks like
this:
</p>
<div class="example">
<pre class="example">* Menu:
* Info:    (info).     Documentation browsing system.
* Emacs:   (emacs).    The extensible, self-documenting
                      text editor.
* Texinfo: (texinfo).  With one source file, make
                      either a printed manual using
                      @TeX{} or an Info file.
&hellip;
</pre></div>

<p>Each of these menu entries points to the &lsquo;Top&rsquo; node of the Info file
that is named in parentheses.  (The menu entry does not need to
specify the &lsquo;Top&rsquo; node, since Info goes to the &lsquo;Top&rsquo; node if no node
name is mentioned.  See <a href="Other-Info-Files.html">Nodes in Other Info
Files</a>.)
</p>
<p>Thus, the &lsquo;<samp>Info</samp>&rsquo; entry points to the &lsquo;Top&rsquo; node of the
<samp>info</samp> file and the &lsquo;<samp>Emacs</samp>&rsquo; entry points to the &lsquo;Top&rsquo; node
of the <samp>emacs</samp> file.
</p>
<p>In each of the Info files, the &lsquo;Up&rsquo; pointer of the &lsquo;Top&rsquo; node refers
back to the <code>dir</code> file.  For example, the line for the &lsquo;Top&rsquo;
node of the Emacs manual looks like this in Info:
</p>
<div class="example">
<pre class="example">File: emacs  Node: Top, Up: (DIR), Next: Distrib
</pre></div>

<p>In this case, the <samp>dir</samp> file name is written in uppercase
letters&mdash;it can be written in either upper- or lowercase.  This is not
true in general, it is a special case for <samp>dir</samp>.
</p>

<hr>
<div class="header">
<p>
Next: <a href="New-Info-File.html" accesskey="n" rel="next">New Info File</a>, Up: <a href="Installing-an-Info-File.html" accesskey="u" rel="up">Installing an Info File</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>



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