blob: df0d9c07652be0d262b92d1b749895b01b612694 [file] [log] [blame]
<!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>Start of Header (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Start of Header (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Start of Header (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="Texinfo-File-Header.html" rel="up" title="Texinfo File Header">
<link href="_0040setfilename.html" rel="next" title="@setfilename">
<link href="First-Line.html" rel="prev" title="First Line">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Start-of-Header">
<div class="nav-panel">
<p>
Next: <a href="_0040setfilename.html" accesskey="n" rel="next"><code class="code">@setfilename</code>: Set the Output File Name</a>, Previous: <a href="First-Line.html" accesskey="p" rel="prev">The First Line of a Texinfo File</a>, Up: <a href="Texinfo-File-Header.html" accesskey="u" rel="up">Texinfo File Header</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="Start-of-Header-1">2.5.2 Start of Header</h4>
<a class="index-entry-id" id="index-Start-of-header-line"></a>
<p>A start-of-header line is a Texinfo comment that looks like this:
</p>
<div class="example">
<pre class="example-preformatted">@c %**start of header
</pre></div>
<p>Write the start-of-header line on the second line of a Texinfo file.
Follow the start-of-header line with an <code class="code">@settitle</code> line and,
optionally, with other commands that globally affect the document
formatting, such as <code class="code">@synindex</code> or <code class="code">@footnotestyle</code>; and
then by an end-of-header line (see <a class="pxref" href="End-of-Header.html">End of Header</a>).
</p>
<p>The start- and end-of-header lines allow you to format only part of a
Texinfo file for Info or printing. See <a class="xref" href="texinfo_002dformat-commands.html">The <code class="code">texinfo-format&hellip;</code> Commands</a>.
</p>
<p>The odd string of characters, &lsquo;<samp class="samp">%**</samp>&rsquo;, is to ensure that no other
comment is accidentally taken for a start-of-header line. You can
change it if you wish by setting the <code class="code">tex-start-of-header</code> and/or
<code class="code">tex-end-of-header</code> Emacs variables. See <a class="xref" href="Texinfo-Mode-Printing.html">Formatting and Printing in Texinfo Mode</a>.
</p>
</div>
</body>
</html>