| <!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>@settitle (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@settitle (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@settitle (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="End-of-Header.html" rel="next" title="End of Header"> |
| <link href="_0040setfilename.html" rel="prev" title="@setfilename"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="subsection-level-extent" id="g_t_0040settitle"> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="End-of-Header.html" accesskey="n" rel="next">End of Header</a>, Previous: <a href="_0040setfilename.html" accesskey="p" rel="prev"><code class="code">@setfilename</code>: Set the Output File Name</a>, Up: <a href="Texinfo-File-Header.html" accesskey="u" rel="up">Texinfo File Header</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> |
| <h4 class="subsection" id="g_t_0040settitle_003a-Set-the-Document-Title">2.5.4 <code class="code">@settitle</code>: Set the Document Title</h4> |
| |
| <a class="anchor" id="settitle"></a><a class="index-entry-id" id="index-settitle"></a> |
| <a class="index-entry-id" id="index-Document-title_002c-specifying"></a> |
| |
| <p>A Texinfo file should contain a line that looks like this: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">@settitle <var class="var">title</var> |
| </pre></div> |
| |
| <p>Write the <code class="code">@settitle</code> command at the beginning of a line and |
| follow it on the same line by the title. Do not write anything else |
| on the line. The <code class="code">@settitle</code> command should precede everything |
| that generates actual output. The best place for it is right after |
| the <code class="code">@setfilename</code> command (described in the previous section). |
| </p> |
| <p>This command tells TeX the title to use in a header or footer |
| for double-sided output, in case such headings are output. For |
| more on headings for TeX, see <a class="ref" href="Heading-Generation.html">Heading Generation</a>. |
| </p> |
| <a class="index-entry-id" id="index-_003ctitle_003e-HTML-tag"></a> |
| <p>In the HTML file produced by <code class="command">makeinfo</code>, <var class="var">title</var> serves as |
| the document ‘<samp class="samp"><title></samp>’ and it becomes the default document |
| description in the ‘<samp class="samp"><head></samp>’ part. |
| </p> |
| <p>When the title page is used in the output, as is generally the case for printed |
| output, the title in the <code class="code">@settitle</code> command does not affect the title as |
| it appears on the title page. Thus, the two do not need not to match exactly. |
| A practice we recommend is to include the version or edition number of the |
| manual in the <code class="code">@settitle</code> title; on the title page, the version number |
| generally appears as a <code class="code">@subtitle</code> so it would be omitted from the |
| <code class="code">@title</code>. See <a class="xref" href="_0040titlepage.html"><code class="code">@titlepage</code></a>. |
| </p> |
| |
| </div> |
| |
| |
| |
| </body> |
| </html> |
