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

<meta name="description" content="Info Format Preamble (GNU Texinfo 6.7)">
<meta name="keywords" content="Info Format Preamble (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="Info-Format-General-Layout.html" rel="up" title="Info Format General Layout">
<link href="Info-Format-Indirect-Table.html" rel="next" title="Info Format Indirect Table">
<link href="Info-Format-Whole-Manual.html" rel="prev" title="Info Format Whole Manual">
<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="Info-Format-Preamble"></span><div class="header">
<p>
Next: <a href="Info-Format-Indirect-Table.html" accesskey="n" rel="next">Info Format Indirect Table</a>, Previous: <a href="Info-Format-Whole-Manual.html" accesskey="p" rel="prev">Info Format Whole Manual</a>, Up: <a href="Info-Format-General-Layout.html" accesskey="u" rel="up">Info Format General Layout</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>
<h4 class="node-heading">Info Format Preamble</h4>
<span id="Info-Format_003a-Preamble"></span><h4 class="subheading">Info Format: Preamble</h4>

<span id="index-Preamble_002c-in-Info-format"></span>

<p>The <tt>&lt;preamble&gt;</tt> is text at the beginning of all output files.
It is not intended to be visible by default in an Info viewer, but
may be displayed upon user request.
</p>
<div class="example">
<pre class="example">    &lt;preamble&gt; =
&lt;identification&gt;       # &quot;This is FILENAME, produced by ...&quot;
&lt;copying text&gt;         # Expansion of @copying text.
&lt;dir entries&gt;          # Derived from @dircategory and @direntry.
</pre></div>

<p>These pieces are:
</p>
<dl compact="compact">
<dt><tt>&lt;identification line&gt;</tt></dt>
<dd><p>An arbitrary string beginning the output file, followed by a blank
line.
</p>
</dd>
<dt><tt>&lt;copying text&gt;</tt></dt>
<dd><p>The expansion of a <code>@copying</code> environment, if the manual has
one (see <a href="_0040copying.html"><code>@copying</code></a>).
</p>
</dd>
<dt><tt>&lt;dir entries&gt;</tt></dt>
<dd><p>The result of any <code>@dircategory</code> and <code>@direntry</code>
commands present in the manual (see <a href="Installing-Dir-Entries.html">Installing Dir Entries</a>).
</p>
</dd>
</dl>





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