diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/latex2man/latex2man.html')
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.html | 609 |
1 files changed, 418 insertions, 191 deletions
diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.html b/Master/texmf-dist/doc/support/latex2man/latex2man.html index 03612aa1acb..fb979503a37 100644 --- a/Master/texmf-dist/doc/support/latex2man/latex2man.html +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.html @@ -1,21 +1,22 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- Manual page created with latex2man on Di 11. Nov 08:21:27 CET 2008 -- --- Author of latex2man: Juergen.Vollmer@informatik-vollmer.de -- --- NOTE: This file is generated, DO NOT EDIT. --> +<!-- Manual page created with latex2man on Mi 22. Dez 13:46:36 CET 2010 +** Author of latex2man: Juergen.Vollmer@informatik-vollmer.de +** NOTE: This file is generated, DO NOT EDIT. --> <html> -<head><title>LATEX2MAN</title></head> -<body bgcolor="white"> -<h1 align=center> +<head><title>LATEX2MAN</title> +<link href="latex2man.css" rel="stylesheet" type="text/css"> +</head><body> +<h1 class="titlehead"> LaTeX2man -<br> A Documentation Tool </h1> -<h4 align=center>Dr. Jürgen Vollmer </h4> -<h4 align=center>2008/11/11</h4> -<h4 align=center>Version 1.23</h4> +<h4 class="authorhead">Dr. Jürgen Vollmer </h4> +<h4 class="datehead">2010/12/22</h4> +<h4 class="versionhead">Version 1.24</h4> <p> -<tt>Latex2man</tt> +<font class="progname">Latex2man</font> is a tool to translate UNIX manual pages written with -LaTeXinto a format understood by the UNIX <em>man</em>(1)-command. +LaTeXinto a format understood by the UNIX <font class="commandname">man</font>(1)-command. Alternatively HTML, TexInfo, or LaTeX code can be produced too. Output of parts of the text may be suppressed using the conditional text feature (for this, LaTeX generation may be used). @@ -43,113 +44,127 @@ feature (for this, LaTeX generation may be used). <li><a href="#section_18">Subsubsection still works </a></li> </ul> <li><a href="#section_19">General Remarks </a></li> -<li><a href="#section_20">Some Bug Fix Tests </a></li> </ul> -<li><a href="#section_21">Requirements </a></li> -<li><a href="#section_22">Changes </a></li> -<li><a href="#section_23">Version </a></li> -<li><a href="#section_24">License and Copyright </a></li> -<li><a href="#section_25">Author </a></li> +<li><a href="#section_20">CSS classnames </a></li> +<li><a href="#section_21">Some Bug Fix Tests </a></li> +<li><a href="#section_22">Requirements </a></li> +<li><a href="#section_23">Changes </a></li> +<li><a href="#section_24">Version </a></li> +<li><a href="#section_25">License and Copyright </a></li> +<li><a href="#section_26">Author </a></li> </ul> <p> -<h2><a name="section_1">Synopsis</a></h2> +<h2 class="sectionname"><a name="section_1">Synopsis</a></h2> <p> -<tt>latex2man</tt> -[<b>-t</b><i>transfile</i>] -[<b>-HMTL</b>] -[<b>-h</b>] -[<b>-V</b>] -[<b>-C</b><i>name</i>] -[<b>-a</b><i>char</i>] -<i>infile</i> -<i>outfile</i> +<font class="progname">latex2man</font> +[<font class="optstyle">-t</font><font class="argstyle">transfile</font>] +[<font class="optstyle">-c</font><font class="argstyle">CSSfile</font>] +[<font class="optstyle">-HMTL</font>] +[<font class="optstyle">-h</font>] +[<font class="optstyle">-V</font>] +[<font class="optstyle">-C</font><font class="argstyle">name</font>] +[<font class="optstyle">-a</font><font class="argstyle">char</font>] +<font class="argstyle">infile</font> +<font class="argstyle">outfile</font> <p> -<h2><a name="section_2">Description</a></h2> +<h2 class="sectionname"><a name="section_2">Description</a></h2> -<tt>Latex2man</tt> -reads the file <i>infile</i> -and writes <i>outfile</i>. +<font class="progname">Latex2man</font> +reads the file <font class="argstyle">infile</font> +and writes <font class="argstyle">outfile</font>. The -input must be a LaTeX document using the <tt>latex2man</tt> +input must be a LaTeX document using the <font class="progname">latex2man</font> LaTeXpackage. -<tt>Latex2man</tt> -translates that document into the <em>troff</em>(1) +<font class="progname">Latex2man</font> +translates that document into the <font class="commandname">troff</font>(1) format using -the <b>-man</b> +the <font class="optstyle">-man</font> macro package. <p> -Using the <b>-H</b> +Using the <font class="optstyle">-H</font> option, HTML code can be produced, instead of -<em>troff</em>(1). +<font class="commandname">troff</font>(1). +With this option you can, optionally, specify a <font class="argstyle">CSSfile</font> +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. <p> -Using the <b>-T</b> +Using the <font class="optstyle">-T</font> option, TexInfo code can be produced, instead of -<em>troff</em>(1). +<font class="commandname">troff</font>(1). <p> -Using the <b>-M</b> -option, <em>troff</em>(1) +Using the <font class="optstyle">-M</font> +option, <font class="commandname">troff</font>(1) input is produced. <p> -Using the <b>-L</b> +Using the <font class="optstyle">-L</font> option, LaTeX ouput can be produced, instead of -<em>troff</em>(1). +<font class="commandname">troff</font>(1). <p> -<h2><a name="section_3">Options</a></h2> +<h2 class="sectionname"><a name="section_3">Options</a></h2> <dl compact> -<dt><b>-t</b><i>transfile</i> +<dt><font class="optstyle">-t</font><font class="argstyle">transfile</font> </dt> <dd> Translation for user defined LaTeX macros. </dd> -<dt><b>-M</b> +<dt><font class="optstyle">-c</font><font class="argstyle">CSSfile</font> </dt> -<dd> Produce output suitable for the <em>man</em>(1) +<dd> If you use the <font class="optstyle">-H</font> +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 <font class="argstyle">CSSfile</font> +filename. +</dd> +<dt><font class="optstyle">-M</font> +</dt> +<dd> Produce output suitable for the <font class="commandname">man</font>(1) command (default). </dd> -<dt><b>-H</b> +<dt><font class="optstyle">-H</font> </dt> -<dd> Instead of producing output suitable for the <em>man</em>(1) +<dd> Instead of producing output suitable for the <font class="commandname">man</font>(1) command, HTML code is produced (despite the name of the command). </dd> -<dt><b>-T</b> +<dt><font class="optstyle">-T</font> </dt> -<dd> Instead of producing output suitable for the <em>man</em>(1) +<dd> Instead of producing output suitable for the <font class="commandname">man</font>(1) command, TexInfo code is produced (despite the name of the command). The -generated <tt>.texi</tt>-file -may be processed with <em>makeinfo</em>(1) -(to produce an <tt>.info</tt>-file) +generated <font class="filename">.texi</font>-file +may be processed with <font class="commandname">makeinfo</font>(1) +(to produce an <font class="filename">.info</font>-file) which in turn may be installed using -<em>install-info</em>(1). +<font class="commandname">install-info</font>(1). The Info tags <tt>@dircategory</tt> and <tt>@direntry</tt> are provided. </dd> -<dt><b>-L</b> +<dt><font class="optstyle">-L</font> </dt> -<dd> The LaTeX source is written to the <i>outfile</i>. +<dd> The LaTeX source is written to the <font class="argstyle">outfile</font>. This is -useful in conjunction with the <b>-C</b><i>name</i> +useful in conjunction with the <font class="optstyle">-C</font><font class="argstyle">name</font> option. </dd> -<dt><b>-C</b><i>name</i> +<dt><font class="optstyle">-C</font><font class="argstyle">name</font> </dt> -<dd> Output the conditional text for <i>name</i>. +<dd> Output the conditional text for <font class="argstyle">name</font>. If more -than one name should be given use quotes: <b>-C</b><i>'name1 name2 ...'</i><br> +than one name should be given use quotes: <font class="optstyle">-C</font><font class="argstyle">'name1 name2 ...'</font><br> The following names are defined automatically: <ul compact> -<li><b>-H</b> defines <tt>HTML</tt> +<li><font class="optstyle">-H</font> defines <tt>HTML</tt> </li> -<li><b>-T</b> defines <tt>TEXI</tt> +<li><font class="optstyle">-T</font> defines <tt>TEXI</tt> </li> -<li><b>-M</b> defines <tt>MAN</tt> +<li><font class="optstyle">-M</font> defines <tt>MAN</tt> </li> -<li><b>-L</b> defines <tt>LATEX</tt> +<li><font class="optstyle">-L</font> defines <tt>LATEX</tt> </li> </ul> </dd> -<dt><b>-a</b><i>char</i> +<dt><font class="optstyle">-a</font><font class="argstyle">char</font> </dt> <dd> Is used only in conjunction with -T.<br> @@ -158,73 +173,82 @@ Background:<br> TexInfo ignores all blanks before the first word on a new line. In order to produce some additional space before that word (using \SP) some character has to be printed before the additional space. By default this -is a . (dot). The <i>char</i> +is a . (dot). The <font class="argstyle">char</font> specifies an alternative for that first character. Giving a blank to -<b>-a</b> +<font class="optstyle">-a</font> supresses the indentation of a line.<br> -Note: only for the first \SP of a series that <i>char</i> +Note: only for the first \SP of a series that <font class="argstyle">char</font> is printed. </dd> -<dt><b>-h</b> +<dt><font class="optstyle">-h</font> </dt> <dd> Show a help text. </dd> -<dt><b>-V</b> +<dt><font class="optstyle">-V</font> </dt> <dd> Show version information. </dd> </dl> <p> -<h2><a name="section_4">Files</a></h2> +<h2 class="sectionname"><a name="section_4">Files</a></h2> <p> <dl compact> -<dt><tt>latex2man.tex</tt> +<dt><font class="filename">latex2man.tex</font> </dt> <dd> The LaTeX file containing this Man-page. </dd> -<dt><tt>latex2man.sty</tt> +<dt><font class="filename">latex2man.sty</font> </dt> <dd> The LaTeX package defining the environments and commands. </dd> -<dt><tt>latex2man.cfg</tt> +<dt><font class="filename">latex2man.cfg</font> </dt> -<dd> The configuration file for <tt>Latex2man</tt> +<dd> The configuration file for <font class="progname">Latex2man</font> LaTeX-package. </dd> -<dt><tt>latex2man.trans</tt> +<dt><font class="filename">latex2man.css</font> +</dt> +<dd> File containing example CSS definitions. +</dd> +<dt><font class="filename">latex2man.trans</font> </dt> <dd> File containing example translations of user defined LaTeX macros. </dd> -<dt><tt>fancyheadings.sty</tt> +<dt><font class="filename">fancyheadings.sty</font> </dt> <dd> A LaTeX package used to typeset head- and foot lines. </dd> -<dt><tt>fancyhdr.sty</tt> +<dt><font class="filename">fancyhdr.sty</font> </dt> <dd> A LaTeX package used to typeset head- and foot lines. </dd> -<dt><tt>rcsinfo.sty</tt> +<dt><font class="filename">rcsinfo.sty</font> </dt> <dd> A LaTeX package used to extract and use RCS version control information in LaTeX documents. +<p> +</dd> +<dt><a class="urlstyle" href ="latex2man.pdf"><tt>latex2man.pdf</tt></a> +</dt> +<dd> The PDF version of this document. </dd> </dl> <p> -<h2><a name="section_5">See Also</a></h2> +<h2 class="sectionname"><a name="section_5">See Also</a></h2> <p> -LaTeX,TexInfo, <em>troff</em>(1), -<em>groff</em>(1), -<em>makeinfo</em>(1). +LaTeX,TexInfo, <font class="commandname">troff</font>(1), +<font class="commandname">groff</font>(1), +<font class="commandname">makeinfo</font>(1). <p> -<h2><a name="section_6">LaTeX commands</a></h2> +<h2 class="sectionname"><a name="section_6">LaTeX commands</a></h2> <p> The LaTeX package <tt>latex2man</tt> @@ -232,7 +256,7 @@ is used to write the Man-pages with LaTeX.Since we translate into other text formats, not all LaTeX stuff can be translated. <p> -<h4><a name="section_7">Package Options</a></h4> +<h4 class="subsectionname"><a name="section_7">Package Options</a></h4> The <tt>latex2man</tt> package accepts the following options: @@ -254,7 +278,7 @@ are used. <p> The default option may be specified in the file <tt>latex2man.cfg</tt>. <p> -<h4><a name="section_8">Package Specific Environments</a></h4> +<h4 class="subsectionname"><a name="section_8">Package Specific Environments</a></h4> <p> The following environments are provided by the package: @@ -291,23 +315,23 @@ For example: <p> will be typeset as: <p> -<table> -<tr> -<td>Here </td> -<td> am </td> -<td> I </td> +<table summary="table" class="tablestyle"> +<tr class="rowstyle"> +<td class="cellstyle">Here </td> +<td class="cellstyle"> am </td> +<td class="cellstyle"> I </td> </tr> -<tr> -<td>A 1 </td> -<td> A 2 </td> -<td> A 3 1 2 3 4 5 A 3 1 2 3 4 5</td> +<tr class="rowstyle"> +<td class="cellstyle">A 1 </td> +<td class="cellstyle"> A 2 </td> +<td class="cellstyle"> A 3 1 2 3 4 5 A 3 1 2 3 4 5</td> </tr> -<tr> -<td>B 1 </td> -<td> B 2 </td> -<td> B 3 </td> +<tr class="rowstyle"> +<td class="cellstyle">B 1 </td> +<td class="cellstyle"> B 2 </td> +<td class="cellstyle"> B 3 </td> </tr> </table> @@ -318,7 +342,7 @@ typeset left justified. The <em>width</em> is a length measured absolutly in <em>cm</em>. Processing with LaTeX a <tt>p{width}</tt> column is typeset -as last column. The translation to <em>troff</em>(1) +as last column. The translation to <font class="commandname">troff</font>(1) commands results in a <tt>lw(width)</tt> column specification. Translating @@ -327,15 +351,15 @@ parameter. <p> <tt>\hline</tt> may be used. <p> -If the Man-page is formatted with <em>troff</em>(1) +If the Man-page is formatted with <font class="commandname">troff</font>(1) and tables are used, the -<em>tbl</em>(1) +<font class="commandname">tbl</font>(1) preprocessor should be called, usually by giving -a <b>-t</b> -to the call of <em>troff</em>(1). +a <font class="optstyle">-t</font> +to the call of <font class="commandname">troff</font>(1). When viewing the generated -manula page using <em>man</em>(1), -<em>tbl</em>(1) +manula page using <font class="commandname">man</font>(1), +<font class="commandname">tbl</font>(1) is called automatically. </dd> <dt>\begin{Description}</dt> @@ -383,7 +407,7 @@ in the DVI and PDF-output, not in the troff, TexInfo or HTML output. </dd> </dl> <p> -<h4><a name="section_9">Accepted LaTeX Environments</a></h4> +<h4 class="subsectionname"><a name="section_9">Accepted LaTeX Environments</a></h4> <p> The following environments are accepted: @@ -419,59 +443,61 @@ Another centered line. </li> </ul> <p> -<h4><a name="section_10">Package Specific Macros</a></h4> +<h4 class="subsectionname"><a name="section_10">Package Specific Macros</a></h4> <p> The following commands are provided: <dl compact> <dt>\Opt{option}</dt> -<dd> Option: <tt>\Opt{-o}</tt> will be typeset as <b>-o</b>. +<dd> Option: <tt>\Opt{-o}</tt> will be typeset as <font class="optstyle">-o</font>. </dd> <dt>\Arg{argument}</dt> <dd> Argument: <tt>\Arg{filename}</tt> will be typeset as -<i>filename</i>. +<font class="argstyle">filename</font>. </dd> <dt>\OptArg{option}{argument}</dt> <dd> Option with Argument:<br> -<tt>\OptArg{-o}{filename}</tt> will be typeset as <b>-o</b><i>filename</i>. +<tt>\OptArg{-o}{filename}</tt> will be typeset as <font class="optstyle">-o</font><font class="argstyle">filename</font>. </dd> <dt>\OptoArg{option}{argument}</dt> <dd> Option with optional Argument:<br> <tt>\OptoArg{-o}{filename}</tt> will be -typeset as <b>-o</b>[<i>filename</i>]. +typeset as <font class="optstyle">-o</font>[<font class="argstyle">filename</font>]. </dd> <dt>\oOpt{option}</dt> <dd> Optional option, e.g. <tt>\oOpt{-o}</tt> will be -typeset as [<b>-o</b>]. +typeset as [<font class="optstyle">-o</font>]. </dd> <dt>\oArg{argument}</dt> <dd> Optional argument, e.g. <tt>\oArg{filename}</tt> -will be typeset as [<i>filename</i>]. +will be typeset as [<font class="argstyle">filename</font>]. </dd> <dt>\oOptArg{option}{argument}</dt> <dd> Optional option with argument, e.g.<br> -<tt>\oOptArg{-o}{filename}</tt> will be typeset as [<b>-o</b><i>filename</i>]. +<tt>\oOptArg{-o}{filename}</tt> will be typeset as [<font class="optstyle">-o</font><font class="argstyle">filename</font>]. </dd> <dt>\oOptoArg{option}{argument}</dt> <dd> Optional option with optional -argument, e.g. -<tt>\oOptoArg{-o}{filename}</tt> will be typeset as [<b>-o</b>[<i>filename</i>]]. +argument, e.g.<br> + +<tt>\oOptoArg{-o}{filename}</tt> will be typeset as [<font class="optstyle">-o</font>[<font class="argstyle">filename</font>]]. </dd> <dt>\File{filename}</dt> <dd> used to typeset filenames, e.g. -<tt>\File{filename}</tt> will be typeset as <tt>filename</tt>. +<tt>\File{filename}</tt> will be typeset as <font class="filename">filename</font>. </dd> <dt>\Prog{prog}</dt> <dd> used to typeset program names, e.g. -<tt>\Prog{latex2man}</tt> will be typeset as <tt>latex2man</tt>. +<tt>\Prog{latex2man}</tt> will be typeset as <font class="progname">latex2man</font>. </dd> <dt>\Cmd{command}{chapter}</dt> <dd> used to typeset references to other -commands, e.g. <tt>\Cmd{latex2man}{1}</tt> will be typeset as -<em>latex2man</em>(1). +commands, e.g.<br> + +<tt>\Cmd{latex2man}{1}</tt> will be typeset as <font class="commandname">latex2man</font>(1). </dd> <dt>\Bar</dt> <dd> is typeset as |. @@ -494,7 +520,9 @@ commands, e.g. <tt>\Cmd{latex2man}{1}</tt> will be typeset as <dt>\setVersionWord{..}</dt> <dd> set <tt>..</tt> for the word <em>Version:</em> in -the footline. The default is <tt>\setVersionWord{Version:}</tt>. +the footline.<br> + +The default is <tt>\setVersionWord{Version:}</tt>. </dd> <dt>\Version</dt> <dd> returns the version information. @@ -510,22 +538,26 @@ the footline. The default is <tt>\setVersionWord{Version:}</tt>. <tt>\Email{Juergen.Vollmer@informatik-vollmer.de}</tt> is typeset as:<br> -<a href ="mailto:Juergen.Vollmer@informatik-vollmer.de"><tt>Juergen.Vollmer@informatik-vollmer.de</tt></a>. +<a class="emailstyle" href ="mailto:Juergen.Vollmer@informatik-vollmer.de">Juergen.Vollmer@informatik-vollmer.de</a>. </dd> <dt>\URL{..}</dt> <dd> use to mark an URL: -<tt>\URL{http://www.foo.de/\Tilde vollmer}</tt> is typeset as -<a href ="http://www.foo.de/~vollmer"><tt>http://www.foo.de/~vollmer</tt></a>. +<tt>\URL{http://www.foo.de/\Tilde vollmer}</tt> is typeset as<br> + +<a class="urlstyle" href ="http://www.foo.de/~vollmer"><tt>http://www.foo.de/~vollmer</tt></a>. </dd> <dt>\LatexManEnd</dt> <dd> the input file is read and processed until reading -end-of-file or <tt>\LatexManEnd</tt> (at the beginning of a line). +end-of-file or<br> + +<tt>\LatexManEnd</tt> (at the beginning of a line). LaTeXignores this command. </dd> <dt>\Lbr, \Rbr</dt> <dd> is typeset as [ and ] (these variants are -needed only somtimes like in <tt>item[FooBar\LBr xx \Lbr]</tt>. Usually -<tt>[ ]</tt> will work. +needed only somtimes like in<br> + +<tt>\item[FooBar\LBr xx \Lbr]</tt>. Usually <tt>[ ]</tt> will work. </dd> <dt>\LBr, \RBr</dt> <dd> is typeset as { and } (these variants are @@ -539,7 +571,7 @@ needed when using { or } as arguments to macros. </dd> <dt>\TEXbr</dt> <dd> If processed with LaTeX causes a linebreak (i.e. is -equivalent to \\).In the output of <tt>latex2man</tt> +equivalent to \\).In the output of <font class="progname">latex2man</font> this macro is ignored. </dd> @@ -572,27 +604,27 @@ abc xx<br> Note: Due to some ``problems'' with TexInfo, the lines starting with <tt>\SP</tt> have a leading . (dot) in the TexInfo output, -see <b>-a</b><i>char</i>. +see <font class="optstyle">-a</font><font class="argstyle">char</font>. </dd> </dl> <p> -<h4><a name="section_11">Accepted Macros from the rcsinfo Package</a></h4> +<h4 class="subsectionname"><a name="section_11">Accepted Macros from the rcsinfo Package</a></h4> <p> <dl compact> <dt>\rcsInfo $Id ...$</dt> -<dd> if the LaTeX package <tt>rcsinfo</tt> +<dd> if the LaTeX package <font class="filename">rcsinfo</font> is used, this command is used to extract the date of the Man-page. </dd> <dt>\rcsInfoLongDate</dt> -<dd> if the LaTeX package <tt>rcsinfo</tt> +<dd> if the LaTeX package <font class="filename">rcsinfo</font> is used, this command is used to typeset the date coded in the <tt>$Id ..$</tt> string. </dd> </dl> <p> -<h4><a name="section_12">Accepted LaTeX Macros</a></h4> +<h4 class="subsectionname"><a name="section_12">Accepted LaTeX Macros</a></h4> <p> The following standard LaTeX commands are accepted: @@ -744,7 +776,7 @@ or environment. </dd> <dt>\today</dt> -<dd> 11 November 2008 (see also the <tt>rcsinfo</tt> +<dd> 22 December 2010 (see also the <tt>rcsinfo</tt> LaTeXpackage). </dd> <dt>\ss,\"a, ...</dt> @@ -768,10 +800,10 @@ in texinfo. </dd> </dl> <p> -<h4><a name="section_13">Conditional Text</a></h4> +<h4 class="subsectionname"><a name="section_13">Conditional Text</a></h4> <p> -<tt>latex2man</tt> +<font class="progname">latex2man</font> preprocesses the LaTeX input to allow text to be used conditionally. A special sort of LaTeX comment is used for that purpose. <ul compact> @@ -786,7 +818,7 @@ conditionally. A special sort of LaTeX comment is used for that purpose. A line must contain only such a comment and nothing else. <em>condition</em> is a boolean expression containing ``names'' and operators. The names given with -the <b>-C</b><i>name</i> +the <font class="optstyle">-C</font><font class="argstyle">name</font> option have the value ``true'', while all other names occuring in the expression are assumed to be ``false''. If the evaluation of the boolean expression results in the value ``true'', the text in the @@ -795,20 +827,20 @@ the boolean expression results in the value ``true'', the text in the may be nested. As boolean operators the following are allowed: <p> -<table> -<tr> -<td>||</td> -<td> boolean or </td> +<table summary="table" class="tablestyle"> +<tr class="rowstyle"> +<td class="cellstyle">||</td> +<td class="cellstyle"> boolean or </td> </tr> -<tr> -<td>&& </td> -<td> boolean and </td> +<tr class="rowstyle"> +<td class="cellstyle">&& </td> +<td class="cellstyle"> boolean and </td> </tr> -<tr> -<td>! </td> -<td> negation +<tr class="rowstyle"> +<td class="cellstyle">! </td> +<td class="cellstyle"> negation </table> <p> ( and ) for grouping are allowed. @@ -845,9 +877,9 @@ For example:<br> %@% END-IF %@% <p> -Run this manual page through <tt>latex2man</tt> +Run this manual page through <font class="progname">latex2man</font> with e.g. -<b>-C</b><i>'abc XYZ'</i> +<font class="optstyle">-C</font><font class="argstyle">'abc XYZ'</font> and have a look to the generated output. (If simply running the LaTeX-document through LaTeX,all lines are shown in the .dvi file).<br> @@ -857,22 +889,22 @@ abc NOT set<br> xyz OR !XYZ set<br> <p> -To check the conditional text feature, when <tt>latex2man</tt> +To check the conditional text feature, when <font class="progname">latex2man</font> is called with <dl compact> -<dt><b>-C</b><i>HTML</i> +<dt><font class="optstyle">-C</font><font class="argstyle">HTML</font> </dt> <dd> the lines 1a, 2b, 3b, and 4b; </dd> -<dt><b>-C</b><i>TEXI</i> +<dt><font class="optstyle">-C</font><font class="argstyle">TEXI</font> </dt> <dd> the lines 1b, 2a, 3b, and 4b; </dd> -<dt><b>-C</b><i>MAN</i> +<dt><font class="optstyle">-C</font><font class="argstyle">MAN</font> </dt> <dd> the lines 1b, 2b, 3a, and 4b; </dd> -<dt><b>-C</b><i>LATEX</i> +<dt><font class="optstyle">-C</font><font class="argstyle">LATEX</font> </dt> <dd> the lines 1b, 2b, 3b, and 4a; </dd> @@ -890,12 +922,12 @@ should be shown: <p> 4b. The LATEX conditional was not set. <p> -<h4><a name="section_14">Translation of User Defined Macros</a></h4> +<h4 class="subsectionname"><a name="section_14">Translation of User Defined Macros</a></h4> <p> -The user macro translation file (given by the [<b>-t</b><i>transfile</i>]) +The user macro translation file (given by the [<font class="optstyle">-t</font><font class="argstyle">transfile</font>]) contains -<tt>Perl</tt> +<font class="progname">Perl</font> commands specifying the translation of LaTeX macros defined by the user. These macros may have none, one or two arguments. The following code is expected: @@ -984,11 +1016,11 @@ where <tt>...</tt> is the translation. The <tt>2a</tt> code is used before the first argument, <tt>2b</tt> between the two arguments and <tt>2c</tt> is typeset after the second argument is set. </li> -<li>The file <tt>latex2man.trans</tt> contains some example code. +<li>The file <font class="filename">latex2man.trans</font> contains some example code. </li> </ul> <p> -<h4><a name="section_15">Verbatim Environment</a></h4> +<h4 class="subsectionname"><a name="section_15">Verbatim Environment</a></h4> <p> <pre> @@ -1001,22 +1033,22 @@ verbatim <this is no HTML tag> and no @* TexInfo command </pre> <p> -<h4><a name="section_16">Subsection works</a></h4> +<h4 class="subsectionname"><a name="section_16">Subsection works</a></h4> <p> This is a <tt>\subsection</tt>. <p> -<h5><a name="section_17">Subsubsection works</a></h5> +<h5 class="subsubsectionname"><a name="section_17">Subsubsection works</a></h5> <p> This is a <tt>\subsubsection</tt>. <p> -<h5><a name="section_18">Subsubsection still works</a></h5> +<h5 class="subsubsectionname"><a name="section_18">Subsubsection still works</a></h5> <p> This is another <tt>\subsubsection</tt>. <p> -<h4><a name="section_19">General Remarks</a></h4> +<h4 class="subsectionname"><a name="section_19">General Remarks</a></h4> <p> <ol compact> @@ -1031,17 +1063,209 @@ lines. environments or macros are not translated. Their usage will cause garbage in the output. </li> -<li value =5><tt>latex2man</tt> requires Perl version >= 5.0004_03. +<li value =5><font class="progname">latex2man</font> requires Perl version >= 5.0004_03. </li> -<li value =6>If you want to install the system with the distributed <tt>Makefile</tt>, -you need GNU-<tt>make</tt>. +<li value =6>If you want to install the system with the distributed <font class="filename">Makefile</font>, +you need GNU-<font class="progname">make</font>. If you don't have it, you should execute the -steps shown in the <tt>Makefile</tt> +steps shown in the <font class="filename">Makefile</font> manually. </li> </ol> <p> -<h4><a name="section_20">Some Bug Fix Tests</a></h4> +<h2 class="sectionname"><a name="section_20">CSS classnames</a></h2> + +<p> +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 <font class="argstyle">CSSfile</font> +for these classes: +<p> +<table summary="table" class="tablestyle"> +<tr class="rowstyle"> +<td class="cellstyle"><strong>HTML tag</strong> +</td> +<td class="cellstyle"> <strong>Class</strong> +</td> +<td class="cellstyle"> <strong>Style applies to</strong></td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">body </td> +<td class="cellstyle"> </td> +<td class="cellstyle"> the body of the HTML page </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h1 </td> +<td class="cellstyle"> titlehead </td> +<td class="cellstyle"> the title at the top of the HTML page specified as an argument to the <em>Name</em> +environment </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h4 </td> +<td class="cellstyle"> authorhead </td> +<td class="cellstyle"> the author at the top of the HTML page specified as an argument to the <em>Name</em> +environment </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h4 </td> +<td class="cellstyle"> datehead </td> +<td class="cellstyle"> the date at the top of the HTML page </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h4 </td> +<td class="cellstyle"> versionhead </td> +<td class="cellstyle"> the man page version at the top of the HTML page specified as an argument to the <em>setVersion</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h2 </td> +<td class="cellstyle"> sectionname </td> +<td class="cellstyle"> a section title specified as an argument to the <em>section</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h4 </td> +<td class="cellstyle"> subsectionname </td> +<td class="cellstyle"> a subsection title specified as an argument to the <em>subsection</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">h5 </td> +<td class="cellstyle"> subsubsectionname </td> +<td class="cellstyle"> a subsubsection title specified as an argument to the <em>subsubsection</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> progname </td> +<td class="cellstyle"> a program name specified as an argument to the <em>Prog</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> filename </td> +<td class="cellstyle"> a file name specified as an argument to the <em>File</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> commandname </td> +<td class="cellstyle"> a command name specified as an argument to the <em>Cmd</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> textstyle </td> +<td class="cellstyle"> all text that is not an argument to some LaTeX or latex2man macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> optstyle </td> +<td class="cellstyle"> a name of an option specified as an argument to the <em>Opt</em>, +<em>oOpt</em>, +<em>OptArg</em>, +<em>oOptArg</em> +or <em>oOptoArg</em> +macros </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">font </td> +<td class="cellstyle"> argstyle </td> +<td class="cellstyle"> a name of an argument specified as an argument to the <em>Arg</em>, +<em>oArg</em>, +<em>OptArg</em>, +<em>oOptArg</em> +or <em>oOptoArg</em> +macros </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> urlstyle </td> +<td class="cellstyle"> a URL specified as an argument to the <em>URL</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> urlstyle.link </td> +<td class="cellstyle"> subclass of urlstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> urlstyle.visited </td> +<td class="cellstyle"> subclass of urlstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> urlstyle.hover </td> +<td class="cellstyle"> subclass of urlstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> emailstyle </td> +<td class="cellstyle"> an email specified as an argument to the <em>Email</em> +macro </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> emailstyle.link </td> +<td class="cellstyle"> subclass of emailstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> emailstyle.visited </td> +<td class="cellstyle"> subclass of emailstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">a, font </td> +<td class="cellstyle"> emailstyle.hover </td> +<td class="cellstyle"> subclass of emailstyle class </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">table </td> +<td class="cellstyle"> tablestyle </td> +<td class="cellstyle"> a table specified as a <em>Table</em> +environment </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">tr </td> +<td class="cellstyle"> rowstyle </td> +<td class="cellstyle"> a row of a table specified as a <em>Table</em> +environment </td> +</tr> + +<tr class="rowstyle"> +<td class="cellstyle">td </td> +<td class="cellstyle"> cellstyle </td> +<td class="cellstyle"> a cell of a table specified as a <em>Table</em> +environment </td> +</tr> + +</table> +<p> +<h2 class="sectionname"><a name="section_21">Some Bug Fix Tests</a></h2> <p> <dl compact> @@ -1050,7 +1274,7 @@ manually. Now leading . and ' in generation troff output should work propperly, since a <tt>\&</tt> is added. Therfore the <tt>\Dot</tt> macro has been deleted.<br> -Thanks to <a href ="mailto:Frank.Schilder@Mathematik.Tu-Ilmenau.De"><tt>Frank.Schilder@Mathematik.Tu-Ilmenau.De</tt></a>.<br> +Thanks to <a class="emailstyle" href ="mailto:Frank.Schilder@Mathematik.Tu-Ilmenau.De">Frank.Schilder@Mathematik.Tu-Ilmenau.De</a>.<br> Testcase 1: <dl compact> @@ -1060,7 +1284,7 @@ Testcase 1: </dl> Testcase 2:<br> -<tt>.foobar</tt> +<font class="filename">.foobar</font> Testcase 3:<br> ...<p> @@ -1069,7 +1293,7 @@ abc ...abc . efg ' 123 </dd> <dt>% in verbatim</dt> <dd> A % in a \verb and verbatim-environment was not -emitted correctly. Thanks to Aleksey Nogin <a href ="mailto:nogin@cs.caltech.edu"><tt>nogin@cs.caltech.edu</tt></a> +emitted correctly. Thanks to Aleksey Nogin <a class="emailstyle" href ="mailto:nogin@cs.caltech.edu">nogin@cs.caltech.edu</a> for the bug report and bug fix. <p> <tt>% abc</tt> @@ -1083,20 +1307,20 @@ but ignore comments following this: </dd> </dl> <p> -<h2><a name="section_21">Requirements</a></h2> +<h2 class="sectionname"><a name="section_22">Requirements</a></h2> <p> <dl compact> <dt>Perl</dt> -<dd> <tt>latex2man</tt> +<dd> <font class="progname">latex2man</font> requires Perl version >= 5.0004_03. </dd> <dt>Make</dt> <dd> If you want to install the system with the distributed -<tt>Makefile</tt>, -you need GNU-<tt>make</tt>. +<font class="filename">Makefile</font>, +you need GNU-<font class="progname">make</font>. If you don't have it, you -should execute the steps shown in the <tt>Makefile</tt> +should execute the steps shown in the <font class="filename">Makefile</font> manually. </dd> <dt>LaTeX</dt> @@ -1104,34 +1328,37 @@ manually. </dd> </dl> <p> -<h2><a name="section_22">Changes</a></h2> +<h2 class="sectionname"><a name="section_23">Changes</a></h2> -Please check the file <a href ="latex2man-CHANGES"><tt>latex2man-CHANGES</tt></a> -for the list of changes. +Please check the file <a class="urlstyle" href ="latex2man-CHANGES.html"><tt>latex2man-CHANGES.html</tt></a> +for the list of changes and +acknowledgment to people contributing bugfixes or enhancements. <p> -<h2><a name="section_23">Version</a></h2> +<h2 class="sectionname"><a name="section_24">Version</a></h2> <p> -Version: 1.23 of 2008/11/11. +Version: 1.24 of 2010/12/22. <p> -<h2><a name="section_24">License and Copyright</a></h2> +<h2 class="sectionname"><a name="section_25">License and Copyright</a></h2> <p> <dl compact> <dt>Copyright</dt> <dd> © 1998, Dr. Jürgen Vollmer, Viktoriastraße 15, -D-76133 Karlsruhe, Germany, <a href ="mailto:Juergen.Vollmer@informatik-vollmer.de"><tt>Juergen.Vollmer@informatik-vollmer.de</tt></a> +D-76133 Karlsruhe, Germany,<br> + +<a class="emailstyle" href ="mailto:Juergen.Vollmer@informatik-vollmer.de">Juergen.Vollmer@informatik-vollmer.de</a> <p> -The actual version of <tt>Latex2man</tt> +The actual version of <font class="progname">Latex2man</font> may be found on my homepage<br> -<a href ="http://www.informatik-vollmer.de/software/latex2man.html"><tt>http://www.informatik-vollmer.de/software/latex2man.html</tt></a>. +<a class="urlstyle" href ="http://www.informatik-vollmer.de/software/latex2man.html"><tt>http://www.informatik-vollmer.de/software/latex2man.html</tt></a>. <p> </dd> <dt>License</dt> <dd> This program can be redistributed and/or modified under the terms of the LaTeX Project Public License Distributed from CTAN archives -in directory <tt>macros/latex/base/lppl.txt</tt>; +in directory <font class="filename">macros/latex/base/lppl.txt</font>; either version 1 of the License, or any later version. <p> @@ -1142,7 +1369,7 @@ the place where you are living. </dd> </dl> <p> -<h2><a name="section_25">Author</a></h2> +<h2 class="sectionname"><a name="section_26">Author</a></h2> <p> Dr. Jürgen Vollmer <br> @@ -1151,9 +1378,9 @@ Viktoriastraße 15 <br> D-76133 Karlsruhe <br> -Email: <a href ="mailto:Juergen.Vollmer@informatik-vollmer.de"><tt>Juergen.Vollmer@informatik-vollmer.de</tt></a> +Email: <a class="emailstyle" href ="mailto:Juergen.Vollmer@informatik-vollmer.de">Juergen.Vollmer@informatik-vollmer.de</a> <br> -WWW: <a href ="http://www.informatik-vollmer.de"><tt>http://www.informatik-vollmer.de</tt></a>. +WWW: <a class="urlstyle" href ="http://www.informatik-vollmer.de"><tt>http://www.informatik-vollmer.de</tt></a>. <p> </body> </html> |