blob: 3533317074be2aacad8a1566f018fbf203be4b9c [file]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 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". -->
<title>Info Format Preamble (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Info Format Preamble (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Info Format Preamble (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<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">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Info-Format-Preamble">
<div class="nav-panel">
<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: A 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="subsection" id="Info-Format_003a-Preamble">F.1.2 Info Format: Preamble</h4>
<a class="index-entry-id" id="index-Preamble_002c-in-Info-format"></a>
<p>The <code class="t">&lt;preamble&gt;</code> 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-preformatted"> &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 class="table">
<dt><code class="t">&lt;identification line&gt;</code></dt>
<dd><p>An arbitrary string beginning the output file, followed by a blank
line.
</p>
</dd>
<dt><code class="t">&lt;copying text&gt;</code></dt>
<dd><p>The expansion of a <code class="code">@copying</code> environment, if the manual has
one (see <a class="pxref" href="_0040copying.html"><code class="code">@copying</code>: Declare Copying Permissions</a>).
</p>
</dd>
<dt><code class="t">&lt;dir entries&gt;</code></dt>
<dd><p>The result of any <code class="code">@dircategory</code> and <code class="code">@direntry</code>
commands present in the manual (see <a class="pxref" href="Installing-Dir-Entries.html">Installing Info Directory Files</a>).
</p>
</dd>
</dl>
</div>
</body>
</html>