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

<meta name="description" content="@top Command (GNU Texinfo 6.7)">
<meta name="keywords" content="@top Command (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="Nodes.html" rel="up" title="Nodes">
<link href="Node-Menu-Illustration.html" rel="next" title="Node Menu Illustration">
<link href="First-Node.html" rel="prev" title="First Node">
<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="g_t_0040top-Command"></span><div class="header">
<p>
Next: <a href="Node-Menu-Illustration.html" accesskey="n" rel="next">Node Menu Illustration</a>, Previous: <a href="First-Node.html" accesskey="p" rel="prev">First Node</a>, Up: <a href="Nodes.html" accesskey="u" rel="up">Nodes</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-_0040top-Sectioning-Command"></span><h3 class="section">4.6 The <code>@top</code> Sectioning Command</h3>

<span id="top-command"></span><span id="makeinfo-top"></span><span id="makeinfo-top-command"></span><span id="index-top-1"></span>

<p>The <code>@top</code> command is a special sectioning command that you
should only use after a &lsquo;<samp>@node Top</samp>&rsquo; line at the beginning of a
Texinfo file.  The <code>@top</code> command tells the <code>makeinfo</code>
formatter which node is to be used as the root of the node tree.
</p>
<p>It produces the same sort of output as <code>@unnumbered</code>
(see <a href="_0040unnumbered-_0040appendix.html"><code>@unnumbered @appendix</code></a>).
</p>
<p>The <code>@top</code> node is conventionally wrapped in an
<code>@ifnottex</code> conditional so that it will not appear in TeX
output (see <a href="Conditionals.html">Conditionals</a>).
Thus, in practice, a Top node usually looks like this:
</p>
<div class="example">
<pre class="example">@ifnottex
@node Top
@top <var>your-manual-title</var>

<var>very-high-level-summary</var>
@end ifnottex
</pre></div>

<p><code>@top</code> is ignored when raising or lowering sections.  That is,
it is never lowered and nothing can be raised to it
(see <a href="Raise_002flower-sections.html">Raise/lower sections</a>).
</p>




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