GNU Info

Info Node: (texinfo)settitle

(texinfo)settitle


Next: documentdescription Prev: setfilename Up: Header
Enter node , (file) or (file)node

`@settitle': Set the document title
-----------------------------------

  In order to be made into a printed manual, a Texinfo file must contain
a line that looks like this:

     @settitle TITLE

  In the HTML file produced by `makeinfo', TITLE serves as the default
document description in the `<head>' part; see Note:
documentdescription, for how to change that.

  Write the `@settitle' command at the beginning of a line and follow
it on the same line by the title.  This tells TeX the title to use in a
header or footer.  Do not write anything else on the line; anything on
the line after the command is considered part of the title, including a
comment.

  Conventionally, when TeX formats a Texinfo file for double-sided
output, the title is printed in the left-hand (even-numbered) page
headings and the current chapter title is printed in the right-hand
(odd-numbered) page headings.  (TeX learns the title of each chapter
from each `@chapter' command.)  Page footers are not printed.

  Even if you are printing in a single-sided style, TeX looks for an
`@settitle' command line, in case you include the manual title in the
heading.

  The `@settitle' command should precede everything that generates
actual output in TeX.

  Although the title in the `@settitle' command is usually the same as
the title on the title page, it does not affect the title as it appears
on the title page.  Thus, the two do not need not match exactly;  and
the title in the `@settitle' command can be a shortened or expanded
version of the title as it appears on the title page. (Note:
`@titlepage'.)

  TeX prints page headings only for that text that comes after the
`@end titlepage' command in the Texinfo file, or that comes after an
`@headings' command that turns on headings.  (Note: The `@headings'
Command, for more information.)

  You may, if you wish, create your own, customized headings and
footings.  Note: Page Headings, for a detailed discussion of
this process.


automatically generated by info2www version 1.2.2.9