summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latex2man/latex2man.texi
blob: d299fa1907fab995a0818baf7b9aabddc1842d28 (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
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename latex2man.info
@settitle latex2man
@c %**end of header
@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
* Latex2man: (latex2man). Its Man-Page 
@end direntry
@titlepage
@title latex2man
@subtitle Documentation Tools
@author Dr.~J@"urgen Vollmer
@end titlepage
@node Top, Description, (dir), (dir)
@top 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). 

@section Synopsis


latex2man
[ -t@var{transfile} ]
[ -c@var{CSSfile} ]
[ -HMTL ]
[ -h ]
[ -V ]
[ -C@var{name} ]
@*
[ -a@var{char} ]
@var{infile}
@var{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:: 
@end menu
@node Description,  Options,  Top, Top  
@section Description

Latex2man
reads the file @var{infile}
and writes @var{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 @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 
troff(1).

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

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

@node Options,  Files,  Description, Top  
@section Options

@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). 
@item -H
Instead of producing output suitable for the man(1)
command, HTML code is produced (despite the name of the command). 
@item -T
Instead of producing output suitable for the man(1)
command, TexInfo code is produced (despite the name of the command). The 
generated @file{.texi}-file
may be processed with makeinfo(1)
(to produce an @file{.info}-file)
which in turn may be installed using 
install-info(1).
The Info tags @t{@@dircategory} and 
@t{@@direntry} are provided. 
@item -L
The LaTeX source is written to the @var{outfile}.
This is 
useful in conjunction with the -C@var{name}
option. 
@item -C@var{name}
Output the conditional text for @var{name}.
If more 
than one name should be given use quotes: -C@var{'name1 name2 ...'}@*

The following names are defined automatically: 
@itemize @bullet
@item
-H defines @t{HTML}
@item
-T defines @t{TEXI}
@item
-M defines @t{MAN}
@item
-L defines @t{LATEX}
@end itemize
@item -a@var{char}
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 @var{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 @var{char}
is printed. 
@item -h
Show a help text. 
@item -V
Show version information. 
@end table

@node Files,  See Also,  Options, Top  
@section Files


@table @samp
@item @file{latex2man.tex}
The LaTeX file containing this Man-page. 
@item @file{latex2man.sty}
The LaTeX package defining the environments and 
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. 
@item @file{fancyheadings.sty}
A LaTeX package used to typeset head- and 
foot lines. 
@item @file{fancyhdr.sty}
A LaTeX package used to typeset head- and foot 
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  
@section See Also


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

@node LaTeX commands, Package Options,  See Also, Top  
@section LaTeX commands


The LaTeX package @t{latex2man}
is used to write the Man-pages with 
LaTeX.Since we translate into other text formats, not all LaTeX stuff can 
be translated. 

@node Package Options,  Package Specific Environments,  LaTeX commands, Top 
@subsection Package Options

The @t{latex2man}
package accepts the following options: 

@table @samp
@item fancy
use the LaTeX package @t{fancyheadings}.
@item fancyhdr
use the LaTeX package @t{fancyhdr}.
@item nofancy
neither the LaTeX package @t{fancyheadings}
nor 
@t{fancyhdr}
are used. 
@end table

The default option may be specified in the file @t{latex2man.cfg}.

@node Package Specific Environments,  Accepted LaTeX Environments, Package Options, Top  
@subsection Package Specific Environments


The following environments are provided by the package: 
@table @samp
@item \begin@{Name@}@{chapter@}@{name@}@{author@}@{info@}@{title@} 
The 
@t{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 @t{Name}
environment must be the first 
environment in the document. Processing starts with this environment. Any 
text before this is ignored (exception: the @t{setVersion} and 
@t{setDate} commands). (Note: all arguments of \begin@{Name@} must 
be written on one line). 
@item \begin@{Table@}[width]@{columns@}
The @t{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: 

@t{\begin@{Table@}[2cm]@{3@}} @*

@t{Here & am & I \\\hline} @*

@t{A 1 & A 2 & A 3 1 2 3 4 5 A 3 1 2 3 4 5 \\} @*

@t{B 1 & B 2 & B 3 \\} @*

@t{\end@{Table@}} 

will be typeset as: 

@multitable @columnfractions  0.3 0.3 0.3
@item Here @tab  am @tab  I 

@item 
A 1 @tab  A 2 @tab  A 3 1 2 3 4 5 A 3 1 2 3 4 5

@item B 1 @tab  B 2 @tab  B 3 

@end multitable

If no optional @emph{width}
argument is given, all entries are 
typeset left justified. 
The @emph{width}
is a length measured absolutly in @emph{cm}.
Processing with LaTeX a @t{p@{width@}} column is typeset 
as last column. The translation to troff(1)
commands 
results in a @t{lw(width)}
column specification. Translating 
to HTML and TexInfo ignores the @emph{width}
parameter. 

@t{\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. 
@item \begin@{Description@}
is the same as \begin@{description@} 
@item \begin@{Description@}[label]
is similar to 
\begin@{description@}, but the item labels have at minimum the size 
of the (optional) word @emph{label}.
The difference is visible only 
in the DVI and PDF-output, not in the troff, TexInfo or HTML output. 
@table @samp
@item a
|a @t{\begin@{description@}} 
@item ab
|ab 
@item abc
|abc 
@end table
@table @samp
@item a
|a @t{\begin@{Description@}} 
@item ab
|ab 
@item abc
|abc 
@end table
@table @samp
@item a
|a @t{\begin@{Description@}[aa]} 
@item ab
|ab 
@item abc
|abc 
@end table
@end table

@node Accepted LaTeX Environments, Package Specific Macros,  Package Specific Environments, Top  
@subsection Accepted LaTeX Environments


The following environments are accepted: 
@itemize @bullet
@item
@t{description}
@item
@t{enumerate}
@item
@t{itemize}
@item
@t{verbatim}
@item
@t{center}
@end itemize

They may be nested: 
@itemize @bullet
@item
Itemize and nested center: 

@center A centered line.@*
@center Another centered line. 
@center 
@item
Another item an nested enumerate 
@enumerate
@item
a 
@item
b 
@end enumerate
@end itemize

@node Package Specific Macros,  Accepted Macros from the rcsinfo Package,  Accepted LaTeX Environments, Top 
@subsection Package Specific Macros


The following commands are provided: 
@table @samp
@item \Opt@{option@}
Option: @t{\Opt@{-o@}} will be typeset as -o.
@item \Arg@{argument@}
Argument: @t{\Arg@{filename@}} will be typeset as 
@var{filename}.
@item \OptArg@{option@}@{argument@}
Option with Argument:@*

@t{\OptArg@{-o@}@{filename@}} will be typeset as -o@var{filename}.
@item \OptoArg@{option@}@{argument@}
Option with optional Argument:@*

@t{\OptoArg@{-o@}@{filename@}} will be 
typeset as -o[@var{filename}].
@item \oOpt@{option@}
Optional option, e.g.  @t{\oOpt@{-o@}} will be 
typeset as [ -o ].
@item \oArg@{argument@}
Optional argument, e.g.  @t{\oArg@{filename@}} 
will be typeset as [ @var{filename} ].
@item \oOptArg@{option@}@{argument@}
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.@*

@t{\oOptoArg@{-o@}@{filename@}} will be typeset as [ -o[@var{filename}] ].
@item \File@{filename@}
used to typeset filenames, e.g.  
@t{\File@{filename@}} will be typeset as @file{filename}.
@item \Prog@{prog@}
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).
@item \Bar
is typeset as |.
@item \Bs
(BackSlash) is typeset as \.
@item \Tilde
is typeset as a ~.
@item \Dots
is typeset as ...
@item \Bullet
us typeset as *.
@item \setVersion@{..@}
set @t{..} as version information. 
@item \setVersionWord@{..@}
set @t{..} for the word @emph{Version:}
in 
the footline.@*

The default is @t{\setVersionWord@{Version:@}}. 
@item \Version
returns the version information. 
@item \setDate@{..@}
sets @t{..} as date information. 
@item \Date
returns the date information. 
@item \Email@{..@}
use to mark an Email address:@*

@t{\Email@{Juergen.Vollmer@@informatik-vollmer.de@}} is typeset as:@*

@email{Juergen.Vollmer@@informatik-vollmer.de}.
@item \URL@{..@}
use to mark an URL: 
@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). 
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. 
@item \LBr, \RBr
is typeset as @{ and @} (these variants are 
needed when using @{ or @} as arguments to macros. 
@item \Circum
is typeset as ^.
@item \Percent
is typeset as %.
@item \TEXbr
If processed with LaTeX causes a linebreak (i.e.  is 
equivalent to \\).In the output of latex2man
this macro is 
ignored. 
@item \TEXIbr
If TexInfo output is generated, causes a linebreak (i.e.  is 
equivalent to \\),otherwise ignored. 
@item \MANbr
If Man-Page output is generated, causes a linebreak (i.e.  is 
equivalent to \\),otherwise ignored. 
@item \HTMLbr
If HTML output is generated, causes a linebreak (i.e.  is 
equivalent to \\),otherwise ignored. 
@item \medskip
An empty line. 
@item \SP
Produces some extra space, works also at the beginning of lines. 
The code of the second line looks like: 
@t{\SP abc \SP\SP xx\\}:@*

abc @ @ @ @ @ @ xx@*

.@ abc @ @ @ @ xx@*

.@ .@ abc @ @ xx 

Note: Due to some ``problems'' with TexInfo, the lines starting with 
@t{\SP}
have a leading . (dot) in the TexInfo output, 
see -a@var{char}.
@end table

@node Accepted Macros from the rcsinfo Package,  Accepted LaTeX Macros, Package Specific Macros, Top  
@subsection Accepted Macros from the rcsinfo Package


@table @samp
@item \rcsInfo $Id ...$
if the LaTeX package @file{rcsinfo}
is used, 
this command is used to extract the date of the Man-page. 
@item \rcsInfoLongDate
if the LaTeX package @file{rcsinfo}
is used, this 
command is used to typeset the date coded in the @t{$Id ..$} string. 
@end table

@node Accepted LaTeX Macros, Conditional Text,  Accepted Macros from the rcsinfo Package, Top  
@subsection Accepted LaTeX Macros


The following standard LaTeX commands are accepted: 
@table @samp
@item \section@{..@}
The @t{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: @emph{Name}
(special handling as environment, c.f.  above), @emph{Synopsis},
@emph{Description},
@emph{Options},
@emph{Files},
@emph{See Also},
@emph{Diagnostics},
@emph{Return Values},
@emph{Bugs},
@emph{Author},
@emph{version},
etc. 

@emph{Synopsis}
must be the first section after the @t{Name}
environment. 

Note: Do not use LaTeX-macrosin section names. 
@item \subsection@{..@}
works as well as 
@item \subsubsection@{..@}
those. 
@item \emph@{..@}
@t{\emph@{example@}} is typeset as @emph{example}.
@item \textbf@{..@}
@t{\textbf@{example@}} is typeset as @strong{example}.
@item \texttt@{..@}
@t{\textt@{example@}} is typeset as @t{example}.
@item \underline@{..@}
@t{\underline@{example@}} is typeset as 
example of underline.
@item \date@{..@}
uses @t{..} as date. 
@item \verb+..+
but only + is allowed as delimiter. 
@item $<$
is typeset as <. 
@item $>$
is typeset as >. 
@item $<=$
is typeset as <=. 
@item $>=$
is typeset as >=. 
@item $=$
is typeset as =. 
@item $<>$
is typeset as <>. 
@item $\ge$
is typeset as $>=$.
@item $\le$
is typeset as $<=$.
@item $\leftarrow$
is typeset as $<--$.
@item $\Leftarrow$
is typeset as $<==$.
@item $\rightarrow$
is typeset as $-->$.
@item $\Rightarrow$
is typeset as $==>$.
@item \@{
is typeset as @{. 
@item \@}
is typeset as @}. 
@item \$
is typeset as $. 
@item \$
is typeset as $,should be used inside macro 
arguments. 
@item \_
is typeset as _. 
@item \&
is typeset as &. 
@item \#
is typeset as #. 
@item \%
is typeset as %. 
@item \,
is typeset as smaller blank - - (between the two -) 
@item \-
is used to mark hyphenation in a word. 
@item \\
is typeset as a linebreak or marks the end of a column in the 
@t{Table}
environment. 
@item \
(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 @t{\SP}
command). 
@item ~
is typeset as a blank. 
@item \copyright
is typeset as @copyright{}.
@item \noindent
@item \hline
inside a @t{Table}
environment. 
@item \item
inside a @t{itemize},
@t{enumerate},
or 
@t{description}
environment. 
@item \today
22 December 2010(see also the @t{rcsinfo}
LaTeXpackage). 
@item \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@{äöüÄÖÜß@}@*

@strong{@"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. @t{@"A}
becomes @t{&Auml};
in HTML and @t{@@"A}
in texinfo. 
@end table

@node Conditional Text,  Translation of User Defined Macros,  Accepted LaTeX Macros, Top 
@subsection 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. 
@itemize @bullet
@item
%@@% IF @emph{condition} %@@%
@item
%@@% ELSE %@@% 
@item
%@@% END-IF %@@% 
@end itemize

A line must contain only such a comment and nothing else. @emph{condition}
is 
a boolean expression containing ``names'' and operators. The names given with 
the -C@var{name}
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 @t{IF/ELSE/END-IF}
may be nested. As boolean 
operators the following are allowed: 

@multitable @columnfractions  0.45 0.45
@item ||@tab  boolean or 

@item && @tab  boolean and 

@item ! @tab  negation 
@end multitable

( and ) for grouping are allowed. 

@noindent

For example:@*

%@@% IF abc %@@%@*

@t{}abc set@*

@t{}%@@%  IF xyz %@@%@*

@t{}xyz set@*

@t{}%@@%  ELSE %@@%@*

@t{}xyz NOT set@*

@t{}%@@%  END-IF %@@%@*

%@@% ELSE %@@%@*

@t{}abc NOT set@*

@t{}%@@%  IF xyz || !XYZ %@@%@*

@t{}xyz OR !XYZ set@*

@t{}%@@%  ELSE %@@%@*

@t{}xyz OR !XYZ NOT set@*

@t{}%@@%  END-IF %@@%@*

%@@% END-IF %@@%

@noindent

Run this manual page through latex2man
with e.g.  
-C@var{'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@*


@noindent

To check the conditional text feature, when latex2man
is called with 
@table @samp
@item -C@var{HTML}
the lines 1a, 2b, 3b, and 4b; 
@item -C@var{TEXI}
the lines 1b, 2a, 3b, and 4b; 
@item -C@var{MAN}
the lines 1b, 2b, 3a, and 4b; 
@item -C@var{LATEX}
the lines 1b, 2b, 3b, and 4a; 
@item calling LaTeX without preprocessing
all lines 
@end table
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. 

@node Translation of User Defined Macros,  Verbatim Environment,  Conditional Text, Top  
@subsection Translation of User Defined Macros


The user macro translation file (given by the [ -t@var{transfile} ])
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: 

@itemize @bullet
@item
Comments start with a # up to the end of the line. 
@item
For a macro @t{\foo} with no arguments, the following code must be 
specified: 
@table @samp
@item Translation to Man-Pages
@t{$manMacro@{'foo'@} = '...';} 
@item Translation to HTML
@t{$htmlMacro@{'foo'@} = '...';} 
@item Translation to TexInfo
@t{$texiMacro@{'foo'@} = '...';} 
@end table

where @t{...} is the translation. 

@item
For a macro @t{\foo@{..@}} with one argument, the following code must be 
specified: 
@table @samp
@item Translation to Man-Pages
@t{$manMacro1a@{'foo'@} = '...';}@*
 
@t{$manMacro1b@{'foo'@} = '...';} 
@item Translation to HTML
@t{$htmlMacro1a@{'foo'@} = '...';}@*
 
@t{$htmlMacro1b@{'foo'@} = '...';} 

@item Translation to TexInfo
@t{$texiMacro1a@{'foo'@} = '...';}@*
 
@t{$texiMacro1b@{'foo'@} = '...';} 
@end table

where @t{...} is the translation. The @t{1a} code is used before the 
argument, while @t{1b} is typeset after the argument is set. 

@item
For a macro @t{\foo@{..@}@{..@}} with two arguments, the following code 
must be specified: 
@table @samp
@item Translation to Man-Pages
@t{$manMacro2a@{'foo'@} = '...';}@*
 
@t{$manMacro2b@{'foo'@} = '...';}@*
 
@t{$manMacro2c@{'foo'@} = '...';} 
@item Translation to HTML
@t{$htmlMacro2a@{'foo'@} = '...';}@*
 
@t{$htmlMacro2b@{'foo'@} = '...';}@*
 
@t{$htmlMacro2c@{'foo'@} = '...';} 
@item Translation to TexInfo
@t{$texiMacro2a@{'foo'@} = '...';}@*
 
@t{$texiMacro2b@{'foo'@} = '...';}@*
 
@t{$texiMacro2c@{'foo'@} = '...';} 
@end table

where @t{...} is the translation. The @t{2a} code is used before the 
first argument, @t{2b} between the two arguments and @t{2c} is 
typeset after the second argument is set. 
@item
The file @file{latex2man.trans} contains some example code.
@end itemize

@node Verbatim Environment,  Subsection works,  Translation of User Defined Macros, Top  
@subsection Verbatim Environment


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

@node Subsection works,  Subsubsection works,  Verbatim Environment, Top  
@subsection Subsection works


This is a @t{\subsection}. 

@node Subsubsection works,  Subsubsection still works,  Subsection works, Top  
@subsubsection Subsubsection works


This is a @t{\subsubsection}. 

@node Subsubsection still works,  General Remarks,  Subsubsection works, Top  
@subsubsection Subsubsection still works


This is another @t{\subsubsection}. 

@node General Remarks,  CSS classnames,  Subsubsection still works, Top  
@subsection General Remarks


@enumerate
@item
Empty lines are typeset as paragraph separators. 
@item
The arguments of the LaTeX commands must not be split over several 
lines. 
@item
Do not nest calls to macros. 
@item
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. 
@item
latex2man requires Perl version >= 5.0004_03.
@item
If you want to install the system with the distributed @file{Makefile},
you need GNU-make.
If you don't have it, you should execute the 
steps shown in the @file{Makefile}
manually. 
@end enumerate

@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
@item Leading . and '
Now leading . and ' in generation troff output should work propperly, 
since a @t{\&} is added. Therfore the @t{\Dot} macro has been deleted.@*

Thanks to @email{Frank.Schilder@@Mathematik.Tu-Ilmenau.De}.@*

Testcase 1: 
@table @samp
@item '\n'
... 
@end table
Testcase 2:@*

@file{.foobar}
Testcase 3:@*

...
abc ...abc . efg ' 123 

@item % in verbatim
A % in a \verb and verbatim-environment was not 
emitted correctly. Thanks to Aleksey Nogin @email{nogin@@cs.caltech.edu}
for the bug report and bug fix. 

@t{% abc} 

@*
.@ @ @ %@ abc@ %@*

but ignore comments following this: 

@end table

@node Requirements,  Changes,  Some Bug Fix Tests, Top  
@section Requirements


@table @samp
@item Perl
latex2man
requires Perl version >= 5.0004_03. 
@item Make
If you want to install the system with the distributed 
@file{Makefile},
you need GNU-make.
If you don't have it, you 
should execute the steps shown in the @file{Makefile}
manually. 
@item LaTeX
LaTeX2e is required. 
@end table

@node Changes,  Version,  Requirements, Top  
@section Changes

Please check the file @url{latex2man-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.24 of 2010/12/22.

@node License and Copyright,  Author,  Version, Top  
@section License and Copyright


@table @samp
@item Copyright
@copyright{}1998, Dr. J@"urgen Vollmer, Viktoriastra@ss{}e 15, 
D-76133 Karlsruhe, Germany,@*

@email{Juergen.Vollmer@@informatik-vollmer.de}

The actual version of Latex2man
may be found on my homepage@*

@url{http://www.informatik-vollmer.de/software/latex2man.html}.

@item License
This program can be redistributed and/or modified under the 
terms of the LaTeX Project Public License Distributed from CTAN archives 
in directory @file{macros/latex/base/lppl.txt};
either version 1 of the 
License, or any later version. 

@item Misc
If you find this software useful, please send me a postcard from 
the place where you are living. 
@end table

@node Author,  ,  License and Copyright, Top  
@section Author


@noindent

Dr. J@"urgen Vollmer @*

Viktoriastra@ss{}e 15 @*

D-76133 Karlsruhe @*

Email: @email{Juergen.Vollmer@@informatik-vollmer.de}
@*
WWW: @url{http://www.informatik-vollmer.de}.

@bye
@c NOTE: This file is generated, DO NOT EDIT.