/usr/share/doc/texinfo/html/First-Node.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 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: First Node</title>

<meta name="description" content="GNU Texinfo 5.2: First Node">
<meta name="keywords" content="GNU Texinfo 5.2: First Node">
<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="_0040node.html#g_t_0040node" rel="up" title="@node">
<link href="_0040top-Command.html#g_t_0040top-Command" rel="next" title="@top Command">
<link href="Node-Line-Requirements.html#Node-Line-Requirements" rel="previous" title="Node Line Requirements">
<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="First-Node"></a>
<div class="header">
<p>
Next: <a href="_0040top-Command.html#g_t_0040top-Command" accesskey="n" rel="next"><tt>@top</tt> Command</a>, Previous: <a href="Node-Line-Requirements.html#Node-Line-Requirements" accesskey="p" rel="previous">Node Line Requirements</a>, Up: <a href="_0040node.html#g_t_0040node" accesskey="u" rel="up"><tt>@node</tt></a> &nbsp; [<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="The-First-Node"></a>
<h4 class="subsection">6.1.4 The First Node</h4>
<a name="index-Top-node-is-first"></a>
<a name="index-First-node"></a>

<p>The first node of a Texinfo file is the <em>Top</em> node, except in an
included file (see <a href="Include-Files.html#Include-Files">Include Files</a>).  The Top node should contain a
short summary, copying permissions, and a master menu.  See <a href="The-Top-Node.html#The-Top-Node">The Top Node</a>, for more information on the Top node contents and examples.
</p>
<p>Here is a description of the node pointers to be used in the Top node:
</p>
<ul>
<li> <a name="index-Up-node-of-Top-node"></a>
<a name="index-_0028dir_0029-as-Up-node-of-Top-node"></a>
The Top node (which must be named &lsquo;<samp>top</samp>&rsquo; or &lsquo;<samp>Top</samp>&rsquo;) should have
as its &lsquo;Up&rsquo; node the name of a node in another file, where there is a
menu that leads to this file.  Specify the file name in parentheses.

<p>Usually, all Info files are installed in one system-wide Info tree
(often constructed from multiple directories).  In this case, use
&lsquo;<samp>(dir)</samp>&rsquo; as the parent of the Top node; this specifies the
top-level node in the <samp>dir</samp> file, which contains the main menu
for the Info system as a whole.
</p>
</li><li> <a name="index-Next-node-of-Top-node"></a>
The &lsquo;Next&rsquo; node of the Top node should be the first chapter in your
document.

</li></ul>

<p>See <a href="Installing-an-Info-File.html#Installing-an-Info-File">Installing an Info File</a>, for more information about installing
an Info file in the <samp>info</samp> directory.
</p>
<p>It is usually best to leave the pointers off entirely and let the
tools implicitly define them, with this simple result:
</p>
<div class="example">
<pre class="example">@node Top
</pre></div>





</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / First-Node.html
