diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/latex2man/latex2man.txt')
-rw-r--r-- | Master/texmf-dist/doc/support/latex2man/latex2man.txt | 100 |
1 files changed, 35 insertions, 65 deletions
diff --git a/Master/texmf-dist/doc/support/latex2man/latex2man.txt b/Master/texmf-dist/doc/support/latex2man/latex2man.txt index 32ed428840b..652cf610552 100644 --- a/Master/texmf-dist/doc/support/latex2man/latex2man.txt +++ b/Master/texmf-dist/doc/support/latex2man/latex2man.txt @@ -9,12 +9,10 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) the text may be suppressed using the conditional text feature (for this, LaTeX generation may be used). - [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 - [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- @@ -31,8 +29,7 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) Using the [1m-M [22moption, [4mtroff[24m(1) input is produced. - Using the [1m-L [22moption, LaTeX ouput can be produced, instead of [4mtroff[24m(1). - + Using the [1m-L [22moption, LaTeX ouput can be produced, instead of [4mtroff[24m(1). [1mOPTIONS[0m [1m-t[4m[22mtransfile[0m @@ -43,22 +40,27 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) style sheets. The link to the CSS file is inserted into the gen- eratedHTML output using the specified [4mCSSfile[24m filename. - [1m-M [22mProduce output suitable for the [4mman[24m(1) command (default). + [1m-M[0m + Produce output suitable for the [4mman[24m(1) command (default). - [1m-H [22mInstead of producing output suitable for the [4mman[24m(1) command, + [1m-H[0m + Instead of producing output suitable for the [4mman[24m(1) command, HTML code is produced (despite the name of the command). - [1m-T [22mInstead of producing output suitable for the [4mman[24m(1) command, + [1m-T[0m + Instead 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 [4mmakeinfo[24m(1) (to pro- duce an .info-file) which in turn may be installed using [4minstall-info[24m(1). The Info tags @dircategory and @direntry are provided. - [1m-L [22mThe LaTeX source is written to the [4moutfile[24m. This is useful in + [1m-L[0m + The LaTeX source is written to the [4moutfile[24m. This is useful in conjunction with the [1m-C[4m[22mname[24m option. - [1m-C[4m[22mname[24m Output the conditional text for [4mname[24m. If more than one name + [1m-C[4m[22mname[0m + 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: @@ -70,8 +72,8 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) [1m* -L [22mdefines LATEX - - [1m-a[4m[22mchar[24m Is used only in conjunction with -T. + [1m-a[4m[22mchar[0m + 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 @@ -81,15 +83,19 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) supresses the indentation of a line. Note: only for the first \SP of a series that [4mchar[24m is printed. - [1m-h [22mShow a help text. - - [1m-V [22mShow version information. + [1m-h[0m + Show a help text. + [1m-V[0m + Show version information. [1mFILES[0m latex2man.tex The LaTeX file containing this Man-page. + latex2man.inc + A file read with \input{..} . + latex2man.sty The LaTeX package defining the environments and commands. @@ -113,25 +119,20 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) A LaTeX package used to extract and use RCS version control information in LaTeX documents. - [1mlatex2man.pdf[0m The PDF version of this document. - [1mSEE ALSO[0m LaTeX,TexInfo, [4mtroff[24m(1), [4mgroff[24m(1), [4mmakeinfo[24m(1). - [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. - [1mPACKAGE OPTIONS[0m The latex2man package accepts the following options: - fancy use the LaTeX package fancyheadings. fancyhdr @@ -142,7 +143,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) The default option may be specified in the file latex2man.cfg. - [1mPACKAGE SPECIFIC ENVIRONMENTS[0m The following environments are provided by the package: @@ -170,7 +170,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) will be typeset as: - Here am I ---------------------- A 1 A 2 A 3 1 2 @@ -207,22 +206,18 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) abc |abc - a |a \begin{Description} ab |ab abc |abc - a |a \begin{Description}[aa] ab |ab abc |abc - - [1mACCEPTED LaTeX ENVIRONMENTS[0m The following environments are accepted: @@ -249,8 +244,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) 2. b - - [1mPACKAGE SPECIFIC MACROS[0m The following commands are provided: @@ -379,7 +372,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) 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. - [1mACCEPTED MACROS FROM THE RCSINFO PACKAGE[0m \rcsInfo $Id ...$ if the LaTeX package rcsinfo is used, this command is used to @@ -389,7 +381,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) if the LaTeX package rcsinfo is used, this command is used to typeset the date coded in the $Id ..$ string. - [1mACCEPTED LaTeX MACROS[0m The following standard LaTeX commands are accepted: @@ -496,7 +487,7 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) \item inside a itemize, enumerate, or description environment. - \today 22 December 2010(see also the rcsinfo LaTeXpackage). + \today 13 April 2017(see also the rcsinfo LaTeXpackage). \ss,\"a, ... \ss = ß, \"a= ä, \"o= ö, \"u= ü, \"A= Ä, \"O= Ö, \"U= Ü. It is @@ -513,6 +504,8 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) translated into the equivalent letter of the desired output format. E.g. Ä becomes Ä in HTML and @"A in texinfo. + \input{..} + Read and process the given filename. [1mCONDITIONAL TEXT[0m latex2man preprocesses the LaTeX input to allow text to be used condi- @@ -533,8 +526,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) ``else''-part is skipped (and vice versa). The IF/ELSE/END-IF may be nested. As boolean operators the following are allowed: - - ( and ) for grouping are allowed. For example: @@ -562,11 +553,14 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) To check the conditional text feature, when latex2man is called with - [1m-C[4m[22mHTML[24m the lines 1a, 2b, 3b, and 4b; + [1m-C[4m[22mHTML[0m + the lines 1a, 2b, 3b, and 4b; - [1m-C[4m[22mTEXI[24m the lines 1b, 2a, 3b, and 4b; + [1m-C[4m[22mTEXI[0m + the lines 1b, 2a, 3b, and 4b; - [1m-C[4m[22mMAN[24m the lines 1b, 2b, 3a, and 4b; + [1m-C[4m[22mMAN[0m + the lines 1b, 2b, 3a, and 4b; [1m-C[4m[22mLATEX[0m the lines 1b, 2b, 3b, and 4a; @@ -584,14 +578,12 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) 4b. The LATEX conditional was not set. - [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 code is expected: - [1m* [22mComments start with a # up to the end of the line. [1m* [22mFor a macro \foo with no arguments, the following code must be @@ -608,7 +600,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) where ... is the translation. - [1m* [22mFor a macro \foo{..} with one argument, the following code must be specified: @@ -620,7 +611,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) $htmlMacro1a{'foo'} = '...'; $htmlMacro1b{'foo'} = '...'; - Translation to TexInfo $texiMacro1a{'foo'} = '...'; $texiMacro1b{'foo'} = '...'; @@ -628,7 +618,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) where ... is the translation. The 1a code is used before the argument, while 1b is typeset after the argument is set. - [1m* [22mFor a macro \foo{..}{..} with two arguments, the following code must be specified: @@ -653,7 +642,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) [1m* [22mThe file latex2man.trans contains some example code. - [1mVERBATIM ENVIRONMENT[0m This {is} @@ -664,19 +652,15 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) <this is no HTML tag> and no @* TexInfo command - [1mSUBSECTION WORKS[0m This is a \subsection. - [1mSubsubsection works[0m This is a \subsubsection. - [1mSubsubsection still works[0m This is another \subsubsection. - [1mGENERAL REMARKS[0m 1. Empty lines are typeset as paragraph separators. @@ -695,13 +679,11 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) you need GNU-make. If you don't have it, you should execute the steps shown in the Makefile manually. - [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 @@ -756,7 +738,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) 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- @@ -773,7 +754,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) abc ... abc . efg ' 123 - %in verbatim A % in a \verb and verbatim-environment was not emitted cor- rectly. Thanks to Aleksey Nogin [1mnogin@cs.caltech.edu [22mfor the bug @@ -786,7 +766,6 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) but ignore comments following this: - [1mREQUIREMENTS[0m Perl latex2man requires Perl version >= 5.0004_03. @@ -796,45 +775,36 @@ LATEX2MAN(1) Documentation Tools LATEX2MAN(1) LaTeX LaTeX2e is required. - [1mCHANGES[0m Please check the file [1mlatex2man-CHANGES [22mfor the list of changes and acknowledgment to people contributing bugfixes or enhancements. - [1mVERSION[0m - Version: 1.24 of 2010/12/22. - + Version: 1.25 of 2017/04/13. [1mLICENSE AND COPYRIGHT[0m Copyright - (C)1998, Dr. Jürgen Vollmer, Viktoriastraße 15, D-76133 Karl- - sruhe, Germany, + (C)1998, Dr. Jürgen Vollmer, Am Rennbuckel 21, D-76185 Karls- + ruhe, Germany, [1mJuergen.Vollmer@informatik-vollmer.de[0m The actual version of Latex2man may be found on my homepage [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 archives in directory macros/latex/base/lppl.txt; either version 1 of the License, or any later version. - Misc If you find this software useful, please send me a postcard from the place where you are living. - [1mAUTHOR[0m Dr. Jürgen Vollmer - Viktoriastraße 15 - D-76133 Karlsruhe + Am Rennbuckel 21 + D-76185 Karlsruhe Email: [1mJuergen.Vollmer@informatik-vollmer.de[0m WWW: [1mhttp://www.informatik-vollmer.de[22m. - - - -Documentation Tools 2010/12/22 LATEX2MAN(1) +Documentation Tools 2017/04/13 LATEX2MAN(1) |