summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latex2man/latex2man.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/latex2man/latex2man.1')
-rw-r--r--Master/texmf-dist/doc/support/latex2man/latex2man.1278
1 files changed, 263 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.1 b/Master/texmf-dist/doc/support/latex2man/latex2man.1
index 587dbf434b8..1c1773fc588 100644
--- a/Master/texmf-dist/doc/support/latex2man/latex2man.1
+++ b/Master/texmf-dist/doc/support/latex2man/latex2man.1
@@ -1,5 +1,5 @@
'\" t
-.\" Manual page created with latex2man on Di 11. Nov 08:21:27 CET 2008
+.\" Manual page created with latex2man on Mi 22. Dez 13:46:36 CET 2010
.\" NOTE: This file is generated, DO NOT EDIT.
.de Vb
.ft CW
@@ -10,7 +10,7 @@
.fi
..
-.TH "LATEX2MAN" "1" "2008/11/11" "Documentation Tools " "Documentation Tools "
+.TH "LATEX2MAN" "1" "2010/12/22" "Documentation Tools " "Documentation Tools "
.SH NAME
.PP
@@ -26,6 +26,7 @@ feature (for this, LaTeX generation may be used).
.PP
latex2man
[\fB\-t\fP\fItransfile\fP]
+[\fB\-c\fP\fICSSfile\fP]
[\fB\-HMTL\fP]
[\fB\-h\fP]
[\fB\-V\fP]
@@ -51,6 +52,10 @@ macro package.
Using the \fB\-H\fP
option, HTML code can be produced, instead of
\fItroff\fP(1)\&.
+With this option you can, optionally, specify a \fICSSfile\fP
+as an argument.
+CSS (Cascading Style Sheets) allows you to control the appearance of the resulting HTML page.
+See below for the names of CSS classes that are included in the HTML tags as attributes.
.PP
Using the \fB\-T\fP
option, TexInfo code can be produced, instead of
@@ -70,6 +75,13 @@ option, LaTeX ouput can be produced, instead of
\fB\-t\fP\fItransfile\fP
Translation for user defined LaTeX macros.
.TP
+\fB\-c\fP\fICSSfile\fP
+ If you use the \fB\-H\fP
+you can also specify a file that contains CSS
+style sheets. The link to the CSS file is inserted into the generatedHTML output using the
+specified \fICSSfile\fP
+filename.
+.TP
\fB\-M\fP
Produce output suitable for the \fIman\fP(1)
command (default).
@@ -157,6 +169,9 @@ latex2man.cfg
The configuration file for Latex2man
LaTeX\-package.
.TP
+latex2man.css
+ File containing example CSS definitions.
+.TP
latex2man.trans
File containing example translations of user
defined LaTeX macros.
@@ -173,6 +188,10 @@ rcsinfo.sty
A LaTeX package used to extract and use RCS version
control information in LaTeX documents.
.PP
+.TP
+\fBlatex2man.pdf\fP
+ The PDF version of this document.
+.PP
.SH SEE ALSO
.PP
@@ -431,7 +450,8 @@ Optional option with argument, e.g.
.TP
\\oOptoArg{option}{argument}
Optional option with optional
-argument, e.g.
+argument, e.g.
+.br
\\oOptoArg{\-o}{filename} will be typeset as [\fB\-o\fP[\fIfilename\fP]]\&.
.TP
\\File{filename}
@@ -444,8 +464,9 @@ used to typeset program names, e.g.
.TP
\\Cmd{command}{chapter}
used to typeset references to other
-commands, e.g. \\Cmd{latex2man}{1} will be typeset as
-\fIlatex2man\fP(1)\&.
+commands, e.g.
+.br
+\\Cmd{latex2man}{1} will be typeset as \fIlatex2man\fP(1)\&.
.TP
\\Bar
is typeset as |\&.
@@ -469,7 +490,9 @@ set \&.. as version information.
\\setVersionWord{\&.\&.}
set \&.. for the word \fIVersion:\fP
in
-the footline. The default is \\setVersionWord{Version:}\&.
+the footline.
+.br
+The default is \\setVersionWord{Version:}\&.
.TP
\\Version
returns the version information.
@@ -489,18 +512,22 @@ use to mark an Email address:
.TP
\\URL{\&.\&.}
use to mark an URL:
-\\URL{http://www.foo.de/\\Tilde vollmer} is typeset as
+\\URL{http://www.foo.de/\\Tilde vollmer} is typeset as
+.br
\fBhttp://www.foo.de/~vollmer\fP\&.
.TP
\\LatexManEnd
the input file is read and processed until reading
-end\-of\-file or \\LatexManEnd (at the beginning of a line).
+end\-of\-file or
+.br
+\\LatexManEnd (at the beginning of a line).
LaTeXignores this command.
.TP
\\Lbr, \\Rbr
is typeset as [ and ] (these variants are
-needed only somtimes like in item[FooBar\\LBr xx \\Lbr]\&. Usually
-[ ] will work.
+needed only somtimes like in
+.br
+\\item[FooBar\\LBr xx \\Lbr]\&. Usually [ ] will work.
.TP
\\LBr, \\RBr
is typeset as { and } (these variants are
@@ -697,7 +724,7 @@ description
environment.
.TP
\\today
-11 November 2008(see also the rcsinfo
+22 December 2010(see also the rcsinfo
LaTeXpackage).
.TP
\\ss,\\"a, ...
@@ -988,7 +1015,225 @@ If you don\&'t have it, you should execute the
steps shown in the Makefile
manually.
.PP
-.SS SOME BUG FIX TESTS
+.SH CSS CLASSNAMES
+
+.PP
+The table below shows the names of CSS classes that will be included in the HTML tags as attributes.
+You can specify the CSS style properties in the \fICSSfile\fP
+for these classes:
+.PP
+.TS
+tab(&);
+l l lw(8.5cm).
+T{
+\fBHTML tag\fP
+T}&T{
+\fBClass\fP
+T}&T{
+\fBStyle applies to\fP
+T}
+T{
+body
+T}&T{
+T}&T{
+the body of the HTML page
+T}
+T{
+h1
+T}&T{
+titlehead
+T}&T{
+the title at the top of the HTML page specified as an argument to the \fIName\fP
+environment
+T}
+T{
+h4
+T}&T{
+authorhead
+T}&T{
+the author at the top of the HTML page specified as an argument to the \fIName\fP
+environment
+T}
+T{
+h4
+T}&T{
+datehead
+T}&T{
+the date at the top of the HTML page
+T}
+T{
+h4
+T}&T{
+versionhead
+T}&T{
+the man page version at the top of the HTML page specified as an argument to the \fIsetVersion\fP
+macro
+T}
+T{
+h2
+T}&T{
+sectionname
+T}&T{
+a section title specified as an argument to the \fIsection\fP
+macro
+T}
+T{
+h4
+T}&T{
+subsectionname
+T}&T{
+a subsection title specified as an argument to the \fIsubsection\fP
+macro
+T}
+T{
+h5
+T}&T{
+subsubsectionname
+T}&T{
+a subsubsection title specified as an argument to the \fIsubsubsection\fP
+macro
+T}
+T{
+font
+T}&T{
+progname
+T}&T{
+a program name specified as an argument to the \fIProg\fP
+macro
+T}
+T{
+font
+T}&T{
+filename
+T}&T{
+a file name specified as an argument to the \fIFile\fP
+macro
+T}
+T{
+font
+T}&T{
+commandname
+T}&T{
+a command name specified as an argument to the \fICmd\fP
+macro
+T}
+T{
+font
+T}&T{
+textstyle
+T}&T{
+all text that is not an argument to some LaTeX or latex2man macro
+T}
+T{
+font
+T}&T{
+optstyle
+T}&T{
+a name of an option specified as an argument to the \fIOpt\fP,
+\fIoOpt\fP,
+\fIOptArg\fP,
+\fIoOptArg\fP
+or \fIoOptoArg\fP
+macros
+T}
+T{
+font
+T}&T{
+argstyle
+T}&T{
+a name of an argument specified as an argument to the \fIArg\fP,
+\fIoArg\fP,
+\fIOptArg\fP,
+\fIoOptArg\fP
+or \fIoOptoArg\fP
+macros
+T}
+T{
+a, font
+T}&T{
+urlstyle
+T}&T{
+a URL specified as an argument to the \fIURL\fP
+macro
+T}
+T{
+a, font
+T}&T{
+urlstyle.link
+T}&T{
+subclass of urlstyle class
+T}
+T{
+a, font
+T}&T{
+urlstyle.visited
+T}&T{
+subclass of urlstyle class
+T}
+T{
+a, font
+T}&T{
+urlstyle.hover
+T}&T{
+subclass of urlstyle class
+T}
+T{
+a, font
+T}&T{
+emailstyle
+T}&T{
+an email specified as an argument to the \fIEmail\fP
+macro
+T}
+T{
+a, font
+T}&T{
+emailstyle.link
+T}&T{
+subclass of emailstyle class
+T}
+T{
+a, font
+T}&T{
+emailstyle.visited
+T}&T{
+subclass of emailstyle class
+T}
+T{
+a, font
+T}&T{
+emailstyle.hover
+T}&T{
+subclass of emailstyle class
+T}
+T{
+table
+T}&T{
+tablestyle
+T}&T{
+a table specified as a \fITable\fP
+environment
+T}
+T{
+tr
+T}&T{
+rowstyle
+T}&T{
+a row of a table specified as a \fITable\fP
+environment
+T}
+T{
+td
+T}&T{
+cellstyle
+T}&T{
+a cell of a table specified as a \fITable\fP
+environment
+T}
+.TE
+.PP
+.SH SOME BUG FIX TESTS
+
.PP
.TP
Leading . and \&'
@@ -1051,12 +1296,13 @@ LaTeX LaTeX2e is required.
.SH CHANGES
Please check the file \fBlatex2man\-CHANGES\fP
-for the list of changes.
+for the list of changes and
+acknowledgment to people contributing bugfixes or enhancements.
.PP
.SH VERSION
.PP
-Version: 1.23 of 2008/11/11\&.
+Version: 1.24 of 2010/12/22\&.
.PP
.SH LICENSE AND COPYRIGHT
@@ -1064,7 +1310,9 @@ Version: 1.23 of 2008/11/11\&.
.TP
Copyright
(C)1998, Dr. Jürgen Vollmer, Viktoriastraße 15,
-D\-76133 Karlsruhe, Germany, \fBJuergen.Vollmer@informatik\-vollmer.de\fP
+D\-76133 Karlsruhe, Germany,
+.br
+\fBJuergen.Vollmer@informatik\-vollmer.de\fP
.PP
The actual version of Latex2man
may be found on my homepage