summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi')
-rw-r--r--Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi953
1 files changed, 603 insertions, 350 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
index bac9e0992a2..7ce2d93da39 100644
--- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
+++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
@@ -1,27 +1,28 @@
\input texinfo
-@c $Id: latex2e.texi 282 2014-05-19 16:31:57Z karl $
+@c $Id: latex2e.texi 333 2015-05-12 17:12:37Z karl $
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename latex2e.info
-@set UPDATED May 2014
-@settitle @LaTeX{}2e reference manual (@value{UPDATED})
+@set UPDATED May 2015
+@settitle @LaTeX{}2e unofficial reference manual (@value{UPDATED})
@comment %**end of header (This is for running Texinfo on a region.)
@c latex 2.09 commands should all be present now,
@c xx but latex2e stuff is missing.
+@c xx random list of a few of the missing items is at the end of this file
@c
-@c xx mention \nocorr, \textit and ic
-@c xx give actual smallskip/etc. defaults
+@c xx ending a run with errors
+@c xx ctan, distributions, components of TeX
+@c xx classes and packages -- required, additional, useful; oberdiek; fonts
@c
-@c xx merge http://ctan.org/tex-archive/info/latex-info/ (alt-latex-info)
+@c xx merge http://mirror.ctan.org/info/latex-info/ (alt-latex-info)
+@c xx merge http://mirror.ctan.org/latex2e-reference.tar.gz
@c xx merge permuted-index
@c xx merge latex-manual from savannah
@c
@c xx The typeset source2e has an index with all kernel
@c xx commands, though some are internal and shouldn't be included.
@c xx classes.dtx et al. define additional commands.
-@c xx See also http://www.ctan.org/pkg/macros2e.
-@c
-@c xx packages -- required, additional, useful; oberdiek; fonts
+@c xx See also http://ctan.org/pkg/macros2e.
@copying
This document is an unofficial reference manual for @LaTeX{}, a
@@ -34,13 +35,13 @@ George@tie{}D. Greenwade of Sam Houston State University. The
@LaTeX{}2e version was adapted from this by Torsten Martinsen. Karl
Berry made further updates and additions, and gratefully acknowledges
using @cite{Hypertext Help with @LaTeX{}}, by Sheldon Green, and
-@cite{@LaTeX{} Command Summary} (for @LaTeX{} 2.09) by L.@tie{}Botway
-and C.@tie{}Biemesderfer (published by the @TeX{} Users Group as
-@cite{@TeX{}niques} number 10), as reference material (no text was
-directly copied).
+@cite{@LaTeX{} Command Summary} (for @LaTeX{}@tie{}2.09) by
+L.@tie{}Botway and C.@tie{}Biemesderfer (published by the @TeX{} Users
+Group as @cite{@TeX{}niques} number 10), as reference material (no
+text was directly copied).
Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013,
-2014 Karl Berry.@*
+2014, 2015 Karl Berry.@*
Copyright 1988, 1994, 2007 Stephen Gilmore.@*
Copyright 1994, 1995, 1996 Torsten Martinsen.
@@ -74,7 +75,7 @@ into another language, under the above conditions for modified versions.
@end tex
@titlepage
-@title @LaTeX{}: An unofficial reference manual
+@title @LaTeX{}2e: An unofficial reference manual
@subtitle @value{UPDATED}
@author @url{http://home.gna.org/latexrefman}
@page
@@ -86,17 +87,14 @@ into another language, under the above conditions for modified versions.
@contents
@node Top
-@top @LaTeX{}2e
+@top @LaTeX{}2e: An unofficial reference manual
-This document is an unofficial reference manual for @LaTeX{}, a
-document preparation system, version as of @value{UPDATED}. It is
-intended to cover @LaTeX{}2e, which has been the standard version of
-@LaTeX{} for many years.
+This document is an unofficial reference manual (version of
+@value{UPDATED}) for @LaTeX{}2e, a document preparation system.
@menu
* About this document:: Bug reporting, etc.
* Overview:: What is @LaTeX{}?
-* Starting & ending:: The standard beginning and end of a document.
* Document classes:: Some of the various classes available.
* Fonts:: Italic, bold, typewriter, etc.
* Layout:: Controlling the page layout.
@@ -106,7 +104,7 @@ intended to cover @LaTeX{}2e, which has been the standard version of
* Line breaking:: Influencing line breaks.
* Page breaking:: Influencing page breaks.
* Footnotes:: How to produce footnotes.
-* Definitions:: Define your own commands etc.
+* Definitions:: Define your own commands, etc.
* Counters:: Internal counters used by @LaTeX{}.
* Lengths:: The length commands.
* Making paragraphs:: Paragraph commands.
@@ -118,7 +116,7 @@ intended to cover @LaTeX{}2e, which has been the standard version of
* Special insertions:: Inserting reserved and special characters.
* Splitting the input:: Dealing with big files by splitting.
* Front/back matter:: Tables of contents, glossaries, indexes.
-* Letters:: The letter class.
+* Letters:: The @code{letter} class.
* Terminal input/output:: User interaction.
* Command line:: System-independent command-line behavior.
* Document templates:: Starter templates for various document classes.
@@ -130,159 +128,315 @@ intended to cover @LaTeX{}2e, which has been the standard version of
@node About this document
@chapter About this document
-@cindex Knuth, Donald E.
-@cindex Lamport, Leslie
-@cindex @LaTeX{} Project team
-The @LaTeX{} document preparation system is implemented as a macro
-package for Donald@tie{}E. Knuth's @TeX{} typesetting program.
-@LaTeX{} was originally created by Leslie Lamport; it is now
-maintained by a group of volunteers (@url{http://latex-project.org}).
-The official documentation written by the @LaTeX{} project is
-available from their web site.
-
@cindex bug reporting
@cindex reporting bugs
-@findex @email{latexrefman-discuss@@gna.org} @r{email address}
-The present document is completely unofficial and has not been
-reviewed by the @LaTeX{} maintainers. Do not send bug reports or
-anything else about this document to them. Instead, please send all
-comments to @email{latexrefman-discuss@@gna.org}.
-
-The home page for this document is
+@findex @url{http://home.gna.org/latexrefman} @r{home page}
+This is an unofficial reference manual for the @LaTeX{}2e document
+preparation system, which is a macro package for the @TeX{}
+typesetting program (@pxref{Overview}). This document's home page is
@url{http://home.gna.org/latexrefman}. That page has links to the
-current output in various formats, sources, mailing lists, and other
-infrastructure.
+current output in various formats, sources, mailing list archives and
+subscriptions, and other infrastructure.
+
+@cindex @LaTeX{} vs.@: @LaTeX{}2e
+In this document, we will mostly just use `@LaTeX{}' rather than
+`@LaTeX{}2e', since the previous version of @LaTeX{}@tie{}(2.09) was
+retired many years ago.
-Of course, there are many, many other sources of information about
-@LaTeX{}. Here are a few:
+@cindex unofficial nature of this manual
+@cindex @LaTeX{} Project team
+@findex @email{latexrefman-discuss@@gna.org} @r{email address}
+@LaTeX{} is currently maintained by a group of volunteers
+(@url{http://latex-project.org}). The official documentation written by
+the @LaTeX{} project is available from their web site. This document is
+completely unofficial and has not been reviewed by the @LaTeX{}
+maintainers. Do not send bug reports or anything else about this
+document to them. Instead, please send all comments to
+@email{latexrefman-discuss@@gna.org}.
+
+This document is a reference. There is a vast array of other sources
+of information about @LaTeX{}, at all levels. Here are a few
+introductions.
@table @url
-@item http://www.ctan.org/pkg/latex-doc-ptr
+@item http://ctan.org/pkg/latex-doc-ptr
+@findex latex-doc-ptr @r{document}
Two pages of recommended references to @LaTeX{} documentation.
-@item http://www.ctan.org/pkg/first-latex-doc
+@item http://ctan.org/pkg/first-latex-doc
+@findex first-latex-doc @r{document}
Writing your first document, with a bit of both text and math.
-@item http://www.ctan.org/pkg/usrguide
-The guide for document authors maintained as part of @LaTeX{}; there
-are several others.
+@item http://ctan.org/pkg/usrguide
+@findex usrguide @r{official documentation}
+The guide for document authors that is maintained as part of @LaTeX{};
+there are plenty of others available elsewhere.
+
+@item http://ctan.org/pkg/lshort
+@findex lshort @r{document}
+A short introduction to @LaTeX{}, translated to many languages.
@item http://tug.org/begin.html
-Introduction to the @TeX{} system, including @LaTeX{}.
+Introduction to the @TeX{} system, including @LaTeX{}, with further
+references.
+
@end table
@node Overview
@chapter Overview of @LaTeX{}
-What is @LaTeX{}?
-
@cindex overview of @LaTeX{}
@cindex basics of @LaTeX{}
+@cindex Knuth, Donald E.
+@cindex Lamport, Leslie
@cindex @LaTeX{} overview
-@LaTeX{} typesets a file of text using the @TeX{} program and the
-@LaTeX{} ``macro package'' for @TeX{}. That is, it processes an input
-file containing the text of a document with interspersed commands that
-describe how the text should be formatted. @LaTeX{} files are plain
-text that can be written in any reasonable editor. It produces at
-least three files as output:
-@enumerate
-@item
-The main output file, which is one of:
+@LaTeX{} is a system for typesetting documents. It was originally
+created by Leslie Lamport and is now maintained by a group of volunteers
+(@url{http://latex-project.org}). It is widely used, particularly for
+complex and technical documents, such as those involving mathematics.
+
+@cindex macro package, @LaTeX{} as
+A @LaTeX{} user writes an input file containing text along with
+interspersed commands, for instance commands describing how the text
+should be formatted. It is implemented as a set of related commands
+that interface with Donald@tie{}E. Knuth's @TeX{} typesetting program
+(the technical term is that @LaTeX{} is a @dfn{macro package} for the
+@TeX{} engine). The user produces the output document by giving that
+file to the @TeX{} engine.
+
+The term @LaTeX{} is also sometimes used to mean the language in which
+the document is marked up, that is, to mean the set of commands
+available to a @LaTeX{} user.
+
+@cindex Lamport @TeX{}
+@cindex pronunciation
+The name @LaTeX{} is short for ``Lamport @TeX{}''. It is pronounced
+LAH-teck or LAY-teck, or sometimes LAY-tecks. Inside a document,
+produce the logo with @code{\LaTeX}. Where use of the logo is not
+sensible, such as in plain text, write it as @samp{LaTeX}.
+
+@menu
+* Starting and ending:: The standard beginning and end of a document.
+* Output files:: Files produced.
+* @TeX{} engines:: Programs that implementation @LaTeX{}.
+* @LaTeX{} command syntax:: General syntax of @LaTeX{} commands.
+@end menu
+
+
+@node Starting and ending
+@section Starting and ending
+
+@anchor{Starting & ending}@c old name
+@cindex starting & ending
+@cindex ending & starting
+@cindex hello, world
+
+@LaTeX{} files have a simple global structure, with a standard
+starting and ending. Here is a ``hello, world'' example:
+
+@example
+\documentclass@{article@}
+\begin@{document@}
+Hello, \LaTeX\ world.
+\end@{document@}
+@end example
+
+@cindex document class, defined
+@noindent
+Here, the @samp{article} is the so-called @dfn{document class},
+implemented in a file @file{article.cls}. Any document class can be
+used. A few document classes are defined by @LaTeX{} itself, and vast
+array of others are widely available. @xref{Document classes}.
+
+@cindex preamble, defined
+You can include other @LaTeX{} commands between the
+@code{\documentclass} and the @code{\begin@{document@}} commands.
+This area is called the @dfn{preamble}.
+
+The @code{\begin@{document@} ... \end@{document@}} is a so-called
+@dfn{environment}; the @samp{document} environment (and no others) is
+required in all @LaTeX{} documents. @LaTeX{} provides many
+environments itself, and many more are defined separately.
+@xref{Environments}.
+
+The following sections discuss how to produce PDF or other output from
+a @LaTeX{} input file.
+
+
+@node Output files
+@section Output files
+
+@LaTeX{} produces a main output file and at least two accessory files.
+The main output file's name ends in either @file{.dvi} or @file{.pdf}.
@table @code
@item .dvi
@findex .dvi @r{file}
@findex latex @r{command}
-If invoked as @command{latex}, a ``Device Independent'' (@file{.dvi})
-file is produced. This contains commands that can be translated into
-commands for virtually any output device. You can view such
-@file{.dvi} output of @LaTeX{} by using a program such as
-@command{xdvi} (display directly), @command{dvips} (convert to
-PostScript), or @command{dvipdfmx} (convert to PDF).
+@findex xdvi @r{command}
+@findex dvips @r{command}
+@findex dvipdfmx @r{command}
+@findex dvitype @r{command}
+If @LaTeX{} is invoked with the system command @command{latex} then it
+produces a DeVice Independent file, with extension @file{.dvi}. You
+can view this file with a command such as @command{xdvi}, or convert
+it to a PostScript @code{.ps} file with @command{dvips} or to a
+Portable Document Format @code{.pdf} file with @command{dvipdfmx}.
+The contents of the file can be dumped in human-readable form with
+@command{dvitype}. A vast array of other DVI utility programs are
+available (@url{http://mirror.ctan.org/tex-archive/dviware}).
@item .pdf
@findex .pdf @r{file}
@cindex pdf@TeX{}
@findex pdflatex @r{command}
-If invoked as @command{pdflatex}, a ``Portable Document Format''
-(@file{.pdf}) file. Typically, this is a self-contained file, with
-all fonts and images embedded. This can be very useful, but it does
-make the output much larger than the @file{.dvi} produced from the
-same document.
-
-@findex lualatex @r{command}
-@cindex Lua@TeX{}
-If invoked as @command{lualatex}, a @file{.pdf} file is created using
-the Lua@TeX{} engine (@url{http://luatex.org}).
-
-@findex xelatex @r{command}
-@cindex Xe@TeX{}
-If invoked as @command{xelatex}, a @file{.pdf} file is created using
-the Xe@TeX{} engine (@url{http://tug.org/xetex}).
+If @LaTeX{} is invoked via the system command @command{pdflatex},
+among other commands (@pxref{@TeX{} engines}), then the main output is
+a Portable Document Format (PDF) file. Typically this is a
+self-contained file, with all fonts and images included.
@end table
-Many other less-common variants of @LaTeX{} (and @TeX{}) exist, which
-can produce HTML, XML, and other things.
+@LaTeX{} also produces at least two additional files.
-@item
+@table @code
+@item .log
@cindex transcript file
@cindex log file
@findex .log @r{file}
-The ``transcript'' or @file{.log} file that contains summary
-information and diagnostic messages for any errors discovered in the
-input file.
+This transcript file contains summary information such as a list of
+loaded packages. It also includes diagnostic messages and perhaps
+additional information for any errors.
-@item
+@item .aux
@cindex auxiliary file
@findex .aux @r{file}
-An ``auxiliary'' or @file{.aux} file. This is used by @LaTeX{} itself,
-for things such as cross-references.
-@end enumerate
+@cindex cross references, resolving
+@cindex forward references, resolving
+@cindex references, resolving forward
+Auxiliary information is used by @LaTeX{} for things such as
+cross references. For example, the first time that @LaTeX{} finds a
+forward reference---a cross reference to something that has not yet
+appeared in the source---it will appear in the output as a doubled
+question mark @code{??}. When the referred-to spot does eventually
+appear in the source then @LaTeX{} writes its location information to
+this @code{.aux} file. On the next invocation, @LaTeX{} reads the
+location information from this file and uses it to resolve the
+reference, replacing the double question mark with the remembered
+location.
-An open-ended list of other files might be created. We won't try to
-list them all. Xxx components?
+@end table
-@findex \ @r{character starting commands}
-@findex [...] @r{for optional arguments}
-@findex @{...@} @r{for required arguments}
-In the @LaTeX{} input file, a command name starts with a @code{\},
-followed by either (a)@tie{}a string of letters or (b)@tie{}a single
-non-letter. Arguments contained in square brackets, @code{[]}, are
-optional while arguments contained in braces, @code{@{@}}, are
-required.
+@findex .lof @r{file}
+@cindex list of figures file
+@findex .lot @r{file}
+@cindex list of tables file
+@findex .toc @r{file}
+@cindex table of contents file
+@cindex contents file
+@LaTeX{} may produce yet more files, characterized by the filename
+ending. These include a @code{.lof} file that is used to make a list
+of figures, a @code{.lot} file used to make a list of tables, and a
+@code{.toc} file used to make a table of contents. A particular class
+may create others; the list is open-ended.
-@cindex case sensitivity of @LaTeX{}
-@LaTeX{} is case sensitive. Enter all commands in lower case unless
-explicitly directed to do otherwise.
+@node @TeX{} engines
+@section @TeX{} engines
-@node Starting & ending
-@chapter Starting & ending
+@cindex engines, @TeX{}
+@cindex implementations of @TeX{}
+@cindex UTF-8
+@cindex Unicode input, native
+@cindex TrueType fonts
+@cindex OpenType fonts
-@cindex starting & ending
-@cindex ending & starting
+@LaTeX{} is defined to be a set of commands that are run by a @TeX{}
+implementation (@pxref{Overview}). This section gives a terse
+overview of the main programs.
-A minimal input file looks like the following:
+@table @code
+@item latex
+@itemx pdflatex
+@cindex pdf@TeX{} engine
+@findex etex @r{command}
+@cindex e-@TeX{}
+In @TeX{} Live (@url{http://tug.org/texlive}, if @LaTeX{} is invoked
+via either the system command @command{latex} or @command{pdflatex},
+then the pdf@TeX{} engine is run (@url{http://ctan.org/pkg/pdftex}).
+When invoked as @command{latex}, the main output is a @file{.dvi}
+file; as @command{pdflatex}, the main output is a @file{.pdf} file.
+
+pdf@TeX{} incorporates the e-@TeX{} extensions to Knuth's original
+program (@url{http://ctan.org/pkg/etex}), including additional
+programming features and bi-directional typesetting, and has plenty of
+extensions of its own. e-@TeX{} is available on its own as the
+command @command{etex}, but this is plain @TeX{} (and produces
+@file{.dvi}).
+
+In other @TeX{} distributions, @command{latex} may invoke e-@TeX{}
+rather than pdf@TeX{}. In any case, the e-@TeX{} extensions can be
+assumed to be available in @LaTeX{}.
+
+@item lualatex
+@findex lualatex @r{command}
+@cindex Lua@TeX{}
+If @LaTeX{} is invoked via the system command @command{lualatex}, the
+Lua@TeX{} engine is run (@url{http://ctan.org/pkg/luatex}). This
+program allows code written in the scripting language Lua
+(@url{http://luatex.org}) to interact with @TeX{}'s typesetting.
+Lua@TeX{} handles UTF-8 Unicode input natively, can handle OpenType
+and TrueType fonts, and produces a @file{.pdf} file by default.
+There is also @command{dvilualatex} to produce a @file{.dvi} file,
+but this is rarely used.
+
+@item xelatex
+@findex xelatex @r{command}
+@cindex Xe@TeX{}
+If @LaTeX{} is invoked with the system command @command{xelatex}, the
+Xe@TeX{} engine is run (@url{http://tug.org/xetex}). Like Lua@TeX{},
+Xe@TeX{} also natively supports UTF-8 Unicode and TrueType and
+OpenType fonts, though the implementation is completely different,
+mainly using external libraries instead of internal code. Xe@TeX{}
+produces a @file{.pdf} file as output; it does not support DVI output.
-@example
-\documentclass@{@var{class}@}
-\begin@{document@}
-@var{your text}
-\end@{document@}
-@end example
+@end table
-@noindent
-where the @var{class} is a valid document class for @LaTeX{}.
-@xref{Document classes}, for details of the various document classes
-available locally.
+Other variants of @LaTeX{} and @TeX{} exist, e.g., to provide
+additional support for Japanese and other languages ([u]p@TeX{},
+@url{http://ctan.org/pkg/ptex}, @url{http://ctan.org/pkg/uptex}).
-@cindex preamble, defined
-You may include other @LaTeX{} commands between the @code{\documentclass}
-and the @code{\begin@{document@}} commands (this area is called the
-@dfn{preamble}).
+
+@node @LaTeX{} command syntax
+@section @LaTeX{} command syntax
+
+@cindex command syntax
+@findex \ @r{character starting commands}
+@findex [...] @r{for optional arguments}
+@findex @{...@} @r{for required arguments}
+In the @LaTeX{} input file, a command name starts with a @code{\}; the
+name itself then consists of either (a)@tie{}a string of letters or
+(b)@tie{}a single non-letter.
+
+A command may be followed by zero, one, or more arguments, either
+required or optional. Required arguments are contained in curly
+braces, @code{@{...@}}. Optional arguments are contained in square
+brackets, @code{[...]}. Generally, but not universally, if the
+command accepts an optional argument, it comes first, before any
+required arguments.
+
+Some commands have a @code{*} form that is related to the form without
+a @code{*}, such as @code{\chapter} and @code{\chapter*}.
+
+@LaTeX{} commands are case sensitive; neither @code{\Begin@{document@}}
+nor @code{\begin@{Document@}} will work. Most commands are lowercase,
+but in any event you must enter all commands in the same case as they
+are defined.
+
+This manual describes all accepted options and @code{*}-forms for the
+commands it covers (barring unintentional omissions, a.k.a.@: bugs).
@node Document classes
@@ -292,31 +446,43 @@ and the @code{\begin@{document@}} commands (this area is called the
@cindex classes of documents
@findex \documentclass
-The class of a given document is defined with the command:
+The document's overall class is defined with this command, which is
+normally the first command in a @LaTeX{} source file.
@example
\documentclass[@var{options}]@{@var{class}@}
@end example
-@noindent
-The @code{\documentclass} command must be the first command in a
-@LaTeX{} source file.
-
@findex article @r{class}
@findex report @r{class}
@findex book @r{class}
@findex letter @r{class}
@findex slides @r{class}
-Built-in @LaTeX{} document @var{class} names are (many other document
-classes are available as add-ons; @pxref{Overview}):
+The following document @var{class} names are built into @LaTeX{}.
+(Many other document classes are available as separate packages;
+@pxref{Overview}.)
-@example
-article report book letter slides
-@end example
+@table @code
+@item article
+For a journal article, a presentation, and miscellaneous general use.
+
+@item book
+Full-length books, including chapters and possibly including front
+matter, such as a preface, and back matter, such as an appendix
+(@pxref{Front/back matter}).
+
+@item report
+For documents of length between an @code{article} and a @code{book},
+such as technical reports or theses, which may contain several chapters.
-@c xx briefly describe each one
+@item slides
+For slide presentations---rarely used today. In its place the
+@code{beamer} package is perhaps the most prevalent (@pxref{beamer
+template}).
+
+@end table
-Standard @var{options} are described below.
+Standard @var{options} are described in the next section.
@menu
* Document class options:: Global options.
@@ -331,10 +497,9 @@ Standard @var{options} are described below.
@cindex class options
@cindex global options
-You can specify so-called @dfn{global options} or @dfn{class options}
-to the @code{\documentclass} command by enclosing them in square
-brackets as usual. To specify more than one @var{option}, separate
-them with a comma:
+You can specify so-called @dfn{global options} or @dfn{class options} to
+the @code{\documentclass} command by enclosing them in square brackets.
+To specify more than one @var{option}, separate them with a comma, as in:
@example
\documentclass[@var{option1},@var{option2},...]@{@var{class}@}
@@ -376,22 +541,40 @@ a4paper a5paper b5paper executivepaper legalpaper letterpaper
Miscellaneous other options:
@table @code
-@item draft, final
+@item draft
+@itemx final
@cindex black boxes, omitting
-mark/do not mark overfull boxes with a big black box; default is @code{final}.
+Mark (@code{draft}) or do not mark (@code{final}) overfull boxes with a
+black box in the margin; default is @code{final}.
+
@item fleqn
+@cindex flush left equations
+@cindex centered equations
+@cindex equations, flush left vs.@: centered
Put displayed formulas flush left; default is centered.
+
@item landscape
+@cindex landscape orientation
+@cindex portrait orientation
Selects landscape format; default is portrait.
+
@item leqno
+@cindex left-hand equation numbers
+@cindex right-hand equation numbers
+@cindex equation numbers, left vs.@: right
Put equation numbers on the left side of equations; default is the right side.
+
@item openbib
+@cindex bibliography format, open
Use ``open'' bibliography format.
-@item titlepage, notitlepage
+
+@item titlepage
+@itemx notitlepage
+@cindex title page, separate or run-in
Specifies whether the title page is separate; default depends on the class.
@end table
-These options are not available with the slides class:
+The following options are not available with the @code{slides} class.
@findex onecolumn @r{option}
@findex twocolumn @r{option}
@@ -409,28 +592,28 @@ Typeset in one or two columns; default is @code{onecolumn}.
@findex \evensidemargin
@findex \oddsidemargin
Selects one- or two-sided layout; default is @code{oneside}, except
-for the @code{book} class.
+that in the @code{book} class the default is @code{twoside}.
-The @code{\evensidemargin} (@code{\oddsidemargin} parameter determines
-the distance on even (odd) numbered pages between the left side of the
-page and the text's left margin. The defaults vary with the paper
-size and whether one- or two-side layout is selected. For one-sided
-printing the text is centered, for two-sided, @code{\oddsidemargin} is
-40% of the difference between @code{\paperwidth} and @code{\textwidth},
-with @code{\evensidemargin} the remainder.
+For one-sided printing, the text is centered on the page. For two-sided
+printing, the @code{\evensidemargin} (@code{\oddsidemargin}) parameter
+determines the distance on even (odd) numbered pages between the left
+side of the page and the text's left margin, with @code{\oddsidemargin}
+being 40% of the difference between @code{\paperwidth} and
+@code{\textwidth}, and @code{\evensidemargin} is the remainder.
@item openright
@itemx openany
-Determines if a chapter should start on a
-right-hand page; default is @code{openright} for book.
+Determines if a chapter should start on a right-hand page; default is
+@code{openright} for @code{book}, and @code{openany} for @code{report}.
@end table
+@findex clock @r{option to @code{slides} class}
The @code{slides} class offers the option @code{clock} for printing
the time at the bottom of each note.
-
-@cindex packages, loading
@cindex loading additional packages
+@cindex packages, loading additional
+@cindex additional packages, loading
@findex \usepackage
Additional packages are loaded like this:
@@ -438,8 +621,9 @@ Additional packages are loaded like this:
\usepackage[@var{options}]@{@var{pkg}@}
@end example
-To specify more than one @var{pkg}, you can separate them with a
-comma, or use multiple @code{\usepackage} commands.
+To specify more than one package, you can separate them with a comma,
+as in @code{\usepackage@{@var{pkg1},@var{pkg2},...@}}, or use multiple
+@code{\usepackage} commands.
@cindex global options
@cindex options, global
@@ -459,7 +643,7 @@ Two important aspects of selecting a @dfn{font} are specifying a size
and a style. The @LaTeX{} commands for doing this are described here.
@menu
-* Font styles:: Select roman, italics etc.
+* Font styles:: Select roman, italics, etc.
* Font sizes:: Select point size.
* Low-level font commands:: Select encoding, family, series, shape.
@end menu
@@ -481,13 +665,22 @@ arguments. The scope of the declaration form lasts until the next type
style command or the end of the current group.
These commands, in both the argument form and the declaration form,
-are cumulative; e.g.,, you can say either @code{\sffamily\bfseries} or
+are cumulative; e.g., you can say either @code{\sffamily\bfseries} or
@code{\bfseries\sffamily} to get bold sans serif.
You can alternatively use an environment form of the declarations; for
instance, @code{\begin@{ttfamily@}...\end@{ttfamily@}}.
-These commands automatically supply an italic correction if needed.
+@findex \nocorrlist
+@findex \nocorr
+These font-switching commands automatically insert italic corrections
+if needed. (@xref{\/}, for the details of italic corrections.)
+Specifically, they insert the italic correction unless the following
+character is in the list @code{\nocorrlist}, which by default consists
+of a period and a comma. To suppress the automatic insertion of
+italic correction, use @code{\nocorr} at the start or end of the
+command argument, such as @code{\textit@{\nocorr text@}} or
+@code{\textsc@{text \nocorr@}}.
@table @code
@item \textrm (\rmfamily)
@@ -600,8 +793,8 @@ FAQ entry: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf}.
@LaTeX{} also provides the following commands, which unconditionally
switch to the given style, that is, are @emph{not} cumulative. Also,
they are used differently than the above commands: @code{@{\@var{cmd}
-...@}} instead of @code{\@var{cmd}@{...@}}. These are two very
-different things.
+...@}} instead of @code{\@var{cmd}@{...@}}. These are two unrelated
+constructs.
@ftable @code
@item \bf
@@ -814,7 +1007,7 @@ Miscellaneous commands for controlling the general layout of the page.
* \twocolumn:: Use two-column layout.
* \flushbottom:: Make all text pages the same height.
* \raggedbottom:: Allow text pages of differing height.
-* Page layout parameters:: \headheight \footskip.
+* Page layout parameters:: @code{\headheight} @code{\footskip}.
@end menu
@@ -984,7 +1177,7 @@ then divided by two.
@item \topskip
Minimum distance between the top of the page body and the baseline of
-the first line of text. For the standard clases, the default is the
+the first line of text. For the standard classes, the default is the
same as the font size, e.g., @samp{10pt} at @samp{10pt}.
@end ftable
@@ -999,7 +1192,7 @@ Sectioning commands provide the means to structure your text into units:
@ftable @code
@item \part
@item \chapter
-(report and book class only)
+(@code{report} and @code{book} class only)
@item \section
@item \subsection
@item \subsubsection
@@ -1094,7 +1287,8 @@ A @code{\label} command appearing in ordinary text assigns to
inside a numbered environment assigns that number to @var{key}.
A @var{key} name can consist of any sequence of letters, digits, or
-punctuation characters. Upper and lowercase letters are distinguished.
+punctuation characters. Upper and lowercase letters are
+distinguished, as usual.
To avoid accidentally creating two labels with the same name, it is
common to use labels consisting of a prefix and a suffix separated by
@@ -1238,8 +1432,8 @@ Math arrays are produced with the @code{array} environment, normally
within an @code{equation} environment (@pxref{equation}). It has a
single mandatory @var{template} argument describing the number of
columns and the alignment within them. Each column @var{col} is
-specified by a single letter that tells how items in that row should
-be formatted, as follows:
+specified by a single letter that tells how items in each row of that
+column should be formatted, as follows:
@table @code
@item c
@@ -1250,7 +1444,7 @@ flush left
flush right
@end table
-@findex \\ (for @code{array})
+@findex \\ @r{(for @code{array})}
Column entries are separated by @code{&}. Column entries may include
other @LaTeX{} commands. Each row of the array is terminated with
@code{\\}.
@@ -1294,7 +1488,7 @@ Synopsis:
\end@{center@}
@end example
-@findex \\ (for @code{center})
+@findex \\ @r{(for @code{center})}
The @code{center} environment allows you to create a paragraph
consisting of lines that are centered within the left and right
margins on the current page. Each line is terminated with the
@@ -1402,7 +1596,7 @@ equation number, use the @code{equation} environment (@pxref{equation}).
@findex document @r{environment}
The @code{document} environment encloses the body of a document.
-It is required in every @LaTeX{} document. @xref{Starting & ending}.
+It is required in every @LaTeX{} document. @xref{Starting and ending}.
@node enumerate
@@ -1493,13 +1687,13 @@ Nevertheless, here is a description of @code{eqnarray}:
\end@{eqnarray@}
@end example
-@findex \\ (for @code{eqnarray})
+@findex \\ @r{(for @code{eqnarray})}
The @code{eqnarray} environment is used to display a sequence of
-equations or inequalities. It is very much like a three-column
+equations or inequalities. It is similar to a three-column
@code{array} environment, with consecutive rows separated by @code{\\}
and consecutive items within a row separated by an @code{&}.
-@findex \\* (for @code{eqnarray})
+@findex \\* @r{(for @code{eqnarray})}
@code{\\*} can also be used to separate equations, with its normal
meaning of not allowing a page break at that line.
@@ -1576,9 +1770,8 @@ output. To ameliorate this, use the @code{stfloats} or
FAQ: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat}.
@item h
-@cindex @code{float} package
-(Here)---at the position in the text where the figure environment
-appears. However, this is not allowed by itself; @code{t} is
+(Here)---at the position in the text where the @code{figure} environment
+appears. However, @code{t} is not allowed by itself; @code{t} is
automatically added.
@cindex here, putting floats
@@ -1601,7 +1794,7 @@ see above.
@end table
-The standard report and article classes use the default placement
+The standard @code{report} and @code{article} classes use the default placement
@code{tbp}.
The body of the figure is made up of whatever text, @LaTeX{} commands,
@@ -1618,7 +1811,7 @@ non-float text:
@ftable @code
@findex \bottomfraction
-The maximum fraction of the page allowed to be occuped by floats at
+The maximum fraction of the page allowed to be occupied by floats at
the bottom; default @samp{.3}.
@item \floatpagefraction
@@ -1652,18 +1845,22 @@ Space between the last (first) float at the top (bottom) of a page;
default @samp{20pt plus2pt minus4pt}.
@end ftable
-Parameters relating to the number of floats on a page:
+Counters relating to the number of floats on a page:
@ftable @code
-@item \bottomnumber
+@item bottomnumber
Maximum number of floats that can appear at the bottom of a text page;
default 1.
-@item \topnumber
+@item dbltopnumber
+Maximum number of full-sized floats that can appear at the top of a
+two-column page; default 2.
+
+@item topnumber
Maximum number of floats that can appear at the top of a text page;
default 2.
-@item \totalnumber
+@item totalnumber
Maximum number of floats that can appear on a text page; default 3.
@end ftable
@@ -1710,7 +1907,7 @@ You can use the @code{filecontents} environment at any point after the
declaration @code{\usepackage@{filecontents@}}, not just before
@code{\documentclass}.
-@item
+@item
The @code{filecontents} package also provides a @code{filecontents*}
environment which is used in the same way as the @code{filecontents}
environment except that it won't insert any leading comment, so it is
@@ -1723,9 +1920,9 @@ unrelated to using the created file. So you need to use, for
instance, @code{\input} or @code{\usepackage} or @code{\bibliography}
or whatever is applicable, to use the created file.
-This environment is also useful to make a self-contained document, for
-example, for a bug report, or to keep a @file{.bib} file with the main
-document.
+This environment is also useful to make a document in a self-contained
+file, for example, for a bug report, or to keep the content of a
+@file{.bib} file in the same file as the main document.
@node flushleft
@@ -2159,6 +2356,7 @@ The @code{picture} commands are described in the following sections.
@subsection @code{\circle}
@findex \circle
+Synopsis:
@example
\circle[*]@{@var{diameter}@}
@end example
@@ -2167,21 +2365,24 @@ The @code{\circle} command produces a circle with a diameter as close
to the specified one as possible. The @code{*}-form of the command
draws a solid circle.
-Circles up to 40 pt can be drawn.
+Circles up to 40@dmn{pt} can be drawn.
@node \makebox (picture)
@subsection @code{\makebox}
-@findex \makebox (picture)
+@findex \makebox @r{(for @code{picture})}
-@code{\makebox(width,height)[position]@{...@}}
+Synopsis:
+@example
+\makebox(@var{width},@var{height})[@var{position}]@{@var{text}@}
+@end example
The @code{\makebox} command for the picture environment is similar to
the normal @code{\makebox} command except that you must specify a
-@code{width} and @code{height} in multiples of @code{\unitlength}.
+@var{width} and @var{height} in multiples of @code{\unitlength}.
-The optional argument, @code{[position]}, specifies the quadrant that
-your text appears in. You may select up to two of the following:
+The optional argument, @code{[@var{position}]}, specifies the quadrant that
+your @var{text} appears in. You may select up to two of the following:
@table @code
@item t
@@ -2238,8 +2439,8 @@ Draws a box with a dashed line. Synopsis:
rectangle has overall width @var{rwidth} and height @var{rheight}.
The @var{text} is positioned at optional @var{pos}. @c xxref positions.
-A dashed box looks best when the @code{rwidth} and @code{rheight} are
-multiples of the @code{dlen}.
+A dashed box looks best when the @var{rwidth} and @var{rheight} are
+multiples of the @var{dlen}.
@node \frame
@@ -2270,10 +2471,12 @@ Synopsis:
The @code{\line} command draws a line with the given @var{length} and
slope @var{xslope}/@var{yslope}.
+@cindex @code{pict2e} package
+@cindex graphics packages
Standard @LaTeX{} can only draw lines with @math{@var{slope} = x/y},
where @math{x} and @math{y} have integer values from @minus{}6
-through@tie{}6. For lines of any slope, not to mention other shapes,
-see the @code{curve2e} and many many other packages on CTAN.
+through@tie{}6. For lines of any slope, and plenty of other shapes,
+see @code{pict2e} and many other packages on CTAN.
@node \linethickness
@@ -2353,13 +2556,17 @@ boxes with rounded corners.
@node \put
@subsection @code{\put}
-
@findex \put
-@code{\put(x coord,y coord)@{ ... @}}
+Synopsis:
-The @code{\put} command places the item specified by the mandatory
-argument at the given coordinates.
+@example
+\put(@var{xcoord},@var{ycoord})@{ ... @}
+@end example
+
+The @code{\put} command places the material specified by the
+(mandatory) argument in braces at the given coordinate,
+(@var{xcoord},@var{ycoord}).
@node \shortstack
@@ -2395,12 +2602,12 @@ Objects are separated with @code{\\}.
Synopsis:
@example
-\vector(@var{x-slope},@var{y-slope})@{@var{length}@}
+\vector(@var{xslope},@var{yslope})@{@var{length}@}
@end example
The @code{\vector} command draws a line with an arrow of the specified
-length and slope. The @math{x} and @math{y} values must lie between
-@minus{}4 and +4, inclusive.
+length and slope. The @math{@var{xslope}} and @math{@var{yslope}}
+values must lie between @minus{}4 and +4, inclusive.
@node quotation
@@ -2435,7 +2642,7 @@ normally.
@cindex displaying quoted text without paragraph indentation
@cindex paragraph indentations in quoted text, omitting
-Snyopsis:
+Synopsis:
@example
\begin@{quote@}
@@ -2476,7 +2683,7 @@ the width of each column is constant and known in advance.
This environment can be broken across pages, unlike the @code{tabular}
environment.
-The following commands can be used inside a @code{tabbing} enviroment:
+The following commands can be used inside a @code{tabbing} environment:
@ftable @code
@item \\ @r{(tabbing)}
@@ -2941,7 +3148,7 @@ Like @code{plain}, but more compact labels.
In addition, numerous other Bib@TeX{} style files exist tailored to
the demands of various publications. See
-@url{http://www.ctan.org/tex-archive/biblio/bibtex/contrib}.
+@url{http://mirror.ctan.org/biblio/bibtex/contrib}.
The @code{\bibliography} command is what actually produces the
bibliography. The argument to @code{\bibliography} refers to files
@@ -3149,8 +3356,8 @@ mode.
@cindex hyphenation, forcing
The @code{\-} command tells @LaTeX{} that it may hyphenate the word at
-that point. @LaTeX{} is very good at hyphenating, and it will usually
-find most of the correct hyphenation points, and almost never use an
+that point. @LaTeX{} is pretty good at hyphenating, and usually finds
+most of the correct hyphenation points, while almost never using an
incorrect one. The @code{\-} command is used for the exceptional
cases.
@@ -3428,7 +3635,7 @@ redefine @code{\@@fnsymbol}.
Produces the rule separating the main text on a page from the page's
footnotes. Default dimensions: @code{0.4pt} thick (or wide), and
@code{0.4\columnwidth} long in the standard document classes (except
-slides, where it does not appear).
+@code{slides}, where it does not appear).
@item \footnotesep
The height of the strut placed at the beginning of the footnote. By
@@ -3454,7 +3661,7 @@ footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for
* \newlength:: Define a new length.
* \newsavebox:: Define a new box.
* \newenvironment & \renewenvironment:: Define a new environment.
-* \newtheorem:: Define a new theorem-like environment.
+* \newtheorem:: Define a new @code{theorem}-like environment.
* \newfont:: Define a new font name.
* \protect:: Using tricky commands.
@end menu
@@ -3471,8 +3678,8 @@ footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for
command, respectively. Synopses:
@example
- \newcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optarg}]@{@var{defn}@}
-\renewcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optarg}]@{@var{defn}@}
+ \newcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optargval}]@{@var{defn}@}
+\renewcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optargval}]@{@var{defn}@}
@end example
@table @var
@@ -3482,7 +3689,7 @@ The *-form of these commands requires that the arguments not contain
multiple paragraphs of text (not @code{\long}, in plain @TeX{} terms).
@item cmd
-The command name beginning with @code{\}. For @code{\newcommand}, it
+The command name, beginning with @code{\}. For @code{\newcommand}, it
must not be already defined and must not begin with @code{\end}; for
@code{\renewcommand}, it must already be defined.
@@ -3491,12 +3698,14 @@ An optional integer from 1 to 9 specifying the number of arguments
that the command will take. The default is for the command to have no
arguments.
-@item optarg
-If this optional parameter is present, it means that the command's
-first argument is optional. The default value of the optional
-argument (i.e., if it is not specified in the call) is @var{optarg},
-or, if that argument is present in the @code{\newcommand} but has an
-empty value, the string @samp{def}.
+@item optargval
+If this optional parameter is present, it means that the first
+argument of command @var{cmd} is optional and its default value (i.e.,
+if it is not specified in the call) is @var{optarg}. In otherwise,
+when calling the macro, if no @code{[@var{value}]} is given after
+@code{@var{cmd}}---which is different from having @code{[]} for an
+empty @var{value}---then string @samp{@var{optargval}} becomes the
+value of @code{#1} within @var{defn} when the macro is expanded.
@item defn
The text to be substituted for every occurrence of @code{cmd}; a
@@ -3515,14 +3724,14 @@ text of the @var{n}th argument.
Synopsis:
@example
-\newcounter@{@var{cnt}@}[@var{countername}]
+\newcounter@{@var{countername}@}[@var{supercounter}]
@end example
-The @code{\newcounter} command defines a new counter named @var{cnt}.
+The @code{\newcounter} command defines a new counter named @var{countername}.
The new counter is initialized to zero.
-Given the optional argument @code{[@var{countername}]}, @var{cnt}
-will be reset whenever @var{countername} is incremented.
+Given the optional argument @code{[@var{super}]}, @var{countername}
+will be reset whenever the counter named @var{supercounter} is incremented.
@xref{Counters}, for more information about counters.
@@ -3539,7 +3748,7 @@ Synopsis:
@end example
The @code{\newlength} command defines the mandatory argument as a
-@code{length} command with a value of @code{0in}. The argument must
+@dfn{length} command with a value of zero. The argument must
be a control sequence, as in @code{\newlength@{\foo@}}. An error
occurs if @code{\foo} is already defined.
@@ -3750,7 +3959,7 @@ uses Arabic numbers: `1', `2', @enddots{}
@item \roman
uses lowercase roman numerals: `i', `ii', @enddots{}
-@item \roman
+@item \Roman
uses uppercase roman numerals: `I', `II', @enddots{}
@item \fnsymbol
@@ -3758,18 +3967,13 @@ prints the value of @var{counter} in a specific sequence of nine
symbols (conventionally used for labeling footnotes). The value of
@var{counter} must be between@tie{}1 and@tie{}9, inclusive.
-@tex
-Here are the symbols:
-$\ast$ $\dagger$ $\ddagger$ $\S$ $\P$ $\parallel$
-$\ast\ast$ $\dagger\dagger$ $\ddagger\ddagger$
-@end tex
-@ifnottex
-The symbols mostly aren't supported in Info, but here are the names:
+Here are the symbols (as Unicode code points in ASCII output):
+
@display
-asterisk(*) dagger ddagger section-sign paragraph-sign parallel
-double-asterisk(**) double-dagger double-ddagger
+asterisk(*) dagger(@U{2021}) ddagger(@U{2021})
+section-sign(@U{00A7}) paragraph-sign(@U{00B6}) parallel(@U{2225})
+double-asterisk(**) double-dagger(@U{2021}@U{2021}) double-ddagger(@U{2021}@U{2021})
@end display
-@end ifnottex
@end ftable
@@ -3821,10 +4025,10 @@ be used anywhere @LaTeX{} expects a number, for example:
Synopsis:
@example
-\setcounter@{@var{\counter}@}@{@var{value}@}
+\setcounter@{@var{counter}@}@{@var{value}@}
@end example
-The @code{\setcounter} command sets the value of @var{\counter} to the
+The @code{\setcounter} command sets the value of @var{counter} to the
@var{value} argument.
@@ -4918,7 +5122,10 @@ parenthesized modulus, as in (@math{\pmod 2^n - 1})
@math{\sinh}
@item \sup
-@math{\sup}
+sup
+@c don't try to use \sup since that turned into a Texinfo command
+@c and it's not worth hassling with different versions when it's
+@c just three roman letters anyway.
@item \tan
@math{\tan}
@@ -5078,7 +5285,7 @@ For example, @math{\overbrace{x+\cdots+x}^{k \rm\;times}}.
@item \overline@{@var{text}@}
Generates a horizontal line over @var{tex}.
-For exampe, @math{\overline{x+y}}.
+For example, @math{\overline{x+y}}.
@item \sqrt[@var{root}]@{arg@}
Produces the representation of the square root of @var{arg}. The
@@ -5131,8 +5338,7 @@ $\vdots$.
@cindex paragraph mode
@cindex math mode
@cindex left-to-right mode
-@cindex lR mode
-
+@cindex LR mode
When @LaTeX{} is processing your input text, it is always in one of three
modes:
@@ -5146,32 +5352,35 @@ Math mode
Left-to-right mode, called LR mode for short
@end itemize
-@LaTeX{} changes mode only when it goes up or down a staircase to a
-different level, though not all level changes produce mode changes.
Mode changes occur only when entering or leaving an environment, or when
@LaTeX{} is processing the argument of certain text-producing commands.
-``Paragraph mode'' is the most common; it's the one @LaTeX{} is in
-when processing ordinary text. In that mode, @LaTeX{} breaks your
-text into lines and breaks the lines into pages. @LaTeX{} is in
-``math mode'' when it's generating a mathematical formula. In ``LR
-mode'', as in paragraph mode, @LaTeX{} considers the output that it
-produces to be a string of words with spaces between them. However,
-unlike paragraph mode, @LaTeX{} keeps going from left to right; it
-never starts a new line in LR mode. Even if you put a hundred words
-into an @code{\mbox}, @LaTeX{} would keep typesetting them from left
-to right inside a single box, and then complain because the resulting
-box was too wide to fit on the line.
-
-@LaTeX{} is in LR mode when it starts making a box with an @code{\mbox}
-command. You can get it to enter a different mode inside the box - for
-example, you can make it enter math mode to put a formula in the box.
+@dfn{Paragraph mode} is the most common; it's the one @LaTeX{} is in
+when processing ordinary text. In this mode, @LaTeX{} breaks the
+input text into lines and breaks the lines into pages.
+
+@LaTeX{} is in @dfn{math mode} when it's generating a mathematical
+formula, either displayed math or within a line.
+
+@findex \mbox@r{, and LR mode}
+In @dfn{LR mode}, as in paragraph mode, @LaTeX{} considers the output
+that it produces to be a string of words with spaces between them.
+However, unlike paragraph mode, @LaTeX{} keeps going from left to
+right; it never starts a new line in LR mode. Even if you put a
+hundred words into an @code{\mbox}, @LaTeX{} would keep typesetting
+them from left to right inside a single box (and then most likely
+complain because the resulting box was too wide to fit on the line).
+@LaTeX{} is in LR mode when it starts making a box with an
+@code{\mbox} command. You can get it to enter a different mode inside
+the box---for example, you can make it enter math mode to put a
+formula in the box.
+
There are also several text-producing commands and environments for
-making a box that put @LaTeX{} in paragraph mode. The box make by one of
-these commands or environments will be called a @code{parbox}. When
-@LaTeX{} is in paragraph mode while making a box, it is said to be in
-``inner paragraph mode''. Its normal paragraph mode, which it starts out
-in, is called ``outer paragraph mode''.
+making a box that put @LaTeX{} into paragraph mode. The box made by
+one of these commands or environments will be called a @code{parbox}.
+When @LaTeX{} is in paragraph mode while making a box, it is said to
+be in ``inner paragraph mode'' (no page breaks). Its normal paragraph
+mode, which it starts out in, is called ``outer paragraph mode''.
@node Page styles
@@ -5242,7 +5451,9 @@ Synopsis:
\pagenumbering@{@var{style}@}
@end example
-Specifies the style of page numbers, according to @var{style}:
+Specifies the style of page numbers, according to @var{style}; also
+resets the page number to 1. The @var{style} argument is one of
+the following:
@table @code
@item arabic
@@ -5336,9 +5547,9 @@ Horizontal space
* \hspace:: Fixed horizontal space.
* \hfill:: Stretchable horizontal space.
* \SPACE:: Normal interword space.
-* \AT:: Ending a sentence.
+* \@@:: Ending a sentence.
* \thinspace:: One-sixth of an em.
-* \/:: Per-character italic correction.
+* \/:: Insert italic correction.
* \hrulefill:: Stretchable horizontal rule.
* \dotfill:: Stretchable horizontal dots.
@@ -5373,8 +5584,10 @@ form.
@node \hfill
@section @code{\hfill}
-
@findex \hfill
+
+@cindex stretch, infinite horizontal
+@cindex infinite horizontal stretch
The @code{\hfill} fill command produces a ``rubber length'' which has
no natural space but can stretch or shrink horizontally as far as
needed.
@@ -5386,24 +5599,25 @@ equivalent to @code{\hfill}.
@node \SPACE
-@section @code{\SPACE}
+@section @code{\SPACE}: Normal interword space
@findex \SPACE
@findex \TAB
@findex \NEWLINE
The @code{\ } (space) command produces a normal interword space. It's
-useful after punctuation which shouldn't end a sentence. For example
-@code{Knuth's article in Proc.\ Amer.\ Math\. Soc.\ is fundamental}.
-It is also often used after control sequences, as in @code{\TeX\ is a
+useful after punctuation which shouldn't end a sentence. For example,
+@code{the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental}. It
+is also often used after control sequences, as in @code{\TeX\ is a
nice system.}
In normal circumstances, @code{\}@key{tab} and @code{\}@key{newline}
are equivalent to @code{\ }.
-@node \AT
-@section @code{\@@}
+@node \@@
+@section @code{\@@}: Force sentence-ending punctuation
@findex \@@
+@anchor{\AT}@c old name
The @code{\@@} command makes the following punctuation character end a
sentence even if it normally would not. This is typically used after
@@ -5417,7 +5631,7 @@ a capital letter. Here are side-by-side examples with and without
@noindent produces
-@c Texinfo does it differently, but the result is the same.
+@c Texinfo has different commands, but the result is the same.
@quotation
@dots{} in C@. Pascal, though @dots{}@*
@dots{} in C. Pascal, though @dots{}
@@ -5425,17 +5639,18 @@ a capital letter. Here are side-by-side examples with and without
@node \thinspace
-@section @code{\thinspace}
+@section @code{\thinspace}: Insert 1/6@dmn{em}
@findex \thinspace
@code{\thinspace} produces an unbreakable and unstretchable space that
-is 1/6 of an em. This is the proper space to use in nested quotes, as
-in '@dmn{''}.
+is 1/6 of an em. This is the proper space to use between nested
+quotes, as in '@dmn{}''.@c Abuse @dmn, which is a thin space in Texinfo.
@node \/
-@section @code{\/}
+@section @code{\/}: Insert italic correction
@findex \/
+@cindex italic correction
The @code{\/} command produces an @dfn{italic correction}. This is a
small space defined by the font designer for a given character,
@@ -5454,6 +5669,11 @@ normal letters, it can help. Compare
@end ifnottex
with @i{f: f;}.
+When changing fonts with commands such as @code{\textit@{italic
+text@}} or @code{@{\itshape italic text@}}, @LaTeX{} will
+automatically insert an italic correction if appropriate (@pxref{Font
+styles}).
+
Despite the name, roman characters can also have an italic
correction. Compare
@tex
@@ -5464,6 +5684,9 @@ pdf@TeX{} (in the @TeX{} output, there is a small space after the `f')
@end ifnottex
with pdf@TeX{}.
+There is no concept of italic correction in math mode; spacing is done
+in a different way.
+
@node \hrulefill
@section @code{\hrulefill}
@@ -5495,43 +5718,49 @@ with dots instead of just white space.
The @code{\addvspace} command normally adds a vertical space of height
length. However, if vertical space has already been added to the same
point in the output by a previous @code{\addvspace} command, then this
-command will not add more space than needed to make the natural length
-of the total vertical space equal to @code{length}.
+command will not add more space than is needed to make the natural
+length of the total vertical space equal to @code{length}.
@node \bigskip \medskip \smallskip
@section @code{\bigskip \medskip \smallskip}
-These commands produce a given amount of space.
+These commands produce a given amount of space, specified by the
+document class.
@table @code
@item \bigskip
@findex \bigskip
@findex \bigskipamount
-The same as @code{\vspace@{bigskipamount@}}, ordinarily about one line
-space (with stretch and shrink).
+The same as @code{\vspace@{\bigskipamount@}}, ordinarily about one line
+space, with stretch and shrink (the default for the @code{book} and
+@code{article} classes is @code{12pt plus 4pt minus 4pt}).
@item \medskip
@findex \medskip
@findex \medskipamount
-The same as @code{\vspace@{medskipamount@}}, ordinarily
-about half of a line space (with stretch and shrink).
+The same as @code{\vspace@{\medskipamount@}}, ordinarily about half of
+a line space, with stretch and shrink (the default for the @code{book}
+and @code{article} classes is @code{6pt plus 2pt minus 2pt}).
@item \smallskip
@findex \smallskip
@findex \smallskipamount
-The same as @code{\vspace@{smallskipamount@}}, ordinarily about a
-quarter of a line space (with stretch and shrink).
+The same as @code{\vspace@{\smallskipamount@}}, ordinarily about a
+quarter of a line space, with stretch and shrink (the default for the
+@code{book} and @code{article} classes is @code{3pt plus 1pt minus
+1pt}).
@end table
-The @code{\...amount} parameters are determined by the document class.
-
@node \vfill
@section @code{\vfill}
@findex \vfill
+@cindex stretch, infinite vertical
+@cindex infinite vertical stretch
+
The @code{\vfill} fill command produces a rubber length (glue) which
can stretch or shrink vertically as far as needed. It's equivalent to
@code{\vspace@{\fill@}} (@pxref{\hfill}).
@@ -5566,12 +5795,12 @@ used in the arguments of the box-making commands.
@menu
* \mbox:: Horizontal boxes.
* \fbox and \framebox:: Put a frame around a box.
-* lrbox:: An environment like \sbox.
+* lrbox:: An environment like @code{\sbox}.
* \makebox:: Box, adjustable position.
* \parbox:: Box with text in paragraph mode.
* \raisebox:: Raise or lower text.
-* \savebox:: Like \makebox, but save the text for later use.
-* \sbox:: Like \mbox, but save the text for later use.
+* \savebox:: Like @code{\makebox}, but save the text for later use.
+* \sbox:: Like @code{\mbox}, but save the text for later use.
* \usebox:: Print saved text.
@end menu
@@ -5765,7 +5994,7 @@ included in the normal output, it is saved in the box labeled
@node \usebox
-@section @code{\usebox@{@var{\boxcmd}}
+@section @code{\usebox@{@var{\boxcmd}@}}
@findex \usebox
Synopsis:
@@ -5785,7 +6014,7 @@ Synopsis:
special meaning do not correspond to simple characters you can type.
@menu
-* Reserved characters:: Inserting # $ % & ~ _ ^ \ @{ @}
+* Reserved characters:: Inserting @samp{# $ % & ~ _ ^ \ @{ @}}
* Text symbols:: Inserting other non-letter symbols in text.
* Accents:: Inserting accents.
* Non-English characters:: Inserting other non-English characters.
@@ -5873,6 +6102,11 @@ The double dagger symbol (in text).
@cindex logo, @LaTeX{}
The @LaTeX{} logo.
+@item \LaTeXe
+@cindex @LaTeX{}2e logo
+@cindex logo, @LaTeX{}2e
+The @LaTeX{}2e logo.
+
@item \guillemotleft @r{(@guillemotleft{})}
@itemx \guillemotright @r{(@guillemotright{})}
@itemx \guilsinglleft @r{(@guilsinglleft{})}
@@ -5917,7 +6151,7 @@ English pounds sterling: @pounds{}.
@cindex double low-9 quotation mark
@cindex single low-9 quotation mark
@cindex low-9 quotation marks, single and double
-Double and single quotation marks on the baseline:
+Double and single quotation marks on the baseline:
@quotedblbase{} and @quotesinglbase{}.
@item \rq
@@ -6055,8 +6289,8 @@ Feminine and masculine ordinal symbols: @ordf{}, @ordm{}.
Centered period: @math{\cdot}.
@item \textquestiondown @r{(or @code{?`})}
-@cindex questionation point, upside-down
-Upside down questionation point: @questiondown{}.
+@cindex question mark, upside-down
+Upside down question mark: @questiondown{}.
@item \textquotedblleft @r{(or @code{``})}
@cindex left quote, double
@@ -6127,6 +6361,8 @@ Visible space symbol.
@cindex characters, accented
@cindex letters, accented
+@cindex @code{babel} package
+@cindex multilingual support
@LaTeX{} has wide support for many of the world's scripts and
languages, through the @code{babel} package and related support. This
section does not attempt to cover all that support. It merely lists
@@ -6311,8 +6547,8 @@ used in languages other than English.
@item \dh
@itemx \DH
-@findex \dh (@ae{})
-@findex \DH (@AE{})
+@findex \dh (@dh{})
+@findex \DH (@DH{})
@cindex Icelandic eth
@cindex eth, Icelandic letter
Icelandic letter eth: @dh{} and @DH{}.
@@ -6321,7 +6557,7 @@ Icelandic letter eth: @dh{} and @DH{}.
@itemx \DJ
@findex \dj
@findex \DJ
-xxxx
+Crossed d and D, a.k.a.@: capital and small letter d with stroke.
@item \ij
@itemx \IJ
@@ -6341,7 +6577,7 @@ ij and IJ (except somewhat closer together than appears here).
@itemx \NG
@findex \ng
@findex \NG
-xxxx
+Latin letter eng, also used in phonetics.
@item \o
@itemx \O
@@ -6528,17 +6764,20 @@ table of contents, write a @code{\newpage} command after the
@findex \listoffigures
@findex \listoftables
+@findex .lof @r{file}
+@findex .lot @r{file}
The analogous commands @code{\listoffigures} and @code{\listoftables}
-produce a list of figures and a list of tables, respectively.
-Everything works exactly the same as for the table of contents.
+produce a list of figures and a list of tables (from @file{.lof} and
+@file{.lot} files), respectively. Everything works exactly the same
+as for the table of contents.
@findex \nofiles
The command @code{\nofiles} overrides these commands, and
@emph{prevents} any of these lists from being generated.
@menu
-* \addcontentsline:: Add an entry to table of contents etc.
-* \addtocontents:: Add text directly to table of contents file etc.
+* \addcontentsline:: Add an entry to table of contents, etc.
+* \addtocontents:: Add text directly to table of contents file, etc.
@end menu
@@ -6571,14 +6810,14 @@ For the list of tables.
@end table
@item entry
-The actual text of the entry.
+The text of the entry.
@end table
@findex \contentsline
What is written to the @file{.@var{ext}} file is the
command @code{\contentsline@{@var{unit}@}@{@var{name}@}}.
-@c ?? how hardwired are these values? other unit names?
+@c xx how hardwired are these values? other unit names?
@node \addtocontents
@@ -6591,9 +6830,9 @@ generates the table of contents or lists of figures or tables.
@table @var
@item ext
-The extension of the file on which information is to be written:
-@file{toc} (table of contents), @file{lof} (list of figures), or
-@file{lot} (list of tables).
+The extension of the file on which information is to be written,
+typically one of: @file{toc} (table of contents), @file{lof} (list of
+figures), or @file{lot} (list of tables).
@item text
The text to be written.
@@ -6617,6 +6856,7 @@ Specifically, what gets written is the command
@code{\glossaryentry@{@var{text}@}@{@var{pageno}@}}, where
@var{pageno} is the current @code{\thepage} value.
+@cindex glossary @r{package}
The @code{glossary} package on CTAN provides support for fancier
glossaries.
@@ -6640,6 +6880,7 @@ Specifically, what gets written is the command
is the current @code{\thepage} value.
@cindex `see' and `see also' index entries
+@cindex index entries, `see' and `see also'
To generate a index entry for `bar' that says `See foo', use a
vertical bar: @code{\index@{bar|see@{foo@}@}}. Use @code{seealso}
instead of @code{see} to make a `See also' entry.
@@ -6730,7 +6971,7 @@ These commands are used with the @code{letter} class.
* \cc:: Cc list.
* \closing:: Saying goodbye.
* \encl:: List of enclosed material.
-* \location:: Your organisation's address.
+* \location:: Your organization's address.
* \makelabels:: Making address labels.
* \name:: Your name, for the return address.
* \opening:: Saying hello.
@@ -6751,7 +6992,7 @@ should appear on the letter and the envelope. Separate lines of the
address should be separated by @code{\\} commands.
If you do not make an @code{\address} declaration, then the letter
-will be formatted for copying onto your organisation's standard
+will be formatted for copying onto your organization's standard
letterhead. (@xref{Overview}, for details on your local
implementation). If you give an @code{\address} declaration, then the
letter will be formatted as a personal letter.
@@ -6813,7 +7054,7 @@ Declare a list of one more enclosures.
@code{\location@{address@}}
-This modifies your organisation's standard address. This only appears
+This modifies your organization's standard address. This only appears
if the @code{firstpage} pagestyle is selected.
@@ -6885,7 +7126,6 @@ space for your signature. @code{\\} starts a new line within
Used after a @code{\stopbreaks} command to allow page breaks again.
-
@node \stopbreaks
@section @code{\stopbreaks}
@findex \stopbreaks
@@ -6895,7 +7135,6 @@ Used after a @code{\stopbreaks} command to allow page breaks again.
Inhibit page breaks until a @code{\startbreaks} command occurs.
-
@node \telephone
@section @code{\telephone}
@findex \telephone
@@ -6962,18 +7201,22 @@ printed, independent of surrounding spaces. A @code{^^J} in
@chapter Command line
@cindex command line
+@findex .tex, @r{default extension}
The input file specification indicates the file to be formatted;
@TeX{} uses @file{.tex} as a default file extension. If you omit the
-input file entirely, @TeX{} accepts input from the terminal. You
-specify command options by supplying a string as a parameter to the
-command; e.g.
+input file entirely, @TeX{} accepts input from the terminal. You can
+also specify arbitrary @LaTeX{} input by starting with a backslash.
+For example, this processes @file{foo.tex} without pausing after every
+error:
@example
latex '\nonstopmode\input foo.tex'
@end example
-@noindent
-will process @file{foo.tex} without pausing after every error.
+@findex --help @r{command-line option}
+With many, but not all, implementations, command-line options can also
+be specified in the usual Unix way, starting with @samp{-} or
+@samp{--}. For a list of those options, try @samp{latex --help}.
@cindex @samp{*} prompt
@cindex prompt, @samp{*}
@@ -6982,6 +7225,7 @@ If @LaTeX{} stops in the middle of the document and gives you a
@samp{*} prompt, it is waiting for input. You can type @code{\stop}
(and return) and it will prematurely end the document.
+@xref{@TeX{} engines}, for other system commands invoking @LaTeX{}.
@node Document templates
@@ -6989,43 +7233,22 @@ If @LaTeX{} stops in the middle of the document and gives you a
@cindex document templates
Although not reference material, perhaps these document templates will
-be useful. Additional template resources are listed
+be useful. Additional template resources are listed at
@url{http://tug.org/interest.html#latextemplates}.
@menu
-* book template::
* beamer template::
+* book template::
* tugboat template::
@end menu
-@node book template
-@section @code{book} template
-
-@verbatim
-\documentclass{book}
-\title{Book Class Template}
-\author{Alex Author}
-
-\begin{document}
-\maketitle
-
-\chapter{First}
-Some text.
-
-\chapter{Second}
-Some other text.
-
-\section{A subtopic}
-The end.
-\end{document}
-@end verbatim
-
-
@node beamer template
@section @code{beamer} template
-The @code{beamer} class creates slides presentations.
+@cindex @code{beamer} template and class
+The @code{beamer} class creates presentation slides. It has a vast
+array of features, but here is a basic template:
@verbatim
\documentclass{beamer}
@@ -7055,9 +7278,35 @@ One web resource for this:
@url{http://robjhyndman.com/hyndsight/beamer/}.
+@node book template
+@section @code{book} template
+
+@verbatim
+\documentclass{book}
+\title{Book Class Template}
+\author{Alex Author}
+
+\begin{document}
+\maketitle
+
+\chapter{First}
+Some text.
+
+\chapter{Second}
+Some other text.
+
+\section{A subtopic}
+The end.
+\end{document}
+@end verbatim
+
+
@node tugboat template
@section @code{tugboat} template
+@cindex TUGboat template
+@cindex @code{ltugboat} class
+
@cite{TUGboat} is the journal of the @TeX{} Users Group,
@url{http://tug.org/TUGboat}.
@@ -7092,8 +7341,8 @@ This is an example article for \TUB{}.
This is an example article for \TUB, from
\url{http://tug.org/TUGboat/location.html}.
-We recommend the graphicx package for image inclusions, and the
-hyperref package for active url's (in the \acro{PDF} output).
+We recommend the \texttt{graphicx} package for image inclusions, and the
+\texttt{hyperref} package for active urls in the \acro{PDF} output.
Nowadays \TUB\ is produced using \acro{PDF} files exclusively.
The \texttt{ltugboat} class provides these abbreviations and many more:
@@ -7168,3 +7417,7 @@ Email \verb|tugboat@tug.org| if problems or questions.
\@onlypreamble\DeclareTextSymbolDefault@item
\@onlypreamble\DeclareTextAccentDefault@item
\def\UndeclareTextCommand#1#2{%
+
+@c Local Variables:
+@c ispell-dictionary: "english"
+@c End: