path: root/Master/texmf-dist/doc/info/latex2e.info

This is latex2e.info, produced by texi2any version 5.1+dev from
latex2e.texi.

This document is an unofficial reference manual for LaTeX, a document
preparation system, version of May 2013.

   This manual was originally translated from 'LATEX.HLP' v1.0a in the
VMS Help Library.  The pre-translation version was written by George D.
Greenwade of Sam Houston State University.  The LaTeX 2.09 version was
written by Stephen Gilmore.  The LaTeX2e version was adapted from this
by Torsten Martinsen.  Karl Berry made further updates and additions,
and gratefully acknowledges using 'Hypertext Help with LaTeX', by
Sheldon Green, and the 'LaTeX Command Summary' (for LaTeX 2.09) by
L. Botway and C. Biemesderfer (published by the TeX Users Group as
'TeXniques' number 10), as reference material (no text was directly
copied).

   Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Karl Berry.
Copyright (C) 1988, 1994, 2007 Stephen Gilmore.
Copyright (C) 1994, 1995, 1996 Torsten Martinsen.

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions.
INFO-DIR-SECTION TeX
START-INFO-DIR-ENTRY
* LaTeX2e: (latex2e).              Unofficial LaTeX reference manual.
END-INFO-DIR-ENTRY


File: latex2e.info,  Node: Top,  Next: About this document,  Up: (dir)

LaTeX2e
*******

This document is an unofficial reference manual for LaTeX, a document
preparation system, version as of May 2013.  It is intended to cover
LaTeX2e, which has been the standard version of LaTeX for many years.

* 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.
* Typefaces::			And fonts, such as bold, italics etc.
* Layout::			Controlling the page layout.
* Sectioning::			How to section properly.
* Cross references::		Automatic referencing.
* Environments::		Such as enumerate & itemize.
* Line breaking::	        Influencing line breaks.
* Page breaking::	        Influencing page breaks.
* Footnotes::			How to produce footnotes.
* Definitions::			Define your own commands etc.
* Counters::			Internal counters used by LaTeX.
* Lengths::			The length commands.
* Making paragraphs::		Paragraph commands.
* Math formulas::		How to create mathematical formulas.
* Modes::			Paragraph, Math or LR modes.
* Page styles::			Various styles of page layout.
* Spaces::		        Horizontal and vertical space.
* Boxes::                       Making boxes.
* 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.
* Terminal input/output::	User interaction.
* Command line::                System-independent command-line behavior.
* Document templates::          Starter templates for various document classes.
* Concept Index::		General index.
* Command Index::           	Alphabetical list of LaTeX commands.


File: latex2e.info,  Node: About this document,  Next: Overview,  Prev: Top,  Up: Top

1 About this document
*********************

The LaTeX document preparation system is implemented as a macro package
for Donald E. Knuth's TeX typesetting program.  LaTeX was originally
created by Leslie Lamport; it is now maintained by a group of volunteers
(<http://latex-project.org>).  The official documentation written by the
LaTeX project is available from their web site.

   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
<latexrefman-discuss@gna.org>.

   The home page for this document is <http://home.gna.org/latexrefman>.
That page has links to the current output in various formats, sources,
mailing lists, and other infrastructure.

   Of course, there are many, many other sources of information about
LaTeX.  Here are a few:

<http://www.ctan.org/pkg/latex-doc-ptr>
     Two pages of recommended references to LaTeX documentation.

<http://www.ctan.org/pkg/first-latex-doc>
     Writing your first document, with a bit of both text and math.

<http://www.ctan.org/pkg/usrguide>
     The guide for document authors maintained as part of LaTeX; there
     are several others.

<http://tug.org/begin.html>
     Introduction to the TeX system, including LaTeX.


File: latex2e.info,  Node: Overview,  Next: Starting & ending,  Prev: About this document,  Up: Top

2 Overview of LaTeX
*******************

What is LaTeX?

   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:

  1. The main output file, which is one of:

     '.dvi'
          If invoked as 'latex', a "Device Independent" ('.dvi') file is
          produced.  This contains commands that can be translated into
          commands for virtually any output device.  You can view such
          '.dvi' output of LaTeX by using a program such as 'xdvi'
          (display directly), 'dvips' (convert to PostScript), or
          'dvipdfmx' (convert to PDF).

     '.pdf'
          If invoked as 'pdflatex', a "Portable Document Format"
          ('.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 '.dvi' produced
          from the same document.

          If invoked as 'lualatex', a '.pdf' file is created using the
          LuaTeX engine (<http://luatex.org>).

          If invoked as 'xelatex', a '.pdf' file is created using the
          XeTeX engine (<http://tug.org/xetex>).

     Many other less-common variants of LaTeX (and TeX) exist, which can
     produce HTML, XML, and other things.

  2. The "transcript" or '.log' file that contains summary information
     and diagnostic messages for any errors discovered in the input
     file.

  3. An "auxiliary" or '.aux' file.  This is used by LaTeX itself, for
     things such as cross-references.

   An open-ended list of other files might be created.  We won't try to
list them all.  Xxx components?

   In the LaTeX input file, a command name starts with a '\', followed
by either (a) a string of letters or (b) a single non-letter.  Arguments
contained in square brackets, '[]', are optional while arguments
contained in braces, '{}', are required.

   LaTeX is case sensitive.  Enter all commands in lower case unless
explicitly directed to do otherwise.


File: latex2e.info,  Node: Starting & ending,  Next: Document classes,  Prev: Overview,  Up: Top

3 Starting & ending
*******************

A minimal input file looks like the following:

     \documentclass{CLASS}
     \begin{document}
     YOUR TEXT
     \end{document}

where the CLASS is a valid document class for LaTeX.  *Note Document
classes::, for details of the various document classes available
locally.

   You may include other LaTeX commands between the '\documentclass' and
the '\begin{document}' commands (this area is called the "preamble").


File: latex2e.info,  Node: Document classes,  Next: Typefaces,  Prev: Starting & ending,  Up: Top

4 Document classes
******************

The class of a given document is defined with the command:

     \documentclass[OPTIONS]{CLASS}

The '\documentclass' command must be the first command in a LaTeX source
file.

   Built-in LaTeX document CLASS names are (many other document classes
are available as add-ons; *note Overview::):

     article  report  book  letter  slides

   Standard OPTIONS are described below.

* Menu:

* Document class options::   Global options.


File: latex2e.info,  Node: Document class options,  Up: Document classes

4.1 Document class options
==========================

You can specify so-called "global options" or "class options" to the
'\documentclass' command by enclosing them in square brackets as usual.
To specify more than one OPTION, separate them with a comma:

     \documentclass[OPTION1,OPTION2,...]{CLASS}

   Here is the list of the standard class options.

   All of the standard classes except 'slides' accept the following
options for selecting the typeface size (default is '10pt'):

     10pt  11pt  12pt

   All of the standard classes accept these options for selecting the
paper size (default is 'letterpaper'):

     a4paper a5paper b5paper executivepaper legalpaper letterpaper

   Miscellaneous other options:

'draft, final'
     mark/do not mark overfull boxes with a big black box; default is
     'final'.
'fleqn'
     Put displayed formulas flush left; default is centered.
'landscape'
     Selects landscape format; default is portrait.
'leqno'
     Put equation numbers on the left side of equations; default is the
     right side.
'openbib'
     Use "open" bibliography format.
'titlepage, notitlepage'
     Specifies whether the title page is separate; default depends on
     the class.

   These options are not available with the slides class:

'onecolumn'
'twocolumn'
     Typeset in one or two columns; default is 'onecolumn'.

'oneside'
'twoside'
     Selects one- or two-sided layout; default is 'oneside', except for
     the 'book' class.

     The '\evensidemargin' ('\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,
     '\oddsidemargin' is 40% of the difference between '\paperwidth' and
     '\textwidth', with '\evensidemargin' the remainder.

'openright'
'openany'
     Determines if a chapter should start on a right-hand page; default
     is 'openright' for book.

   The 'slides' class offers the option 'clock' for printing the time at
the bottom of each note.

   Additional packages are loaded like this:

     \usepackage[OPTIONS]{PKG}

   To specify more than one PKG, you can separate them with a comma, or
use multiple '\usepackage' commands.

   Any options given in the '\documentclass' command that are unknown by
the selected document class are passed on to the packages loaded with
'\usepackage'.


File: latex2e.info,  Node: Typefaces,  Next: Layout,  Prev: Document classes,  Up: Top

5 Typefaces
***********

Two important aspects of selecting a "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 sizes::                  Select point size.
* Low-level font commands::     Select encoding, family, series, shape.


File: latex2e.info,  Node: Font styles,  Next: Font sizes,  Up: Typefaces

5.1 Font styles
===============

The following type style commands are supported by LaTeX.

   This first group of commands is typically used like '\textit{italic
text}'.  The corresponding command in parenthesis is the "declaration
form", which takes no arguments.  The scope of the declaration form
lasts until the next type style command or the end of the current group.

   The declaration forms are cumulative; i.e., you can say either
'\sffamily\bfseries' or '\bfseries\sffamily' to get bold sans serif.

   You can alternatively use an environment form of the declarations;
for instance, '\begin{ttfamily}...\end{ttfamily}'.

   These commands automatically supply an italic correction if the
'\textrm (\rmfamily)'
     Roman.

'\textit (\itshape)'
     Italics.

'\emph'
     Emphasis (switches between '\textit' and '\textrm').

'\textmd (\mdseries)'
     Medium weight (default).

'\textbf (\bfseries)'
     Boldface.

'\textup (\upshape)'
     Upright (default).  The opposite of slanted.

'\textsl (\slshape)'
     Slanted.

'\textsf (\sffamily)'
     Sans serif.

'\textsc (\scshape)'
     Small caps.

'\texttt (\ttfamily)'
     Typewriter.

'\textnormal (\normalfont)'
     Main document font.

'\mathrm'
     Roman, for use in math mode.

'\mathbf'
     Boldface, for use in math mode.

'\mathsf'
     Sans serif, for use in math mode.

'\mathtt'
     Typewriter, for use in math mode.

'\mathit'
'(\mit)'
     Italics, for use in math mode.

'\mathnormal'
     For use in math mode, e.g.  inside another type style declaration.

'\mathcal'
     'Calligraphic' letters, for use in math mode.

   In addition, the command '\mathversion{bold}' can be used for
switching to bold letters and symbols in formulas.
'\mathversion{normal}' restores the default.

   Finally, the command '\oldstylenums{NUMERALS}' will typeset so-called
"old-style" numerals, which have differing heights and depths (and
sometimes widths) from the standard "lining" numerals.  LaTeX's default
fonts support this, and will respect '\textbf' (but not other styles;
there are no italic old-style numerals in Computer Modern).  Many other
fonts have old-style numerals also; sometimes the 'textcomp' package
must be loaded, and sometimes package options are provided to make them
the default.  FAQ entry:
<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf>.

   LaTeX also provides these commands, which unconditionally switch to
the given style, that is, are _not_ cumulative.  They are used
differently than the above commands, too: '{\CMD ...}' instead of
'\CMD{...}'.  These are two very different things.

'\bf'
     Switch to bold face.

'\cal'
     Switch to calligraphic letters for math.

'\em'
     Emphasis (italics within roman, roman within italics).

'\it'
     Italics.

'\rm'
     Roman.

'\sc'
     Small caps.

'\sf'
     Sans serif.

'\sl'
     Slanted (oblique).

'\tt'
     Typewriter (monospace, fixed-width).


File: latex2e.info,  Node: Font sizes,  Next: Low-level font commands,  Prev: Font styles,  Up: Typefaces

5.2 Font sizes
==============

The following standard type size commands are supported by LaTeX.  The
table shows the command name and the corresponding actual font size used
(in points) with the '10pt', '11pt', and '12pt' document size options,
respectively (*note Document class options::).

Command                   '10pt'  '11pt'  '12pt'
--------------------------------------------------
'\tiny'                   5       6       6
'\scriptsize'             7       8       8
'\footnotesize'           8       9       10
'\small'                  9       10      10.95
'\normalsize' (default)   10      10.95   12
'\large'                  12      12      14.4
'\Large'                  14.4    14.4    17.28
'\LARGE'                  17.28   17.28   20.74
'\huge'                   20.74   20.74   24.88
'\Huge'                   24.88   24.88   24.88

   The commands as listed here are "declaration forms".  The scope of
the declaration form lasts until the next type style command or the end
of the current group.  You can also use the environment form of these
commands; for instance, '\begin{tiny}...\end{tiny}'.


File: latex2e.info,  Node: Low-level font commands,  Prev: Font sizes,  Up: Typefaces

5.3 Low-level font commands
===========================

These commands are primarily intended for writers of macros and
packages.  The commands listed here are only a subset of the available
ones.

'\fontencoding{enc}'
     Select font encoding.  Valid encodings include 'OT1' and 'T1'.

'\fontfamily{family}'
     Select font family.  Valid families include:

        * 'cmr' for Computer Modern Roman
        * 'cmss' for Computer Modern Sans Serif
        * 'cmtt' for Computer Modern Typewriter

     and numerous others.

'\fontseries{series}'
     Select font series.  Valid series include:

        * 'm' Medium (normal)
        * 'b' Bold
        * 'c' Condensed
        * 'bc' Bold condensed
        * 'bx' Bold extended

     and various other combinations.

'\fontshape{shape}'
     Select font shape.  Valid shapes are:

        * 'n' Upright (normal)
        * 'it' Italic
        * 'sl' Slanted (oblique)
        * 'sc' Small caps
        * 'ui' Upright italics
        * 'ol' Outline

     The two last shapes are not available for most font families.

'\fontsize{size}{skip}'
     Set font size.  The first parameter is the font size to switch to
     and the second is the line spacing to use; this is stored in a
     parameter named '\baselineskip'.  The unit of both parameters
     defaults to pt.  The default '\baselineskip' for the Computer
     Modern typeface is 1.2 times the '\fontsize'.

     The line spacing is also multiplied by the value of the
     '\baselinestretch' parameter when the type size changes; the
     default is 1.  However, the best way to "double space" a document,
     if you should be unlucky enough to have to produce such, is to use
     the 'setspace' package; see
     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace>.

'\linespread{FACTOR}'
     Equivalent to '\renewcommand{\baselinestretch}{FACTOR}', and
     therefore must be followed by '\selectfont' to have any effect.
     Best specified in the preamble, or use the 'setspace' package, as
     described just above.

     The changes made by calling the font commands described above do
     not come into effect until '\selectfont' is called.

'\usefont{enc}{family}{series}{shape}'
     The same as invoking '\fontencoding', '\fontfamily', '\fontseries'
     and '\fontshape' with the given parameters, followed by
     '\selectfont'.


File: latex2e.info,  Node: Layout,  Next: Sectioning,  Prev: Typefaces,  Up: Top

6 Layout
********

Miscellaneous commands for controlling the general layout of the page.

* Menu:

* \onecolumn::              Use one-column layout.
* \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.


File: latex2e.info,  Node: \onecolumn,  Next: \twocolumn,  Up: Layout

6.1 '\onecolumn'
================

The '\onecolumn' declaration starts a new page and produces
single-column output.  This is the default.


File: latex2e.info,  Node: \twocolumn,  Next: \flushbottom,  Prev: \onecolumn,  Up: Layout

6.2 '\twocolumn'
================

Synopsis:

     \twocolumn[TEXT1COL]

   The '\twocolumn' declaration starts a new page and produces
two-column output.  If the optional TEXT1COL argument is present, it is
typeset in one-column mode before the two-column typesetting starts.

   These parameters control typesetting in two-column output:

'\columnsep'
     The distance between columns (35pt by default).

'\columnseprule'
     The width of the rule between columns; the default is 0pt, so there
     is no rule.

'\columnwidth'
     The width of the current column; this is equal to '\textwidth' in
     single-column text.

   These parameters control float behavior in two-column output:

'\dbltopfraction'
     Maximum fraction at the top of a two-column page that may be
     occupied by floats.  Default '.7', can be usefully redefined to
     (say) '.9' to avoid going to float pages so soon.

'\dblfloatpagefraction'
     The minimum fraction of a float page that must be occupied by
     floats, for a two-column float page.  Default '.5'.

'\dblfloatsep'
     Distance between floats at the top or bottom of a two-column float
     page.  Default '12pt plus2pt minus2pt' for '10pt' and '11pt'
     documents, '14pt plus2pt minus4pt' for '12pt'.

'\dbltextfloatsep'
     Distance between a multi-column float at the top or bottom of a
     page and the main text.  Default '20pt plus2pt minus4pt'.


File: latex2e.info,  Node: \flushbottom,  Next: \raggedbottom,  Prev: \twocolumn,  Up: Layout

6.3 '\flushbottom'
==================

The '\flushbottom' declaration makes all text pages the same height,
adding extra vertical space where necessary to fill out the page.

   This is the default if 'twocolumn' mode is selected (*note Document
class options::).


File: latex2e.info,  Node: \raggedbottom,  Next: Page layout parameters,  Prev: \flushbottom,  Up: Layout

6.4 '\raggedbottom'
===================

The '\raggedbottom' declaration makes all pages the natural height of
the material on that page.  No rubber lengths will be stretched.


File: latex2e.info,  Node: Page layout parameters,  Prev: \raggedbottom,  Up: Layout

6.5 Page layout parameters
==========================

'\headheight'
     Height of the box that contains the running head.  Default is
     '30pt', except in the 'book' class, where it varies with the type
     size.

'\headsep'
     Vertical distance between the bottom of the header line and the top
     of the main text.  Default is '25pt', except in the 'book' class,
     where it varies with the type size.

'\footskip'
     Distance from the baseline of the last line of text to the baseline
     of the page footer.  Default is '30pt', except in the 'book' class,
     where it varies with the type size.

'\linewidth'
     Width of the current line, decreased for each nested 'list' (*note
     list::).  Specifically, it is smaller than '\textwidth' by the sum
     of '\leftmargin' and '\rightmargin' (*note itemize::).  The default
     varies with the font size, paper width, two-column mode, etc.  For
     an 'article' document in '10pt', it's set to '345pt'; in two-column
     mode, that becomes '229.5pt'.

'\textheight'
     The normal vertical height of the page body; the default varies
     with the font size, document class, etc.  For an 'article' or
     'report' document in '10pt', it's set to '43\baselineskip'; for
     'book', it's '41\baselineskip'.  For '11pt', it's '38\baselineskip'
     and for '12pt', '36\baselineskip'.

'\textwidth'
     The full horizontal width of the entire page body; the default
     varies as usual.  For an 'article' or 'report' document, it's
     '345pt' at '10pt', '360pt' at '11pt', and '390pt' at '12pt'.  For a
     'book' document, it's '4.5in' at '10pt', and '5in' at '11pt' or
     '12pt'.

     In multi-column output, '\textwidth' remains the width of the
     entire page body, while '\columnwidth' is the width of one column
     (*note \twocolumn::).

     In lists (*note list::), '\textwidth' remains the width of the
     entire page body (and '\columnwidth' the width of the entire
     column), while '\linewidth' may decrease for nested lists.

     Inside a minipage (*note minipage::) or '\parbox' (*note
     \parbox::), all the width-related parameters are set to the
     specified width, and revert to their normal values at the end of
     the 'minipage' or '\parbox'.

     For completeness: '\hsize' is the TeX primitive parameter used when
     text is broken into lines.  It should not be used in normal LaTeX
     documents.

'\topmargin'
     Space between the top of the TeX page (one inch from the top of the
     paper, by default) and the top of the header.  The default is
     computed based on many other parameters: '\paperheight - 2in -
     \headheight - \headsep - \textheight - \footskip', and then divided
     by two.

'\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 same as the font size, e.g., '10pt' at '10pt'.


File: latex2e.info,  Node: Sectioning,  Next: Cross references,  Prev: Layout,  Up: Top

7 Sectioning
************

Sectioning commands provide the means to structure your text into units:

'\part'
'\chapter'
     (report and book class only)
'\section'
'\subsection'
'\subsubsection'
'\paragraph'
'\subparagraph'

   All sectioning commands take the same general form, e.g.,

     \chapter[TOCTITLE]{TITLE}

   In addition to providing the heading TITLE in the main text, the
section title can appear in two other places:

  1. The table of contents.
  2. The running head at the top of the page.

   You may not want the same text in these places as in the main text.
To handle this, the sectioning commands have an optional argument
TOCTITLE that, when given, specifies the text for these other places.

   Also, all sectioning commands have '*'-forms that print TITLE as
usual, but do not include a number and do not make an entry in the table
of contents.  For instance:

     \section*{Preamble}

   The '\appendix' command changes the way following sectional units are
numbered.  The '\appendix' command itself generates no text and does not
affect the numbering of parts.  The normal use of this command is
something like

     \chapter{A Chapter}
     ...
     \appendix
     \chapter{The First Appendix}

   The 'secnumdepth' counter controls printing of section numbers.  The
setting

     \setcounter{secnumdepth}{LEVEL}

suppresses heading numbers at any depth > LEVEL, where 'chapter' is
level zero.  (*Note \setcounter::.)


File: latex2e.info,  Node: Cross references,  Next: Environments,  Prev: Sectioning,  Up: Top

8 Cross references
******************

One reason for numbering things like figures and equations is to refer
the reader to them, as in "See Figure 3 for more details."

* Menu:

* \label::      Assign a symbolic name to a piece of text.
* \pageref::    Refer to a page number.
* \ref::        Refer to a section, figure or similar.


File: latex2e.info,  Node: \label,  Next: \pageref,  Up: Cross references

8.1 '\label'
============

Synopsis:

     \label{KEY}

   A '\label' command appearing in ordinary text assigns to KEY the
number of the current sectional unit; one appearing inside a numbered
environment assigns that number to KEY.

   A KEY name can consist of any sequence of letters, digits, or
punctuation characters.  Upper and lowercase letters are distinguished.

   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 a
colon or period.  Some conventionally-used prefixes:

'ch'
     for chapters
'sec'
     for lower-level sectioning commands
'fig'
     for figures
'tab'
     for tables
'eq'
     for equations

   Thus, a label for a figure would look like 'fig:snark' or
'fig.snark'.


File: latex2e.info,  Node: \pageref,  Next: \ref,  Prev: \label,  Up: Cross references

8.2 '\pageref{KEY}'
===================

Synopsis:

     \pageref{KEY}

   The '\pageref'{KEY} command produces the page number of the place in
the text where the corresponding '\label'{KEY} command appears.


File: latex2e.info,  Node: \ref,  Prev: \pageref,  Up: Cross references

8.3 '\ref{KEY}'
===============

Synopsis:

     \ref{KEY}

   The '\ref' command produces the number of the sectional unit,
equation, footnote, figure, ..., of the corresponding '\label' command
(*note \label::).  It does not produce any text, such as the word
'Section' or 'Figure', just the bare number itself.


File: latex2e.info,  Node: Environments,  Next: Line breaking,  Prev: Cross references,  Up: Top

9 Environments
**************

LaTeX provides many environments for marking off certain text.  Each
environment begins and ends in the same manner:

     \begin{ENVNAME}
     ...
     \end{ENVNAME}

* Menu:

* abstract::    Produce an abstract.
* array::       Math arrays.
* center::      Centered lines.
* description:: Labelled lists.
* displaymath:: Formulas that appear on their own line.
* document::    Enclose the whole document.
* enumerate::   Numbered lists.
* eqnarray::    Sequences of aligned equations.
* equation::    Displayed equation.
* figure::      Floating figures.
* flushleft::   Flushed left lines.
* flushright::  Flushed right lines.
* itemize::     Bulleted lists.
* letter::      Letters.
* list::        Generic list environment.
* math::        In-line math.
* minipage::    Miniature page.
* picture::     Picture with text, arrows, lines and circles.
* quotation::   Indented environment with paragraph indentation.
* quote::       Indented environment with no paragraph indentation.
* tabbing::     Align text arbitrarily.
* table::       Floating tables.
* tabular::     Align text in columns.
* thebibliography::     Bibliography or reference list.
* theorem::     Theorems, lemmas, etc.
* titlepage::   For hand crafted title pages.
* verbatim::    Simulating typed input.
* verse::       For poetry and other things.


File: latex2e.info,  Node: abstract,  Next: array,  Up: Environments

9.1 'abstract'
==============

Synopsis:
     \begin{abstract}
     ...
     \end{abstract}

   Environment for producing an abstract, possibly of multiple
paragraphs.


File: latex2e.info,  Node: array,  Next: center,  Prev: abstract,  Up: Environments

9.2 'array'
===========

Synopsis:

     \begin{array}{TEMPLATE}
     COL1 TEXT&COL1 TEXT&COLN}\\
     ...
     \end{array}

   Math arrays are produced with the 'array' environment, normally
within an 'equation' environment (*note equation::).  It has a single
mandatory TEMPLATE argument describing the number of columns and the
alignment within them.  Each column COL is specified by a single letter
that tells how items in that row should be formatted, as follows:

'c'
     centered
'l'
     flush left
'r'
     flush right

   Column entries are separated by '&'.  Column entries may include
other LaTeX commands.  Each row of the array is terminated with '\\'.

   In the template, the construct '@{TEXT}' puts TEXT between columns in
each row.

   Here's an example:

     \begin{equation}
       \begin{array}{lrc}
       left1 & right1 & centered1 \\
       left2 & right2 & centered2 \\
       \end{array}
     \end{equation}

   The '\arraycolsep' parameter defines half the width of the space
separating columns; the default is '5pt'.  *Note tabular::, for other
parameters which affect formatting in 'array' environments, namely
'\arrayrulewidth' and '\arraystretch'.

   The 'array' environment can only be used in math mode.


File: latex2e.info,  Node: center,  Next: description,  Prev: array,  Up: Environments

9.3 'center'
============

Synopsis:

     \begin{center}
     LINE1 \\
     LINE2 \\
     \end{center}

   The '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 string '\\'.

* Menu:

* \centering::          Declaration form of the 'center' environment.


File: latex2e.info,  Node: \centering,  Up: center

9.3.1 '\centering'
------------------

The '\centering' declaration corresponds to the 'center' environment.
This declaration can be used inside an environment such as 'quote' or in
a 'parbox'.  Thus, the text of a figure or table can be centered on the
page by putting a '\centering' command at the beginning of the figure or
table environment.

   Unlike the 'center' environment, the '\centering' command does not
start a new paragraph; it simply changes how LaTeX formats paragraph
units.  To affect a paragraph unit's format, the scope of the
declaration must contain the blank line or '\end' command (of an
environment such as quote) that ends the paragraph unit.

   Here's an example:

     \begin{quote}
     \centering
     first line \\
     second line \\
     \end{quote}


File: latex2e.info,  Node: description,  Next: displaymath,  Prev: center,  Up: Environments

9.4 'description'
=================

Synopsis:

     \begin{description}
     \item [LABEL1] ITEM1
     \item [LABEL2] ITEM2
     ...
     \end{description}

   The 'description' environment is used to make labelled lists.  Each
LABEL is typeset in bold, flush right.  The ITEM text may contain
multiple paragraphs.

   Another variation: since the bold style is applied to the labels, if
you typeset a label in typewriter using '\texttt', you'll get bold
typewriter: '\item[\texttt{bold and typewriter}]'.  This may be too
bold, among other issues.  To get just typewriter, use '\tt', which
resets all other style variations: '\item[{\tt plain typewriter}]'.

   For details about list spacing, see *note itemize::.


File: latex2e.info,  Node: displaymath,  Next: document,  Prev: description,  Up: Environments

9.5 'displaymath'
=================

Synopsis:

     \begin{displaymath}
     MATH
     \end{displaymath}

or

     \[MATH\]

   The 'displaymath' environment ('\[...\]' is a synonym) typesets the
MATH text on its own line, centered by default.  The global 'fleqn'
option makes equations flush left; see *note Document class options::.

   No equation number is added to 'displaymath' text; to get an equation
number, use the 'equation' environment (*note equation::).


File: latex2e.info,  Node: document,  Next: enumerate,  Prev: displaymath,  Up: Environments

9.6 'document'
==============

The 'document' environment encloses the body of a document.  It is
required in every LaTeX document.  *Note Starting & ending::.


File: latex2e.info,  Node: enumerate,  Next: eqnarray,  Prev: document,  Up: Environments

9.7 'enumerate'
===============

Synopsis:

     \begin{enumerate}
     \item ITEM1
     \item ITEM2
     ...
     \end{enumerate}

   The 'enumerate' environment produces a numbered list.  Enumerations
can be nested within one another, up to four levels deep.  They can also
be nested within other paragraph-making environments, such as 'itemize'
(*note itemize::) and 'description' (*note description::).

   Each item of an enumerated list begins with an '\item' command.
There must be at least one '\item' command within the environment.

   By default, the numbering at each level is done like this:

  1. 1., 2., ...
  2. (a), (b), ...
  3. i., ii., ...
  4. A., B., ...

   The 'enumerate' environment uses the counters '\enumi' through
'\enumiv' counters (*note Counters::).  If the optional argument to
'\item' is given, the counter is not incremented for that item.

   The 'enumerate' environment uses the commands '\labelenumi' through
'\labelenumiv' to produce the default label.  So, you can use
'\renewcommand' to change the labels (*note \newcommand &
\renewcommand::).  For instance, to have the first level use uppercase
letters:

     \renewcommand{\labelenumi}{\Alph{enumi}}


File: latex2e.info,  Node: eqnarray,  Next: equation,  Prev: enumerate,  Up: Environments

9.8 'eqnarray'
==============

First, a caveat: the 'eqnarray' environment has some infelicities which
cannot be overcome; the article "Avoid eqnarray!" by Lars Madsen
describes them in detail
(<http://tug.org/TUGboat/tb33-1/tb103madsen.pdf>).  The bottom line is
that it is better to use the 'align' environment (and others) from the
'amsmath' package.

   Nevertheless, here is a description of 'eqnarray':

     \begin{eqnarray}  (or 'eqnarray*')
     FORMULA1 \\
     FORMULA2 \\
     ...
     \end{eqnarray}

   The 'eqnarray' environment is used to display a sequence of equations
or inequalities.  It is very much like a three-column 'array'
environment, with consecutive rows separated by '\\' and consecutive
items within a row separated by an '&'.

   '\\*' can also be used to separate equations, with its normal meaning
of not allowing a page break at that line.

   An equation number is placed on every line unless that line has a
'\nonumber' command.  Alternatively, The '*'-form of the environment
('\begin{eqnarray*} ... \end{eqnarray*}') will omit equation numbering
entirely, while otherwise being the same as 'eqnarray'.

   The command '\lefteqn' is used for splitting long formulas across
lines.  It typesets its argument in display style flush left in a box of
zero width.


File: latex2e.info,  Node: equation,  Next: figure,  Prev: eqnarray,  Up: Environments

9.9 'equation'
==============

Synopsis:

     \begin{equation}
     MATH
     \end{equation}

   The 'equation' environment starts a 'displaymath' environment (*note
displaymath::), e.g., centering the MATH text on the page, and also
places an equation number in the right margin.


File: latex2e.info,  Node: figure,  Next: flushleft,  Prev: equation,  Up: Environments

9.10 'figure'
=============

     \begin{figure[*]}[PLACEMENT]
     FIGBODY
     \label{LABEL}
     \caption[LOFTITLE]{TEXT}
     \end{figure}

   Figures are objects that are not part of the normal text, and are
instead "floated" to a convenient place, such as the top of a page.
Figures will not be split between two pages.

   When typesetting in double-columns, the starred form produces a
full-width figure (across both columns).

   The optional argument '[placement]' determines where LaTeX will try
to place your figure.  There are four places where LaTeX can possibly
put a float:

't'
     (Top)--at the top of a text page.

'b'
     (Bottom)--at the bottom of a text page.  However, 'b' is not
     allowed for full-width floats ('figure*') with double-column
     output.  To ameliorate this, use the 'stfloats' or 'dblfloatfix'
     package, but see the discussion at caveats in the FAQ:
     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat>.

'h'
     (Here)--at the position in the text where the figure environment
     appears.  However, this is not allowed by itself; 't' is
     automatically added.

     To absolutely force a figure to appear "here", you can
     '\usepackage{float}' and use the 'H' specifier which it defines.
     For further discussion, see the FAQ entry at
     <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere>.

'p'
     (Page of floats)--on a separate float page, which is a page
     containing no text, only floats.

'!'
     Used in addition to one of the above; for this float only, LaTeX
     ignores the restrictions on both the number of floats that can
     appear and the relative amounts of float and non-float text on the
     page.  The '!' specifier does _not_ mean "put the float here"; see
     above.

   The standard report and article classes use the default placement
'tbp'.

   The body of the figure is made up of whatever text, LaTeX commands,
etc. you wish.

   The '\caption' command specifies caption TEXT for the figure.  The
caption is numbered by default.  If LOFTITLE is present, it is used in
the list of figures instead of TEXT (*note Tables of contents::).

   Parameters relating to fractions of pages occupied by float and
non-float text:

     The maximum fraction of the page allowed to be occuped by floats at
     the bottom; default '.3'.

'\floatpagefraction'
     The minimum fraction of a float page that must be occupied by
     floats; default '.5'.

'\textfraction'
     Minimum fraction of a page that must be text; if floats take up too
     much space to preserve this much text, floats will be moved to a
     different page.  The default is '.2'.

'\topfraction'
     Maximum fraction at the top of a page that may be occupied before
     floats; default '.7'.

   Parameters relating to vertical space around floats:

'\floatsep'
     Space between floats at the top or bottom of a page; default '12pt
     plus2pt minus2pt'.

'\intextsep'
     Space above and below a float in the middle of the main text;
     default '12pt plus2pt minus2pt' for '10pt' and '11pt' styles, '14pt
     plus4pt minus4pt' for '12pt'.

'\textfloatsep'
     Space between the last (first) float at the top (bottom) of a page;
     default '20pt plus2pt minus4pt'.

   Parameters relating to the number of floats on a page:

'\bottomnumber'
     Maximum number of floats that can appear at the bottom of a text
     page; default 1.

'\topnumber'
     Maximum number of floats that can appear at the top of a text page;
     default 2.

'\totalnumber'
     Maximum number of floats that can appear on a text page; default 3.

   The principal TeX FAQ entry relating to floats:
<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats>.


File: latex2e.info,  Node: flushleft,  Next: flushright,  Prev: figure,  Up: Environments

9.11 'flushleft'
================

     \begin{flushleft}
     LINE1 \\
     LINE2 \\
     ...
     \end{flushleft}

   The 'flushleft' environment allows you to create a paragraph
consisting of lines that are flush to the left-hand margin and ragged
right Each line must be terminated with the string '\\'.

* Menu:

* \raggedright::        Declaration form of the 'flushleft' environment.


File: latex2e.info,  Node: \raggedright,  Up: flushleft

9.11.1 '\raggedright'
---------------------

The '\raggedright' declaration corresponds to the 'flushleft'
environment.  This declaration can be used inside an environment such as
'quote' or in a 'parbox'.

   Unlike the 'flushleft' environment, the '\raggedright' command does
not start a new paragraph; it only changes how LaTeX formats paragraph
units.  To affect a paragraph unit's format, the scope of the
declaration must contain the blank line or '\end' command that ends the
paragraph unit.


File: latex2e.info,  Node: flushright,  Next: itemize,  Prev: flushleft,  Up: Environments

9.12 'flushright'
=================

     \begin{flushright}
     LINE1 \\
     LINE2 \\
     ...
     \end{flushright}

   The 'flushright' environment allows you to create a paragraph
consisting of lines that are flush to the right-hand margin and ragged
left.  Each line must be terminated with the string '\\'.

* Menu:

* \raggedleft::   Declaration form of the 'flushright' environment.


File: latex2e.info,  Node: \raggedleft,  Up: flushright

9.12.1 '\raggedleft'
--------------------

The '\raggedleft' declaration corresponds to the 'flushright'
environment.  This declaration can be used inside an environment such as
'quote' or in a 'parbox'.

   Unlike the 'flushright' environment, the '\raggedleft' command does
not start a new paragraph; it only changes how LaTeX formats paragraph
units.  To affect a paragraph unit's format, the scope of the
declaration must contain the blank line or '\end' command that ends the
paragraph unit.


File: latex2e.info,  Node: itemize,  Next: letter,  Prev: flushright,  Up: Environments

9.13 'itemize'
==============

Synopsis:

     \begin{itemize}
     \item ITEM1
     \item ITEM2
     ...
     \end{itemize}

   The 'itemize' environment produces an "unordered", "bulleted" list.
Itemizations can be nested within one another, up to four levels deep.
They can also be nested within other paragraph-making environments, such
as 'enumerate' (*note enumerate::).

   Each item of an 'itemize' list begins with an '\item' command.  There
must be at least one '\item' command within the environment.

   By default, the marks at each level look like this:

  1. * (bullet)
  2. -- (bold en-dash)
  3. * (asterisk)
  4. .  (centered dot, rendered here as a period)

   The 'itemize' environment uses the commands '\labelitemi' through
'\labelitemiv' to produce the default label.  So, you can use
'\renewcommand' to change the labels.  For instance, to have the first
level use diamonds:

     \renewcommand{\labelitemi}{$\diamond$}

   The '\leftmargini' through '\leftmarginvi' parameters define the
distance between the left margin of the enclosing environment and the
left margin of the list.  By convention, '\leftmargin' is set to the
appropriate '\leftmarginN' when a new level of nesting is entered.

   The defaults vary from '.5em' (highest levels of nesting) to '2.5em'
(first level), and are a bit reduced in two-column mode.  This example
greatly reduces the margin space for outermost lists:

     \setlength{\leftmargini}{1.25em} % default 2.5em

   Some parameters that affect list formatting:

'\itemindent'
     Extra indentation before each item in a list; default zero.

'\labelsep'
     Space between the label and text of an item; default '.5em'.

'\labelwidth'
     Width of the label; default '2em', or '1.5em' in two-column mode.

'\listparindent'
     Extra indentation added to second and subsequent paragraphs within
     a list item; default '0pt'.

'\rightmargin'
     Horizontal distance between the right margin of the list and the
     enclosing environment; default '0pt', except in the 'quote',
     'quotation', and 'verse' environments, where it is set equal to
     '\leftmargin'.

   Parameters affecting vertical spacing between list items (rather
loose, by default).

'\itemsep'
     Vertical space between items.  The default is '2pt plus1pt
     minus1pt' for '10pt' documents, '3pt plus2pt minus1pt' for '11pt',
     and '4.5pt plus2pt minus1pt' for '12pt'.

'\parsep'
     Extra vertical space between paragraphs within a list item.
     Defaults are the same as '\itemsep'.

'\topsep'
     Vertical space between the first item and the preceding paragraph.
     For top-level lists, the default is '8pt plus2pt minus4pt' for
     '10pt' documents, '9pt plus3pt minus5pt' for '11pt', and '10pt
     plus4pt minus6pt' for '12pt'.  These are reduced for nested lists.

'\partopsep'
     Extra space added to '\topsep' when the list environment starts a
     paragraph.  The default is '2pt plus1pt minus1pt' for '10pt'
     documents, '3pt plus1pt minus1pt' for '11pt', and '3pt plus2pt
     minus2pt' for '12pt'.

   Especially for lists with short items, it may be desirable to elide
space between items.  Here is an example defining an 'itemize*'
environment with no extra spacing between items, or between paragraphs
within a single item ('\parskip' is not list-specific, *note
\parskip::):

     \newenvironment{itemize*}%
       {\begin{itemize}%
         \setlength{\itemsep}{0pt}%
         \setlength{\parsep}{0pt}}%
         \setlength{\parskip}{0pt}}%
       {\end{itemize}}


File: latex2e.info,  Node: letter,  Next: list,  Prev: itemize,  Up: Environments

9.14 'letter' environment: writing letters
==========================================

This environment is used for creating letters.  *Note Letters::.


File: latex2e.info,  Node: list,  Next: math,  Prev: letter,  Up: Environments

9.15 'list'
===========

The 'list' environment is a generic environment which is used for
defining many of the more specific environments.  It is seldom used in
documents, but often in macros.

     \begin{list}{LABELING}{SPACING}
     \item ITEM1
     \item ITEM2
     ...
     \end{list}

   The mandatory LABELING argument specifies how items should be
labelled (unless the optional argument is supplied to '\item').  This
argument is a piece of text that is inserted in a box to form the label.
It can and usually does contain other LaTeX commands.

   The mandatory SPACING argument contains commands to change the
spacing parameters for the list.  This argument will most often be
empty, i.e., '{}', which leaves the default spacing.

   The width used for typesetting the list items is specified by
'\linewidth' (*note Page layout parameters::).


File: latex2e.info,  Node: math,  Next: minipage,  Prev: list,  Up: Environments

9.16 'math'
===========

Synopsis:

     \begin{math}
     MATH
     \end{math}

   The 'math' environment inserts the given MATH within the running
text.  '\(...\))' and '$...$' are synonyms.  *Note Math formulas::.


File: latex2e.info,  Node: minipage,  Next: picture,  Prev: math,  Up: Environments

9.17 'minipage'
===============

     \begin{minipage}[POSITION][HEIGHT][INNER-POS]{WIDTH}
     TEXT
     \end{minipage}

   The 'minipage' environment typesets its body TEXT in a block that
will not be broken across pages.  This is similar to the '\parbox'
command (*note \parbox::), but unlike '\parbox', other paragraph-making
environments can be used inside a minipage.

   The arguments are the same as for '\parbox' (*note \parbox::).

   By default, paragraphs are not indented in the 'minipage'
environment.  You can restore indentation with a command such as
'\setlength{\parindent}{1pc}' command.

   Footnotes in a 'minipage' environment are handled in a way that is
particularly useful for putting footnotes in figures or tables.  A
'\footnote' or '\footnotetext' command puts the footnote at the bottom
of the minipage instead of at the bottom of the page, and it uses the
'\mpfootnote' counter instead of the ordinary 'footnote' counter (*note
Counters::).

   However, don't put one minipage inside another if you are using
footnotes; they may wind up at the bottom of the wrong minipage.


File: latex2e.info,  Node: picture,  Next: quotation,  Prev: minipage,  Up: Environments

9.18 'picture'
==============

     \begin{picture}(width,height)(x offset,y offset)
     ... PICTURE COMMANDS ...
     \end{picture}

   The 'picture' environment allows you to create just about any kind of
picture you want containing text, lines, arrows and circles.  You tell
LaTeX where to put things in the picture by specifying their
coordinates.  A coordinate is a number that may have a decimal point and
a minus sign--a number like '5', '0.3' or '-3.1416'.  A coordinate
specifies a length in multiples of the unit length '\unitlength', so if
'\unitlength' has been set to '1cm', then the coordinate 2.54 specifies
a length of 2.54 centimeters.

   You should only change the value of '\unitlength', using the
'\setlength' command, outside of a 'picture' environment.  The default
value is '1pt'.

   A position is a pair of coordinates, such as '(2.4,-5)', specifying
the point with x-coordinate '2.4' and y-coordinate '-5'.  Coordinates
are specified in the usual way with respect to an origin, which is
normally at the lower-left corner of the picture.  Note that when a
position appears as an argument, it is not enclosed in braces; the
parentheses serve to delimit the argument.

   The 'picture' environment has one mandatory argument, which is a
'position'.  It specifies the size of the picture.  The environment
produces a rectangular box with width and height determined by this
argument's x- and y-coordinates.

   The 'picture' environment also has an optional 'position' argument,
following the 'size' argument, that can change the origin.  (Unlike
ordinary optional arguments, this argument is not contained in square
brackets.)  The optional argument gives the coordinates of the point at
the lower-left corner of the picture (thereby determining the origin).
For example, if '\unitlength' has been set to '1mm', the command

     \begin{picture}(100,200)(10,20)

produces a picture of width 100 millimeters and height 200 millimeters,
whose lower-left corner is the point (10,20) and whose upper-right
corner is therefore the point (110,220).  When you first draw a picture,
you typically omit the optional argument, leaving the origin at the
lower-left corner.  If you then want to modify your picture by shifting
everything, you can just add the appropriate optional argument.

   The environment's mandatory argument determines the nominal size of
the picture.  This need bear no relation to how large the picture really
is; LaTeX will happily allow you to put things outside the picture, or
even off the page.  The picture's nominal size is used by LaTeX in
determining how much room to leave for it.

   Everything that appears in a picture is drawn by the '\put' command.
The command

     \put (11.3,-.3){...}

puts the object specified by '...' in the picture, with its reference
point at coordinates (11.3,-.3).  The reference points for various
objects will be described below.

   The '\put' command creates an "LR box".  You can put anything that
can go in an '\mbox' (*note \mbox::) in the text argument of the '\put'
command.  When you do this, the reference point will be the lower left
corner of the box.

   The 'picture' commands are described in the following sections.

* Menu:

* \circle::             Draw a circle.
* \makebox (picture)::  Draw a box of the specified size.
* \framebox (picture):: Draw a box with a frame around it.
* \dashbox::            Draw a dashed box.
* \frame::              Draw a frame around an object.
* \line::               Draw a straight line.
* \linethickness::      Set the line thickness.
* \thicklines::         A heavier line thickness.
* \thinlines::          The default line thickness.
* \multiput::           Draw multiple instances of an object.
* \oval::               Draw an ellipse.
* \put::                Place an object at a specified place.
* \shortstack::         Make a pile of objects.
* \vector::             Draw a line with an arrow.


File: latex2e.info,  Node: \circle,  Next: \makebox (picture),  Up: picture

9.18.1 '\circle'
----------------

     \circle[*]{DIAMETER}

   The '\circle' command produces a circle with a diameter as close to
the specified one as possible.  The '*'-form of the command draws a
solid circle.

   Circles up to 40 pt can be drawn.


File: latex2e.info,  Node: \makebox (picture),  Next: \framebox (picture),  Prev: \circle,  Up: picture

9.18.2 '\makebox'
-----------------

'\makebox(width,height)[position]{...}'

   The '\makebox' command for the picture environment is similar to the
normal '\makebox' command except that you must specify a 'width' and
'height' in multiples of '\unitlength'.

   The optional argument, '[position]', specifies the quadrant that your
text appears in.  You may select up to two of the following:

't'
     Moves the item to the top of the rectangle.

'b'
     Moves the item to the bottom.

'l'
     Moves the item to the left.

'r'
     Moves the item to the right.

   *Note \makebox::.


File: latex2e.info,  Node: \framebox (picture),  Next: \dashbox,  Prev: \makebox (picture),  Up: picture

9.18.3 '\framebox'
------------------

Synopsis:

     \framebox(WIDTH,HEIGHT)[POS]{...}

   The '\framebox' command is like '\makebox' (see previous section),
except that it puts a frame around the outside of the box that it
creates.

   The '\framebox' command produces a rule of thickness '\fboxrule', and
leaves a space '\fboxsep' between the rule and the contents of the box.


File: latex2e.info,  Node: \dashbox,  Next: \frame,  Prev: \framebox (picture),  Up: picture

9.18.4 '\dashbox'
-----------------

Draws a box with a dashed line.  Synopsis:

     \dashbox{DLEN}(RWIDTH,RHEIGHT)[POS]{TEXT}

   '\dashbox' creates a dashed rectangle around TEXT in a 'picture'
environment.  Dashes are DLEN units long, and the rectangle has overall
width RWIDTH and height RHEIGHT.  The TEXT is positioned at optional
POS.

   A dashed box looks best when the 'rwidth' and 'rheight' are multiples
of the 'dlen'.


File: latex2e.info,  Node: \frame,  Next: \line,  Prev: \dashbox,  Up: picture

9.18.5 '\frame'
---------------

Synopsis:

     \frame{TEXT}

   The '\frame' command puts a rectangular frame around TEXT.  The
reference point is the bottom left corner of the frame.  No extra space
is put between the frame and the object.


File: latex2e.info,  Node: \line,  Next: \linethickness,  Prev: \frame,  Up: picture

9.18.6 '\line'
--------------

Synopsis:

     \line(XSLOPE,YSLOPE){LENGTH}

   The '\line' command draws a line with the given LENGTH and slope
XSLOPE/YSLOPE.

   Standard LaTeX can only draw lines with SLOPE = x/y, where x and y
have integer values from -6 through 6.  For lines of any slope, not to
mention other shapes, see the 'curve2e' and many many other packages on
CTAN.


File: latex2e.info,  Node: \linethickness,  Next: \thicklines,  Prev: \line,  Up: picture

9.18.7 '\linethickness'
-----------------------

The '\linethickness{DIM}' command declares the thickness of horizontal
and vertical lines in a picture environment to be DIM, which must be a
positive length.

   '\linethickness' does not affect the thickness of slanted lines,
circles, or the quarter circles drawn by '\oval'.


File: latex2e.info,  Node: \thicklines,  Next: \thinlines,  Prev: \linethickness,  Up: picture

9.18.8 '\thicklines'
--------------------

The '\thicklines' command is an alternate line thickness for horizontal
and vertical lines in a picture environment; cf. *note \linethickness::
and *note \thinlines::.


File: latex2e.info,  Node: \thinlines,  Next: \multiput,  Prev: \thicklines,  Up: picture

9.18.9 '\thinlines'
-------------------

The '\thinlines' command is the default line thickness for horizontal
and vertical lines in a picture environment; cf. *note \linethickness::
and *note \thicklines::.


File: latex2e.info,  Node: \multiput,  Next: \oval,  Prev: \thinlines,  Up: picture

9.18.10 '\multiput'
-------------------

Synopsis:
     \multiput(X,Y)(DELTA_X,DELTA_Y){N}{OBJ}

   The '\multiput' command copies the object OBJ in a regular pattern
across a picture.  OBJ is first placed at position (x,y), then at
(x+\delta x,y+\delta y), and so on, N times.


File: latex2e.info,  Node: \oval,  Next: \put,  Prev: \multiput,  Up: picture

9.18.11 '\oval'
---------------

Synopsis:

     \oval(WIDTH,HEIGHT)[PORTION]

   The '\oval' command produces a rectangle with rounded corners.  The
optional argument PORTION allows you to select part of the oval via the
following:

't'
     selects the top portion;
'b'
     selects the bottom portion;
'r'
     selects the right portion;
'l'
     selects the left portion.

   The "corners" of the oval are made with quarter circles with a
maximum radius of 20pt, so large "ovals" will look more like boxes with
rounded corners.


File: latex2e.info,  Node: \put,  Next: \shortstack,  Prev: \oval,  Up: picture

9.18.12 '\put'
--------------

'\put(x coord,y coord){ ... }'

   The '\put' command places the item specified by the mandatory
argument at the given coordinates.


File: latex2e.info,  Node: \shortstack,  Next: \vector,  Prev: \put,  Up: picture

9.18.13 '\shortstack'
---------------------

Synopsis:

     \shortstack[POSITION]{...\\...\\...}

   The '\shortstack' command produces a stack of objects.  The valid
positions are:

'r'
     Move the objects to the right of the stack.
'l'
     Move the objects to the left of the stack
'c'
     Move the objects to the centre of the stack (default)

   Objects are separated with '\\'.


File: latex2e.info,  Node: \vector,  Prev: \shortstack,  Up: picture

9.18.14 '\vector'
-----------------

Synopsis:

     \vector(X-SLOPE,Y-SLOPE){LENGTH}

   The '\vector' command draws a line with an arrow of the specified
length and slope.  The x and y values must lie between -4 and +4,
inclusive.


File: latex2e.info,  Node: quotation,  Next: quote,  Prev: picture,  Up: Environments

9.19 'quotation'
================

Synopsis:

     \begin{quotation}
     TEXT
     \end{quotation}

   The margins of the 'quotation' environment are indented on both the
left and the right.  The text is justified at both margins.  Leaving a
blank line between text produces a new paragraph.

   Unlike the 'quote' environment, each paragraph is indented normally.


File: latex2e.info,  Node: quote,  Next: tabbing,  Prev: quotation,  Up: Environments

9.20 'quote'
============

Snyopsis:

     \begin{quote}
     TEXT
     \end{quote}

   The margins of the 'quote' environment are indented on both the left
and the right.  The text is justified at both margins.  Leaving a blank
line between text produces a new paragraph.

   Unlike the 'quotation' environment, paragraphs are not indented.


File: latex2e.info,  Node: tabbing,  Next: table,  Prev: quote,  Up: Environments

9.21 'tabbing'
==============

Synopsis:

     \begin{tabbing}
     ROW1COL1 \= ROW1COL2 \= ROW1COL3 \= ROW1COL4 \\
     ROW2COL1 \>                \> ROW2COL3 \\
     ...
     \end{tabbing}

   The 'tabbing' environment provides a way to align text in columns.
It works by setting tab stops and tabbing to them much as was done on an
ordinary typewriter.  It is best suited for cases where the width of
each column is constant and known in advance.

   This environment can be broken across pages, unlike the 'tabular'
environment.

   The following commands can be used inside a 'tabbing' enviroment:

'\\ (tabbing)'
     End a line.

'\= (tabbing)'
     Sets a tab stop at the current position.

'\> (tabbing)'
     Advances to the next tab stop.

'\<'
     Put following text to the left of the local margin (without
     changing the margin).  Can only be used at the start of the line.

'\+'
     Moves the left margin of the next and all the following commands
     one tab stop to the right, beginning tabbed line if necessary.

'\-'
     Moves the left margin of the next and all the following commands
     one tab stop to the left, beginning tabbed line if necessary.

'\' (tabbing)'
     Moves everything that you have typed so far in the current column,
     i.e.  everything from the most recent '\>', '\<', '\'', '\\', or
     '\kill' command, to the right of the previous column, flush against
     the current column's tab stop.

'\` (tabbing)'
     Allows you to put text flush right against any tab stop, including
     tab stop 0.  However, it can't move text to the right of the last
     column because there's no tab stop there.  The '\`' command moves
     all the text that follows it, up to the '\\' or '\end{tabbing}'
     command that ends the line, to the right margin of the tabbing
     environment.  There must be no '\>' or '\'' command between the
     '\`' and the command that ends the line.

'\a (tabbing)'
     In a 'tabbing' environment, the commands '\=', '\'' and '\`' do not
     produce accents as usual (*note Accents::).  Instead, the commands
     '\a=', '\a'' and '\a`' are used.

'\kill'
     Sets tab stops without producing text.  Works just like '\\' except
     that it throws away the current line instead of producing output
     for it.  The effect of any '\=', '\+' or '\-' commands in that line
     remain in effect.

'\poptabs'
     Restores the tab stop positions saved by the last '\pushtabs'.

'\pushtabs'
     Saves all current tab stop positions.  Useful for temporarily
     changing tab stop positions in the middle of a 'tabbing'
     environment.

'\tabbingsep'
     Distance to left of tab stop moved by '\''.

   This example typesets a Pascal function in a traditional format:

     \begin{tabbing}
     function \= fact(n : integer) : integer;\\
              \> begin \= \+ \\
                    \> if \= n $>$ 1 then \+ \\
                             fact := n * fact(n-1) \- \\
                       else \+ \\
                             fact := 1; \-\- \\
                 end;\\
     \end{tabbing}


File: latex2e.info,  Node: table,  Next: tabular,  Prev: tabbing,  Up: Environments

9.22 'table'
============

Synopsis:

      \begin{table}[placement]

       body of the table

      \caption{table title}
      \end{table}

   Tables are objects that are not part of the normal text, and are
usually "floated" to a convenient place, like the top of a page.  Tables
will not be split between two pages.

   The optional argument '[placement]' determines where LaTeX will try
to place your table.  There are four places where LaTeX can possibly put
a float; these are the same as that used with the 'figure' environment,
and described there (*note figure::).

   The standard 'report' and 'article' classes use the default placement
'[tbp]'.

   The body of the table is made up of whatever text, LaTeX commands,
etc., you wish.  The '\caption' command allows you to title your table.


File: latex2e.info,  Node: tabular,  Next: thebibliography,  Prev: table,  Up: Environments

9.23 'tabular'
==============

Synopsis:

     \begin{tabular}[pos]{cols}
     column 1 entry & column 2 entry ... & column n entry \\
     ...
     \end{tabular}

or

     \begin{tabular*}{width}[pos]{cols}
     column 1 entry & column 2 entry ... & column n entry \\
     ...
     \end{tabular*}

   These environments produce a box consisting of a sequence of rows of
items, aligned vertically in columns.

   '\\' must be used to specify the end of each row of the table, except
for the last, where it is optional--unless an '\hline' command (to put a
rule below the table) follows.

   The mandatory and optional arguments consist of:

'width'
     Specifies the width of the 'tabular*' environment.  There must be
     rubber space between columns that can stretch to fill out the
     specified width.

'pos'
     Specifies the vertical position; default is alignment on the centre
     of the environment.

     't'
          align on top row

     'b'
          align on bottom row

'cols'
     Specifies the column formatting.  It consists of a sequence of the
     following specifiers, corresponding to the sequence of columns and
     intercolumn material.

     'l'
          A column of left-aligned items.

     'r'
          A column of right-aligned items.

     'c'
          A column of centered items.

     '|'
          A vertical line the full height and depth of the environment.

     '@{TEXT}'
          This inserts TEXT in every row.  An @-expression suppresses
          the intercolumn space normally inserted between columns; any
          desired space before the adjacent item must be included in
          TEXT.

          To insert commands that are automatically executed before a
          given column, you have to load the 'array' package and use the
          '>{...}' specifier.

          An '\extracolsep{wd}' command in an @-expression causes an
          extra space of width 'wd' to appear to the left of all
          subsequent columns, until countermanded by another
          '\extracolsep' command.  Unlike ordinary intercolumn space,
          this extra space is not suppressed by an @-expression.  An
          '\extracolsep' command can be used only in an @-expression in
          the 'cols' argument.

     'p{WD}'
          Produces a column with each item typeset in a parbox of width
          WD, as if it were the argument of a '\parbox[t]{WD}' command.
          However, a '\\' may not appear in the item, except in the
          following situations:

            1. inside an environment like 'minipage', 'array', or
               'tabular'.
            2. inside an explicit '\parbox'.
            3. in the scope of a '\centering', '\raggedright', or
               '\raggedleft' declaration.  The latter declarations must
               appear inside braces or an environment when used in a
               'p'-column element.

     '*{NUM}{COLS}'
          Equivalent to NUM copies of COLS, where NUM is a positive
          integer and COLS is any list of column-specifiers, which may
          contain another '*-expression'.

   Parameters that control formatting:

'\arrayrulewidth'
     Thickness of the rule created by '|', '\hline', and '\vline' in the
     'tabular' and 'array' environments; the default is '.4pt'.

'\arraystretch'
     Scaling of spacing between rows in the 'tabular' and 'array'
     environments; default is '1', for no scaling.

'\doublerulesep'
     Horizontal distance between the vertical rules produced by '||' in
     the 'tabular' and 'array' environments; default is '2pt'.

'\tabcolsep'
     Half the width of the space between columns; default is '6pt'.

   The following commands can be used inside a 'tabular' environment:

* Menu:

* \multicolumn::        Make an item spanning several columns.
* \cline::              Draw a horizontal line spanning some columns.
* \hline::              Draw a horizontal line spanning all columns.
* \vline::              Draw a vertical line.


File: latex2e.info,  Node: \multicolumn,  Next: \cline,  Up: tabular

9.23.1 '\multicolumn'
---------------------

Synopsis:
     \multicolumn{COLS}{POS}{TEXT}

   The '\multicolumn' command makes an entry that spans several columns.
The first mandatory argument, COLS, specifies the number of columns to
span.  The second mandatory argument, POS, specifies the formatting of
the entry; 'c' for centered, 'l' for flushleft, 'r' for flushright.  The
third mandatory argument, TEXT, specifies what text to put in the entry.

   Here's an example showing two columns separated by an en-dash;
'\multicolumn' is used for the heading:

     \begin{tabular}{r@{--}l}
     \multicolumn{2}{c}{\bf Unicode}\cr
        0x80&0x7FF   \cr
       0x800&0xFFFF  \cr
     0x10000&0x1FFFF \cr
     \end{tabular}


File: latex2e.info,  Node: \cline,  Next: \hline,  Prev: \multicolumn,  Up: tabular

9.23.2 '\cline'
---------------

Synopsis:

     \cline{I-J}

   The '\cline' command draws horizontal lines across the columns
specified, beginning in column I and ending in column J, which are
specified in the mandatory argument.


File: latex2e.info,  Node: \hline,  Next: \vline,  Prev: \cline,  Up: tabular

9.23.3 '\hline'
---------------

The '\hline' command draws a horizontal line the width of the enclosing
'tabular' or 'array' environment.  It's most commonly used to draw a
line at the top, bottom, and between the rows of a table.


File: latex2e.info,  Node: \vline,  Prev: \hline,  Up: tabular

9.23.4 '\vline'
---------------

The '\vline' command will draw a vertical line extending the full height
and depth of its row.  An '\hfill' command can be used to move the line
to the edge of the column.  It can also be used in an @-expression.


File: latex2e.info,  Node: thebibliography,  Next: theorem,  Prev: tabular,  Up: Environments

9.24 'thebibliography'
======================

Synopsis:

     \begin{thebibliography}{WIDEST-LABEL}
     \bibitem[LABEL]{CITE_KEY}
     ...
     \end{thebibliography}

   The 'thebibliography' environment produces a bibliography or
reference list.

   In the 'article' class, this reference list is labelled "References";
in the 'report' class, it is labelled "Bibliography".  You can change
the label (in the standard classes) by redefining the command
'\refname'.  For instance, this eliminates it entirely:

     \renewcommand{\refname}{}

   The mandatory WIDEST-LABEL argument is text that, when typeset, is as
wide as the widest item label produced by the '\bibitem' commands.  It
is typically given as '9' for bibliographies with less than 10
references, '99' for ones with less than 100, etc.

* Menu:

* \bibitem::            Specify a bibliography item.
* \cite::               Refer to a bibliography item.
* \nocite::             Include an item in the bibliography.
* Using BibTeX::        Automatic generation of bibliographies.


File: latex2e.info,  Node: \bibitem,  Next: \cite,  Up: thebibliography

9.24.1 '\bibitem'
-----------------

Synopsis:
     \bibitem[LABEL]{CITE_KEY}

   The '\bibitem' command generates an entry labelled by LABEL.  If the
LABEL argument is missing, a number is automatically generated using the
'enumi' counter.  The CITE_KEY is any sequence of letters, numbers, and
punctuation symbols not containing a comma.

   This command writes an entry to the '.aux' file containing the item's
CITE_KEY and label.  When the '.aux' file is read by the
'\begin{document}' command, the item's 'label' is associated with
'cite_key', causing references to CITE_KEY with a '\cite' command (see
next section) to produce the associated label.


File: latex2e.info,  Node: \cite,  Next: \nocite,  Prev: \bibitem,  Up: thebibliography

9.24.2 '\cite'
--------------

Synopsis:

     \cite[SUBCITE]{KEYS

   The KEYS argument is a list of one or more citation keys, separated
by commas.  This command generates an in-text citation to the references
associated with KEYS by entries in the '.aux' file.

   The text of the optional SUBCITE argument appears after the citation.
For example, '\cite[p.~314]{knuth}' might produce '[Knuth, p. 314]'.


File: latex2e.info,  Node: \nocite,  Next: Using BibTeX,  Prev: \cite,  Up: thebibliography

9.24.3 '\nocite'
----------------

'\nocite{key_list}'

   The '\nocite' command produces no text, but writes 'key_list', which
is a list of one or more citation keys, on the '.aux' file.


File: latex2e.info,  Node: Using BibTeX,  Prev: \nocite,  Up: thebibliography

9.24.4 Using BibTeX
-------------------

If you use the BibTeX program by Oren Patashnik (highly recommended if
you need a bibliography of more than a couple of titles) to maintain
your bibliography, you don't use the 'thebibliography' environment
(*note thebibliography::).  Instead, you include the lines

     \bibliographystyle{BIBSTYLE}
     \bibliography{BIBFILE1,BIBFILE2}

   The '\bibliographystyle' command does not produce any output of its
own.  Rather, it defines the style in which the bibliography will be
produced: BIBSTYLE refers to a file BIBSTYLE'.bst', which defines how
your citations will look.  The standard STYLE names distributed with
BibTeX are:

'alpha'
     Sorted alphabetically.  Labels are formed from name of author and
     year of publication.
'plain'
     Sorted alphabetically.  Labels are numeric.
'unsrt'
     Like 'plain', but entries are in order of citation.
'abbrv'
     Like 'plain', but more compact labels.

   In addition, numerous other BibTeX style files exist tailored to the
demands of various publications.  See
<http://www.ctan.org/tex-archive/biblio/bibtex/contrib>.

   The '\bibliography' command is what actually produces the
bibliography.  The argument to '\bibliography' refers to files named
'BIBFILE.bib', which should contain your database in BibTeX format.
Only the entries referred to via '\cite' and '\nocite' will be listed in
the bibliography.


File: latex2e.info,  Node: theorem,  Next: titlepage,  Prev: thebibliography,  Up: Environments

9.25 'theorem'
==============

Synopsis:

     \begin{theorem}
     THEOREM-TEXT
     \end{theorem}

   The 'theorem' environment produces "Theorem N" in boldface followed
by THEOREM-TEXT, where the numbering possibilities for N are described
under '\newtheorem' (*note \newtheorem::).


File: latex2e.info,  Node: titlepage,  Next: verbatim,  Prev: theorem,  Up: Environments

9.26 'titlepage'
================

Synopsis:

     \begin{titlepage}
     TEXT
     \end{titlepage}

   The 'titlepage' environment creates a title page, i.e., a page with
no printed page number or heading.  It also causes the following page to
be numbered page one.  Formatting the title page is left to you.  The
'\today' command may be useful on title pages (*note \today::).

   You can use the '\maketitle' command (*note \maketitle::) to produce
a standard title page without a 'titlepage' environment.


File: latex2e.info,  Node: verbatim,  Next: verse,  Prev: titlepage,  Up: Environments

9.27 'verbatim'
===============

Synopsis:

     \begin{verbatim}
     LITERAL-TEXT
     \end{verbatim}

   The 'verbatim' environment is a paragraph-making environment in which
LaTeX produces exactly what you type in; for instance the '\' character
produces a printed '\'.  It turns LaTeX into a typewriter with carriage
returns and blanks having the same effect that they would on a
typewriter.

   The 'verbatim' uses a monospaced typewriter-like font ('\tt').

* Menu:

* \verb::       The macro form of the 'verbatim' environment.


File: latex2e.info,  Node: \verb,  Up: verbatim

9.27.1 '\verb'
--------------

Synopsis:

     \verbCHARLITERAL-TEXTCHAR
     \verb*CHARLITERAL-TEXTCHAR

   The '\verb' command typesets LITERAL-TEXT as it is input, including
special characters and spaces, using the typewriter ('\tt') font.  No
spaces are allowed between '\verb' or '\verb*' and the delimiter CHAR,
which begins and ends the verbatim text.  The delimiter must not appear
in LITERAL-TEXT.

   The '*'-form differs only in that spaces are printed with a "visible
space" character.


File: latex2e.info,  Node: verse,  Prev: verbatim,  Up: Environments

9.28 'verse'
============

Synopsis:

     \begin{verse}
     LINE1 \\
     LINE2 \\
     ...
     \end{verse}

   The 'verse' environment is designed for poetry, though you may find
other uses for it.

   The margins are indented on the left and the right, paragraphs are
not indented, and the text is not justified.  Separate the lines of each
stanza with '\\', and use one or more blank lines to separate the
stanzas.


File: latex2e.info,  Node: Line breaking,  Next: Page breaking,  Prev: Environments,  Up: Top

10 Line breaking
****************

The first thing LaTeX does when processing ordinary text is to translate
your input file into a sequence of glyphs and spaces.  To produce a
printed document, this sequence must be broken into lines (and these
lines must be broken into pages).

   LaTeX usually does the line (and page) breaking for you, but in some
environments, you do the line breaking yourself with the '\\' command,
and you can always manually force breaks.

* Menu:

* \\::                         Start a new line.
* \obeycr & \restorecr::       Make each input line start a new output line.
* \newline::                   Break the line
* \- (hyphenation)::           Insert explicit hyphenation.
* \fussy::                     Be fussy about line breaking.
* \sloppy::                    Be sloppy about line breaking.
* \hyphenation::               Tell LaTeX how to hyphenate a word.
* \linebreak & \nolinebreak::  Forcing & avoiding line breaks.


File: latex2e.info,  Node: \\,  Next: \obeycr & \restorecr,  Up: Line breaking

10.1 '\\'[*][MORESPACE]
=======================

The '\\' command tells LaTeX to start a new line.  It has an optional
argument, MORESPACE, that specifies how much extra vertical space is to
be inserted before the next line.  This can be a negative amount.

   The '\\*' command is the same as the ordinary '\\' command except
that it tells LaTeX not to start a new page after the line.


File: latex2e.info,  Node: \obeycr & \restorecr,  Next: \newline,  Prev: \\,  Up: Line breaking

10.2 '\obeycr' & '\restorecr'
=============================

The '\obeycr' command makes a return in the input file ('^^M',
internally) the same as '\\' (followed by '\relax').  So each new line
in the input will also be a new line in the output.

   '\restorecr' restores normal line-breaking behavior.


File: latex2e.info,  Node: \newline,  Next: \- (hyphenation),  Prev: \obeycr & \restorecr,  Up: Line breaking

10.3 '\newline'
===============

The '\newline' command breaks the line at the present point, with no
stretching of the text before it.  It can only be used in paragraph
mode.


File: latex2e.info,  Node: \- (hyphenation),  Next: \fussy,  Prev: \newline,  Up: Line breaking

10.4 '\-' (discretionary hyphen)
================================

The '\-' 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 incorrect
one.  The '\-' command is used for the exceptional cases.

   When you insert '\-' commands in a word, the word will only be
hyphenated at those points and not at any of the hyphenation points that
LaTeX might otherwise have chosen.


File: latex2e.info,  Node: \fussy,  Next: \sloppy,  Prev: \- (hyphenation),  Up: Line breaking

10.5 '\fussy'
=============

The declaration '\fussy' (which is the default) makes TeX picky about
line breaking.  This usually avoids too much space between words, at the
cost of an occasional overfull box.

   This command cancels the effect of a previous '\sloppy' command
(*note \sloppy::.


File: latex2e.info,  Node: \sloppy,  Next: \hyphenation,  Prev: \fussy,  Up: Line breaking

10.6 '\sloppy'
==============

The declaration '\sloppy' makes TeX less fussy about line breaking.
This will avoid overfull boxes, at the cost of loose interword spacing.

   Lasts until a '\fussy' command is issued (*note \fussy::).


File: latex2e.info,  Node: \hyphenation,  Next: \linebreak & \nolinebreak,  Prev: \sloppy,  Up: Line breaking

10.7 '\hyphenation'
===================

Synopsis:

     \hyphenation{WORD-ONE WORD-TWO}

   The '\hyphenation' command declares allowed hyphenation points with a
'-' character in the given words.  The words are separated by spaces.
TeX will only hyphenate if the word matches exactly, no inflections are
tried.  Multiple '\hyphenation' commands accumulate.  Some examples (the
default TeX hyphenation patterns misses the hyphenations in these
words):

     \hyphenation{ap-pen-dix col-umns data-base data-bases}


File: latex2e.info,  Node: \linebreak & \nolinebreak,  Prev: \hyphenation,  Up: Line breaking

10.8 '\linebreak' & '\nolinebreak'
==================================

Synopses:

     \linebreak[PRIORITY]
     \nolinebreak[PRIORITY]

   By default, the '\linebreak' ('\nolinebreak') command forces
(prevents) a line break at the current position.  For '\linebreak', the
spaces in the line are stretched out so that it extends to the right
margin as usual.

   With the optional argument PRIORITY, you can convert the command from
a demand to a request.  The PRIORITY must be a number from 0 to 4.  The
higher the number, the more insistent the request.


File: latex2e.info,  Node: Page breaking,  Next: Footnotes,  Prev: Line breaking,  Up: Top

11 Page breaking
****************

LaTeX starts new pages asynchronously, when enough material has
accumulated to fill up a page.  Usually this happens automatically, but
sometimes you may want to influence the breaks.

* Menu:

* \cleardoublepage::           Start a new right-hand page.
* \clearpage::                 Start a new page.
* \newpage::                   Start a new page.
* \enlargethispage::           Enlarge the current page a bit.
* \pagebreak & \nopagebreak::  Forcing & avoiding page breaks.


File: latex2e.info,  Node: \cleardoublepage,  Next: \clearpage,  Up: Page breaking

11.1 '\cleardoublepage'
=======================

The '\cleardoublepage' command ends the current page and causes all
figures and tables that have so far appeared in the input to be printed.
In a two-sided printing style, it also makes the next page a right-hand
(odd-numbered) page, producing a blank page if necessary.


File: latex2e.info,  Node: \clearpage,  Next: \newpage,  Prev: \cleardoublepage,  Up: Page breaking

11.2 '\clearpage'
=================

The '\clearpage' command ends the current page and causes all figures
and tables that have so far appeared in the input to be printed.


File: latex2e.info,  Node: \newpage,  Next: \enlargethispage,  Prev: \clearpage,  Up: Page breaking

11.3 '\newpage'
===============

The '\newpage' command ends the current page, but does not clear floats
(see '\clearpage' above).


File: latex2e.info,  Node: \enlargethispage,  Next: \pagebreak & \nopagebreak,  Prev: \newpage,  Up: Page breaking

11.4 '\enlargethispage'
=======================

'\enlargethispage{size}'

   '\enlargethispage*{size}'

   Enlarge the '\textheight' for the current page by the specified
amount; e.g.  '\enlargethispage{\baselineskip}' will allow one
additional line.

   The starred form tries to squeeze the material together on the page
as much as possible.  This is normally used together with an explicit
'\pagebreak'.


File: latex2e.info,  Node: \pagebreak & \nopagebreak,  Prev: \enlargethispage,  Up: Page breaking

11.5 '\pagebreak' & '\nopagebreak'
==================================

Synopses:

     \pagebreak[PRIORITY]
     \nopagebreak[PRIORITY]

   By default, the '\pagebreak' ('\nopagebreak') command forces
(prevents) a page break at the current position.  With '\pagebreak', the
vertical space on the page is stretched out where possible so that it
extends to the normal bottom margin.

   With the optional argument PRIORITY, you can convert the '\pagebreak'
command from a demand to a request.  The number must be a number from 0
to 4.  The higher the number, the more insistent the request is.


File: latex2e.info,  Node: Footnotes,  Next: Definitions,  Prev: Page breaking,  Up: Top

12 Footnotes
************

Footnotes can be produced in one of two ways.  They can be produced with
one command, the '\footnote' command.  They can also be produced with
two commands, the '\footnotemark' and the '\footnotetext' commands.

* Menu:

* \footnote::           Insert a footnote.
* \footnotemark::       Insert footnote mark only.
* \footnotetext::       Insert footnote text only.
* Symbolic footnotes::  Using symbols instead of numbers for footnotes.
* Footnote parameters:: Parameters for footnote formatting.


File: latex2e.info,  Node: \footnote,  Next: \footnotemark,  Up: Footnotes

12.1 '\footnote'
================

Synopsis:

     \footnote[NUMBER]{TEXT}

   The '\footnote' command places the numbered footnote TEXT at the
bottom of the current page.  The optional argument NUMBER changes the
default footnote number.

   This command can only be used in outer paragraph mode; i.e., you
cannot use it in sectioning commands like '\chapter', in figures, tables
or in a 'tabular' environment.  (See following sections.)


File: latex2e.info,  Node: \footnotemark,  Next: \footnotetext,  Prev: \footnote,  Up: Footnotes

12.2 '\footnotemark'
====================

With no optional argument, the '\footnotemark' command puts the current
footnote number in the text.  This command can be used in inner
paragraph mode.  You give the text of the footnote separately, with the
'\footnotetext' command.

   This command can be used to produce several consecutive footnote
markers referring to the same footnote with

     \footnotemark[\value{footnote}]

after the first '\footnote' command.


File: latex2e.info,  Node: \footnotetext,  Next: Symbolic footnotes,  Prev: \footnotemark,  Up: Footnotes

12.3 '\footnotetext'
====================

Synopsis:

     \footnotetext[NUMBER]{TEXT}

   The '\footnotetext' command places TEXT at the bottom of the page as
a footnote.  This command can come anywhere after the '\footnotemark'
command.  The '\footnotetext' command must appear in outer paragraph
mode.

   The optional argument NUMBER changes the default footnote number.


File: latex2e.info,  Node: Symbolic footnotes,  Next: Footnote parameters,  Prev: \footnotetext,  Up: Footnotes

12.4 Symbolic footnotes
=======================

If you want to use symbols for footnotes, rather than increasing
numbers, redefine '\thefootnote' like this:

     \renewcommand{\thefootnote}{\fnsymbol{footnote}}

   The '\fnsymbol' command produces a predefined series of symbols
(*note \alph \Alph \arabic \roman \Roman \fnsymbol::).  If you want to
use a different symbol as your footnote mark, you'll need to also
redefine '\@fnsymbol'.


File: latex2e.info,  Node: Footnote parameters,  Prev: Symbolic footnotes,  Up: Footnotes

12.5 Footnote parameters
========================

'\footnoterule'
     Produces the rule separating the main text on a page from the
     page's footnotes.  Default dimensions: '0.4pt' thick (or wide), and
     '0.4\columnwidth' long in the standard document classes (except
     slides, where it does not appear).

'\footnotesep'
     The height of the strut placed at the beginning of the footnote.
     By default, this is set to the normal strut for '\footnotesize'
     fonts (*note Font sizes::), therefore there is no extra space
     between footnotes.  This is '6.65pt' for '10pt', '7.7pt' for
     '11pt', and '8.4pt' for '12pt'.


File: latex2e.info,  Node: Definitions,  Next: Counters,  Prev: Footnotes,  Up: Top

13 Definitions
**************

LaTeX has support for making new commands of many different kinds.

* Menu:

* \newcommand & \renewcommand::         (Re)define a new command.
* \newcounter::                         Define a new counter.
* \newlength::                          Define a new length.
* \newsavebox::                         Define a new box.
* \newenvironment & \renewenvironment:: Define a new environment.
* \newtheorem::                         Define a new theorem-like environment.
* \newfont::                            Define a new font name.
* \protect::                            Using tricky commands.


File: latex2e.info,  Node: \newcommand & \renewcommand,  Next: \newcounter,  Up: Definitions

13.1 '\newcommand' & '\renewcommand'
====================================

'\newcommand' and '\renewcommand' define and redefine a command,
respectively.  Synopses:

       \newcommand[*]{CMD}[NARGS][OPTARG]{DEFN}
     \renewcommand[*]{CMD}[NARGS][OPTARG]{DEFN}

'*'
     The *-form of these commands requires that the arguments not
     contain multiple paragraphs of text (not '\long', in plain TeX
     terms).

CMD
     The command name beginning with '\'.  For '\newcommand', it must
     not be already defined and must not begin with '\end'; for
     '\renewcommand', it must already be defined.

NARGS
     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.

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 OPTARG, or,
     if that argument is present in the '\newcommand' but has an empty
     value, the string 'def'.

DEFN
     The text to be substituted for every occurrence of 'cmd'; a
     construct of the form '#N' in DEFN is replaced by the text of the
     Nth argument.


File: latex2e.info,  Node: \newcounter,  Next: \newlength,  Prev: \newcommand & \renewcommand,  Up: Definitions

13.2 '\newcounter'
==================

Synopsis:

     \newcounter{CNT}[COUNTERNAME]

   The '\newcounter' command defines a new counter named CNT.  The new
counter is initialized to zero.

   Given the optional argument '[COUNTERNAME]', CNT will be reset
whenever COUNTERNAME is incremented.

   *Note Counters::, for more information about counters.


File: latex2e.info,  Node: \newlength,  Next: \newsavebox,  Prev: \newcounter,  Up: Definitions

13.3 '\newlength'
=================

Synopsis:

     \newlength{\ARG}

   The '\newlength' command defines the mandatory argument as a 'length'
command with a value of '0in'.  The argument must be a control sequence,
as in '\newlength{\foo}'.  An error occurs if '\foo' is already defined.

   *Note Lengths::, for how to set the new length to a nonzero value,
and for more information about lengths in general.


File: latex2e.info,  Node: \newsavebox,  Next: \newenvironment & \renewenvironment,  Prev: \newlength,  Up: Definitions

13.4 '\newsavebox'
==================

Synopsis:

     \newsavebox{CMD}

   Defines '\CMD', which must be a command name not already defined, to
refer to a new bin for storing boxes.


File: latex2e.info,  Node: \newenvironment & \renewenvironment,  Next: \newtheorem,  Prev: \newsavebox,  Up: Definitions

13.5 '\newenvironment' & '\renewenvironment'
============================================

Synopses:

       \newenvironment[*]{ENV}[NARGS][DEFAULT]{BEGDEF}{ENDDEF}
     \renewenvironment[*]{ENV}[NARGS]{BEGDEF}{ENDDEF}

   These commands define or redefine an environment ENV, that is,
'\begin{ENV} ... \end{ENV}'.

'*'
     The *-form of these commands requires that the arguments (not the
     contents of the environment) not contain multiple paragraphs of
     text.

ENV
     The name of the environment.  For '\newenvironment', ENV must not
     be an existing environment, and the command '\ENV' must be
     undefined.  For '\renewenvironment', ENV must be the name of an
     existing environment.

NARGS
     An integer from 1 to 9 denoting the number of arguments of the
     newly-defined environment.  The default is no arguments.

DEFAULT
     If this is specified, the first argument is optional, and DEFAULT
     gives the default value for that argument.

BEGDEF
     The text expanded at every occurrence of '\begin{ENV}'; a construct
     of the form '#N' in BEGDEF is replaced by the text of the Nth
     argument.

ENDDEF
     The text expanded at every occurrence of '\end{ENV}'.  It may not
     contain any argument parameters.


File: latex2e.info,  Node: \newtheorem,  Next: \newfont,  Prev: \newenvironment & \renewenvironment,  Up: Definitions

13.6 '\newtheorem'
==================

     \newtheorem{NEWENV}{LABEL}[WITHIN]
     \newtheorem{NEWENV}[NUMBERED_LIKE]{LABEL}

   This command defines a theorem-like environment.  Arguments:

NEWENV
     The name of the environment to be defined; must not be the name of
     an existing environment or otherwise defined.

LABEL
     The text printed at the beginning of the environment, before the
     number.  For example, 'Theorem'.

NUMBERED_LIKE
     (Optional.)  The name of an already defined theorem-like
     environment; the new environment will be numbered just like
     NUMBERED_LIKE.

WITHIN
     (Optional.)  The name of an already defined counter, a sectional
     unit.  The new theorem counter will be reset at the same time as
     the WITHIN counter.

   At most one of NUMBERED_LIKE and WITHIN can be specified, not both.


File: latex2e.info,  Node: \newfont,  Next: \protect,  Prev: \newtheorem,  Up: Definitions

13.7 '\newfont'
===============

Synopsis:

     \newfont{CMD}{FONTNAME}

   Defines a control sequence '\CMD', which must not already be defined,
to make FONTNAME be the current font.  The file looked for on the system
is named 'FONTNAME.tfm'.

   This is a low-level command for setting up to use an individual font.
More commonly, fonts are defined in families through '.fd' files.


File: latex2e.info,  Node: \protect,  Prev: \newfont,  Up: Definitions

13.8 '\protect'
===============

Footnotes, line breaks, any command that has an optional argument, and
many more are so-called "fragile" commands.  When a fragile command is
used in certain contexts, called "moving arguments", it must be preceded
by '\protect'.  In addition, any fragile commands within the arguments
must have their own '\protect'.

   Some examples of moving arguments are '\caption' (*note figure::),
'\thanks' (*note \maketitle::), and expressions in 'tabular' and 'array'
environments (*note tabular::).

   Commands which are not fragile are called "robust".  They must not be
preceded by '\protect'.

   See also:

<http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html>
<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect>


File: latex2e.info,  Node: Counters,  Next: Lengths,  Prev: Definitions,  Up: Top

14 Counters
***********

Everything LaTeX numbers for you has a counter associated with it.  The
name of the counter is the same as the name of the environment or
command that produces the number, except with no '\'.  ('enumi'-'enumiv'
are used for the nested enumerate environment.)  Below is a list of the
counters used in LaTeX's standard document classes to control numbering.

     part            paragraph       figure          enumi
     chapter         subparagraph    table           enumii
     section         page            footnote        enumiii
     subsection      equation        mpfootnote      enumiv
     subsubsection

* Menu:

* \alph \Alph \arabic \roman \Roman \fnsymbol::  Print value of a counter.
* \usecounter::         Use a specified counter in a list environment.
* \value::              Use the value of a counter in an expression.
* \setcounter::         Set the value of a counter.
* \addtocounter::       Add a quantity to a counter.
* \refstepcounter::     Add to counter, resetting subsidiary counters.
* \stepcounter::        Add to counter, resetting subsidiary counters.
* \day \month \year::   Numeric date values.


File: latex2e.info,  Node: \alph \Alph \arabic \roman \Roman \fnsymbol,  Next: \usecounter,  Up: Counters

14.1 '\alph \Alph \arabic \roman \Roman \fnsymbol': Printing counters
=====================================================================

All of these commands take a single counter as an argument, for
instance, '\alph{enumi}'.

'\alph'
     prints COUNTER using lowercase letters: 'a', 'b', ...

'\Alph'
     uses uppercase letters: 'A', 'B', ...

'\arabic'
     uses Arabic numbers: '1', '2', ...

'\roman'
     uses lowercase roman numerals: 'i', 'ii', ...

'\roman'
     uses uppercase roman numerals: 'I', 'II', ...

'\fnsymbol'
     prints the value of COUNTER in a specific sequence of nine symbols
     (conventionally used for labeling footnotes).  The value of COUNTER
     must be between 1 and 9, inclusive.

     The symbols mostly aren't supported in Info, but here are the
     names:
          asterix(*) dagger ddagger section-sign paragraph-sign parallel
          double-asterix(**) double-dagger double-ddagger


File: latex2e.info,  Node: \usecounter,  Next: \value,  Prev: \alph \Alph \arabic \roman \Roman \fnsymbol,  Up: Counters

14.2 '\usecounter{COUNTER}'
===========================

Synopsis:

     \usecounter{COUNTER}

   The '\usecounter' command is used in the second argument of the
'list' environment to specify COUNTER to be used to number the list
items.


File: latex2e.info,  Node: \value,  Next: \setcounter,  Prev: \usecounter,  Up: Counters

14.3 '\value{COUNTER}'
======================

Synopsis:

     \value{COUNTER}

   The '\value' command produces the value of COUNTER.  It can be used
anywhere LaTeX expects a number, for example:

     \setcounter{myctr}{3}
     \addtocounter{myctr}{1}
     \hspace{\value{myctr}\parindent}


File: latex2e.info,  Node: \setcounter,  Next: \addtocounter,  Prev: \value,  Up: Counters

14.4 '\setcounter{COUNTER}{VALUE}'
==================================

Synopsis:

     \setcounter{\COUNTER}{VALUE}

   The '\setcounter' command sets the value of \COUNTER to the VALUE
argument.


File: latex2e.info,  Node: \addtocounter,  Next: \refstepcounter,  Prev: \setcounter,  Up: Counters

14.5 '\addtocounter{COUNTER}{VALUE}'
====================================

The '\addtocounter' command increments COUNTER by the amount specified
by the VALUE argument, which may be negative.


File: latex2e.info,  Node: \refstepcounter,  Next: \stepcounter,  Prev: \addtocounter,  Up: Counters

14.6 '\refstepcounter{COUNTER}'
===============================

The '\refstepcounter' command works in the same way as '\stepcounter'
*Note \stepcounter::, except it also defines the current '\ref' value to
be the result of '\thecounter'.


File: latex2e.info,  Node: \stepcounter,  Next: \day \month \year,  Prev: \refstepcounter,  Up: Counters

14.7 '\stepcounter{COUNTER}'
============================

The '\stepcounter' command adds one to COUNTER and resets all subsidiary
counters.


File: latex2e.info,  Node: \day \month \year,  Prev: \stepcounter,  Up: Counters

14.8 '\day \month \year': Predefined counters
=============================================

LaTeX defines counters for the day of the month ('\day', 1-31), month of
the year ('\month', 1-12), and year ('\year', Common Era).  When TeX
starts up, they are set to the current values on the system where TeX is
running.  They are not updated as the job progresses.

   The related command '\today' produces a string representing the
current day (*note \today::).


File: latex2e.info,  Node: Lengths,  Next: Making paragraphs,  Prev: Counters,  Up: Top

15 Lengths
**********

A 'length' is a measure of distance.  Many LaTeX commands take a length
as an argument.

* Menu:

* \setlength::          Set the value of a length.
* \addtolength::        Add a quantity to a length.
* \settodepth::         Set a length to the depth of something.
* \settoheight::        Set a length to the height of something.
* \settowidth::         Set a length to the width of something.
* Predefined lengths::  Lengths that are, like, predefined.


File: latex2e.info,  Node: \setlength,  Next: \addtolength,  Up: Lengths

15.1 '\setlength{\LEN}{VALUE}'
==============================

The '\setlength' sets the value of \LEN to the VALUE argument, which can
be expressed in any units that LaTeX understands, i.e., inches ('in'),
millimeters ('mm'), points ('pt'), big points ('bp', etc.


File: latex2e.info,  Node: \addtolength,  Next: \settodepth,  Prev: \setlength,  Up: Lengths

15.2 \addtolength{\LEN}{AMOUNT}
===============================

The '\addtolength' command increments a "length command" \LEN by the
amount specified in the AMOUNT argument, which may be negative.


File: latex2e.info,  Node: \settodepth,  Next: \settoheight,  Prev: \addtolength,  Up: Lengths

15.3 '\settodepth'
==================

'\settodepth{\gnat}{text}'

   The '\settodepth' command sets the value of a 'length' command equal
to the depth of the 'text' argument.


File: latex2e.info,  Node: \settoheight,  Next: \settowidth,  Prev: \settodepth,  Up: Lengths

15.4 '\settoheight'
===================

'\settoheight{\gnat}{text}'

   The '\settoheight' command sets the value of a 'length' command equal
to the height of the 'text' argument.


File: latex2e.info,  Node: \settowidth,  Next: Predefined lengths,  Prev: \settoheight,  Up: Lengths

15.5 '\settowidth{\LEN}{TEXT}'
==============================

The '\settowidth' command sets the value of the command \LEN to the
width of the TEXT argument.


File: latex2e.info,  Node: Predefined lengths,  Prev: \settowidth,  Up: Lengths

15.6 Predefined lengths
=======================

'\width'

   '\height'

   '\depth'

   '\totalheight'

   These length parameters can be used in the arguments of the
box-making commands (*note Boxes::).  They specify the natural width,
etc., of the text in the box.  '\totalheight' equals '\height' +
'\depth'.  To make a box with the text stretched to double the natural
size, e.g., say

   '\makebox[2\width]{Get a stretcher}'


File: latex2e.info,  Node: Making paragraphs,  Next: Math formulas,  Prev: Lengths,  Up: Top

16 Making paragraphs
********************

A paragraph is ended by one or more completely blank lines--lines not
containing even a '%'.  A blank line should not appear where a new
paragraph cannot be started, such as in math mode or in the argument of
a sectioning command.

* Menu:

* \indent::        Indent this paragraph.
* \noindent::      Do not indent this paragraph.
* \parskip::       Space added before paragraphs.
* Marginal notes:: Putting remarks in the margin.


File: latex2e.info,  Node: \indent,  Next: \noindent,  Up: Making paragraphs

16.1 '\indent'
==============

'\indent' produces a horizontal space whose width equals the width of
the '\parindent' length, the normal paragraph indentation.  It is used
to add paragraph indentation where it would otherwise be suppressed.

   The default value for '\parindent' is '1em' in two-column mode,
otherwise '15pt' for '10pt' documents, '17pt' for '11pt', and '1.5em'
for '12pt'.


File: latex2e.info,  Node: \noindent,  Next: \parskip,  Prev: \indent,  Up: Making paragraphs

16.2 '\noindent'
================

When used at the beginning of the paragraph, '\noindent' suppresses any
paragraph indentation.  It has no effect when used in the middle of a
paragraph.


File: latex2e.info,  Node: \parskip,  Next: Marginal notes,  Prev: \noindent,  Up: Making paragraphs

16.3 '\parskip'
===============

'\parskip' is a rubber length defining extra vertical space added before
each paragraph.  The default is '0pt plus1pt'.


File: latex2e.info,  Node: Marginal notes,  Prev: \parskip,  Up: Making paragraphs

16.4 Marginal notes
===================

Synopsis:

     \marginpar[LEFT]{RIGHT}

   The '\marginpar' command creates a note in the margin.  The first
line of the note will have the same baseline as the line in the text
where the '\marginpar' occurs.

   When you only specify the mandatory argument RIGHT, the text will be
placed

   * in the right margin for one-sided layout;
   * in the outside margin for two-sided layout;
   * in the nearest margin for two-column layout.

   The command '\reversemarginpar' places subsequent marginal notes in
the opposite (inside) margin.  '\normalmarginpar' places them in the
default position.

   When you specify both arguments, LEFT is used for the left margin,
and RIGHT is used for the right margin.

   The first word will normally not be hyphenated; you can enable
hyphenation there by beginning the node with '\hspace{0pt}'.

   These parameters affect the formatting of the note:

'\marginparpush'
     Minimum vertical space between notes; default '7pt' for '12pt'
     documents, '5pt' else.

'\marginparsep'
     Horizontal space between the main text and the note; default '11pt'
     for '10pt' documents, '10pt' else.

'\marginparwidth'
     Width of the note itself; default for a one-sided '10pt' document
     is '90pt', '83pt' for '11pt', and '68pt' for '12pt'; '17pt' more in
     each case for a two-sided document.  In two column mode, the
     default is '48pt'.

   The standard LaTeX routine for marginal notes does not prevent notes
from falling off the bottom of the page.


File: latex2e.info,  Node: Math formulas,  Next: Modes,  Prev: Making paragraphs,  Up: Top

17 Math formulas
****************

There are three environments that put LaTeX in math mode:

'math'
     For formulas that appear right in the text.
'displaymath'
     For formulas that appear on their own line.
'equation'
     The same as the displaymath environment except that it adds an
     equation number in the right margin.

   The 'math' environment can be used in both paragraph and LR mode, but
the 'displaymath' and 'equation' environments can be used only in
paragraph mode.  The 'math' and 'displaymath' environments are used so
often that they have the following short forms:

     \(...\)   instead of   \begin{math}...\end{math}
     \[...\]   instead of   \begin{displaymath}...\end{displaymath}

   In fact, the 'math' environment is so common that it has an even
shorter form:

     $ ... $   instead of   \(...\)

   The '\boldmath' command changes math letters and symbols to be in a
bold font.  It is used _outside_ of math mode.  Conversely, the
'\unboldmath' command changes math glyphs to be in a normal font; it too
is used _outside_ of math mode.

   The '\displaystyle' declaration forces the size and style of the
formula to be that of 'displaymath', e.g., with limits above and below
summations.  For example
     $\displaystyle \sum_{n=0}^\infty x_n $

* Menu:

* Subscripts & superscripts::   Also known as exponent or index.
* Math symbols::                Various mathematical squiggles.
* Math functions::              Math function names like sin and exp.
* Math accents::                Accents in math.
* Spacing in math mode::        Thick, medium, thin and negative spaces.
* Math miscellany::             Stuff that doesn't fit anywhere else.


File: latex2e.info,  Node: Subscripts & superscripts,  Next: Math symbols,  Up: Math formulas

17.1 Subscripts & superscripts
==============================

To get an expression exp to appear as a subscript, you just type
'_{'exp'}'.  To get exp to appear as a superscript, you type '^{'exp'}'.
LaTeX handles superscripted superscripts and all of that stuff in the
natural way.  It even does the right thing when something has both a
subscript and a superscript.


File: latex2e.info,  Node: Math symbols,  Next: Math functions,  Prev: Subscripts & superscripts,  Up: Math formulas

17.2 Math symbols
=================

LaTeX provides almost any mathematical symbol you're likely to need.
The commands for generating them can be used only in math mode.  For
example, if you include '$\pi$' in your source, you will get the pi
symbol (\pi) in your output.

'\|'
     \|

'\aleph'
     \aleph

'\alpha'
     \alpha

'\amalg'
     \amalg (binary operation)

'\angle'
     \angle

'\approx'
     \approx (relation)

'\ast'
     \ast (binary operation)

'\asymp'
     \asymp (relation)

'\backslash'
     \ (delimiter)

'\beta'
     \beta

'\bigcap'
     \bigcap

'\bigcirc'
     \bigcirc (binary operation)

'\bigcup'
     \bigcup

'\bigodot'
     \bigodot

'\bigoplus'
     \bigoplus

'\bigotimes'
     \bigotimes

'\bigtriangledown'
     \bigtriangledown (binary operation)

'\bigtriangleup'
     \bigtriangleup (binary operation)

'\bigsqcup'
     \bigsqcup

'\biguplus'
     \biguplus

'\bigcap'
     \bigvee

'\bigwedge'
     \bigwedge

'\bot'
     \bot

'\bowtie'
     \bowtie (relation)

'\Box'
     (square open box symbol)

'\bullet'
     \bullet (binary operation)

'\cap'
     \cap (binary operation)

'\cdot'
     \cdot (binary operation)

'\chi'
     \chi

'\circ'
     \circ (binary operation)

'\clubsuit'
     \clubsuit

'\cong'
     \cong (relation)

'\coprod'
     \coprod

'\cup'
     \cup (binary operation)

'\dagger'
     \dagger (binary operation)

'\dashv'
     \dashv (relation)

'\ddagger'
     \dagger (binary operation)

'\Delta'
     \Delta

'\delta'
     \delta

'\Diamond'
     bigger \diamond

'\diamond'
     \diamond (binary operation)

'\diamondsuit'
     \diamondsuit

'\div'
     \div (binary operation)

'\doteq'
     \doteq (relation)

'\downarrow'
     \downarrow (delimiter)

'\Downarrow'
     \Downarrow (delimiter)

'\ell'
     \ell

'\emptyset'
     \emptyset

'\epsilon'
     \epsilon

'\equiv'
     \equiv (relation)

'\eta'
     \eta

'\exists'
     \exists

'\flat'
     \flat

'\forall'
     \forall

'\frown'
     \frown (relation)

'\Gamma'
     \Gamma

'\gamma'
     \gamma

'\ge'
     \ge

'\geq'
     \geq (relation)

'\gets'
     \gets

'\gg'
     \gg (relation)

'\hbar'
     \hbar

'\heartsuit'
     \heartsuit

'\hookleftarrow'
     \hookleftarrow

'\hookrightarrow'
     \hookrightarrow

'\iff'
     \iff

'\Im'
     \Im

'\in'
     \in (relation)

'\infty'
     \infty

'\int'
     \int

'\iota'
     \iota

'\Join'
     condensed bowtie symbol (relation)

'\kappa'
     \kappa

'\Lambda'
     \Lambda

'\lambda'
     \lambda

'\land'
     \land

'\langle'
     \langle (delimiter)

'\lbrace'
     \lbrace (delimiter)

'\lbrack'
     \lbrack (delimiter)

'\lceil'
     \lceil (delimiter)

'\le'
     \le

'\leadsto'

'\Leftarrow'
     \Leftarrow

'\leftarrow'
     \leftarrow

'\leftharpoondown'
     \leftharpoondown

'\leftharpoonup'
     \leftharpoonup

'\Leftrightarrow'
     \Leftrightarrow

'\leftrightarrow'
     \leftrightarrow

'\leq'
     \leq (relation)

'\lfloor'
     \lfloor (delimiter)

'\lhd'
     (left-pointing arrow head)

'\ll'
     \ll (relation)

'\lnot'
     \lnot

'\longleftarrow'
     \longleftarrow

'\longleftrightarrow'
     \longleftrightarrow

'\longmapsto'
     \longmapsto

'\longrightarrow'
     \longrightarrow

'\lor'
     \lor

'\mapsto'
     \mapsto

'\mho'

'\mid'
     \mid (relation)

'\models'
     \models (relation)

'\mp'
     \mp (binary operation)

'\mu'
     \mu

'\nabla'
     \nabla

'\natural'
     \natural

'\ne'
     \ne

'\nearrow'
     \nearrow

'\neg'
     \neg

'\neq'
     \neq (relation)

'\ni'
     \ni (relation)

'\not'
     Overstrike a following operator with a /, as in \not=.

'\notin'
     \ni

'\nu'
     \nu

'\nwarrow'
     \nwarrow

'\odot'
     \odot (binary operation)

'\oint'
     \oint

'\Omega'
     \Omega

'\omega'
     \omega

'\ominus'
     \ominus (binary operation)

'\oplus'
     \oplus (binary operation)

'\oslash'
     \oslash (binary operation)

'\otimes'
     \otimes (binary operation)

'\owns'
     \owns

'\parallel'
     \parallel (relation)

'\partial'
     \partial

'\perp'
     \perp (relation)

'\phi'
     \phi

'\Pi'
     \Pi

'\pi'
     \pi

'\pm'
     \pm (binary operation)

'\prec'
     \prec (relation)

'\preceq'
     \preceq (relation)

'\prime'
     \prime

'\prod'
     \prod

'\propto'
     \propto (relation)

'\Psi'
     \Psi

'\psi'
     \psi

'\rangle'
     \rangle (delimiter)

'\rbrace'
     \rbrace (delimiter)

'\rbrack'
     \rbrack (delimiter)

'\rceil'
     \rceil (delimiter)

'\Re'
     \Re

'\rfloor'
     \rfloor

'\rhd'
     (binary operation)

'\rho'
     \rho

'\Rightarrow'
     \Rightarrow

'\rightarrow'
     \rightarrow

'\rightharpoondown'
     \rightharpoondown

'\rightharpoonup'
     \rightharpoonup

'\rightleftharpoons'
     \rightleftharpoons

'\searrow'
     \searrow

'\setminus'
     \setminus (binary operation)

'\sharp'
     \sharp

'\Sigma'
     \Sigma

'\sigma'
     \sigma

'\sim'
     \sim (relation)

'\simeq'
     \simeq (relation)

'\smallint'
     \smallint

'\smile'
     \smile (relation)

'\spadesuit'
     \spadesuit

'\sqcap'
     \sqcap (binary operation)

'\sqcup'
     \sqcup (binary operation)

'\sqsubset'
     (relation)

'\sqsubseteq'
     \sqsubseteq (relation)

'\sqsupset'
     (relation)

'\sqsupseteq'
     \sqsupseteq (relation)

'\star'
     \star (binary operation)

'\subset'
     \subset (relation)

'\subseteq'
     \subseteq (relation)

'\succ'
     \succ (relation)

'\succeq'
     \succeq (relation)

'\sum'
     \sum

'\supset'
     \supset (relation)

'\supseteq'
     \supseteq (relation)

'\surd'
     \surd

'\swarrow'
     \swarrow

'\tau'
     \tau

'\theta'
     \theta

'\times'
     \times (binary operation)

'\to'
     \to

'\top'
     \top

'\triangle'
     \triangle

'\triangleleft'
     \triangleleft (binary operation)

'\triangleright'
     \triangleright (binary operation)

'\unlhd'
     left-pointing arrowhead with line under (binary operation)

'\unrhd'
     right-pointing arrowhead with line under (binary operation)

'\Uparrow'
     \Uparrow (delimiter)

'\uparrow'
     \uparrow (delimiter)

'\Updownarrow'
     \Updownarrow (delimiter)

'\updownarrow'
     \updownarrow (delimiter)

'\uplus'
     \uplus (binary operation)

'\Upsilon'
     \Upsilon

'\upsilon'
     \upsilon

'\varepsilon'
     \varepsilon

'\varphi'
     \varphi

'\varpi'
     \varpi

'\varrho'
     \varrho

'\varsigma'
     \varsigma

'\vartheta'
     \vartheta

'\vdash'
     \vdash (relation)

'\vee'
     \vee (binary operation)

'\Vert'
     \Vert (delimiter)

'\vert'
     \vert (delimiter)

'\wedge'
     \wedge (binary operation)

'\wp'
     \wp

'\wr'
     \wr (binary operation)

'\Xi'
     \Xi

'\xi'
     \xi

'\zeta'
     \zeta


File: latex2e.info,  Node: Math functions,  Next: Math accents,  Prev: Math symbols,  Up: Math formulas

17.3 Math functions
===================

These commands produce roman function names in math mode with proper
spacing.

'\arccos'
     \arccos

'\arcsin'
     \arcsin

'\arctan'
     \arctan

'\arg'
     \arg

'\bmod'
     Binary modulo operator (x \bmod y)

'\cos'
     \cos

'\cosh'
     \cosh

'\cot'
     \cos

'\coth'
     \cosh

'\csc'
     \csc

'\deg'
     \deg

'\det'
     \deg

'\dim'
     \dim

'\exp'
     \exp

'\gcd'
     \gcd

'\hom'
     \hom

'\inf'
     \inf

'\ker'
     \ker

'\lg'
     \lg

'\lim'
     \lim

'\liminf'
     \liminf

'\limsup'
     \limsup

'\ln'
     \ln

'\log'
     \log

'\max'
     \max

'\min'
     \min

'\pmod'
     parenthesized modulus, as in (\pmod 2^n - 1)

'\Pr'
     \Pr

'\sec'
     \sec

'\sin'
     \sin

'\sinh'
     \sinh

'\sup'
     \sup

'\tan'
     \tan

'\tanh'
     \tanh


File: latex2e.info,  Node: Math accents,  Next: Spacing in math mode,  Prev: Math functions,  Up: Math formulas

17.4 Math accents
=================

LaTeX provides a variety of commands for producing accented letters in
math.  These are different from accents in normal text (*note
Accents::).

'\acute'
     Math acute accent: \acute{x}.

'\bar'
     Math bar-over accent: \bar{x}.

'\breve'
     Math breve accent: \breve{x}.

'\check'
     Math ha'c<ek (check) accent: \check{x}.

'\ddot'
     Math dieresis accent: \ddot{x}.

'\dot'
     Math dot accent: \dot{x}.

'\grave'
     Math grave accent: \grave{x}.

'\hat'
     Math hat (circumflex) accent: \hat{x}.

'\imath'
     Math dotless i.

'\jmath'
     Math dotless j.

'\mathring'
     Math ring accent: x*.

'\tilde'
     Math tilde accent: \tilde{x}.

'\vec'
     Math vector symbol: \vec{x}.

'\widehat'
     Math wide hat accent: \widehat{x+y}.

'\widehat'
     Math wide tilde accent: \widetilde{x+y}.


File: latex2e.info,  Node: Spacing in math mode,  Next: Math miscellany,  Prev: Math accents,  Up: Math formulas

17.5 Spacing in math mode
=========================

In a 'math' environment, LaTeX ignores the spaces you type and puts in
the spacing according to the normal rules for mathematics texts.  If you
want different spacing, LaTeX provides the following commands for use in
math mode:

'\;'
     A thick space (5\over18\,quad).
'\:'
'\>'
     Both of these produce a medium space (2\over9\,quad).
'\,'
     A thin space (1\over6\,quad); not restricted to math mode.
'\!'
     A negative thin space (-{1\over6}\,quad).


File: latex2e.info,  Node: Math miscellany,  Prev: Spacing in math mode,  Up: Math formulas

17.6 Math miscellany
====================

'\*'
     A "discretionary" multiplication symbol, at which a line break is
     allowed.

'\cdots'
     A horizontal ellipsis with the dots raised to the center of the
     line.

'\ddots'
     A diagonal ellipsis: \ddots.

'\frac{num}{den}'
     Produces the fraction 'num' divided by 'den'.

'\left DELIM1 ... \right DELIM2'
     The two delimiters need not match; '.' acts as a null delimiter,
     producing no output.  The delimiters are sized according to the
     math in between.  Example: '\left( \sum_i=1^10 a_i \right]'.

'\overbrace{TEXT}'
     Generates a brace over TEXT.  For example,
     \overbrace{x+\cdots+x}^{k \rm\;times}.

'\overline{TEXT}'
     Generates a horizontal line over TEX.  For exampe, \overline{x+y}.

'\sqrt[ROOT]{arg}'
     Produces the representation of the square root of ARG.  The
     optional argument ROOT determines what root to produce.  For
     example, the cube root of 'x+y' would be typed as
     '$\sqrt[3]{x+y}$'.

'\stackrel{TEXT}{RELATION}'
     Puts TEXT above RELATION.  For example,
     '\stackrel{f}{\longrightarrow}'.

'\underbrace{math}'
     Generates MATH with a brace underneath.

'\underline{text}'
     Causes TEXT, which may be either math mode or not, to be
     underlined.  The line is always below the text, taking account of
     descenders.

'\vdots'
     Produces a vertical ellipsis.


File: latex2e.info,  Node: Modes,  Next: Page styles,  Prev: Math formulas,  Up: Top

18 Modes
********

When LaTeX is processing your input text, it is always in one of three
modes:

   * Paragraph mode
   * Math mode
   * Left-to-right mode, called LR mode for short

   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 '\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 '\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 '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".


File: latex2e.info,  Node: Page styles,  Next: Spaces,  Prev: Modes,  Up: Top

19 Page styles
**************

The '\documentclass' command determines the size and position of the
page's head and foot.  The page style determines what goes in them.

* Menu:

* \maketitle::          Generate a title page.
* \pagenumbering::      Set the style used for page numbers.
* \pagestyle::		Change the headings/footings style.
* \thispagestyle::      Change the headings/footings style for this page.


File: latex2e.info,  Node: \maketitle,  Next: \pagenumbering,  Up: Page styles

19.1 '\maketitle'
=================

The '\maketitle' command generates a title on a separate title
page--except in the 'article' class, where the title is placed at the
top of the first page.  Information used to produce the title is
obtained from the following declarations:

'\author{NAME \and NAME2}'
     The '\author' command declares the document author(s), where the
     argument is a list of authors separated by '\and' commands.  Use
     '\\' to separate lines within a single author's entry--for example,
     to give the author's institution or address.

'\date{TEXT}'
     The '\date' command declares TEXT to be the document's date.  With
     no '\date' command, the current date (*note \today::) is used.

'\thanks{TEXT}'
     The '\thanks' command produces a '\footnote' to the title, usually
     used for credit acknowledgements.

'\title{TEXT}'
     The '\title' command declares TEXT to be the title of the document.
     Use '\\' to force a line break, as usual.


File: latex2e.info,  Node: \pagenumbering,  Next: \pagestyle,  Prev: \maketitle,  Up: Page styles

19.2 '\pagenumbering'
=====================

Synopsis:

     \pagenumbering{STYLE}

   Specifies the style of page numbers, according to STYLE:

'arabic'
     arabic numerals
'roman'
     lowercase Roman numerals
'Roman'
     uppercase Roman numerals
'alph'
     lowercase letters
'Alph'
     uppercase letters


File: latex2e.info,  Node: \pagestyle,  Next: \thispagestyle,  Prev: \pagenumbering,  Up: Page styles

19.3 '\pagestyle'
=================

Synopsis:

     \pagestyle{STYLE}

   The '\pagestyle' command specifies how the headers and footers are
typeset from the current page onwards.  Values for STYLE:

'plain'
     Just a plain page number.

'empty'
     Empty headers and footers, e.g., no page numbers.

'headings'
     Put running headers on each page.  The document style specifies
     what goes in the headers.

'myheadings'
     Custom headers, specified via the '\markboth' or the '\markright'
     commands.

   Here are the descriptions of '\markboth' and '\markright':

'\markboth{LEFT}{RIGHT}'
     Sets both the left and the right heading.  A "left-hand heading"
     (LEFT) is generated by the last '\markboth' command before the end
     of the page, while a "right-hand heading" (RIGHT is generated by
     the first '\markboth' or '\markright' that comes on the page if
     there is one, otherwise by the last one before the page.

'\markright{RIGHT}'
     Sets the right heading, leaving the left heading unchanged.


File: latex2e.info,  Node: \thispagestyle,  Prev: \pagestyle,  Up: Page styles

19.4 '\thispagestyle{STYLE}'
============================

The '\thispagestyle' command works in the same manner as the
'\pagestyle' command (see previous section) except that it changes to
STYLE for the current page only.


File: latex2e.info,  Node: Spaces,  Next: Boxes,  Prev: Page styles,  Up: Top

20 Spaces
*********

LaTeX has many ways to produce white (or filled) space.

   Another space-producing command is '\,' to produce a "thin" space
(usually 1/6quad).  It can be used in text mode, but is more often
useful in math mode (*note Spacing in math mode::).

* Menu:

Horizontal space
* \hspace::             Fixed horizontal space.
* \hfill::              Stretchable horizontal space.
* \SPACE::              Normal interword space.
* \AT::                 Ending a sentence.
* \thinspace::          One-sixth of an em.
* \/::                  Per-character italic correction.
* \hrulefill::          Stretchable horizontal rule.
* \dotfill::            Stretchable horizontal dots.

Vertical space
* \addvspace::                    Add arbitrary vertical space if needed.
* \bigskip \medskip \smallskip::  Fixed vertical spaces.
* \vfill::                        Infinitely stretchable vertical space.
* \vspace::                       Add arbitrary vertical space.


File: latex2e.info,  Node: \hspace,  Next: \hfill,  Up: Spaces

20.1 '\hspace'
==============

Synopsis:

     \hspace[*]{LENGTH}

   The '\hspace' command adds horizontal space.  The LENGTH argument can
be expressed in any terms that LaTeX understands: points, inches, etc.
It is a rubber length.  You can add both negative and positive space
with an '\hspace' command; adding negative space is like backspacing.

   LaTeX normally removes horizontal space that comes at the beginning
or end of a line.  To preserve this space, use the optional '*' form.


File: latex2e.info,  Node: \hfill,  Next: \SPACE,  Prev: \hspace,  Up: Spaces

20.2 '\hfill'
=============

The '\hfill' fill command produces a "rubber length" which has no
natural space but can stretch or shrink horizontally as far as needed.

   The '\fill' parameter is the rubber length itself (technically, the
glue value '0pt plus1fill'); thus, '\hspace\fill' is equivalent to
'\hfill'.


File: latex2e.info,  Node: \SPACE,  Next: \AT,  Prev: \hfill,  Up: Spaces

20.3 '\SPACE'
=============

The '\ ' (space) command produces a normal interword space.  It's useful
after punctuation which shouldn't end a sentence.  For example 'Knuth's
article in Proc.\ Amer.\ Math\. Soc.\ is fundamental'.  It is also often
used after control sequences, as in '\TeX\ is a nice system.'

   In normal circumstances, '\'<tab> and '\'<newline> are equivalent to
'\ '.


File: latex2e.info,  Node: \AT,  Next: \thinspace,  Prev: \SPACE,  Up: Spaces

20.4 '\@'
=========

The '\@' command makes the following punctuation character end a
sentence even if it normally would not.  This is typically used after a
capital letter.  Here are side-by-side examples with and without '\@':

     ... in C\@. Pascal, though ...
     ... in C. Pascal, though ...

produces

     ... in C.  Pascal, though ...
     ... in C. Pascal, though ...


File: latex2e.info,  Node: \thinspace,  Next: \/,  Prev: \AT,  Up: Spaces

20.5 '\thinspace'
=================

'\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 '".


File: latex2e.info,  Node: \/,  Next: \hrulefill,  Prev: \thinspace,  Up: Spaces

20.6 '\/'
=========

The '\/' command produces an "italic correction".  This is a small space
defined by the font designer for a given character, to avoid the
character colliding with whatever follows.  The italic f character
typically has a large italic correction value.

   If the following character is a period or comma, it's not necessary
to insert an italic correction, since those punctuation symbols have a
very small height.  However, with semicolons or colons, as well as
normal letters, it can help.  Compare f: f; (in the TeX output, the 'f's
are nicely separated) with f: f;.

   Despite the name, roman characters can also have an italic
correction.  Compare pdfTeX (in the TeX output, there is a small space
after the 'f') with pdfTeX.


File: latex2e.info,  Node: \hrulefill,  Next: \dotfill,  Prev: \/,  Up: Spaces

20.7 '\hrulefill'
=================

The '\hrulefill' fill command produces a "rubber length" which can
stretch or shrink horizontally.  It will be filled with a horizontal
rule.


File: latex2e.info,  Node: \dotfill,  Next: \addvspace,  Prev: \hrulefill,  Up: Spaces

20.8 '\dotfill'
===============

The '\dotfill' command produces a "rubber length" that fills with dots
instead of just white space.


File: latex2e.info,  Node: \addvspace,  Next: \bigskip \medskip \smallskip,  Prev: \dotfill,  Up: Spaces

20.9 '\addvspace'
=================

'\addvspace{length}'

   The '\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 '\addvspace' command, then this
command will not add more space than needed to make the natural length
of the total vertical space equal to 'length'.


File: latex2e.info,  Node: \bigskip \medskip \smallskip,  Next: \vfill,  Prev: \addvspace,  Up: Spaces

20.10 '\bigskip \medskip \smallskip'
====================================

These commands produce a given amount of space.

'\bigskip'
     The same as '\vspace{bigskipamount}', ordinarily about one line
     space (with stretch and shrink).

'\medskip'
     The same as '\vspace{medskipamount}', ordinarily about half of a
     line space (with stretch and shrink).

'\smallskip'
     The same as '\vspace{smallskipamount}', ordinarily about a quarter
     of a line space (with stretch and shrink).

   The '\...amount' parameters are determined by the document class.


File: latex2e.info,  Node: \vfill,  Next: \vspace,  Prev: \bigskip \medskip \smallskip,  Up: Spaces

20.11 '\vfill'
==============

The '\vfill' fill command produces a rubber length (glue) which can
stretch or shrink vertically as far as needed.  It's equivalent to
'\vspace{\fill}' (*note \hfill::).


File: latex2e.info,  Node: \vspace,  Prev: \vfill,  Up: Spaces

20.12 '\vspace[*]{LENGTH}'
==========================

Synopsis:

     \vspace[*]{LENGTH}

   The '\vspace' command adds the vertical space LENGTH, i.e., a rubber
length.  LENGTH can be negative or positive.

   Ordinarily, LaTeX removes vertical space added by '\vspace' at the
top or bottom of a page.  With the optional '*' argument, the space is
not removed.


File: latex2e.info,  Node: Boxes,  Next: Special insertions,  Prev: Spaces,  Up: Top

21 Boxes
********

All the predefined length parameters (*note Predefined lengths::) can be
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.
* \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.
* \usebox::             Print saved text.


File: latex2e.info,  Node: \mbox,  Next: \fbox and \framebox,  Up: Boxes

21.1 '\mbox{TEXT}'
==================

The '\mbox' command creates a box just wide enough to hold the text
created by its argument.  The TEXT is not broken into lines, so it can
be used to prevent hyphenation.


File: latex2e.info,  Node: \fbox and \framebox,  Next: lrbox,  Prev: \mbox,  Up: Boxes

21.2 '\fbox' and '\framebox'
============================

Synopses:

     \fbox{TEXT}
     \framebox[WIDTH][POSITION]{TEXT}

   The '\fbox' and '\framebox' commands are like '\mbox', except that
they put a frame around the outside of the box being created.

   In addition, the '\framebox' command allows for explicit
specification of the box width with the optional WIDTH argument (a
dimension), and positioning with the optional POSITION argument.

   Both commands produce a rule of thickness '\fboxrule' (default
'.4pt'), and leave a space of '\fboxsep' (default '3pt') between the
rule and the contents of the box.

   *Note \framebox (picture)::, for the '\framebox' command in the
'picture' environment.


File: latex2e.info,  Node: lrbox,  Next: \makebox,  Prev: \fbox and \framebox,  Up: Boxes

21.3 'lrbox'
============

'\begin{lrbox}{cmd} text \end{lrbox}'

   This is the environment form of '\sbox'.

   The text inside the environment is saved in the box 'cmd', which must
have been declared with '\newsavebox'.


File: latex2e.info,  Node: \makebox,  Next: \parbox,  Prev: lrbox,  Up: Boxes

21.4 '\makebox'
===============

Synopsis:

     \makebox[WIDTH][POSITION]{TEXT}

   The '\makebox' command creates a box just wide enough to contain the
TEXT specified.  The width of the box is specified by the optional WIDTH
argument.  The position of the text within the box is determined by the
optional POSITION argument, which may take the following values:

'c'
     Centered (default).
'l'
     Flush left.
'r'
     Flush right.
's'
     Stretch (justify) across entire WIDTH; TEXT must contain
     stretchable space for this to work.

   '\makebox' is also used within the picture environment *note \makebox
(picture)::.


File: latex2e.info,  Node: \parbox,  Next: \raisebox,  Prev: \makebox,  Up: Boxes

21.5 '\parbox'
==============

Synopsis:

     \parbox[POSITION][HEIGHT][INNER-POS]{WIDTH}{TEXT}

   The '\parbox' command produces a box whose contents are created in
'paragraph' mode.  It should be used to make a box small pieces of text,
with nothing fancy inside.  In particular, you shouldn't use any
paragraph-making environments inside a '\parbox' argument.  For larger
pieces of text, including ones containing a paragraph-making
environment, you should use a 'minipage' environment (*note minipage::).

   '\parbox' has two mandatory arguments:

WIDTH
     the width of the parbox;
TEXT
     the text that goes inside the parbox.

   The optional POSITION argument allows you to align either the top or
bottom line in the parbox with the baseline of the surrounding text
(default is top).

   The optional HEIGHT argument overrides the natural height of the box.

   The INNER-POS argument controls the placement of the text inside the
box, as follows; if it is not specified, POSITION is used.

't'
     text is placed at the top of the box.
'c'
     text is centered in the box.
'b'
     text is placed at the bottom of the box.
's'
     stretch vertically; the text must contain vertically stretchable
     space for this to work.


File: latex2e.info,  Node: \raisebox,  Next: \savebox,  Prev: \parbox,  Up: Boxes

21.6 '\raisebox'
================

Synopsis:

     \raisebox{distance}[HEIGHT][DEPTH]{text}

   The '\raisebox' command raises or lowers TEXT.  The first mandatory
argument specifies how high TEXT is to be raised (or lowered if it is a
negative amount).  TEXT itself is processed in LR mode.

   The optional arguments HEIGHT and DEPTH are dimensions.  If they are
specified, LaTeX treats TEXT as extending a certain distance above the
baseline (height) or below (depth), ignoring its natural height and
depth.


File: latex2e.info,  Node: \savebox,  Next: \sbox,  Prev: \raisebox,  Up: Boxes

21.7 '\savebox'
===============

Synopsis:

     \savebox{\BOXCMD}[WIDTH][POS]{TEXT}

   This command typeset TEXT in a box just as with '\makebox' (*note
\makebox::), except that instead of printing the resulting box, it saves
it in the box labeled \BOXCMD, which must have been declared with
'\newsavebox' (*note \newsavebox::).


File: latex2e.info,  Node: \sbox,  Next: \usebox,  Prev: \savebox,  Up: Boxes

21.8 '\sbox{\BOXCMD}{TEXT}'
===========================

Synopsis:

     \sbox{\BOXCMD}{TEXT}

   '\sbox' types TEXT in a box just as with '\mbox' (*note \mbox::)
except that instead of the resulting box being included in the normal
output, it is saved in the box labeled \BOXCMD.  \BOXCMD must have been
previously declared with '\newsavebox' (*note \newsavebox::).


File: latex2e.info,  Node: \usebox,  Prev: \sbox,  Up: Boxes

21.9 '\usebox{\BOXCMD'
======================

Synopsis:

     \usebox{\BOXCMD}

   '\usebox' producesthe box most recently saved in the bin \BOXCMD by a
'\savebox' command (*note \savebox::).


File: latex2e.info,  Node: Special insertions,  Next: Splitting the input,  Prev: Boxes,  Up: Top

22 Special insertions
*********************

LaTeX provides commands for inserting characters that have a special
meaning do not correspond to simple characters you can type.

* Menu:

* Reserved characters::     Inserting # $ % & ~ _ ^ \ { }
* Text symbols::            Inserting other non-letter symbols in text.
* Accents::                 Inserting accents.
* Non-English characters::  Inserting other non-English characters.
* \rule::                   Inserting lines and rectangles.
* \today::                  Inserting today's date.


File: latex2e.info,  Node: Reserved characters,  Next: Text symbols,  Up: Special insertions

22.1 Reserved characters
========================

The following characters play a special role in LaTeX and are called
"reserved characters" or "special characters".

     # $ % & ~ _ ^ \ { }

   Whenever you write one of these characters into your file, LaTeX will
do something special.  If you simply want the character to be printed as
itself, include a '\' in front of the character.  For example, '\$' will
produce '$' in your output.

   One exception to this rule is '\' itself, because '\\' has its own
special (context-dependent) meaning.  A roman \ is produced by typing
'$\backslash$' in your file, and a typewriter '\' is produced by using
'\' in a verbatim command (*note verbatim::).

   Also, '\~' and '\^' place tilde and circumflex accents over the
following letter, as in o~ and o^ (*note Accents::); to get a standalone
'~' or '^', you can again use a verbatim command.

   Finally, you can access any character of the current font once you
know its number by using the '\symbol' command.  For example, the
visible space character used in the '\verb*' command has the code
decimal 32, so it can be typed as '\symbol{32}'.

   You can also specify octal numbers with ''' or hexadecimal numbers
with '"', so the previous example could also be written as
'\symbol{'40}' or '\symbol{"20}'.


File: latex2e.info,  Node: Text symbols,  Next: Accents,  Prev: Reserved characters,  Up: Special insertions

22.2 Text symbols
=================

LaTeX provides commands to generate a number of non-letter symbols in
running text.  Some of these, especially the more obscure ones, are not
available in OT1; you may need to load the 'textcomp' package.

'\copyright'
'\textcopyright'
     The copyright symbol, (C).

'\dag'
     The dagger symbol (in text).

'\ddag'
     The double dagger symbol (in text).

'\LaTeX'
     The LaTeX logo.

'\guillemotleft (<<)'
'\guillemotright (>>)'
'\guilsinglleft (<)'
'\guilsinglright (>)'
     Double and single angle quotation marks, commonly used in French:
     <<, >>, <, >.

'\ldots'
'\dots'
'\textellipsis'
     An ellipsis (three dots at the baseline): '...'.  '\ldots' and
     '\dots' also work in math mode.

'\lq'
     Left (opening) quote: '.

'\P'
'\textparagraph'
     Paragraph sign (pilcrow).

'\pounds'
'\textsterling'
     English pounds sterling: #.

'\quotedblbase (,,)'
'\quotesinglbase (,)'
     Double and single quotation marks on the baseline: ,, and ,.

'\rq'
     Right (closing) quote: '.

'\S'
     Section symbol.

'\TeX'
     The TeX logo.

'\textasciicircum'
     ASCII circumflex: ^.

'\textasciitilde'
     ASCII tilde: ~.

'\textasteriskcentered'
     Centered asterisk: *.

'\textbackslash'
     Backslash: \.

'\textbar'
     Vertical bar: |.

'\textbardbl'
     Double vertical bar.

'\textbigcircle'
     Big circle symbol.

'\textbraceleft'
     Left brace: {.

'\textbraceright'
     Right brace: }.

'\textbullet'
     Bullet: *.

'\textcircled{LETTER}'
     LETTER in a circle, as in (R).

'\textcompwordmark'
'\textcapitalwordmark'
'\textascenderwordmark'
     Composite word mark (invisible).  The '\textcapital...' form has
     the cap height of the font, while the '\textascender...' form has
     the ascender height.

'\textdagger'
     Dagger: \dag.

'\textdaggerdbl'
     Double dagger: \ddag.

'\textdollar (or '$')'
     Dollar sign: $.

'\textemdash (or '---')'
     Em-dash: -- (for punctuation).

'\textendash (or '--')'
     En-dash: -- (for ranges).

'\texteuro'
     The Euro symbol: Euro.

'\textexclamdown (or '!`')'
     Upside down exclamation point: !.

'\textgreater'
     Greater than: >.

'\textless'
     Less than: <.

'\textleftarrow'
     Left arrow.

'\textordfeminine'
'\textordmasculine'
     Feminine and masculine ordinal symbols: a, o.

'\textperiodcentered'
     Centered period: \cdot.

'\textquestiondown (or '?`')'
     Upside down questionation point: ?.

'\textquotedblleft (or '``')'
     Double left quote: ".

'\textquotedblright (or ''')'
     Double right quote: ".

'\textquoteleft (or '`')'
     Single left quote: '.

'\textquoteright (or ''')'
     Single right quote: '.

'\textquotestraightbase'
'\textquotestraightdblbase'
     Single and double straight quotes on the baseline.

'\textregistered'
     Registered symbol: (R).

'\textrightarrow'
     Right arrow.

'\textthreequartersemdash'
     "Three-quarters" em-dash, between en-dash and em-dash.

'\texttrademark'
     Trademark symbol: ^{\hbox{TM}}.

'\texttwelveudash'
     "Two-thirds" em-dash, between en-dash and em-dash.

'\textunderscore'
     Underscore: _.

'\textvisiblespace'
     Visible space symbol.


File: latex2e.info,  Node: Accents,  Next: Non-English characters,  Prev: Text symbols,  Up: Special insertions

22.3 Accents
============

LaTeX has wide support for many of the world's scripts and languages,
through the 'babel' package and related support.  This section does not
attempt to cover all that support.  It merely lists the core LaTeX
commands for creating accented characters.

   The '\capital...' commands produce alternative forms for use with
capital letters.  These are not available with OT1.

'\"'
'\capitaldieresis'
     Produces an umlaut (dieresis), as in o".

'\''
'\capitalacute'
     Produces an acute accent, as in o'.  In the 'tabbing' environment,
     pushes current column to the right of the previous column (*note
     tabbing::).

'\.'
     Produces a dot accent over the following, as in o..

'\='
'\capitalmacron'
     Produces a macron (overbar) accent over the following, as in o=.

'\^'
'\capitalcircumflex'
     Produces a circumflex (hat) accent over the following, as in o^.

'\`'
'\capitalgrave'
     Produces a grave accent over the following, as in o`.  In the
     'tabbing' environment, move following text to the right margin
     (*note tabbing::).

'\~'
'\capitaltilde'
     Produces a tilde accent over the following, as in n~.

'\b'
     Produces a bar accent under the following, as in o_.

'\c'
'\capitalcedilla'
     Produces a cedilla accent under the following, as in c,.

'\d'
'\capitaldotaccent'
     Produces a dot accent under the following, as in .o.

'\H'
'\capitalhungarumlaut'
     Produces a long Hungarian umlaut accent over the following, as in
     o''.

'\i'
     Produces a dotless i, as in 'i'.

'\j'
     Produces a dotless j, as in 'j'.

'\k'
'\capitalogonek'
     Produces a letter with ogonek, as in 'o;'.  Not available in the
     OT1 encoding.

'\r'
'\capitalring'
     Produces a ring accent, as in 'o*'.

'\t'
'\capitaltie'
'\newtie'
'\capitalnewtie'
     Produces a tie-after accent, as in 'oo['.  The '\newtie' form is
     centered in its box.

'\u'
'\capitalbreve'
     Produces a breve accent, as in 'o('.

'\underbar'
     Not exactly an accent, this produces a bar under the argument text.
     The argument is always processed in horizontal mode.  The bar is
     always a fixed position under the baseline, thus crossing through
     descenders.  See also '\underline' in *note Math miscellany::.

'\v'
'\capitalcaron'
     Produces a ha'c<ek (check, caron) accent, as in 'o<'.


File: latex2e.info,  Node: Non-English characters,  Next: \rule,  Prev: Accents,  Up: Special insertions

22.4 Non-English characters
===========================

Here are the basic LaTeX commands for inserting characters commonly used
in languages other than English.

'\aa'
'\AA'
     aa and AA.

'\ae'
'\AE'
     ae and AE.

'\dh'
'\DH'
     Icelandic letter eth: d and D.

'\dj'
'\DJ'
     xxxx

'\ij'
'\IJ'
     ij and IJ (except somewhat closer together than appears here).

'\l'
'\L'
     /l and /L.

'\ng'
'\NG'
     xxxx

'\o'
'\O'
     /o and /O.

'\oe'
'\OE'
     oe and OE.

'\ss'
'\SS'
     ss and SS.

'\th'
'\TH'
     Icelandic letter thorn: th and TH.


File: latex2e.info,  Node: \rule,  Next: \today,  Prev: Non-English characters,  Up: Special insertions

22.5 '\rule'
============

Synopsis:

     \rule[RAISE]{WIDTH}{THICKNESS}

   The '\rule' command produces "rules", that is, lines or rectangles.
The arguments are:

RAISE
     How high to raise the rule (optional).

WIDTH
     The length of the rule (mandatory).

THICKNESS
     The thickness of the rule (mandatory).


File: latex2e.info,  Node: \today,  Prev: \rule,  Up: Special insertions

22.6 '\today'
=============

The '\today' command produces today's date, in the format 'MONTH DD,
YYYY'; for example, 'July 4, 1976'.  It uses the predefined counters
'\day', '\month', and '\year' (*note \day \month \year::) to do this.
It is not updated as the program runs.

   The 'datetime' package, among others, can produce a wide variety of
other date formats.


File: latex2e.info,  Node: Splitting the input,  Next: Front/back matter,  Prev: Special insertions,  Up: Top

23 Splitting the input
**********************

A large document requires a lot of input.  Rather than putting the whole
input in a single large file, it's more efficient to split it into
several smaller ones.  Regardless of how many separate files you use,
there is one that is the root file; it is the one whose name you type
when you run LaTeX.

* Menu:

* \include::            Conditionally include a file.
* \includeonly::        Determine which files are included.
* \input::              Unconditionally include a file.


File: latex2e.info,  Node: \include,  Next: \includeonly,  Up: Splitting the input

23.1 '\include'
===============

Synopsis:

     \include{FILE}

   If no '\includeonly' command is present, the '\include' command
executes '\clearpage' to start a new page (*note \clearpage::), then
reads FILE, then does another '\clearpage'.

   Given an '\includeonly' command, the '\include' actions are only run
if FILE is listed as an argument to '\includeonly'.  See the next
section.

   The '\include' command may not appear in the preamble or in a file
read by another '\include' command.


File: latex2e.info,  Node: \includeonly,  Next: \input,  Prev: \include,  Up: Splitting the input

23.2 \'includeonly'
===================

Synopsis:

     \includeonly{FILE1,FILE2,...}

   The '\includeonly' command controls which files will be read by
subsequent '\include' commands.  The list of filenames is
comma-separated.  Each FILE must exactly match a filename specified in a
'\include' command for the selection to be effective.

   This command can only appear in the preamble.


File: latex2e.info,  Node: \input,  Prev: \includeonly,  Up: Splitting the input

23.3 \input
===========

Synopsis:

     \input{FILE}

   The '\input' command causes the specified FILE to be read and
processed, as if its contents had been inserted in the current file at
that point.

   If FILE does not end in '.tex' (e.g., 'foo' or 'foo.bar'), it is
first tried with that extension ('foo.tex' or 'foo.bar.tex').  If that
is not found, the original FILE is tried ('foo' or 'foo.bar').


File: latex2e.info,  Node: Front/back matter,  Next: Letters,  Prev: Splitting the input,  Up: Top

24 Front/back matter
********************

* Menu:

* Tables of contents::
* Glossaries::
* Indexes::


File: latex2e.info,  Node: Tables of contents,  Next: Glossaries,  Up: Front/back matter

24.1 Tables of contents
=======================

A table of contents is produced with the '\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 have generated a
'.toc' file.

   The '\tableofcontents' command produces a heading, but it does not
automatically start a new page.  If you want a new page after the table
of contents, write a '\newpage' command after the '\tableofcontents'
command.

   The analogous commands '\listoffigures' and '\listoftables' produce a
list of figures and a list of tables, respectively.  Everything works
exactly the same as for the table of contents.

   The command '\nofiles' overrides these commands, and _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.


File: latex2e.info,  Node: \addcontentsline,  Next: \addtocontents,  Up: Tables of contents

24.1.1 \addcontentsline
-----------------------

The '\addcontentsline'{EXT}{UNIT}{TEXT} command adds an entry to the
specified list or table where:

EXT
     The extension of the file on which information is to be written,
     typically one of: 'toc' (table of contents), 'lof' (list of
     figures), or 'lot' (list of tables).

UNIT
     The name of the sectional unit being added, typically one of the
     following, matching the value of the EXT argument:

     'toc'
          The name of the sectional unit: 'part', 'chapter', 'section',
          'subsection', 'subsubsection'.
     'lof'
          For the list of figures.
     'lot'
          For the list of tables.

ENTRY
     The actual text of the entry.

   What is written to the '.EXT' file is the command
'\contentsline{UNIT}{NAME}'.


File: latex2e.info,  Node: \addtocontents,  Prev: \addcontentsline,  Up: Tables of contents

24.1.2 \addtocontents
---------------------

The '\addtocontents'{EXT}{TEXT} command adds text (or formatting
commands) directly to the '.EXT' file that generates the table of
contents or lists of figures or tables.

EXT
     The extension of the file on which information is to be written:
     'toc' (table of contents), 'lof' (list of figures), or 'lot' (list
     of tables).

TEXT
     The text to be written.


File: latex2e.info,  Node: Glossaries,  Next: Indexes,  Prev: Tables of contents,  Up: Front/back matter

24.2 Glossaries
===============

The command '\makeglossary' enables creating glossaries.

   The command '\glossary{TEXT}' writes a glossary entry for TEXT to an
auxiliary file with the '.glo' extension.

   Specifically, what gets written is the command
'\glossaryentry{TEXT}{PAGENO}', where PAGENO is the current '\thepage'
value.

   The 'glossary' package on CTAN provides support for fancier
glossaries.


File: latex2e.info,  Node: Indexes,  Prev: Glossaries,  Up: Front/back matter

24.3 Indexes
============

The command '\makeindex' enables creating indexes.  Put this in the
preamble.

   The command '\index{TEXT}' writes an index entry for TEXT to an
auxiliary file with the '.idx' extension.

   Specifically, what gets written is the command
'\indexentry{TEXT}{PAGENO}', where PAGENO is the current '\thepage'
value.

   To generate a index entry for 'bar' that says 'See foo', use a
vertical bar: '\index{bar|see{foo}}'.  Use 'seealso' instead of 'see' to
make a 'See also' entry.

   The text 'See' is defined by the macro '\seename', and 'See also' by
the macro '\alsoname'.  These can be redefined for other languages.

   The generated '.idx' file is then sorted with an external command,
usually either 'makeindex' (<http://mirror.ctan.org/indexing/makeindex>)
or (the multi-lingual) 'xindy' (<http://xindy.sourceforge.net>).  This
results in a '.ind' file, which can then be read to typeset the index.

   The index is usually generated with the '\printindex' command.  This
is defined in the 'makeidx' package, so '\usepackage{makeidx}' needs to
be in the preamble.

   The rubber length '\indexspace' is inserted before each new letter in
the printed index; its default value is '10pt plus5pt minus3pt'.

   The 'showidx' package causes each index entries to be shown in the
margin on the page where the entry appears.  This can help in preparing
the index.

   The 'multind' package supports multiple indexes.  See also the TeX
FAQ entry on this topic,
<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind>.


File: latex2e.info,  Node: Letters,  Next: Terminal input/output,  Prev: Front/back matter,  Up: Top

25 Letters
**********

You can use LaTeX to typeset letters, both personal and business.  The
'letter' document class is designed to make a number of letters at once,
although you can make just one if you so desire.

   Your '.tex' source file has the same minimum commands as the other
document classes, i.e., you must have the following commands as a
minimum:

      \documentclass{letter}
      \begin{document}
       ... letters ...
      \end{document}

   Each letter is a 'letter' environment, whose argument is the name and
address of the recipient.  For example, you might have:

      \begin{letter}{Mr. Joe Smith\\ 2345 Princess St.
           \\ Edinburgh, EH1 1AA}
        ...
      \end{letter}

   The letter itself begins with the '\opening' command.  The text of
the letter follows.  It is typed as ordinary LaTeX input.  Commands that
make no sense in a letter, like '\chapter', do not work.  The letter
closes with a '\closing' command.

   After the 'closing', you can have additional material.  The '\cc'
command produces the usual "cc: ...".  There's also a similar '\encl'
command for a list of enclosures.  With both these commands, use '\\' to
separate the items.

   These commands are used with the 'letter' class.

* Menu:

* \address::            Your return address.
* \cc::                 Cc list.
* \closing::            Saying goodbye.
* \encl::               List of enclosed material.
* \location::           Your organisation's address.
* \makelabels::         Making address labels.
* \name::               Your name, for the return address.
* \opening::            Saying hello.
* \ps::                 Adding a postscript.
* \signature::          Your signature.
* \startbreaks::        Allow page breaks.
* \stopbreaks::         Disallow page breaks.
* \telephone::          Your phone number.


File: latex2e.info,  Node: \address,  Next: \cc,  Up: Letters

25.1 \address{RETURN-ADDRESS}
=============================

The '\address' specifies the return address of a letter, as it should
appear on the letter and the envelope.  Separate lines of the address
should be separated by '\\' commands.

   If you do not make an '\address' declaration, then the letter will be
formatted for copying onto your organisation's standard letterhead.
(*Note Overview::, for details on your local implementation).  If you
give an '\address' declaration, then the letter will be formatted as a
personal letter.


File: latex2e.info,  Node: \cc,  Next: \closing,  Prev: \address,  Up: Letters

25.2 '\cc'
==========

Synopsis:

     \cc{NAME1\\NAME2}

   Produce a list of NAMEs the letter was copied to.  Each name is
printed on a separate line.


File: latex2e.info,  Node: \closing,  Next: \encl,  Prev: \cc,  Up: Letters

25.3 '\closing'
===============

Synopsis:

     \closing{text}

   A letter closes with a '\closing' command, for example,
     \closing{Best Regards,}


File: latex2e.info,  Node: \encl,  Next: \location,  Prev: \closing,  Up: Letters

25.4 '\encl'
============

Synopsis:

     \encl{LINE1\\LINE2}

   Declare a list of one more enclosures.


File: latex2e.info,  Node: \location,  Next: \makelabels,  Prev: \encl,  Up: Letters

25.5 '\location'
================

'\location{address}'

   This modifies your organisation's standard address.  This only
appears if the 'firstpage' pagestyle is selected.


File: latex2e.info,  Node: \makelabels,  Next: \name,  Prev: \location,  Up: Letters

25.6 '\makelabels'
==================

'\makelabels{number}'

   If you issue this command in the preamble, LaTeX will create a sheet
of address labels.  This sheet will be output before the letters.


File: latex2e.info,  Node: \name,  Next: \opening,  Prev: \makelabels,  Up: Letters

25.7 '\name'
============

'\name{June Davenport}'

   Your name, used for printing on the envelope together with the return
address.


File: latex2e.info,  Node: \opening,  Next: \ps,  Prev: \name,  Up: Letters

25.8 '\opening{TEXT}'
=====================

Synopsis:

     \opening{TEXT}

   A letter begins with the '\opening' command.  The mandatory argument,
TEXT, is whatever text you wish to start your letter.  For instance:

     \opening{Dear Joe,}


File: latex2e.info,  Node: \ps,  Next: \signature,  Prev: \opening,  Up: Letters

25.9 '\ps'
==========

Use the '\ps' command to start a postscript in a letter, after
'\closing'.


File: latex2e.info,  Node: \signature,  Next: \startbreaks,  Prev: \ps,  Up: Letters

25.10 '\signature{TEXT}'
========================

Your name, as it should appear at the end of the letter underneath the
space for your signature.  '\\' starts a new line within TEXT as usual.


File: latex2e.info,  Node: \startbreaks,  Next: \stopbreaks,  Prev: \signature,  Up: Letters

25.11 '\startbreaks'
====================

'\startbreaks'

   Used after a '\stopbreaks' command to allow page breaks again.


File: latex2e.info,  Node: \stopbreaks,  Next: \telephone,  Prev: \startbreaks,  Up: Letters

25.12 '\stopbreaks'
===================

'\stopbreaks'

   Inhibit page breaks until a '\startbreaks' command occurs.


File: latex2e.info,  Node: \telephone,  Prev: \stopbreaks,  Up: Letters

25.13 '\telephone'
==================

'\telephone{number}'

   This is your telephone number.  This only appears if the 'firstpage'
pagestyle is selected.


File: latex2e.info,  Node: Terminal input/output,  Next: Command line,  Prev: Letters,  Up: Top

26 Terminal input/output
************************

* Menu:

* \typein::             Read text from the terminal.
* \typeout::            Write text to the terminal.


File: latex2e.info,  Node: \typein,  Next: \typeout,  Up: Terminal input/output

26.1 '\typein[CMD]{MSG}'
========================

Synopsis:

     \typein[\CMD]{MSG}

   '\typein' prints MSG on the terminal and causes LaTeX to stop and
wait for you to type a line of input, ending with return.  If the
optional \CMD argument is omitted, the typed input is processed as if it
had been included in the input file in place of the '\typein' command.
If the \CMD argument is present, it must be a command name.  This
command name is then defined or redefined to be the typed input.


File: latex2e.info,  Node: \typeout,  Prev: \typein,  Up: Terminal input/output

26.2 '\typeout{MSG}'
====================

Synopsis:

     \typeout{MSG}

   Prints 'msg' on the terminal and in the 'log' file.  Commands in
'msg' that are defined with '\newcommand' or '\renewcommand' (among
others) are replaced by their definitions before being printed.

   LaTeX's usual rules for treating multiple spaces as a single space
and ignoring spaces after a command name apply to 'msg'.  A '\space'
command in 'msg' causes a single space to be printed, independent of
surrounding spaces.  A '^^J' in 'msg' prints a newline.


File: latex2e.info,  Node: Command line,  Next: Document templates,  Prev: Terminal input/output,  Up: Top

27 Command line
***************

The input file specification indicates the file to be formatted; TeX
uses '.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.

     latex '\nonstopmode\input foo.tex'

will process 'foo.tex' without pausing after every error.

   If LaTeX stops in the middle of the document and gives you a '*'
prompt, it is waiting for input.  You can type '\stop' (and return) and
it will prematurely end the document.


File: latex2e.info,  Node: Document templates,  Next: Concept Index,  Prev: Command line,  Up: Top

Appendix A Document templates
*****************************

Although not reference material, perhaps these document templates will
be useful.  Additional template resources are listed
<http://tug.org/interest.html#latextemplates>.

* Menu:

* book template::
* beamer template::
* tugboat template::


File: latex2e.info,  Node: book template,  Next: beamer template,  Up: Document templates

A.1 'book' template
===================

\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}


File: latex2e.info,  Node: beamer template,  Next: tugboat template,  Prev: book template,  Up: Document templates

A.2 'beamer' template
=====================

The 'beamer' class creates slides presentations.

\documentclass{beamer}

\title{Beamer Class template}
\author{Alex Author}
\date{July 31, 2007}

\begin{document}

\maketitle

% without [fragile], any {verbatim} code gets mysterious errors.
\begin{frame}[fragile]
 \frametitle{First Slide}

\begin{verbatim}
  This is \verbatim!
\end{verbatim}

\end{frame}

\end{document}

   One web resource for this:
<http://robjhyndman.com/hyndsight/beamer/>.


File: latex2e.info,  Node: tugboat template,  Prev: beamer template,  Up: Document templates

A.3 'tugboat' template
======================

'TUGboat' is the journal of the TeX Users Group,
<http://tug.org/TUGboat>.

\documentclass{ltugboat}
\usepackage{graphicx}
\usepackage{ifpdf}
\ifpdf
\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black,
            urlcolor=black]{hyperref}
\else
\usepackage{url}
\fi

\title{Example \TUB\ article}

% repeat info for each author.
\author{First Last}
\address{Street Address \\ Town, Postal \\ Country}
\netaddress{user (at) example dot org}
\personalURL{http://example.org/~user/}

\begin{document}

\maketitle

\begin{abstract}
This is an example article for \TUB{}.
\end{abstract}

\section{Introduction}

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).
Nowadays \TUB\ is produced using \acro{PDF} files exclusively.

The \texttt{ltugboat} class provides these abbreviations and many more:

% verbatim blocks are often better in \small
\begin{verbatim}[\small]
\AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW
\BibTeX \CTAN \DTD \HTML
\ISBN \ISSN \LaTeXe
\Mc \mf \MFB \mtex \PCTeX \pcTeX
\PiC \PiCTeX \plain \POBox \PS
\SC \SGML \SliTeX \TANGLE \TB \TP
\TUB \TUG \tug
\UG \UNIX \VAX \XeT \WEB \WEAVE

\Dash \dash \vellipsis \bull \cents \Dag
\careof \thinskip

\acro{FRED} -> {\small[er] fred}  % please use!
\cs{fred}   -> \fred
\env{fred}  -> \begin{fred}
\meta{fred} -> <fred>
\nth{n}     -> 1st, 2nd, ...
\sfrac{3/4} -> 3/4
\booktitle{Book of Fred}
\end{verbatim}

For more information, see the ltubguid document at:
\url{http://mirror.ctan.org/macros/latex/contrib/tugboat}
(we recommend using \verb|mirror.ctan.org| for \CTAN\ references).

Email \verb|tugboat@tug.org| if problems or questions.

\bibliographystyle{plain}  % we recommend the plain bibliography style
\nocite{book-minimal}      % just making the bibliography non-empty
\bibliography{xampl}       % xampl.bib comes with BibTeX

\makesignature
\end{document}


File: latex2e.info,  Node: Concept Index,  Next: Command Index,  Prev: Document templates,  Up: Top

Concept Index
*************