diff options
| author | Karl Berry <karl@freefriends.org> | 2010-12-23 23:37:56 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2010-12-23 23:37:56 +0000 |
| commit | ffb1770349df5fa5ac78779011f37a9900d913e4 (patch) | |
| tree | db3c0c9ad34fb3183be38923c323370f4edc235a /Master/texmf-dist/doc | |
| parent | f3ca29a36043f523ad16099e3466bd3710ec5e3d (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')
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/CHANGES | 6 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/INSTALL | 3 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/Makefile | 45 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/README | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.23 | 1 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.24 | 1 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man-CHANGES.html | 114 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.1 | 278 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.css | 121 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.html | 609 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.pdf | bin | 206853 -> 202717 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.tex | 88 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.texi | 151 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.txt | 398 |
14 files changed, 1400 insertions, 419 deletions
diff --git a/Master/texmf-dist/doc/support/latex2man/CHANGES b/Master/texmf-dist/doc/support/latex2man/CHANGES index d7a166dcfda..c618553f980 100644 --- a/Master/texmf-dist/doc/support/latex2man/CHANGES +++ b/Master/texmf-dist/doc/support/latex2man/CHANGES @@ -2,9 +2,11 @@ Change history of the latex2man package ======================================= -$Id: CHANGES,v 1.60 2008/11/11 07:18:18 vollmer Exp $ +$Id: CHANGES,v 1.64 2010/12/22 09:31:06 vollmer Exp $ +1.24 21 Dec 2010 - Thanks to "Tom Brand" <tbrand@manumit-systems.com>, + who added the CSS support to the HTML generation procedure. 1.23 11 Nov 2008 - use /usr/bin/env to locate the perl interpreter - Thanks to "J.R. Mauro" <jrm8005-at-gmail.com> + Thanks to "J.R. Mauro" <jrm8005-at-gmail.com> 1.22 05 Dec 2007 - Fixed TROFF code generation if none of -H -T -M -L is given. 1.21 05 Jul 2007 - Fixed Makefile diff --git a/Master/texmf-dist/doc/support/latex2man/INSTALL b/Master/texmf-dist/doc/support/latex2man/INSTALL index f87b88d66f7..be092740e3f 100644 --- a/Master/texmf-dist/doc/support/latex2man/INSTALL +++ b/Master/texmf-dist/doc/support/latex2man/INSTALL @@ -31,6 +31,7 @@ The following files should be part of this package: latex2man/latex2man.cfg latex2man/latex2man.sty latex2man/latex2man.trans + latex2man/latex2man.css latex2man/latex2man.1 latex2man/latex2man.txt latex2man/latex2man.html @@ -45,5 +46,5 @@ The following files should be part of this package: Juergen -$Id: INSTALL,v 1.7 2000/03/13 10:25:48 vollmer Entwurf $ +$Id: INSTALL,v 1.8 2010/12/22 09:32:31 vollmer Exp $ diff --git a/Master/texmf-dist/doc/support/latex2man/Makefile b/Master/texmf-dist/doc/support/latex2man/Makefile index f40f285f32b..8a957ff4507 100644 --- a/Master/texmf-dist/doc/support/latex2man/Makefile +++ b/Master/texmf-dist/doc/support/latex2man/Makefile @@ -1,7 +1,7 @@ # Project: Documentation Tools # Descr: Latex --> MAN-page (groff -man), Makefile # Author: Dr. Jürgen Vollmer, Juergen.Vollmer@informatik-vollmer.de -# $Id: Makefile,v 1.106 2008/11/11 07:17:29 vollmer Exp $ +# $Id: Makefile,v 1.110 2010/12/22 12:46:25 vollmer Exp $ BASE = latex2man @@ -23,8 +23,8 @@ EX = --exclude "*.o" --exclude core --exclude "*.tar.gz" --exclude "*~" \ --exclude "*.a" --exclude "*.php" EXrcs = $(EX) --exclude "*/RCS/*" --exclude "*/RCS" -VERSION = 1.23 -V_DATE = 2008/11/11 +VERSION = 1.24 +V_DATE = 2010/12/22 latex2man = ./latex2man D = $ @@ -34,8 +34,7 @@ HOMEPAGE = $(HOME)/Privat/informatik-vollmer/software .PHONY: all clean realclean diff backup src-tar #.SUFFIXES: .tex .html .ps .info .texi .txt -all: $(BASE).1 $(BASE).html $(BASE).texi $(BASE).info $(BASE).txt \ - $(BASE).pdf +all: $(BASE).1 $(BASE).html $(BASE).texi $(BASE).info $(BASE).txt $(BASE).pdf latex2man-CHANGES.html $(MAKE) clean %.ps: %.tex @@ -66,26 +65,36 @@ all: $(BASE).1 $(BASE).html $(BASE).texi $(BASE).info $(BASE).txt \ $(latex2man) -M $*.tex $*.1 %.html: %.tex - $(latex2man) -H $*.tex $*.html + $(latex2man) -H -c $*.css $*.tex $*.html %.texi: %.tex $(latex2man) -T $*.tex $*.texi -CHANGES.html: CHANGES - sed -e's/&/\&/g' -e's/>/\>/g' -e's/</\</g' \ - < CHANGES > CHANGES.html - -$(BASE).php: $(BASE).php.src Makefile CHANGES.html +latex2man-CHANGES.html: CHANGES + @( \ + echo "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2 Final//EN\">"; \ + echo "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=ISO-8859-1\">"; \ + echo "<html><head>"; \ + echo "<title>Changefile of LaTeX2HTML</title>"; \ + echo "</head><body><pre>"; \ + sed -e's/&/\&/g' -e's/>/\>/g' -e's/</\</g' < CHANGES; \ + echo "</pre></body><html>"; \ + ) > latex2man-CHANGES.html + +CHANGES.pre.html: CHANGES + sed -e's/&/\&/g' -e's/>/\>/g' -e's/</\</g' < CHANGES > CHANGES.pre.html; \ + +$(BASE).php: $(BASE).php.src Makefile CHANGES.pre.html sed < $(BASE).php.src \ -e "s|@VERSION@|$(VERSION)|g" \ -e "s|@DATE@|$(V_DATE)|g" \ - -e "/@CHANGELOG@/r CHANGES.html" \ + -e "/@CHANGELOG@/r CHANGES.pre.html" \ -e "/^@.*@$$/d" \ -e "s|$(BASE).src|$(BASE)|g" \ -e "s|$(D)\(Id: $(BASE),v .*\) $(D)|\1|g" |\ sed -e "/$(D)Id: CHANGES,v/d" \ > $(BASE).php - rm -f CHANGES.html + rm -f CHANGES.pre.html latex2man-html.php: latex2man.html Makefile @ (echo '<?php'; \ @@ -121,10 +130,8 @@ latex2man-text.php: latex2man.txt Makefile echo '<?php include "$$prefix/scripts/footer.inc"?>'; \ ) > latex2man-text.php -homepage: latex2man.pdf latex2man.txt latex2man.php latex2man-html.php \ - latex2man-text.php latex2man.info - cp -fp $(TAR_DIST) latex2man.pdf latex2man*.php latex2man.info $(HOMEPAGE) - cp -fp CHANGES $(HOMEPAGE)/latex2man-CHANGES +homepage: latex2man.pdf latex2man.txt latex2man.php latex2man-html.php latex2man-CHANGES.html latex2man-text.php latex2man.info + cp -fp $(TAR_DIST) latex2man.pdf latex2man*.php latex2man.info latex2man-CHANGES.html latex2man.css $(HOMEPAGE) rm -f *.php install: realclean all @@ -142,6 +149,7 @@ install: realclean all cp -f $(BASE).cfg $(CFG_DIR) cp -f $(BASE).1 $(MAN_DIR)/man1 cp -f $(BASE).html $(HTML_DIR) + cp -f $(BASE).css $(HTML_DIR) cp -f $(BASE).info $(INFO_DIR) install-info $(BASE).info $(INFO_DIR)/dir $(MAKE) clean @@ -152,6 +160,7 @@ uninstall: rm -f $(CFG_DIR)/$(BASE).cfg rm -f $(MAN_DIR)/man1/$(BASE).1 rm -f $(HTML_DIR)/$(BASE).html + rm -f $(HTML_DIR)/$(BASE).css rm -f $(INFO_DIR)/$(BASE).info - install-info --quiet --remove $(BASE).info $(INFO_DIR)/dir @@ -184,6 +193,7 @@ dist: $(BASE)/latex2man.cfg \ $(BASE)/latex2man.sty \ $(BASE)/latex2man.trans \ + $(BASE)/latex2man.css \ $(BASE)/latex2man.1 \ $(BASE)/latex2man.txt \ $(BASE)/latex2man.html \ @@ -194,6 +204,7 @@ dist: $(BASE)/README \ $(BASE)/INSTALL \ $(BASE)/CHANGES \ + $(BASE)/latex2man-CHANGES.html \ $(BASE)/THIS-IS-VERSION-$(VERSION) backup: diff --git a/Master/texmf-dist/doc/support/latex2man/README b/Master/texmf-dist/doc/support/latex2man/README index bd7e9042288..66a025d7857 100644 --- a/Master/texmf-dist/doc/support/latex2man/README +++ b/Master/texmf-dist/doc/support/latex2man/README @@ -15,7 +15,7 @@ Requirements: - Latex2man requires Perl version >= 5.0004_03. - LaTeX2e -VERSION: 1.23 +VERSION: 1.24 Author and Copyright (c) 1998: Dr. Jürgen Vollmer @@ -31,4 +31,4 @@ License: If you find this software useful, please send me a postcard. -$Id: README,v 1.62 2008/11/11 07:21:18 vollmer Exp $ +$Id: README,v 1.63 2010/12/22 09:33:29 vollmer Exp $ diff --git a/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.23 b/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.23 deleted file mode 100644 index b6307fa0d6e..00000000000 --- a/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.23 +++ /dev/null @@ -1 +0,0 @@ -VERSION 1.23 DATE=2008/11/11 diff --git a/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.24 b/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.24 new file mode 100644 index 00000000000..2835670c8a8 --- /dev/null +++ b/Master/texmf-dist/doc/support/latex2man/THIS-IS-VERSION-1.24 @@ -0,0 +1 @@ +VERSION 1.24 DATE=2010/12/22 diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man-CHANGES.html b/Master/texmf-dist/doc/support/latex2man/latex2man-CHANGES.html new file mode 100644 index 00000000000..5adcc6c1109 --- /dev/null +++ b/Master/texmf-dist/doc/support/latex2man/latex2man-CHANGES.html @@ -0,0 +1,114 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<html><head> +<title>Changefile of LaTeX2HTML</title> +</head><body><pre> + + Change history of the latex2man package + ======================================= + +$Id: CHANGES,v 1.64 2010/12/22 09:31:06 vollmer Exp $ +1.24 21 Dec 2010 - Thanks to "Tom Brand" <tbrand@manumit-systems.com>, + who added the CSS support to the HTML generation procedure. +1.23 11 Nov 2008 - use /usr/bin/env to locate the perl interpreter + Thanks to "J.R. Mauro" <jrm8005-at-gmail.com> +1.22 05 Dec 2007 - Fixed TROFF code generation if none of -H -T -M -L + is given. +1.21 05 Jul 2007 - Fixed Makefile +1.20 24 Apr 2007 - Added optional parameter to Table-environment + - Fixed generataion of tbl-tables. +1.19 12 Sep 2005 - Thanks to Aleksey Nogin <nogin@cs.caltech.edu> for + his bugfix of the problem he found: + "I came across another issue in the latest + latex2man - if the source file has "\verb+.foo+" in + it, then the ".foo" will be copied to the man page + verbatim and if it happens to be placed on the + beginning of a line, then troff will consider it to + be a command and not display it properly." +1.18 20 July 2005 - latex2man.sty: Removed option pdf. +1.17 14 Oct 2004 - Fixed order of gerating &amp; for HTML + (Thanks to Aleksey Nogin <nogin@cs.caltech.edu>) +1.16 06 Sep 2004 - Fixed handling of % in \verb+..+ and verbatim + environments + (Thanks to Aleksey Nogin <nogin@cs.caltech.edu>) + - added \subsubsection +1.15 12 Dec 2001 - added extra stuff in the headline of man pages + (thanks to Andrew Anderson <aja@emulab.ee.mu.oz.au>) +1.14 18 June 2001 - TROFF generation: fixed handling of leading . and ' + - removed macro \Dot +1.13 08 May 2001 - Added \begin{center} / \end{center}. + - Reimplemented font changing stuff in TROFF + generation (use now troff instead of -man commands). +1.12.3 10 Apr 2001 - Fixed \oOptArg in man output. +1.12.2 12 Mar 2001 - Fixed handling of conditional translation to LaTeX + (if in a IF .. ELSE .. END-IF, the condition + evaluates to true, the ELSE and END-IF are written + to the result file, but not the IF... + Now all %@% directives are written.) +1.12.1 13 Sep 2000 - In \setDate and \setVersion a ~ is replaced by the + output specific blank. +1.12 28 Aug 2000 - Fixed error in htmlVerb (thanks to + Glunz Wolfgang <Wolfgang.Glunz@icn.siemens.de>) + - Fixed error in conditional text handling: + (%@%ELSE%@% was not handled correct). +1.11 25 Aug 2000 - Fixed error in conditional text handling: + (MAN was not enabled by default, when calling + with -M). + - Added eror message, if arguments of \begin{Name}, + \section, and \subsection are not contained on a + single line. +1.10.1 21 Aug 2000 - Better handling of \Tilde. +1.10 13 Jun 2000 - added \Begin{Description}[label] (based on an idea of + Andi Winter <winter@cocolab.de>) + - Thanks to Andi Winter <winter@cocolab.de>: + - fixed: removed wrong line break in date for + TROFF output + - fixed wrong line breaks in some TROFF macros + - fixed wrong output of optional arguments in TROFF + - allow spaces between `\item' and following `[' +1.9.1 20 Mar 2000 - added \OptoArg \oOptoArg Option with optional + argument (Thanks to Andi Winter <winter@cocolab.de>) +1.9 13 Mar 2000 - latex2man.sty: Added option pdf. + latex2man: define names HTML TEXI MAN LATEX + automatically. +1.8 11 Feb 2000 - Added verbatim environment (many thanks to + "Olaf Maibaum" <Maibaum@Informatik.Uni-Oldenburg.DE> + who provided me the troff generation code) + - Added better handling of german Umlaut + - Fixed minor HTML tag mismatch. +1.7.1 17 Nov 1999 - Fixed END_IF handling of -L option. +1.7 25 July 1999 - Allow german Umlaute to be written as \"a, etc. +1.6.4 30 May 1999 - Added fix of Frank.Schilder@Mathematik.TU-Ilmenau.DE + line 418: from + if ($manRS == 0 && $list_nest > 0) { + to + if ($manRS == 0 && $list_nest > 1) { + line 471: from + + # manParagraph; + to + manParagraph; +1.6.3 25 Mar 1999 - Added \, Math stuff is matched now after macro + arguments +1.6.2 21 Nov 1998 - Added \LBr / \RBr, added \setlength{}{} and \itemsep + \Dollar $\ge$, $\le$, $\leftarrow$, $\Leftarrow$, + $\rightarrow$, $\Rightarrow$. +1.6.1 14 Sep 1998 - Added $<=$, $>=$, $=$ $<>$. +1.6 08 Sep 1998 - Added \SP macro. + - Hyphenation \- is translated for TexInfo into @-. + - Runs now under older Versions of Perl (e.g. 5.03). +1.5 22 Aug 1998 - Support for the fanyhdr package, added latex2man.cfg + - Now \% and \- work. +1.4 23 July 1998 - Fixed typos. + - Fixed generated HTML + The following is wrong: <a ..> <h..>....</h..></a> + Correct is: <h..><a ..>...</a></h..> +1.3 03 June 1998 - Add conditional text feature +1.2 18 Jan 1998 - Enumerate/itemize/description environments may + be nested now. + - Output specific line break macros. +1.1 14 Jan 1998 - Fixed bug in HTML generation (no blanks emited + after \hline) +1.0 11 Jan 1998 - Initial version + +</pre></body><html> 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 diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.css b/Master/texmf-dist/doc/support/latex2man/latex2man.css new file mode 100644 index 00000000000..f2c8e676cc0 --- /dev/null +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.css @@ -0,0 +1,121 @@ +/* + * Project: Documentation Tools + * Descr: Latex --> MAN-page (groff -man), LATEX documentation + * CSS example definition, provided by Tom Brand <tbrand@manumit-systems.com> + * Author: Dr. Jürgen Vollmer, Juergen.Vollmer@informatik-vollmer.de + * $Id: latex2man.css,v 1.1 2010/12/22 08:31:45 vollmer Exp $ + */ +body +{ + background: #DDDDDD; +} +.titlehead +{ + text-align: center; + color: maroon; +} +.datehead +{ + text-align: center; + color: maroon; + font-size: 8pt; +} +.authorhead +{ + text-align: center; + color: maroon; + font-size: 8pt; +} +.versionhead +{ + text-align: center; + color: maroon; + font-size: 8pt; +} +.sectionname +{ + color: #0077EE; + font-variant: small-caps; +} +.subsectionname +{ + color: #1111EE; +} +.subsubsectionname +{ + color: #3333EE; +} +.progname +{ + font-family: "monospace"; +} +.filename +{ + font-family: "monospace"; + color: blue; +} +.commandname +{ + font-family: "monospace"; + color: green; +} +.textstyle +{ + font-size: 9pt; +} +.optstyle +{ + font-weight: bold; +} +.argstyle +{ + font-style: italic; +} +.urlstyle +{ + color: #0033BB; + font-weight: bold; + text-decoration: none; +} +.urlstyle.link +{ +} +.urlstyle:visited +{ + color: #BB3300; +} +.urlstyle:hover +{ + background-color: #C0C0C0; + padding: 0.1em 0em 0.1em 0em; +} +.emailstyle +{ + color: #0033BB; + font-weight: bold; + text-decoration: none; +} +.emailstyle.link +{ +} +.emailstyle.visited +{ + color: #BB3300; +} +.emailstyle.hover +{ + background-color: #C0C0C0; + padding: 0.1em 0em 0.1em 0em; +} +.tablestyle +{ + border: 1px solid green; +} +.rowstyle +{ + background: #DDEEFF; +} +.cellstyle +{ + padding: 5px 7px 0px 0px; +} 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> diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.pdf b/Master/texmf-dist/doc/support/latex2man/latex2man.pdf Binary files differindex 13768b901c3..2d85ef399c3 100644 --- a/Master/texmf-dist/doc/support/latex2man/latex2man.pdf +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.pdf 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\\ diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.texi b/Master/texmf-dist/doc/support/latex2man/latex2man.texi index 0614458666d..d299fa1907f 100644 --- a/Master/texmf-dist/doc/support/latex2man/latex2man.texi +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.texi @@ -3,7 +3,7 @@ @setfilename latex2man.info @settitle latex2man @c %**end of header -@c Manual page created with latex2man on Di 11. Nov 08:21:27 CET 2008> +@c Manual page created with latex2man on Mi 22. Dez 13:46:37 CET 2010> @c NOTE: This file is generated, DO NOT EDIT. @dircategory Man-pages @direntry @@ -29,6 +29,7 @@ feature (for this, LaTeX generation may be used). latex2man [ -t@var{transfile} ] +[ -c@var{CSSfile} ] [ -HMTL ] [ -h ] [ -V ] @@ -57,6 +58,7 @@ latex2man * Subsubsection works:: * Subsubsection still works:: * General Remarks:: +* CSS classnames:: * Some Bug Fix Tests:: * Requirements:: * Changes:: @@ -82,6 +84,10 @@ macro package. Using the -H option, HTML code can be produced, instead of troff(1). +With this option you can, optionally, specify a @var{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 -T option, TexInfo code can be produced, instead of @@ -101,6 +107,12 @@ troff(1). @table @samp @item -t@var{transfile} Translation for user defined LaTeX macros. +@item -c@var{CSSfile} +If you use the -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 @var{CSSfile} +filename. @item -M Produce output suitable for the man(1) command (default). @@ -173,6 +185,8 @@ commands. @item @file{latex2man.cfg} The configuration file for 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. @@ -185,6 +199,9 @@ 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 table @node See Also, LaTeX commands, Files, Top @@ -398,7 +415,8 @@ Optional option with argument, e.g.@* @t{\oOptArg@{-o@}@{filename@}} will be typeset as [ -o@var{filename} ]. @item \oOptoArg@{option@}@{argument@} Optional option with optional -argument, e.g. +argument, e.g.@* + @t{\oOptoArg@{-o@}@{filename@}} will be typeset as [ -o[@var{filename}] ]. @item \File@{filename@} used to typeset filenames, e.g. @@ -408,8 +426,9 @@ used to typeset program names, e.g. @t{\Prog@{latex2man@}} will be typeset as latex2man. @item \Cmd@{command@}@{chapter@} used to typeset references to other -commands, e.g. @t{\Cmd@{latex2man@}@{1@}} will be typeset as -latex2man(1). +commands, e.g.@* + +@t{\Cmd@{latex2man@}@{1@}} will be typeset as latex2man(1). @item \Bar is typeset as |. @item \Bs @@ -425,7 +444,9 @@ set @t{..} as version information. @item \setVersionWord@{..@} set @t{..} for the word @emph{Version:} in -the footline. The default is @t{\setVersionWord@{Version:@}}. +the footline.@* + +The default is @t{\setVersionWord@{Version:@}}. @item \Version returns the version information. @item \setDate@{..@} @@ -440,16 +461,20 @@ use to mark an Email address:@* @email{Juergen.Vollmer@@informatik-vollmer.de}. @item \URL@{..@} use to mark an URL: -@t{\URL@{http://www.foo.de/\Tilde vollmer@}} is typeset as +@t{\URL@{http://www.foo.de/\Tilde vollmer@}} is typeset as@* + @url{http://www.foo.de/~vollmer}. @item \LatexManEnd the input file is read and processed until reading -end-of-file or @t{\LatexManEnd} (at the beginning of a line). +end-of-file or@* + +@t{\LatexManEnd} (at the beginning of a line). LaTeXignores this command. @item \Lbr, \Rbr is typeset as [ and ] (these variants are -needed only somtimes like in @t{item[FooBar\LBr xx \Lbr]}. Usually -@t{[ ]} will work. +needed only somtimes like in@* + +@t{\item[FooBar\LBr xx \Lbr]}. Usually @t{[ ]} will work. @item \LBr, \RBr is typeset as @{ and @} (these variants are needed when using @{ or @} as arguments to macros. @@ -619,7 +644,7 @@ or @t{description} environment. @item \today -11 November 2008(see also the @t{rcsinfo} +22 December 2010(see also the @t{rcsinfo} LaTeXpackage). @item \ss,\"a, ... \ss = @ss{}, \"a= @"a, \"o= @"o, \"u= @"u, @@ -864,7 +889,7 @@ This is a @t{\subsubsection}. This is another @t{\subsubsection}. -@node General Remarks, Some Bug Fix Tests, Subsubsection still works, Top +@node General Remarks, CSS classnames, Subsubsection still works, Top @subsection General Remarks @@ -890,8 +915,99 @@ steps shown in the @file{Makefile} manually. @end enumerate -@node Some Bug Fix Tests, Requirements, General Remarks, Top -@subsection Some Bug Fix Tests +@node CSS classnames, Some Bug Fix Tests, General Remarks, Top +@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 @var{CSSfile} +for these classes: + +@noindent + +@multitable @columnfractions 0.3 0.3 0.3 +@item @strong{HTML tag} +@tab @strong{Class} +@tab @strong{Style applies to} + +@item body @tab @tab the body of the HTML page + +@item h1 @tab titlehead @tab the title at the top of the HTML page specified as an argument to the @emph{Name} +environment + +@item h4 @tab authorhead @tab the author at the top of the HTML page specified as an argument to the @emph{Name} +environment + +@item h4 @tab datehead @tab the date at the top of the HTML page + +@item h4 @tab versionhead @tab the man page version at the top of the HTML page specified as an argument to the @emph{setVersion} +macro + +@item h2 @tab sectionname @tab a section title specified as an argument to the @emph{section} +macro + +@item h4 @tab subsectionname @tab a subsection title specified as an argument to the @emph{subsection} +macro + +@item h5 @tab subsubsectionname @tab a subsubsection title specified as an argument to the @emph{subsubsection} +macro + +@item font @tab progname @tab a program name specified as an argument to the @emph{Prog} +macro + +@item font @tab filename @tab a file name specified as an argument to the @emph{File} +macro + +@item font @tab commandname @tab a command name specified as an argument to the @emph{Cmd} +macro + +@item font @tab textstyle @tab all text that is not an argument to some LaTeX or latex2man macro + +@item font @tab optstyle @tab a name of an option specified as an argument to the @emph{Opt}, +@emph{oOpt}, +@emph{OptArg}, +@emph{oOptArg} +or @emph{oOptoArg} +macros + +@item font @tab argstyle @tab a name of an argument specified as an argument to the @emph{Arg}, +@emph{oArg}, +@emph{OptArg}, +@emph{oOptArg} +or @emph{oOptoArg} +macros + +@item a, font @tab urlstyle @tab a URL specified as an argument to the @emph{URL} +macro + +@item a, font @tab urlstyle.link @tab subclass of urlstyle class + +@item a, font @tab urlstyle.visited @tab subclass of urlstyle class + +@item a, font @tab urlstyle.hover @tab subclass of urlstyle class + +@item a, font @tab emailstyle @tab an email specified as an argument to the @emph{Email} +macro + +@item a, font @tab emailstyle.link @tab subclass of emailstyle class + +@item a, font @tab emailstyle.visited @tab subclass of emailstyle class + +@item a, font @tab emailstyle.hover @tab subclass of emailstyle class + +@item table @tab tablestyle @tab a table specified as a @emph{Table} +environment + +@item tr @tab rowstyle @tab a row of a table specified as a @emph{Table} +environment + +@item td @tab cellstyle @tab a cell of a table specified as a @emph{Table} +environment + +@end multitable + +@node Some Bug Fix Tests, Requirements, CSS classnames, Top +@section Some Bug Fix Tests @table @samp @@ -951,13 +1067,14 @@ LaTeX2e is required. @section Changes Please check the file @url{latex2man-CHANGES} -for the list of changes. +for the list of changes and +acknowledgment to people contributing bugfixes or enhancements. @node Version, License and Copyright, Changes, Top @section Version -Version: 1.23 of 2008/11/11. +Version: 1.24 of 2010/12/22. @node License and Copyright, Author, Version, Top @section License and Copyright @@ -966,7 +1083,9 @@ Version: 1.23 of 2008/11/11. @table @samp @item Copyright @copyright{}1998, Dr. J@"urgen Vollmer, Viktoriastra@ss{}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 Latex2man may be found on my homepage@* diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.txt b/Master/texmf-dist/doc/support/latex2man/latex2man.txt index 2ded2fa1000..32ed428840b 100644 --- a/Master/texmf-dist/doc/support/latex2man/latex2man.txt +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.txt @@ -2,82 +2,91 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) -NAME +[1mNAME[0m Latex2man is a tool to translate UNIX manual pages written with LaTeX- - into a format understood by the UNIX man(1)-command. Alternatively + into a format understood by the UNIX [4mman[24m(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). -SYNOPSIS - latex2man [-ttransfile] [-HMTL] [-h] [-V] [-Cname] [-achar] infile out- - file +[1mSYNOPSIS[0m + latex2man [[1m-t[4m[22mtransfile[24m] [[1m-c[4m[22mCSSfile[24m] [[1m-HMTL[22m] [[1m-h[22m] [[1m-V[22m] [[1m-C[4m[22mname[24m] [[1m-a[4m[22mchar[24m] + [4minfile[24m [4moutfile[0m -DESCRIPTION - Latex2man reads the file infile and writes outfile. The input must be +[1mDESCRIPTION[0m + Latex2man reads the file [4minfile[24m and writes [4moutfile[24m. The input must be a LaTeX document using the latex2man LaTeXpackage. Latex2man trans- - lates that document into the troff(1) format using the -man macro pack- + lates that document into the [4mtroff[24m(1) format using the [1m-man [22mmacro pack- age. - Using the -H option, HTML code can be produced, instead of troff(1). + Using the [1m-H [22moption, HTML code can be produced, instead of [4mtroff[24m(1). + With this option you can, optionally, specify a [4mCSSfile[24m 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 -T option, TexInfo code can be produced, instead of troff(1). + Using the [1m-T [22moption, TexInfo code can be produced, instead of [4mtroff[24m(1). - Using the -M option, troff(1) input is produced. + Using the [1m-M [22moption, [4mtroff[24m(1) input is produced. - Using the -L option, LaTeX ouput can be produced, instead of troff(1). + Using the [1m-L [22moption, LaTeX ouput can be produced, instead of [4mtroff[24m(1). -OPTIONS - -ttransfile +[1mOPTIONS[0m + [1m-t[4m[22mtransfile[0m Translation for user defined LaTeX macros. - -M Produce output suitable for the man(1) command (default). + [1m-c[4m[22mCSSfile[0m + If you use the [1m-H [22myou can also specify a file that contains CSS + style sheets. The link to the CSS file is inserted into the gen- + eratedHTML output using the specified [4mCSSfile[24m filename. - -H Instead of producing output suitable for the man(1) command, + [1m-M [22mProduce output suitable for the [4mman[24m(1) command (default). + + [1m-H [22mInstead of producing output suitable for the [4mman[24m(1) command, HTML code is produced (despite the name of the command). - -T Instead of producing output suitable for the man(1) command, + [1m-T [22mInstead of producing output suitable for the [4mman[24m(1) command, TexInfo code is produced (despite the name of the command). The - generated .texi-file may be processed with makeinfo(1) (to pro- + generated .texi-file may be processed with [4mmakeinfo[24m(1) (to pro- duce an .info-file) which in turn may be installed using - install-info(1). The Info tags @dircategory and @direntry are + [4minstall-info[24m(1). The Info tags @dircategory and @direntry are provided. - -L The LaTeX source is written to the outfile. This is useful in - conjunction with the -Cname option. + [1m-L [22mThe LaTeX source is written to the [4moutfile[24m. This is useful in + conjunction with the [1m-C[4m[22mname[24m option. - -Cname Output the conditional text for name. If more than one name - should be given use quotes: -C'name1 name2 ...' + [1m-C[4m[22mname[24m Output the conditional text for [4mname[24m. If more than one name + should be given use quotes: [1m-C[4m[22m'name1[24m [4mname2[24m [4m...'[0m The following names are defined automatically: - * -H defines HTML + [1m* -H [22mdefines HTML - * -T defines TEXI + [1m* -T [22mdefines TEXI - * -M defines MAN + [1m* -M [22mdefines MAN - * -L defines LATEX + [1m* -L [22mdefines LATEX - -achar Is used only in conjunction with -T. + [1m-a[4m[22mchar[24m Is used only in conjunction with -T. Background: 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 addi- - tional space. By default this is a . (dot). The char specifies - an alternative for that first character. Giving a blank to -a + tional space. By default this is a . (dot). The [4mchar[24m specifies + an alternative for that first character. Giving a blank to [1m-a[0m supresses the indentation of a line. - Note: only for the first \SP of a series that char is printed. + Note: only for the first \SP of a series that [4mchar[24m is printed. - -h Show a help text. + [1m-h [22mShow a help text. - -V Show version information. + [1m-V [22mShow version information. -FILES +[1mFILES[0m latex2man.tex The LaTeX file containing this Man-page. @@ -87,6 +96,9 @@ FILES latex2man.cfg The configuration file for Latex2man LaTeX-package. + latex2man.css + File containing example CSS definitions. + latex2man.trans File containing example translations of user defined LaTeX macros. @@ -102,17 +114,21 @@ FILES information in LaTeX documents. -SEE ALSO - LaTeX,TexInfo, troff(1), groff(1), makeinfo(1). + [1mlatex2man.pdf[0m + The PDF version of this document. + + +[1mSEE ALSO[0m + LaTeX,TexInfo, [4mtroff[24m(1), [4mgroff[24m(1), [4mmakeinfo[24m(1). -LaTeX COMMANDS +[1mLaTeX COMMANDS[0m The LaTeX package latex2man is used to write the Man-pages with LaTeX.Since we translate into other text formats, not all LaTeX stuff can be translated. - PACKAGE OPTIONS + [1mPACKAGE OPTIONS[0m The latex2man package accepts the following options: @@ -127,7 +143,7 @@ LaTeX COMMANDS The default option may be specified in the file latex2man.cfg. - PACKAGE SPECIFIC ENVIRONMENTS + [1mPACKAGE SPECIFIC ENVIRONMENTS[0m The following environments are provided by the package: \begin{Name}{chapter}{name}{author}{info}{title} @@ -163,25 +179,25 @@ LaTeX COMMANDS 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 + If no optional [4mwidth[24m argument is given, all entries are typeset left + justified. The [4mwidth[24m is a length measured absolutly in [4mcm[24m. 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. + to [4mtroff[24m(1) commands results in a lw(width) column specification. + Translating to HTML and TexInfo ignores the [4mwidth[24m 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. + If the Man-page is formatted with [4mtroff[24m(1) and tables are used, the + [4mtbl[24m(1) preprocessor should be called, usually by giving a [1m-t [22mto the + call of [4mtroff[24m(1). When viewing the generated manula page using [4mman[24m(1), + [4mtbl[24m(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 + minimum the size of the (optional) word [4mlabel[24m. The difference is visible only in the DVI and PDF-output, not in the troff, TexInfo or HTML output. @@ -207,27 +223,27 @@ LaTeX COMMANDS - ACCEPTED LaTeX ENVIRONMENTS + [1mACCEPTED LaTeX ENVIRONMENTS[0m The following environments are accepted: - * description + [1m* [22mdescription - * enumerate + [1m* [22menumerate - * itemize + [1m* [22mitemize - * verbatim + [1m* [22mverbatim - * center + [1m* [22mcenter They may be nested: - * Itemize and nested center: + [1m* [22mItemize and nested center: A centered line. Another centered line. - * Another item an nested enumerate + [1m* [22mAnother item an nested enumerate 1. a @@ -235,49 +251,49 @@ LaTeX COMMANDS - PACKAGE SPECIFIC MACROS + [1mPACKAGE SPECIFIC MACROS[0m The following commands are provided: \Opt{option} - Option: \Opt{-o} will be typeset as -o. + Option: \Opt{-o} will be typeset as [1m-o[22m. \Arg{argument} - Argument: \Arg{filename} will be typeset as filename. + Argument: \Arg{filename} will be typeset as [4mfilename[24m. \OptArg{option}{argument} Option with Argument: - \OptArg{-o}{filename} will be typeset as -ofilename. + \OptArg{-o}{filename} will be typeset as [1m-o[4m[22mfilename[24m. \OptoArg{option}{argument} Option with optional Argument: - \OptoArg{-o}{filename} will be typeset as -o[filename]. + \OptoArg{-o}{filename} will be typeset as [1m-o[22m[[4mfilename[24m]. \oOpt{option} - Optional option, e.g. \oOpt{-o} will be typeset as [-o]. + Optional option, e.g. \oOpt{-o} will be typeset as [[1m-o[22m]. \oArg{argument} Optional argument, e.g. \oArg{filename} will be typeset as - [filename]. + [[4mfilename[24m]. \oOptArg{option}{argument} Optional option with argument, e.g. - \oOptArg{-o}{filename} will be typeset as [-ofilename]. + \oOptArg{-o}{filename} will be typeset as [[1m-o[4m[22mfilename[24m]. \oOptoArg{option}{argument} - Optional option with optional argument, e.g. \oOp- - toArg{-o}{filename} will be typeset as [-o[filename]]. + Optional option with optional argument, e.g. + \oOptoArg{-o}{filename} will be typeset as [[1m-o[22m[[4mfilename[24m]]. \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 + 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). + used to typeset references to other commands, e.g. + \Cmd{latex2man}{1} will be typeset as [4mlatex2man[24m(1). \Bar is typeset as |. @@ -295,8 +311,8 @@ LaTeX COMMANDS set .. as version information. \setVersionWord{..} - set .. for the word Version: in the footline. The default is - \setVersionWord{Version:}. + set .. for the word [4mVersion:[24m in the footline. + The default is \setVersionWord{Version:}. \Version returns the version information. @@ -309,20 +325,23 @@ LaTeX COMMANDS \Email{..} use to mark an Email address: \Email{Juergen.Vollmer@informatik-vollmer.de} is typeset as: - Juergen.Vollmer@informatik-vollmer.de. + [1mJuergen.Vollmer@informatik-vollmer.de[22m. \URL{..} - use to mark an URL: \URL{http://www.foo.de/\Tilde vollmer} is - typeset as http://www.foo.de/~vollmer. + use to mark an URL: \URL{http://www.foo.de/\Tilde vollmer} is + typeset as + [1mhttp://www.foo.de/~vollmer[22m. \LatexManEnd - the input file is read and processed until reading end-of-file - or \LatexManEnd (at the beginning of a line). LaTeXignores this + 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. + 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 @@ -334,14 +353,14 @@ LaTeX COMMANDS \Percent is typeset as %. - \TEXbr If processed with LaTeX causes a linebreak (i.e. is equivalent + \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 + 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 + \MANbr If Man-Page output is generated, causes a linebreak (i.e. is equivalent to \\),otherwise ignored. \HTMLbr @@ -357,32 +376,32 @@ LaTeX COMMANDS 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. + Note: Due to some ``problems'' with TexInfo, the lines starting with + \SP have a leading . (dot) in the TexInfo output, see [1m-a[4m[22mchar[24m. - ACCEPTED MACROS FROM THE RCSINFO PACKAGE + [1mACCEPTED MACROS FROM THE RCSINFO PACKAGE[0m \rcsInfo $Id ...$ - if the LaTeX package rcsinfo is used, this command is used to + if the LaTeX package rcsinfo is used, this command is used to extract the date of the Man-page. \rcsInfoLongDate - if the LaTeX package rcsinfo is used, this command is used to + if the LaTeX package rcsinfo is used, this command is used to typeset the date coded in the $Id ..$ string. - ACCEPTED LaTeX MACROS + [1mACCEPTED LaTeX MACROS[0m The following standard LaTeX commands are accepted: \section{..} - The section macro takes one argument: the name of the Man-page - section. Each Man-page consists of several sections. Usually - there are the following sections in a Man-page: Name (special - handling as environment, c.f. above), Synopsis, Description, - Options, Files, See Also, Diagnostics, Return Values, Bugs, - Author, version, etc. + The section macro takes one argument: the name of the Man-page + section. Each Man-page consists of several sections. Usually + there are the following sections in a Man-page: [4mName[24m (special + handling as environment, c.f. above), [4mSynopsis[24m, [4mDescription[24m, + [4mOptions[24m, [4mFiles[24m, [4mSee[24m [4mAlso[24m, [4mDiagnostics[24m, [4mReturn[24m [4mValues[24m, [4mBugs[24m, + [4mAuthor[24m, [4mversion[24m, etc. - Synopsis must be the first section after the Name environment. + [4mSynopsis[24m must be the first section after the Name environment. Note: Do not use LaTeX-macrosin section names. @@ -393,16 +412,16 @@ LaTeX COMMANDS those. \emph{..} - \emph{example} is typeset as example. + \emph{example} is typeset as [4mexample[24m. \textbf{..} - \textbf{example} is typeset as example. + \textbf{example} is typeset as [1mexample[22m. \texttt{..} \textt{example} is typeset as example. \underline{..} - \underline{example} is typeset as example of underline . + \underline{example} is typeset as [4mexample[24m [4mof[24m [4munderline[24m . \date{..} uses .. as date. @@ -463,7 +482,7 @@ LaTeX COMMANDS Table environment. \ (a \ followed by a blank) is typeset as a blank, - although it cannot be used at the beginning of a line to make + although it cannot be used at the beginning of a line to make indentation (see the \SP command). ~ is typeset as a blank. @@ -477,41 +496,41 @@ LaTeX COMMANDS \item inside a itemize, enumerate, or description environment. - \today 11 November 2008(see also the rcsinfo LaTeXpackage). + \today 22 December 2010(see also the rcsinfo LaTeXpackage). \ss,\"a, ... - \ss = ß, \"a= ä, \"o= ö, \"u= ü, \"A= Ä, \"O= Ö, \"U= Ü. It is - allowed to surround these macros in { and } in all places, even + \ss = ß, \"a= ä, \"o= ö, \"u= ü, \"A= Ä, \"O= Ö, \"U= Ü. It is + allowed to surround these macros in { and } in all places, even inside other macros, e.g. \textbf{\"a\"o\"u\"A\"O\"U\ss} \textbf{\"a}{\"o}{\"u}{\"A}{\"O}{\"U}{\ss}} \textbf{äöüÄÖÜß} - äöüÄÖÜß äöüÄÖÜß äöüÄÖÜß + [1mäöüÄÖÜß äöüÄÖÜß äöüÄÖÜß[0m - If these letters are used in their LATIN-1 8-bit coding, they are - translated into the equivalent letter of the desired output format. + If these letters are used in their LATIN-1 8-bit coding, they are + translated into the equivalent letter of the desired output format. E.g. Ä becomes Ä in HTML and @"A in texinfo. - CONDITIONAL TEXT - latex2man preprocesses the LaTeX input to allow text to be used condi- + [1mCONDITIONAL TEXT[0m + latex2man preprocesses the LaTeX input to allow text to be used condi- tionally. A special sort of LaTeX comment is used for that purpose. - * %@% IF condition %@% + [1m* [22m%@% IF [4mcondition[24m %@% - * %@% ELSE %@% + [1m* [22m%@% ELSE %@% - * %@% END-IF %@% + [1m* [22m%@% END-IF %@% - A line must contain only such a comment and nothing else. condition is - a boolean expression containing ``names'' and operators. The names - given with the -Cname option have the value ``true'', while all other - names occuring in the expression are assumed to be ``false''. If the + A line must contain only such a comment and nothing else. [4mcondition[24m is + a boolean expression containing ``names'' and operators. The names + given with the [1m-C[4m[22mname[24m 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 ``then''-part is used and the text in the optional - ``else''-part is skipped (and vice versa). The IF/ELSE/END-IF may be + text in the ``then''-part is used and the text in the optional + ``else''-part is skipped (and vice versa). The IF/ELSE/END-IF may be nested. As boolean operators the following are allowed: @@ -535,21 +554,21 @@ LaTeX COMMANDS %@% END-IF %@% %@% END-IF %@% - Run this manual page through latex2man with e.g. -C'abc XYZ' and have - a look to the generated output. (If simply running the LaTeX-document + Run this manual page through latex2man with e.g. [1m-C[4m[22m'abc[24m [4mXYZ'[24m and have + a look to the generated output. (If simply running the LaTeX-document through LaTeX,all lines are shown in the .dvi file). abc NOT set xyz OR !XYZ set To check the conditional text feature, when latex2man is called with - -CHTML the lines 1a, 2b, 3b, and 4b; + [1m-C[4m[22mHTML[24m the lines 1a, 2b, 3b, and 4b; - -CTEXI the lines 1b, 2a, 3b, and 4b; + [1m-C[4m[22mTEXI[24m the lines 1b, 2a, 3b, and 4b; - -CMAN the lines 1b, 2b, 3a, and 4b; + [1m-C[4m[22mMAN[24m the lines 1b, 2b, 3a, and 4b; - -CLATEX + [1m-C[4m[22mLATEX[0m the lines 1b, 2b, 3b, and 4a; calling LaTeX without preprocessing @@ -566,16 +585,16 @@ LaTeX COMMANDS 4b. The LATEX conditional was not set. - TRANSLATION OF USER DEFINED MACROS - The user macro translation file (given by the [-ttransfile]) contains + [1mTRANSLATION OF USER DEFINED MACROS[0m + The user macro translation file (given by the [[1m-t[4m[22mtransfile[24m]) contains Perl commands specifying the translation of LaTeX macros defined by the - user. These macros may have none, one or two arguments. The following + user. These macros may have none, one or two arguments. The following code is expected: - * Comments start with a # up to the end of the line. + [1m* [22mComments start with a # up to the end of the line. - * For a macro \foo with no arguments, the following code must be + [1m* [22mFor a macro \foo with no arguments, the following code must be specified: Translation to Man-Pages @@ -590,7 +609,7 @@ LaTeX COMMANDS where ... is the translation. - * For a macro \foo{..} with one argument, the following code must + [1m* [22mFor a macro \foo{..} with one argument, the following code must be specified: Translation to Man-Pages @@ -606,11 +625,11 @@ LaTeX COMMANDS $texiMacro1a{'foo'} = '...'; $texiMacro1b{'foo'} = '...'; - where ... is the translation. The 1a code is used before the + where ... is the translation. The 1a code is used before the argument, while 1b is typeset after the argument is set. - * For a macro \foo{..}{..} with two arguments, the following code + [1m* [22mFor a macro \foo{..}{..} with two arguments, the following code must be specified: Translation to Man-Pages @@ -628,14 +647,14 @@ LaTeX COMMANDS $texiMacro2b{'foo'} = '...'; $texiMacro2c{'foo'} = '...'; - where ... is the translation. The 2a code is used before the - first argument, 2b between the two arguments and 2c is typeset + where ... is the translation. The 2a code is used before the + first argument, 2b between the two arguments and 2c is typeset after the second argument is set. - * The file latex2man.trans contains some example code. + [1m* [22mThe file latex2man.trans contains some example code. - VERBATIM ENVIRONMENT + [1mVERBATIM ENVIRONMENT[0m This {is} \texttt{a} @@ -646,28 +665,28 @@ LaTeX COMMANDS - SUBSECTION WORKS + [1mSUBSECTION WORKS[0m This is a \subsection. - Subsubsection works + [1mSubsubsection works[0m This is a \subsubsection. - Subsubsection still works + [1mSubsubsection still works[0m This is another \subsubsection. - GENERAL REMARKS + [1mGENERAL REMARKS[0m 1. Empty lines are typeset as paragraph separators. - 2. The arguments of the LaTeX commands must not be split over sev- + 2. The arguments of the LaTeX commands must not be split over sev- eral lines. 3. Do not nest calls to macros. - 4. Except the mentioned environment and macros, the usage of other - LaTeX environments or macros are not translated. Their usage + 4. Except the mentioned environment and macros, the usage of other + LaTeX environments or macros are not translated. Their usage will cause garbage in the output. 5. latex2man requires Perl version >= 5.0004_03. @@ -677,12 +696,73 @@ LaTeX COMMANDS steps shown in the Makefile manually. - SOME BUG FIX TESTS +[1mCSS CLASSNAMES[0m + 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 [4mCSSfile[24m for these classes: + + + [1mHTML tag Class Style applies to[0m + body the body of the HTML page + h1 titlehead the title at the top of the HTML + page specified as an argument to + the [4mName[24m environment + h4 authorhead the author at the top of the HTML + page specified as an argument to + the [4mName[24m 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 [4msetVersion[24m macro + h2 sectionname a section title specified as an + argument to the [4msection[24m macro + h4 subsectionname a subsection title specified as + an argument to the [4msubsection[0m + macro + h5 subsubsectionname a subsubsection title specified + as an argument to the [4msubsubsec-[0m + [4mtion[24m macro + font progname a program name specified as an + argument to the [4mProg[24m macro + font filename a file name specified as an argu- + ment to the [4mFile[24m macro + font commandname a command name specified as an + argument to the [4mCmd[24m 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 [4mOpt[24m, [4moOpt[24m, + [4mOptArg[24m, [4moOptArg[24m or [4moOptoArg[0m + macros + font argstyle a name of an argument specified + as an argument to the [4mArg[24m, [4moArg[24m, + [4mOptArg[24m, [4moOptArg[24m or [4moOptoArg[0m + macros + a, font urlstyle a URL specified as an argument to + the [4mURL[24m 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 [4mEmail[24m 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 [4mTable[0m + environment + tr rowstyle a row of a table specified as a + [4mTable[24m environment + td cellstyle a cell of a table specified as a + [4mTable[24m environment + + +[1mSOME BUG FIX TESTS[0m Leading . and ' Now leading . and ' in generation troff output should work prop- perly, since a \& is added. Therfore the \Dot macro has been deleted. - Thanks to Frank.Schilder@Mathematik.Tu-Ilmenau.De. + Thanks to [1mFrank.Schilder@Mathematik.Tu-Ilmenau.De[22m. Testcase 1: '\n' ... @@ -696,7 +776,7 @@ LaTeX COMMANDS %in verbatim A % in a \verb and verbatim-environment was not emitted cor- - rectly. Thanks to Aleksey Nogin nogin@cs.caltech.edu for the bug + rectly. Thanks to Aleksey Nogin [1mnogin@cs.caltech.edu [22mfor the bug report and bug fix. % abc @@ -707,7 +787,7 @@ LaTeX COMMANDS but ignore comments following this: -REQUIREMENTS +[1mREQUIREMENTS[0m Perl latex2man requires Perl version >= 5.0004_03. Make If you want to install the system with the distributed Makefile, @@ -717,26 +797,28 @@ REQUIREMENTS LaTeX LaTeX2e is required. -CHANGES - Please check the file latex2man-CHANGES for the list of changes. +[1mCHANGES[0m + Please check the file [1mlatex2man-CHANGES [22mfor the list of changes and + acknowledgment to people contributing bugfixes or enhancements. -VERSION - Version: 1.23 of 2008/11/11. +[1mVERSION[0m + Version: 1.24 of 2010/12/22. -LICENSE AND COPYRIGHT +[1mLICENSE AND COPYRIGHT[0m Copyright - (C)1998, Dr. Jürgen Vollmer, Viktoriastraße 15, D-76133 Karl- - sruhe, Germany, Juergen.Vollmer@informatik-vollmer.de + (C)1998, Dr. Jürgen Vollmer, Viktoriastraße 15, D-76133 Karl- + sruhe, Germany, + [1mJuergen.Vollmer@informatik-vollmer.de[0m The actual version of Latex2man may be found on my homepage - http://www.informatik-vollmer.de/software/latex2man.html. + [1mhttp://www.informatik-vollmer.de/software/latex2man.html[22m. License - This program can be redistributed and/or modified under the - terms of the LaTeX Project Public License Distributed from CTAN + This program can be redistributed and/or modified under the + terms of the LaTeX Project Public License Distributed from CTAN archives in directory macros/latex/base/lppl.txt; either version 1 of the License, or any later version. @@ -745,14 +827,14 @@ LICENSE AND COPYRIGHT the place where you are living. -AUTHOR +[1mAUTHOR[0m Dr. Jürgen Vollmer Viktoriastraße 15 D-76133 Karlsruhe - Email: Juergen.Vollmer@informatik-vollmer.de - WWW: http://www.informatik-vollmer.de. + Email: [1mJuergen.Vollmer@informatik-vollmer.de[0m + WWW: [1mhttp://www.informatik-vollmer.de[22m. -Documentation Tools 2008/11/11 LATEX2MAN(1) +Documentation Tools 2010/12/22 LATEX2MAN(1) |