latex2man: Package Specific Macros
Package Specific Macros
-----------------------
The following commands are provided:
`\Opt{option}'
Option: \Opt{-o} will be typeset as -o.
`\Arg{argument}'
Argument: \Arg{filename} will be typeset as FILENAME.
`\OptArg{option}{argument}'
Option with Argument:
\OptArg{-o}{filename} will be typeset as -oFILENAME.
`\OptoArg{option}{argument}'
Option with optional Argument:
\OptoArg{-o}{filename} will be typeset as -o[FILENAME].
`\oOpt{option}'
Optional option, e.g. \oOpt{-o} will be typeset as [ -o ].
`\oArg{argument}'
Optional argument, e.g. \oArg{filename} will be typeset as [
FILENAME ].
`\oOptArg{option}{argument}'
Optional option with argument, e.g.
\oOptArg{-o}{filename} will be typeset as [ -oFILENAME ].
`\oOptoArg{option}{argument}'
Optional option with optional argument, e.g.
\oOptoArg{-o}{filename} will be typeset as [ -o[FILENAME] ].
`\File{filename}'
used to typeset filenames, e.g. \File{filename} will be typeset
as `filename'.
`\Prog{prog}'
used to typeset program names, e.g. \Prog{latex2man} will be
typeset as latex2man.
`\Cmd{command}{chapter}'
used to typeset references to other commands, e.g.
\Cmd{latex2man}{1} will be typeset as latex2man(1).
`\Bar'
is typeset as |.
`\Bs'
(BackSlash) is typeset as \.
`\Tilde'
is typeset as a ~.
`\Dots'
is typeset as ...
`\Bullet'
us typeset as *.
`\setVersion{..}'
set .. as version information.
`\setVersionWord{..}'
set .. for the word _Version:_ in the footline.
The default is \setVersionWord{Version:}.
`\Version'
returns the version information.
`\setDate{..}'
sets .. as date information.
`\Date'
returns the date information.
`\Email{..}'
use to mark an Email address:
\Email{Juergen.Vollmer@informatik-vollmer.de} is typeset as:
<Juergen.Vollmer@informatik-vollmer.de>.
`\URL{..}'
use to mark an URL: \URL{http://www.foo.de/\Tilde vollmer} is
typeset as
`http://www.foo.de/~vollmer'.
`\LatexManEnd'
the input file is read and processed until reading end-of-file or
\LatexManEnd (at the beginning of a line). LaTeXignores this
command.
`\Lbr, \Rbr'
is typeset as [ and ] (these variants are needed only somtimes
like in
\item[FooBar\LBr xx \Lbr]. Usually [ ] will work.
`\LBr, \RBr'
is typeset as { and } (these variants are needed when using { or }
as arguments to macros.
`\Circum'
is typeset as ^.
`\Percent'
is typeset as %.
`\TEXbr'
If processed with LaTeX causes a linebreak (i.e. is equivalent to
\\).In the output of latex2man this macro is ignored.
`\TEXIbr'
If TexInfo output is generated, causes a linebreak (i.e. is
equivalent to \\),otherwise ignored.
`\MANbr'
If Man-Page output is generated, causes a linebreak (i.e. is
equivalent to \\),otherwise ignored.
`\HTMLbr'
If HTML output is generated, causes a linebreak (i.e. is
equivalent to \\),otherwise ignored.
`\medskip'
An empty line.
`\SP'
Produces some extra space, works also at the beginning of lines.
The code of the second line looks like: \SP abc \SP\SP xx\\:
abc xx
. abc xx
. . abc xx
Note: Due to some "problems" with TexInfo, the lines starting with
\SP have a leading . (dot) in the TexInfo output, see -aCHAR.
Info Catalog
latex2man: Accepted LaTeX Environments
latex2man: Top
latex2man: Accepted Macros from the rcsinfo Package