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

<meta name="description" content="@settitle (GNU Texinfo 6.7)">
<meta name="keywords" content="@settitle (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="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">
<!--
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="g_t_0040settitle"></span><div class="header">
<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>@setfilename</code></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>
<span id="g_t_0040settitle_003a-Set-the-Document-Title"></span><h4 class="subsection">3.2.4 <code>@settitle</code>: Set the Document Title</h4>

<span id="settitle"></span><span id="index-settitle"></span>
<span id="index-Document-title_002c-specifying"></span>

<p>A Texinfo file should contain a line that looks like this:
</p>
<div class="example">
<pre class="example">@settitle <var>title</var>
</pre></div>

<p>Write the <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>@settitle</code> command should precede everything
that generates actual output.  The best place for it is right after
the <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 href="Heading-Generation.html">Heading Generation</a>.
</p>
<span id="index-_003ctitle_003e-HTML-tag"></span>
<p>In the HTML file produced by <code>makeinfo</code>, <var>title</var> serves as
the document &lsquo;<samp>&lt;title&gt;</samp>&rsquo;.  It also becomes the default document
description in the &lsquo;<samp>&lt;head&gt;</samp>&rsquo; part
(see <a href="_0040documentdescription.html"><code>@documentdescription</code></a>).
</p>
<p>When the title page is used in the output, the title in the
<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>@settitle</code> title; on the title page, the
version number generally appears as a <code>@subtitle</code> so it would
be omitted from the <code>@title</code>.  See <a href="_0040titlepage.html"><code>@titlepage</code></a>.
</p>




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