summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/info/latex2man.info
blob: 8c21ee1264d3de0d5b7cf950944765ec56834883 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
This is latex2man.info, produced by makeinfo version 4.13 from
latex2man.texi.

INFO-DIR-SECTION Man-pages
START-INFO-DIR-ENTRY
* Latex2man: (latex2man). Its Man-Page
END-INFO-DIR-ENTRY


File: latex2man.info,  Node: Top,  Next: Description,  Prev: (dir),  Up: (dir)

latex2man
*********

Latex2man is a tool to translate UNIX manual pages written with
LaTeXinto a format understood by the UNIX man(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 ] [ -cCSSFILE ] [ -HMTL ] [ -h ] [ -V ] [
-CNAME ]
[ -aCHAR ] INFILE OUTFILE

* Menu:

* Description::
* Options::
* Files::
* See Also::
* LaTeX commands::
* Package Options::
* Package Specific Environments::
* Accepted LaTeX Environments::
* Package Specific Macros::
* Accepted Macros from the rcsinfo Package::
* Accepted LaTeX Macros::
* Conditional Text::
* Translation of User Defined Macros::
* Verbatim Environment::
* Subsection works::
* Subsubsection works::
* Subsubsection still works::
* General Remarks::
* CSS classnames::
* Some Bug Fix Tests::
* Requirements::
* Changes::
* Version::
* License and Copyright::
* Author::


File: latex2man.info,  Node: Description,  Next: Options,  Prev: Top,  Up: Top

Description
===========

Latex2man reads the file INFILE and writes OUTFILE.  The input must be
a LaTeX document using the latex2man LaTeXpackage.  Latex2man
translates that document into the troff(1) format using the -man macro
package.

   Using the -H option, HTML code can be produced, instead of troff(1).
With this option you can, optionally, specify a 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
troff(1).

   Using the -M option, troff(1) input is produced.

   Using the -L option, LaTeX ouput can be produced, instead of
troff(1).


File: latex2man.info,  Node: Options,  Next: Files,  Prev: Description,  Up: Top

Options
=======

`-tTRANSFILE'
     Translation for user defined LaTeX macros.

`-cCSSFILE'
     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 CSSFILE filename.

`-M'
     Produce output suitable for the man(1) command (default).

`-H'
     Instead of producing output suitable for the man(1) command, HTML
     code is produced (despite the name of the command).

`-T'
     Instead of producing output suitable for the man(1) command,
     TexInfo code is produced (despite the name of the command). The
     generated `.texi'-file may be processed with makeinfo(1) (to
     produce an `.info'-file) which in turn may be installed using
     install-info(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.

`-CNAME'
     Output the conditional text for NAME.  If more than one name
     should be given use quotes: -C'NAME1 NAME2 ...'
     The following names are defined automatically:
        * -H defines HTML

        * -T defines TEXI

        * -M defines MAN

        * -L defines LATEX

`-aCHAR'
     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 additional space.
     By default this is a . (dot). The CHAR specifies an alternative
     for that first character. Giving a blank to -a supresses the
     indentation of a line.
     Note: only for the first \SP of a series that CHAR is printed.

`-h'
     Show a help text.

`-V'
     Show version information.


File: latex2man.info,  Node: Files,  Next: See Also,  Prev: Options,  Up: Top

Files
=====

``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.

``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.

``fancyheadings.sty''
     A LaTeX package used to typeset head- and foot lines.

``fancyhdr.sty''
     A LaTeX package used to typeset head- and foot lines.

``rcsinfo.sty''
     A LaTeX package used to extract and use RCS version control
     information in LaTeX documents.

``latex2man.pdf''
     The PDF version of this document.


File: latex2man.info,  Node: See Also,  Next: LaTeX commands,  Prev: Files,  Up: Top

See Also
========

LaTeX,TexInfo, troff(1), groff(1), makeinfo(1).


File: latex2man.info,  Node: LaTeX commands,  Next: Package Options,  Prev: See Also,  Up: Top

LaTeX commands
==============

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.


File: latex2man.info,  Node: Package Options,  Next: Package Specific Environments,  Prev: LaTeX commands,  Up: Top

Package Options
---------------

The latex2man package accepts the following options:

`fancy'
     use the LaTeX package fancyheadings.

`fancyhdr'
     use the LaTeX package fancyhdr.

`nofancy'
     neither the LaTeX package fancyheadings nor fancyhdr are used.

   The default option may be specified in the file latex2man.cfg.


File: latex2man.info,  Node: Package Specific Environments,  Next: Accepted LaTeX Environments,  Prev: Package Options,  Up: Top

Package Specific Environments
-----------------------------

The following environments are provided by the package:
`\begin{Name}{chapter}{name}{author}{info}{title}'
     The Name environment takes five arguments: 1.  the Man-page
     chapter, 2.  the name of the Man-page, 3.  the author, 4.  some
     short information about the tool printed in the footline of the
     Man-page, and 5.  a text which is used as title, for HTML and
     LaTeX (it's ignored for output of the Man-page or TeXinfo. The Name
     environment must be the first environment in the document.
     Processing starts with this environment. Any text before this is
     ignored (exception: the setVersion and setDate commands). (Note:
     all arguments of \begin{Name} must be written on one line).

`\begin{Table}[width]{columns}'
     The Table environment takes two arguments: the first optional one
     specifies a width of the last column, the second one gives the
     number of columns.  For example:

     \begin{Table}[2cm]{3}
     Here & am & I \\\hline
     A 1 & A 2 & A 3 1 2 3 4 5 A 3 1 2 3 4 5 \\
     B 1 & B 2 & B 3 \\
     \end{Table}

     will be typeset as:

     Here                 am                   I
     A 1                  A 2                  A 3 1 2 3 4 5 A 3 1
                                               2 3 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 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.

     \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.

`\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
     is visible only in the DVI and PDF-output, not in the troff,
     TexInfo or HTML output.
    `a'
          |a \begin{description}

    `ab'
          |ab

    `abc'
          |abc

    `a'
          |a \begin{Description}

    `ab'
          |ab

    `abc'
          |abc

    `a'
          |a \begin{Description}[aa]

    `ab'
          |ab

    `abc'
          |abc


File: latex2man.info,  Node: Accepted LaTeX Environments,  Next: Package Specific Macros,  Prev: Package Specific Environments,  Up: Top

Accepted LaTeX Environments
---------------------------

The following environments are accepted:
   * description

   * enumerate

   * itemize

   * verbatim

   * center

   They may be nested:
   * Itemize and nested center:

                              A centered line.
                           Another centered line.

   * Another item an nested enumerate
       1. a

       2. b


File: latex2man.info,  Node: Package Specific Macros,  Next: Accepted Macros from the rcsinfo Package,  Prev: Accepted LaTeX Environments,  Up: Top

Package Specific Macros
-----------------------

The following commands are provided:
`\Opt{option}'
     Option: \Opt{-o} will be typeset as -o.

`\Arg{argument}'
     Argument: \Arg{filename} will be typeset as FILENAME.

`\OptArg{option}{argument}'
     Option with Argument:
     \OptArg{-o}{filename} will be typeset as -oFILENAME.

`\OptoArg{option}{argument}'
     Option with optional Argument:
     \OptoArg{-o}{filename} will be typeset as -o[FILENAME].

`\oOpt{option}'
     Optional option, e.g.  \oOpt{-o} will be typeset as [ -o ].

`\oArg{argument}'
     Optional argument, e.g.  \oArg{filename} will be typeset as [
     FILENAME ].

`\oOptArg{option}{argument}'
     Optional option with argument, e.g.
     \oOptArg{-o}{filename} will be typeset as [ -oFILENAME ].

`\oOptoArg{option}{argument}'
     Optional option with optional argument, e.g.
     \oOptoArg{-o}{filename} will be typeset as [ -o[FILENAME] ].

`\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
     typeset as latex2man.

`\Cmd{command}{chapter}'
     used to typeset references to other commands, e.g.
     \Cmd{latex2man}{1} will be typeset as latex2man(1).

`\Bar'
     is typeset as |.

`\Bs'
     (BackSlash) is typeset as \.

`\Tilde'
     is typeset as a ~.

`\Dots'
     is typeset as ...

`\Bullet'
     us typeset as *.

`\setVersion{..}'
     set .. as version information.

`\setVersionWord{..}'
     set .. for the word _Version:_ in the footline.
     The default is \setVersionWord{Version:}.

`\Version'
     returns the version information.

`\setDate{..}'
     sets .. as date information.

`\Date'
     returns the date information.

`\Email{..}'
     use to mark an Email address:
     \Email{Juergen.Vollmer@informatik-vollmer.de} is typeset as:
     <Juergen.Vollmer@informatik-vollmer.de>.

`\URL{..}'
     use to mark an URL: \URL{http://www.foo.de/\Tilde vollmer} is
     typeset as
     `http://www.foo.de/~vollmer'.

`\LatexManEnd'
     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.

`\LBr, \RBr'
     is typeset as { and } (these variants are needed when using { or }
     as arguments to macros.

`\Circum'
     is typeset as ^.

`\Percent'
     is typeset as %.

`\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
     equivalent to \\),otherwise ignored.

`\MANbr'
     If Man-Page output is generated, causes a linebreak (i.e.  is
     equivalent to \\),otherwise ignored.

`\HTMLbr'
     If HTML output is generated, causes a linebreak (i.e.  is
     equivalent to \\),otherwise ignored.

`\medskip'
     An empty line.

`\SP'
     Produces some extra space, works also at the beginning of lines.
     The code of the second line looks like: \SP abc \SP\SP xx\\:
     abc       xx
     . 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.


File: latex2man.info,  Node: Accepted Macros from the rcsinfo Package,  Next: Accepted LaTeX Macros,  Prev: Package Specific Macros,  Up: Top

Accepted Macros from the rcsinfo Package
----------------------------------------

`\rcsInfo $Id ...$'
     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
     typeset the date coded in the $Id ..$ string.


File: latex2man.info,  Node: Accepted LaTeX Macros,  Next: Conditional Text,  Prev: Accepted Macros from the rcsinfo Package,  Up: Top

Accepted LaTeX Macros
---------------------

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.

     _Synopsis_ must be the first section after the Name environment.

     Note: Do not use LaTeX-macrosin section names.

`\subsection{..}'
     works as well as

`\subsubsection{..}'
     those.

`\emph{..}'
     \emph{example} is typeset as _example_.

`\textbf{..}'
     \textbf{example} is typeset as *example*.

`\texttt{..}'
     \texttt{example} is typeset as example.

`\underline{..}'
     \underline{example} is typeset as example of underline.

`\date{..}'
     uses .. as date.

`\verb+..+'
     but only + is allowed as delimiter.

`$<$'
     is typeset as <.

`$>$'
     is typeset as >.

`$<=$'
     is typeset as <=.

`$>=$'
     is typeset as >=.

`$=$'
     is typeset as =.

`$<>$'
     is typeset as <>.

`$\ge$'
     is typeset as $>=$.

`$\le$'
     is typeset as $<=$.

`$\leftarrow$'
     is typeset as $<-$.

`$\Leftarrow$'
     is typeset as $<==$.

`$\rightarrow$'
     is typeset as $->$.

`$\Rightarrow$'
     is typeset as $==>$.

`\{'
     is typeset as {.

`\}'
     is typeset as }.

`\$'
     is typeset as $.

`\$'
     is typeset as $,should be used inside macro arguments.

`\_'
     is typeset as _.

`\&'
     is typeset as &.

`\#'
     is typeset as #.

`\%'
     is typeset as %.

`\,'
     is typeset as smaller blank - - (between the two -)

`\-'
     is used to mark hyphenation in a word.

`\\'
     is typeset as a linebreak or marks the end of a column in the 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 indentation (see
     the \SP command).

`~'
     is typeset as a blank.

`\copyright'
     is typeset as (C).

`\noindent'

`\hline'
     inside a Table environment.

`\item'
     inside a itemize, enumerate, or description environment.

`\today'
     05 June 2018(see also the rcsinfo LaTeXpackage).

`\ss,\"a, ...'
     \ss = ss, \"a= a", \"o= o", \"u= u", \"A= A", \"O= O", \"U= 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{äöüÄÖÜß}
     *a"o"u"A"O"U"ss a"o"u"A"O"U"ss a"o"u"A"O"U"ss*

     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. A" becomes &Auml; in HTML and @"A in texinfo.

`\input{..}'
     Read and process the given filename.

   Please note: the name of the LaTeX-macrosand its arguments must be
contained in one line.


File: latex2man.info,  Node: Conditional Text,  Next: Translation of User Defined Macros,  Prev: Accepted LaTeX Macros,  Up: Top

Conditional Text
----------------

latex2man preprocesses the LaTeX input to allow text to be used
conditionally. A special sort of LaTeX comment is used for that purpose.
   * %@% IF _condition_ %@%

   * %@% ELSE %@%

   * %@% 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
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
nested. As boolean operators the following are allowed:

||                               boolean or
&&                               boolean and
!                                negation

   ( and ) for grouping are allowed.

For example:
%@% IF abc %@%
abc set
%@%  IF xyz %@%
xyz set
%@%  ELSE %@%
xyz NOT set
%@%  END-IF %@%
%@% ELSE %@%
abc NOT set
%@%  IF xyz || !XYZ %@%
xyz OR !XYZ set
%@%  ELSE %@%
xyz OR !XYZ NOT set
%@%  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
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;

`-CTEXI'
     the lines 1b, 2a, 3b, and 4b;

`-CMAN'
     the lines 1b, 2b, 3a, and 4b;

`-CLATEX'
     the lines 1b, 2b, 3b, and 4a;

`calling LaTeX without preprocessing'
     all lines
   should be shown:

   1b. The HTML conditional was not set.

   2a. This text occurs only when viewing the TEXI output

   3b. The MAN conditional was not set.

   4b. The LATEX conditional was not set.


File: latex2man.info,  Node: Translation of User Defined Macros,  Next: Verbatim Environment,  Prev: Conditional Text,  Up: Top

Translation of User Defined Macros
----------------------------------

The user macro translation file (given by the [ -tTRANSFILE ]) 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:

   * Comments start with a # up to the end of the line.

   * For a macro \foo with no arguments, the following code must be
     specified:
    `Translation to Man-Pages'
          $manMacro{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro{'foo'} = '...';

     where ... is the translation.

   * For a macro \foo{..} with one argument, the following code must be
     specified:
    `Translation to Man-Pages'
          $manMacro1a{'foo'} = '...';
          $manMacro1b{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro1a{'foo'} = '...';
          $htmlMacro1b{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro1a{'foo'} = '...';
          $texiMacro1b{'foo'} = '...';

     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
     must be specified:
    `Translation to Man-Pages'
          $manMacro2a{'foo'} = '...';
          $manMacro2b{'foo'} = '...';
          $manMacro2c{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro2a{'foo'} = '...';
          $htmlMacro2b{'foo'} = '...';
          $htmlMacro2c{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro2a{'foo'} = '...';
          $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 after the
     second argument is set.

   * The file `latex2man.trans' contains some example code.


File: latex2man.info,  Node: Verbatim Environment,  Next: Subsection works,  Prev: Translation of User Defined Macros,  Up: Top

Verbatim Environment
--------------------

.This
.    {is}
.        \texttt{a}
.                  $test$
.                         _of_
.verbatim
.<this is no HTML tag> and no @* TexInfo command

File: latex2man.info,  Node: Subsection works,  Next: Subsubsection works,  Prev: Verbatim Environment,  Up: Top

Subsection works
----------------

This is a \subsection.


File: latex2man.info,  Node: Subsubsection works,  Next: Subsubsection still works,  Prev: Subsection works,  Up: Top

Subsubsection works
...................

This is a \subsubsection.


File: latex2man.info,  Node: Subsubsection still works,  Next: General Remarks,  Prev: Subsubsection works,  Up: Top

Subsubsection still works
.........................

This is another \subsubsection.


File: latex2man.info,  Node: General Remarks,  Next: CSS classnames,  Prev: Subsubsection still works,  Up: Top

General Remarks
---------------

  1. Empty lines are typeset as paragraph separators.

  2. The arguments of the LaTeX commands must not be split over several
     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 will
     cause garbage in the output.

  5. latex2man requires Perl version >= 5.0004_03.

  6. If you want to install the system with the distributed `Makefile',
     you need GNU-make.  If you don't have it, you should execute the
     steps shown in the `Makefile' manually.


File: latex2man.info,  Node: CSS classnames,  Next: Some Bug Fix Tests,  Prev: General Remarks,  Up: Top

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 CSSFILE for these classes:


*HTML tag*             *Class*                *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 _Name_
                                              environment
h4                     authorhead             the author at the top
                                              of the HTML page
                                              specified as an
                                              argument to the _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
                                              _setVersion_ macro
h2                     sectionname            a section title
                                              specified as an
                                              argument to the
                                              _section_ macro
h4                     subsectionname         a subsection title
                                              specified as an
                                              argument to the
                                              _subsection_ macro
h5                     subsubsectionname      a subsubsection title
                                              specified as an
                                              argument to the
                                              _subsubsection_ macro
font                   progname               a program name
                                              specified as an
                                              argument to the _Prog_
                                              macro
font                   filename               a file name specified
                                              as an argument to the
                                              _File_ macro
font                   commandname            a command name
                                              specified as an
                                              argument to the _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 _Opt_,
                                              _oOpt_, _OptArg_,
                                              _oOptArg_ or
                                              _oOptoArg_ macros
font                   argstyle               a name of an argument
                                              specified as an
                                              argument to the _Arg_,
                                              _oArg_, _OptArg_,
                                              _oOptArg_ or
                                              _oOptoArg_ macros
a, font                urlstyle               a URL specified as an
                                              argument to the _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
                                              _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 _Table_ environment
tr                     rowstyle               a row of a table
                                              specified as a _Table_
                                              environment
td                     cellstyle              a cell of a table
                                              specified as a _Table_
                                              environment


File: latex2man.info,  Node: Some Bug Fix Tests,  Next: Requirements,  Prev: CSS classnames,  Up: Top

Some Bug Fix Tests
==================

`Leading . and ''
     Now leading . and ' in generation troff output should work
     propperly, since a \& is added. Therfore the \Dot macro has been
     deleted.
     Thanks to <Frank.Schilder@Mathematik.Tu-Ilmenau.De>.
     Testcase 1:
    `'\n''
          ...
     Testcase 2:
     `.foobar' Testcase 3:
     ...  abc ...abc . efg ' 123

`% in verbatim'
     A % in a \verb and verbatim-environment was not emitted correctly.
     Thanks to Aleksey Nogin <nogin@cs.caltech.edu> for the bug report
     and bug fix.

     % abc

     .   % abc %
     but ignore comments following this:



File: latex2man.info,  Node: Requirements,  Next: Changes,  Prev: Some Bug Fix Tests,  Up: Top

Requirements
============

`Perl'
     latex2man requires Perl version >= 5.0004_03.

`Make'
     If you want to install the system with the distributed `Makefile',
     you need GNU-make.  If you don't have it, you should execute the
     steps shown in the `Makefile' manually.

`LaTeX'
     LaTeX2e is required.


File: latex2man.info,  Node: Changes,  Next: Version,  Prev: Requirements,  Up: Top

Changes
=======

Please check the file `latex2man-CHANGES' for the list of changes and
acknowledgment to people contributing bugfixes or enhancements.


File: latex2man.info,  Node: Version,  Next: License and Copyright,  Prev: Changes,  Up: Top

Version
=======

Version: 1.27 of 2018/06/05.


File: latex2man.info,  Node: License and Copyright,  Next: Author,  Prev: Version,  Up: Top

License and Copyright
=====================

`Copyright'
     (C)1998, Dr. Ju"rgen Vollmer, Am Rennbuckel 21, D-76185 Karlsruhe,
     Germany,
     <Juergen.Vollmer@informatik-vollmer.de>

     The most recent version of Latex2man may be found on my homepage
     `http://www.informatik-vollmer.de/software/latex2man.html'.

`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.


File: latex2man.info,  Node: Author,  Prev: License and Copyright,  Up: Top

Author
======

Dr. Ju"rgen Vollmer
Am Rennbuckel 21
D-76185 Karlsruhe
Email: <Juergen.Vollmer@informatik-vollmer.de>
WWW: `http://www.informatik-vollmer.de'.



Tag Table:
Node: Top187
Node: Description1287
Node: Options2141
Node: Files4057
Node: See Also4922
Node: LaTeX commands5078
Node: Package Options5361
Node: Package Specific Environments5813
Node: Accepted LaTeX Environments8601
Node: Package Specific Macros9133
Node: Accepted Macros from the rcsinfo Package12719
Node: Accepted LaTeX Macros13216
Node: Conditional Text16432
Node: Translation of User Defined Macros18470
Node: Verbatim Environment20584
Node: Subsection works20910
Node: Subsubsection works21085
Node: Subsubsection still works21274
Node: General Remarks21480
Node: CSS classnames22218
Node: Some Bug Fix Tests27899
Node: Requirements28637
Node: Changes29051
Node: Version29290
Node: License and Copyright29433
Node: Author30230

End Tag Table