latex2man: Package Specific Environments
Package Specific Environments
-----------------------------
The following environments are provided by the package:
`\begin{Name}{chapter}{name}{author}{info}{title}'
The Name environment takes five arguments: 1. the Man-page
chapter, 2. the name of the Man-page, 3. the author, 4. some
short information about the tool printed in the footline of the
Man-page, and 5. a text which is used as title, for HTML and
LaTeX (it's ignored for output of the Man-page or TeXinfo. The Name
environment must be the first environment in the document.
Processing starts with this environment. Any text before this is
ignored (exception: the setVersion and setDate commands). (Note:
all arguments of \begin{Name} must be written on one line).
`\begin{Table}[width]{columns}'
The Table environment takes two arguments: the first optional one
specifies a width of the last column, the second one gives the
number of columns. For example:
\begin{Table}[2cm]{3}
Here & am & I \\\hline
A 1 & A 2 & A 3 1 2 3 4 5 A 3 1 2 3 4 5 \\
B 1 & B 2 & B 3 \\
\end{Table}
will be typeset as:
Here am I
A 1 A 2 A 3 1 2 3 4 5 A 3 1
2 3 4 5
B 1 B 2 B 3
If no optional _width_ argument is given, all entries are typeset
left justified. The _width_ is a length measured absolutly in
_cm_. Processing with LaTeX a p{width} column is typeset as last
column. The translation to troff(1) commands results in a lw(width)
column specification. Translating to HTML and TexInfo ignores the
_width_ parameter.
\hline may be used.
If the Man-page is formatted with troff(1) and tables are used, the
tbl(1) preprocessor should be called, usually by giving a -t to
the call of troff(1). When viewing the generated manula page
using man(1), tbl(1) is called automatically.
`\begin{Description}'
is the same as \begin{description}
`\begin{Description}[label]'
is similar to \begin{description}, but the item labels have at
minimum the size of the (optional) word _label_. The difference
is visible only in the DVI and PDF-output, not in the troff,
TexInfo or HTML output.
`a'
|a \begin{description}
`ab'
|ab
`abc'
|abc
`a'
|a \begin{Description}
`ab'
|ab
`abc'
|abc
`a'
|a \begin{Description}[aa]
`ab'
|ab
`abc'
|abc
Info Catalog
latex2man: Package Options
latex2man: Top
latex2man: Accepted LaTeX Environments