JezK
Edit File: Texinfo-File-Header.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://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.8, 8 June 2021), 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-2021 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>Texinfo File Header (GNU Texinfo 6.8)</title> <meta name="description" content="Texinfo File Header (GNU Texinfo 6.8)"> <meta name="keywords" content="Texinfo File Header (GNU Texinfo 6.8)"> <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="Writing-a-Texinfo-File.html" rel="up" title="Writing a Texinfo File"> <link href="Document-Permissions.html" rel="next" title="Document Permissions"> <link href="Short-Sample-Texinfo-File.html" rel="prev" title="Short Sample Texinfo File"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="Texinfo-File-Header"> <div class="header"> <p> Next: <a href="Document-Permissions.html" accesskey="n" rel="next">Document Permissions</a>, Previous: <a href="Short-Sample-Texinfo-File.html" accesskey="p" rel="prev">Short Sample</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</a> [<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="Texinfo-File-Header-1"></span><h3 class="section">2.5 Texinfo File Header</h3> <span id="index-Header-for-Texinfo-files"></span> <span id="index-Texinfo-file-header"></span> <p>Texinfo files start with at least two lines: </p> <div class="example"> <pre class="example">\input texinfo @settitle Sample Manual 1.0 </pre></div> <p>The ‘<samp>\input texinfo</samp>’ line tells TeX to use the <samp>texinfo.tex</samp> file, which tells TeX how to translate the Texinfo @-commands into TeX typesetting commands. (Note the use of the backslash, ‘<samp>\</samp>’; this is correct for TeX.) </p> <p>The <code>@settitle</code> line specifies a title for the page headers (or footers) of the printed manual, and the default title and document description for the ‘<samp><head></samp>’ in HTML. (Strictly speaking, <code>@settitle</code> is optional—if you don’t mind your document being titled ‘Untitled’.) </p> <p>Also, you can optionally write the <code>@settitle</code> line between start-of-header and end-of-header lines if you want to format just part of the Texinfo file in Emacs. </p> <p>It makes sense to include any command that affects document formatting as a whole in the header. <code>@synindex</code> (see <a href="_0040synindex.html"><code>@synindex</code>: Combining Indices</a>), for instance, is another command often included in the header. </p> <ul class="section-toc"> <li><a href="First-Line.html" accesskey="1">The First Line of a Texinfo File</a></li> <li><a href="Start-of-Header.html" accesskey="2">Start of Header</a></li> <li><a href="_0040setfilename.html" accesskey="3"><code>@setfilename</code>: Set the Output File Name</a></li> <li><a href="_0040settitle.html" accesskey="4"><code>@settitle</code>: Set the Document Title</a></li> <li><a href="End-of-Header.html" accesskey="5">End of Header</a></li> </ul> </div> </body> </html>