summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-13 22:26:53 +0000
committerKarl Berry <karl@freefriends.org>2011-05-13 22:26:53 +0000
commit7b1412793a9f44a07b9cbd0dd6111f68e0a91e86 (patch)
tree1e49134cfd98699b34ccebdfea4f2b3bf8f925cc /Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
parentae5426ba24cb178c4e8bb77c4de79f5d04c5512b (diff)
latex2e-help-texinfo (13may11)
git-svn-id: svn://tug.org/texlive/trunk@22463 c570f23f-e606-0410-a88d-b1316a301751
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.texi185
1 files changed, 131 insertions, 54 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 4b90945f28f..df7973788ba 100644
--- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
+++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi
@@ -1,8 +1,8 @@
\input texinfo
-@c $Id: latex2e.texi 257 2010-09-04 02:03:07Z karl $
+@c $Id: latex2e.texi 261 2011-05-12 17:45:37Z karl $
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename latex2e.info
-@set UPDATED July 2010
+@set UPDATED May 2011
@settitle @LaTeX{}2e reference manual (@value{UPDATED})
@comment %**end of header (This is for running Texinfo on a region.)
@@ -13,6 +13,7 @@
@c xx mention usrguide
@c xx mention ! float placement, p.15 of usrguide
@c xx merge http://ctan.org/tex-archive/info/latex-info/
+@c xx merged permuted-index
@c
@c xx The typeset source2e will have an index with all kernel
@c xx commands, which would be a good start. classes.dtx et al.
@@ -35,10 +36,10 @@ Berry made further updates and additions, and gratefully acknowledges
using @cite{Hypertext Help with @LaTeX{}}, by Sheldon Green, and the
@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 (text was not
+@cite{@TeX{}niques} number 10), as reference material (no text was
directly copied).
-Copyright @copyright{} 2007, 2008, 2009, 2010 Karl Berry.@*
+Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Karl Berry.@*
Copyright @copyright{} 1988, 1994, 2007 Stephen Gilmore.@*
Copyright @copyright{} 1994, 1995, 1996 Torsten Martinsen.
@@ -75,7 +76,7 @@ into another language, under the above conditions for modified versions.
@title @LaTeX{}: Structured documents for @TeX{}
@subtitle unofficial @LaTeX{} reference manual
@subtitle @value{UPDATED}
-@author
+@author @url{http://home.gna.org/latexrefman}
@page
@vskip 0pt plus 1filll
@insertcopying
@@ -92,18 +93,8 @@ 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.
-@cindex Knuth, Donald E.
-@cindex Lamport, Leslie
-@cindex @LaTeX{} Project team
-@LaTeX{} 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 there. Again, the present
-document is unofficial and has not been reviewed by the @LaTeX{}
-maintainers.
-
@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.
@@ -136,56 +127,116 @@ maintainers.
@end menu
+@node About this document
+@chapter Overview of @LaTeX{}
+
+@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
+@url{http://home.gna.org/latexrefman}. That page has links to the
+current output in various formats, sources, mailing lists, and other
+infrastructure.
+
+
@node Overview
@chapter Overview of @LaTeX{}
+What is @LaTeX{}?
+
@cindex overview of @LaTeX{}
+@cindex basics of @LaTeX{}
@cindex @LaTeX{} overview
-
-The @LaTeX{} command typesets a file of text using the @TeX{} program
-and the @LaTeX{} ``macro package'' for @TeX{}. To be more specific,
-it processes an input file containing the text of a document with
-interspersed commands that describe how the text should be formatted.
-It produces at least three files as output:
+@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
-A main output file, which is one of:
+The main output file, which is one of:
-@enumerate
-@item
+@table @code
+@item .dvi
+@findex .dvi @r{file}
+@findex latex @r{command}
If invoked as @command{latex}, a ``Device Independent'' (@file{.dvi})
-file. This contains commands that can be translated into commands for
-a variety of output devices. You can view such @file{.dvi} output of
-@LaTeX{} by using a program such as @command{xdvi} (display directly)
-or @command{dvips} (convert to PostScript).
-
-@item
+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).
+
+@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.
-@end enumerate
-There are other less-common variants of @LaTeX{} (and @TeX{}) as well,
-which can produce HTML, XML, and other things.
+@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}).
+
+@end table
+
+Many other less-common variants of @LaTeX{} (and @TeX{}) exist, which
+can produce HTML, XML, and other things.
@item
-A ``transcript'' or @file{.log} file that contains summary information and
-diagnostic messages for any errors discovered in the input file.
+@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.
@item
-An ``auxiliary'' or @file{.aux} file. This is used by @LaTeX{} itself, for
-things such as sectioning.
+@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
-A @LaTeX{} command begins with the command name, which consists of 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
+An open-ended list of other files might be created. We won't try to
+list them all. Xxx components?
+
+@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.
+@cindex case sensitivity of @LaTeX{}
@LaTeX{} is case sensitive. Enter all commands in lower case unless
explicitly directed to do otherwise.
@@ -347,7 +398,7 @@ 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}
+40% of the difference between @code{\paperwidth} and @code{\textwidth},
with @code{\evensidemargin} the remainder.
@item openright
@@ -824,8 +875,11 @@ the page footer. Default is @samp{30pt}, except in the @code{book}
class, where it varies with the type size.
@item \linewidth
-Width of the current line; the default varies with the font size,
-paper width, two-column mode, etc. For an @code{article} document in
+Width of the current line, decreased for each nested @code{list}
+(@pxref{list}). Specifically, it is smaller than @code{\textwidth} by
+the sum of @code{\leftmargin} and @code{\rightmargin}
+(@pxref{itemize}). The default varies with the font size, paper
+width, two-column mode, etc. For an @code{article} document in
@samp{10pt}, it's set to @samp{345pt}; in two-column mode, that
becomes @samp{229.5pt}.
@@ -838,11 +892,30 @@ For @samp{11pt}, it's @samp{38\baselineskip} and for @samp{12pt},
@samp{36\baselineskip}.
@item \textwidth
-The normal horizontal width of the page body; the default varies as
-usual. For an @code{article} or @code{report} document, it's
+The full horizontal width of the entire page body; the default varies
+as usual. For an @code{article} or @code{report} document, it's
@samp{345pt} at @samp{10pt}, @samp{360pt} at @samp{11pt}, and
@samp{390pt} at @samp{12pt}. For a @code{book} document, it's
-@samp{4.5in} at @samp{10pt}, and @samp{5in} at @samp{11pt} or @samp{12pt}.
+@samp{4.5in} at @samp{10pt}, and @samp{5in} at @samp{11pt} or
+@samp{12pt}.
+
+In multi-column output, @code{\textwidth} remains the width of the
+entire page body, while @code{\columnwidth} is the width of one column
+(@pxref{\twocolumn}).
+
+In lists (@pxref{list}), @code{\textwidth} remains the width of the
+entire page body (and @code{\columnwidth} the width of the entire
+column), while @code{\linewidth} may decrease for nested lists.
+
+Inside a minipage (@pxref{minipage}) or @code{\parbox}
+(@pxref{\parbox}), all the width-related parameters are set to the
+specified width, and revert to their normal values at the end of the
+@code{minipage} or @code{\parbox}.
+
+@findex \hsize
+For completeness: @code{\hsize} is the @TeX{} primitive parameter used
+when text is broken into lines. It should not be used in normal
+@LaTeX{} documents.
@item \topmargin
Space between the top of the @TeX{} page (one inch from the top of the
@@ -1751,6 +1824,9 @@ The mandatory @var{spacing} argument contains commands to change the
spacing parameters for the list. This argument will most often be
empty, i.e., @code{@{@}}, which leaves the default spacing.
+The width used for typesetting the list items is specified by
+@code{\linewidth} (@pxref{Page layout parameters}).
+
@node math
@section @code{math}
@@ -3250,6 +3326,7 @@ text of the @var{n}th argument.
@end table
+@c xx \providecommand, * form (non-\long)
@node \newcounter
@section @code{\newcounter}
@@ -5782,10 +5859,6 @@ Left arrow.
@cindex Spanish ordinals, feminine and masculine
Feminine and masculine ordinal symbols: @ordf{}, @ordm{}.
-@item \textordfeminine
-@cindex feminine ordinal symbol
-Feminine ordinal symbol: @registeredsymbol{}.
-
@item \textperiodcentered
@cindex period, centered, in text
@cindex centered period, in text
@@ -5842,7 +5915,9 @@ Right arrow.
Trademark symbol: @math{^{\hbox{TM}}}.
@item \texttwelveudash
-Xx 12u-.
+@cindex two-thirds em-dash
+@cindex em-dash, two-thirds
+``Two-thirds'' em-dash, between en-dash and em-dash.
@item \textunderscore
@cindex underscore, in text
@@ -6248,6 +6323,7 @@ is tried (@samp{foo} or @samp{foo.bar}).
@cindex table of contents, creating
@findex \tableofcontents
+@findex .toc @r{file}
A table of contents is produced with the @code{\tableofcontents}
command. You put the command right where you want the table of
contents to go; @LaTeX{} does the rest for you. A previous run must
@@ -6721,7 +6797,8 @@ 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.
+be useful. Additional templates are collected at
+@url{http://www.howtotex.com/templates}.
@menu
* book template::