summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latex2man/latex2man.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-12-23 23:37:56 +0000
committerKarl Berry <karl@freefriends.org>2010-12-23 23:37:56 +0000
commitffb1770349df5fa5ac78779011f37a9900d913e4 (patch)
treedb3c0c9ad34fb3183be38923c323370f4edc235a /Master/texmf-dist/doc/support/latex2man/latex2man.tex
parentf3ca29a36043f523ad16099e3466bd3710ec5e3d (diff)
latex2man 1.24 (23dec10)
git-svn-id: svn://tug.org/texlive/trunk@20844 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latex2man/latex2man.tex')
-rw-r--r--Master/texmf-dist/doc/support/latex2man/latex2man.tex88
1 files changed, 72 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.tex b/Master/texmf-dist/doc/support/latex2man/latex2man.tex
index b4d02ad8f83..5d1c5fa19df 100644
--- a/Master/texmf-dist/doc/support/latex2man/latex2man.tex
+++ b/Master/texmf-dist/doc/support/latex2man/latex2man.tex
@@ -2,7 +2,7 @@
%% Project: Documentation Tools
%% Descr: Latex --> MAN-page (groff -man), LATEX documentation
%% Author: Dr. Jürgen Vollmer, Juergen.Vollmer@informatik-vollmer.de
-%% $Id: latex2man.tex,v 1.187 2008/11/11 07:21:18 vollmer Exp $
+%% $Id: latex2man.tex,v 1.191 2010/12/22 11:54:49 vollmer Exp $
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% Latex2man is a tool to translate UNIX manual pages written with LaTeX into a
@@ -27,7 +27,8 @@
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\documentclass[english]{article}
+\documentclass[a4paper,english]{article}
+\usepackage{a4wide}
\usepackage[latin1]{inputenc}
\usepackage{babel}
\usepackage{verbatim}
@@ -52,15 +53,15 @@
%% do we have the `rcsinfo' package?
\IfFileExists{rcsinfo.sty}{
\usepackage[nofancy]{rcsinfo}
-\rcsInfo $Id: latex2man.tex,v 1.187 2008/11/11 07:21:18 vollmer Exp $
+\rcsInfo $Id: latex2man.tex,v 1.191 2010/12/22 11:54:49 vollmer Exp $
\setDate{\rcsInfoLongDate}
}{
-\setDate{2008/11/11} %%%% must be manually set, if rcsinfo is not present
+\setDate{2010/12/22} %%%% must be manually set, if rcsinfo is not present
\message{package rcsinfo not present, discard it}
}
\setVersionWord{Version:} %%% that's the default, no need to set it.
-\setVersion{1.23}
+\setVersion{1.24}
\begin{document}
@@ -77,6 +78,7 @@
%%%%%%%%%%%%%%%%%%
\Prog{latex2man} \oOptArg{-t}{transfile}
+ \oOptArg{-c}{CSSfile}
\oOpt{-HMTL} \oOpt{-h} \oOpt{-V} \oOptArg{-C}{name} \TEXIbr
\oOptArg{-a}{char}
\Arg{infile}
@@ -91,6 +93,9 @@ the \Opt{-man} macro package.
Using the \Opt{-H} option, HTML code can be produced, instead of
\Cmd{troff}{1}.
+With this option you can, optionally, specify a \Arg{CSSfile} 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.
Using the \Opt{-T} option, TexInfo code can be produced, instead of
\Cmd{troff}{1}.
@@ -105,6 +110,9 @@ Using the \Opt{-L} option, \LaTeX\ ouput can be produced, instead of
%%%%%%%%%%%%%%%%%
\begin{Description}[\OptArg{-t}{transfile}]\setlength{\itemsep}{0cm}
\item[\OptArg{-t}{transfile}] Translation for user defined \LaTeX\ macros.
+\item[\OptArg{-c}{CSSfile}] If you use the \Opt{-H} 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 \Arg{CSSfile} filename.
\item[\Opt{-M}] Produce output suitable for the \Cmd{man}{1} command (default).
\item[\Opt{-H}] Instead of producing output suitable for the \Cmd{man}{1}
command, HTML code is produced (despite the name of the command).
@@ -147,6 +155,7 @@ Using the \Opt{-L} option, \LaTeX\ ouput can be produced, instead of
commands.
\item[\File{latex2man.cfg}] The configuration file for \Prog{Latex2man}
\LaTeX-package.
+\item[\File{latex2man.css}] File containing example CSS definitions.
\item[\File{latex2man.trans}] File containing example translations of user
defined \LaTeX\ macros.
\item[\File{fancyheadings.sty}] A \LaTeX\ package used to typeset head- and
@@ -155,6 +164,8 @@ Using the \Opt{-L} option, \LaTeX\ ouput can be produced, instead of
lines.
\item[\File{rcsinfo.sty}] A \LaTeX\ package used to extract and use RCS version
control information in \LaTeX\ documents.
+
+\item[\URL{latex2man.pdf}] The PDF version of this document.
\end{Description}
\section{See Also}
@@ -299,15 +310,15 @@ The following commands are provided:
\item[\Bs oOptArg\{option\}\{argument\}] Optional option with argument, e.g.\\
\verb+\oOptArg{-o}{filename}+ will be typeset as \oOptArg{-o}{filename}.
\item[\Bs oOptoArg\{option\}\{argument\}] Optional option with optional
- argument, e.g.\
+ argument, e.g.\\
\verb+\oOptoArg{-o}{filename}+ will be typeset as \oOptoArg{-o}{filename}.
\item[\Bs File\{filename\}] used to typeset filenames, e.g.\
\verb+\File{filename}+ will be typeset as \File{filename}.
\item[\Bs Prog\{prog\}] used to typeset program names, e.g.\
\verb+\Prog{latex2man}+ will be typeset as \Prog{latex2man}.
\item[\Bs Cmd\{command\}\{chapter\}] used to typeset references to other
- commands, e.g.\ \verb+\Cmd{latex2man}{1}+ will be typeset as
- \Cmd{latex2man}{1}.
+ commands, e.g.\\
+ \verb+\Cmd{latex2man}{1}+ will be typeset as \Cmd{latex2man}{1}.
\item[\Bs Bar] is typeset as \Bar.
\item[\Bs Bs] (BackSlash) is typeset as \Bs.
\item[\Bs Tilde] is typeset as a \Tilde.
@@ -315,7 +326,8 @@ The following commands are provided:
\item[\Bs Bullet] us typeset as \Bullet.
\item[\Bs setVersion\{..\}] set \verb+..+ as version information.
\item[\Bs setVersionWord\{..\}] set \verb+..+ for the word \emph{Version:} in
- the footline. The default is \verb+\setVersionWord{Version:}+.
+ the footline.\\
+ The default is \verb+\setVersionWord{Version:}+.
\item[\Bs Version] returns the version information.
\item[\Bs setDate\{..\}] sets \verb+..+ as date information.
\item[\Bs Date] returns the date information.
@@ -323,14 +335,15 @@ The following commands are provided:
\verb+\Email{Juergen.Vollmer@informatik-vollmer.de}+ is typeset as:\\
\Email{Juergen.Vollmer@informatik-vollmer.de}.
\item[\Bs URL\{..\}] use to mark an URL:
- \verb+\URL{http://www.foo.de/\Tilde vollmer}+ is typeset as
+ \verb+\URL{http://www.foo.de/\Tilde vollmer}+ is typeset as\\
\URL{http://www.foo.de/\Tilde vollmer}.
\item[\Bs LatexManEnd] the input file is read and processed until reading
- end-of-file or \verb+\LatexManEnd+ (at the beginning of a line).
+ end-of-file or\\
+ \verb+\LatexManEnd+ (at the beginning of a line).
\LaTeX\ ignores this command.
\item[\Bs Lbr, \Bs Rbr] is typeset as \Lbr\ and \Rbr\ (these variants are
- needed only somtimes like in \verb+item[FooBar\LBr xx \Lbr]+. Usually
- \verb+[ ]+ will work.
+ needed only somtimes like in\\
+ \verb+\item[FooBar\LBr xx \Lbr]+. Usually \verb+[ ]+ will work.
\item[\Bs LBr, \Bs RBr] is typeset as \LBr\ and \RBr\ (these variants are
needed when using \{ or \} as arguments to macros.
\item[\Bs Circum] is typeset as \Circum.
@@ -665,7 +678,42 @@ This is another \verb+\subsubsection+.
steps shown in the \File{Makefile} manually.
\end{enumerate}
-\subsection{Some Bug Fix Tests}
+\section{CSS classnames}
+
+ 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 \Arg{CSSfile} for these classes:
+
+ \noindent
+ \begin{Table}[8.5cm]{3}
+ \textbf{HTML tag} & \textbf{Class} & \textbf{Style applies to}\\
+ body & & the body of the HTML page \\
+ h1 & titlehead & the title at the top of the HTML page specified as an argument to the \emph{Name} environment \\
+ h4 & authorhead & the author at the top of the HTML page specified as an argument to the \emph{Name} environment \\
+ h4 & datehead & the date at the top of the HTML page \\
+ h4 & versionhead & the man page version at the top of the HTML page specified as an argument to the \emph{setVersion} macro \\
+ h2 & sectionname & a section title specified as an argument to the \emph{section} macro \\
+ h4 & subsectionname & a subsection title specified as an argument to the \emph{subsection} macro \\
+ h5 & subsubsectionname & a subsubsection title specified as an argument to the \emph{subsubsection} macro \\
+ font & progname & a program name specified as an argument to the \emph{Prog} macro \\
+ font & filename & a file name specified as an argument to the \emph{File} macro \\
+ font & commandname & a command name specified as an argument to the \emph{Cmd} macro \\
+ font & textstyle & all text that is not an argument to some LaTeX or latex2man macro \\
+ font & optstyle & a name of an option specified as an argument to the \emph{Opt}, \emph{oOpt}, \emph{OptArg}, \emph{oOptArg} or \emph{oOptoArg} macros \\
+ font & argstyle & a name of an argument specified as an argument to the \emph{Arg}, \emph{oArg}, \emph{OptArg}, \emph{oOptArg} or \emph{oOptoArg} macros \\
+ a, font & urlstyle & a URL specified as an argument to the \emph{URL} macro \\
+ a, font & urlstyle.link & subclass of urlstyle class \\
+ a, font & urlstyle.visited & subclass of urlstyle class \\
+ a, font & urlstyle.hover & subclass of urlstyle class \\
+ a, font & emailstyle & an email specified as an argument to the \emph{Email} macro \\
+ a, font & emailstyle.link & subclass of emailstyle class \\
+ a, font & emailstyle.visited & subclass of emailstyle class \\
+ a, font & emailstyle.hover & subclass of emailstyle class \\
+ table & tablestyle & a table specified as a \emph{Table} environment \\
+ tr & rowstyle & a row of a table specified as a \emph{Table} environment \\
+ td & cellstyle & a cell of a table specified as a \emph{Table} environment \\
+ \end{Table}
+
+\section{Some Bug Fix Tests}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% TODO: HTML: a blank line after \begin{description} should not emit a <p>
@@ -715,7 +763,14 @@ but ignore comments following this: % this should be ignored
%@% IF LATEX %@%
{\small\verbatiminput{CHANGES}}
%@% ELSE %@%
-Please check the file \URL{latex2man-CHANGES} for the list of changes.
+%@% IF HTML %@%
+Please check the file \URL{latex2man-CHANGES.html} for the list of changes and
+acknowledgment to people contributing bugfixes or enhancements.
+%@% ELSE %@%
+Please check the file \URL{latex2man-CHANGES} for the list of changes and
+acknowledgment to people contributing bugfixes or enhancements.
+
+%@% END-IF %@%
%@% END-IF %@%
\section{Version}
@@ -728,7 +783,8 @@ Version: \Version\ of \Date.
\begin{description}
\item[Copyright] \copyright\ 1998, Dr.~Jürgen Vollmer, Viktoriastraße 15,
- D-76133 Karlsruhe, Germany, \Email{Juergen.Vollmer@informatik-vollmer.de}
+ D-76133 Karlsruhe, Germany,\\
+ \Email{Juergen.Vollmer@informatik-vollmer.de}
The actual version of \Prog{Latex2man} may be found on my homepage\\