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 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
|
'\" t
.\" Manual page created with latex2man on Sun Nov 25 14:05:37 2018
.\" NOTE: This file is generated, DO NOT EDIT.
.de Vb
.ft CW
.nf
..
.de Ve
.ft R
.fi
..
.TH "LATEX2MAN" "1" "2018/11/25" "Documentation Tools " "Documentation Tools "
.SH NAME
.PP
Latex2man
is a tool to translate UNIX manual pages written with
LaTeXinto a format understood by the UNIX \fIman\fP(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).
.PP
.SH SYNOPSIS
.PP
latex2man
[\fB\-t\fP\fItransfile\fP]
[\fB\-c\fP\fICSSfile\fP]
[\fB\-HMTL\fP]
[\fB\-h\fP]
[\fB\-V\fP]
[\fB\-C\fP\fIname\fP]
[\fB\-a\fP\fIchar\fP]
\fIinfile\fP
\fIoutfile\fP
.PP
.SH DESCRIPTION
Latex2man
reads the file \fIinfile\fP
and writes \fIoutfile\fP\&.
The
input must be a LaTeX document using the latex2man
LaTeXpackage.
Latex2man
translates that document into the \fItroff\fP(1)
format using
the \fB\-man\fP
macro package.
.PP
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
\fItroff\fP(1)\&.
.PP
Using the \fB\-M\fP
option, \fItroff\fP(1)
input is produced.
.PP
Using the \fB\-L\fP
option, LaTeX ouput can be produced, instead of
\fItroff\fP(1)\&.
.PP
.SH OPTIONS
.TP
\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).
.TP
\fB\-H\fP
Instead of producing output suitable for the \fIman\fP(1)
command, HTML code is produced (despite the name of the command).
.TP
\fB\-T\fP
Instead of producing output suitable for the \fIman\fP(1)
command, TexInfo code is produced (despite the name of the command). The
generated \&.texi\-file
may be processed with \fImakeinfo\fP(1)
(to produce an \&.info\-file)
which in turn may be installed using
\fIinstall\-info\fP(1)\&.
The Info tags @dircategory and
@direntry are provided.
.TP
\fB\-L\fP
The LaTeX source is written to the \fIoutfile\fP\&.
This is
useful in conjunction with the \fB\-C\fP\fIname\fP
option.
.TP
\fB\-C\fP\fIname\fP
Output the conditional text for \fIname\fP\&.
If more
than one name should be given use quotes: \fB\-C\fP\fI\&'name1 name2 ...\&'\fP
.br
The following names are defined automatically:
.RS
.TP
.B *
\fB\-H\fP defines HTML
.TP
.B *
\fB\-T\fP defines TEXI
.TP
.B *
\fB\-M\fP defines MAN
.TP
.B *
\fB\-L\fP defines LATEX
.RE
.RS
.PP
.RE
.TP
\fB\-a\fP\fIchar\fP
Is used only in conjunction with \-T.
.br
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 \fIchar\fP
specifies an alternative for that first
character. Giving a blank to
\fB\-a\fP
supresses the indentation of a line.
.br
Note: only for the first \\SP of a series that \fIchar\fP
is printed.
.TP
\fB\-h\fP
Show a help text.
.TP
\fB\-V\fP
Show version information.
.PP
.SH FILES
.PP
.TP
latex2man.tex
The LaTeX file containing this Man\-page.
.TP
latex2man.inc
A file read with \\input{..} \&.
.TP
latex2man.sty
The LaTeX package defining the environments and
commands.
.TP
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.
.TP
fancyheadings.sty
A LaTeX package used to typeset head\- and
foot lines.
.TP
fancyhdr.sty
A LaTeX package used to typeset head\- and foot
lines.
.TP
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
LaTeX,TexInfo, \fItroff\fP(1),
\fIgroff\fP(1),
\fImakeinfo\fP(1)\&.
.PP
.SH LaTeX COMMANDS
.PP
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.
.PP
.SS PACKAGE OPTIONS
The latex2man
package accepts the following options:
.PP
.TP
fancy
use the LaTeX package fancyheadings\&.
.TP
fancyhdr
use the LaTeX package fancyhdr\&.
.TP
nofancy
neither the LaTeX package fancyheadings
nor
fancyhdr
are used.
.PP
The default option may be specified in the file latex2man.cfg\&.
.PP
.SS PACKAGE SPECIFIC ENVIRONMENTS
.PP
The following environments are provided by the package:
.TP
\\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).
.TP
\\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:
.PP
\\begin{Table}[2cm]{3}
.br
Here & am & I \\\\\\hline
.br
A 1 & A 2 & A 3 1 2 3 4 5 A 3 1 2 3 4 5 \\\\
.br
B 1 & B 2 & B 3 \\\\
.br
\\end{Table}
.PP
will be typeset as:
.PP
.TS
tab(&);
l l lw(2cm).
T{
Here
T}&T{
am
T}&T{
I
T}
_
T{
A 1
T}&T{
A 2
T}&T{
A 3 1 2 3 4 5 A 3 1 2 3 4 5
T}
T{
B 1
T}&T{
B 2
T}&T{
B 3
T}
.TE
.PP
If no optional \fIwidth\fP
argument is given, all entries are
typeset left justified.
The \fIwidth\fP
is a length measured absolutly in \fIcm\fP\&.
Processing with LaTeX a p{width} column is typeset
as last column. The translation to \fItroff\fP(1)
commands
results in a lw(width)
column specification. Translating
to HTML and TexInfo ignores the \fIwidth\fP
parameter.
.PP
\\hline may be used.
.PP
If the Man\-page is formatted with \fItroff\fP(1)
and tables are used, the
\fItbl\fP(1)
preprocessor should be called, usually by giving
a \fB\-t\fP
to the call of \fItroff\fP(1)\&.
When viewing the generated
manula page using \fIman\fP(1),
\fItbl\fP(1)
is called automatically.
.TP
\\begin{Description}
is the same as \\begin{description}
.TP
\\begin{Description}[label]
is similar to
\\begin{description}, but the item labels have at minimum the size
of the (optional) word \fIlabel\fP\&.
The difference is visible only
in the DVI and PDF\-output, not in the troff, TexInfo or HTML output.
.RS
.TP
a
|a \\begin{description}
.TP
ab
|ab
.TP
abc
|abc
.RE
.RS
.PP
.RS
.RE
.TP
a
|a \\begin{Description}
.TP
ab
|ab
.TP
abc
|abc
.RE
.RS
.PP
.RS
.RE
.TP
a
|a \\begin{Description}[aa]
.TP
ab
|ab
.TP
abc
|abc
.RE
.RS
.PP
.RE
.PP
.SS ACCEPTED LaTeX ENVIRONMENTS
.PP
The following environments are accepted:
.TP
.B *
description
.TP
.B *
enumerate
.TP
.B *
itemize
.TP
.B *
verbatim
.TP
.B *
center
.PP
They may be nested:
.TP
.B *
Itemize and nested center:
.ce 100
A centered line.
.br
Another centered line.
.ce 0
.TP
.B *
Another item an nested enumerate
.RS
.TP
1.
a
.TP
2.
b
.RE
.RS
.PP
.RE
.PP
.SS PACKAGE SPECIFIC MACROS
.PP
The following commands are provided:
.TP
\\Opt{option}
Option: \\Opt{\-o} will be typeset as \fB\-o\fP\&.
.TP
\\Arg{argument}
Argument: \\Arg{filename} will be typeset as
\fIfilename\fP\&.
.TP
\\OptArg{option}{argument}
Option with Argument:
.br
\\OptArg{\-o}{filename} will be typeset as \fB\-o\fP\fIfilename\fP\&.
.TP
\\OptoArg{option}{argument}
Option with optional Argument:
.br
\\OptoArg{\-o}{filename} will be
typeset as \fB\-o\fP[\fIfilename\fP]\&.
.TP
\\oOpt{option}
Optional option, e.g. \\oOpt{\-o} will be
typeset as [\fB\-o\fP]\&.
.TP
\\oArg{argument}
Optional argument, e.g. \\oArg{filename}
will be typeset as [\fIfilename\fP]\&.
.TP
\\oOptArg{option}{argument}
Optional option with argument, e.g.
.br
\\oOptArg{\-o}{filename} will be typeset as [\fB\-o\fP\fIfilename\fP]\&.
.TP
\\oOptoArg{option}{argument}
Optional option with optional
argument, e.g.
.br
\\oOptoArg{\-o}{filename} will be typeset as [\fB\-o\fP[\fIfilename\fP]]\&.
.TP
\\File{filename}
used to typeset filenames, e.g.
\\File{filename} will be typeset as filename\&.
.TP
\\Prog{prog}
used to typeset program names, e.g.
\\Prog{latex2man} will be typeset as latex2man\&.
.TP
\\Cmd{command}{chapter}
used to typeset references to other
commands, e.g.
.br
\\Cmd{latex2man}{1} will be typeset as \fIlatex2man\fP(1)\&.
.TP
\\Bar
is typeset as |\&.
.TP
\\Bs
(BackSlash) is typeset as \\\&.
.TP
\\Tilde
is typeset as a ~\&.
.TP
\\Dots
is typeset as \&...
.TP
\\Bullet
us typeset as *\&.
.TP
\\setVersion{\&.\&.}
set \&.. as version information.
.TP
\\setVersionWord{\&.\&.}
set \&.. for the word \fIVersion:\fP
in
the footline.
.br
The default is \\setVersionWord{Version:}\&.
.TP
\\Version
returns the version information.
.TP
\\setDate{\&.\&.}
sets \&.. as date information.
.TP
\\Date
returns the date information.
.TP
\\Email{\&.\&.}
use to mark an Email address:
.br
\\Email{Juergen.Vollmer@informatik\-vollmer.de} is typeset as:
.br
\fBJuergen.Vollmer@informatik\-vollmer.de\fP\&.
.TP
\\URL{\&.\&.}
use to mark an URL:
\\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
.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
.br
\\item[FooBar\\LBr xx \\Lbr]\&. Usually [ ] will work.
.TP
\\LBr, \\RBr
is typeset as { and } (these variants are
needed when using { or } as arguments to macros.
.TP
\\Circum
is typeset as ^\&.
.TP
\\Percent
is typeset as %\&.
.TP
\\TEXbr
If processed with LaTeX causes a linebreak (i.e. is
equivalent to \\\\).In the output of latex2man
this macro is
ignored.
.TP
\\TEXIbr
If TexInfo output is generated, causes a linebreak (i.e. is
equivalent to \\\\),otherwise ignored.
.TP
\\MANbr
If Man\-Page output is generated, causes a linebreak (i.e. is
equivalent to \\\\),otherwise ignored.
.TP
\\HTMLbr
If HTML output is generated, causes a linebreak (i.e. is
equivalent to \\\\),otherwise ignored.
.TP
\\medskip
An empty line.
.TP
\\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\\\\:
.br
abc \fB \fP\fB \fP\fB \fPxx
.br
\fB \fPabc \fB \fP\fB \fPxx
.br
\fB \fP\fB \fPabc \fB \fPxx
.PP
Note: Due to some ``problems\&'' with TexInfo, the lines starting with
\\SP
have a leading \&. (dot) in the TexInfo output,
see \fB\-a\fP\fIchar\fP\&.
.PP
.SS ACCEPTED MACROS FROM THE RCSINFO PACKAGE
.PP
.TP
\\rcsInfo $Id ...$
if the LaTeX package rcsinfo
is used,
this command is used to extract the date of the Man\-page.
.TP
\\rcsInfoLongDate
if the LaTeX package rcsinfo
is used, this
command is used to typeset the date coded in the $Id ..$ string.
.PP
.SS ACCEPTED LaTeX MACROS
.PP
The following standard LaTeX commands are accepted:
.TP
\\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: \fIName\fP
(special handling as environment, c.f. above), \fISynopsis\fP,
\fIDescription\fP,
\fIOptions\fP,
\fIFiles\fP,
\fISee Also\fP,
\fIDiagnostics\fP,
\fIReturn Values\fP,
\fIBugs\fP,
\fIAuthor\fP,
\fIversion\fP,
etc.
.PP
\fISynopsis\fP
must be the first section after the Name
environment.
.PP
Note: Do not use LaTeX\-macrosin section names.
.TP
\\subsection{\&.\&.}
works as well as
.TP
\\subsubsection{\&.\&.}
those.
.TP
\\emph{\&.\&.}
\\emph{example} is typeset as \fIexample\fP\&.
.TP
\\textbf{\&.\&.}
\\textbf{example} is typeset as \fBexample\fP\&.
.TP
\\texttt{\&.\&.}
\\texttt{example} is typeset as example\&.
.TP
\\underline{\&.\&.}
\\underline{example} is typeset as
.ul
example of underline
\&.
.TP
\\date{\&.\&.}
uses \&.. as date.
.TP
\\verb+..+
but only + is allowed as delimiter.
.TP
$<$ is typeset as <\&.
.TP
$>$ is typeset as >\&.
.TP
$<=$ is typeset as <=\&.
.TP
$>=$ is typeset as >=\&.
.TP
$=$ is typeset as =\&.
.TP
$<>$ is typeset as <>\&.
.TP
$\\ge$
is typeset as $>=$.
.TP
$\\le$
is typeset as $<=$.
.TP
$\\leftarrow$
is typeset as $<--$.
.TP
$\\Leftarrow$
is typeset as $<==$.
.TP
$\\rightarrow$
is typeset as $-->$.
.TP
$\\Rightarrow$
is typeset as $==>$.
.TP
\\{ is typeset as {\&.
.TP
\\} is typeset as }\&.
.TP
\\$ is typeset as $\&.
.TP
\\$ is typeset as $,should be used inside macro
arguments.
.TP
\\_ is typeset as _\&.
.TP
\\& is typeset as &\&.
.TP
\\# is typeset as #\&.
.TP
\\% is typeset as %\&.
.TP
\\,
is typeset as smaller blank \- \- (between the two \-)
.TP
\\\-
is used to mark hyphenation in a word.
.TP
\\\\ is typeset as a linebreak or marks the end of a column in the
Table
environment.
.TP
\\ (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).
.TP
~ is typeset as a blank.
.TP
\\copyright
is typeset as (C)\&.
.TP
\\noindent
.TP
\\hline
inside a Table
environment.
.TP
\\item
inside a itemize,
enumerate,
or
description
environment.
.TP
\\today
25 November 2018(see also the rcsinfo
LaTeXpackage).
.TP
\\ss,\\"a, ...
\\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.
.Vb
\\textbf{\\"a\\"o\\"u\\"A\\"O\\"U\\ss}
\\textbf{\\"a}{\\"o}{\\"u}{\\"A}{\\"O}{\\"U}{\\ss}}
\\textbf{}
.Ve
.PP
\fB \fP
.PP
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.
.TP
\\input{\&.\&.}
Read and process the given filename.
.PP
Please note: the name of the LaTeX\-macrosand its arguments must be contained in one line.
.PP
.SS CONDITIONAL TEXT
.PP
latex2man
preprocesses the LaTeX input to allow text to be used
conditionally. A special sort of LaTeX comment is used for that purpose.
.TP
.B *
%@% IF \fIcondition\fP %@%
.TP
.B *
%@% ELSE %@%
.TP
.B *
%@% END\-IF %@%
.PP
A line must contain only such a comment and nothing else. \fIcondition\fP
is
a boolean expression containing ``names\&'' and operators. The names given with
the \fB\-C\fP\fIname\fP
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:
.PP
.TS
tab(&);
l l.
T{
||T}&T{
boolean or
T}
T{
&&T}&T{
boolean and
T}
T{
!
T}&T{
negation
.TE
.PP
( and ) for grouping are allowed.
.PP
For example:
.br
%@% IF abc %@%
.br
abc set
.br
%@% IF xyz %@%
.br
xyz set
.br
%@% ELSE %@%
.br
xyz NOT set
.br
%@% END\-IF %@%
.br
%@% ELSE %@%
.br
abc NOT set
.br
%@% IF xyz || !XYZ %@%
.br
xyz OR !XYZ set
.br
%@% ELSE %@%
.br
xyz OR !XYZ NOT set
.br
%@% END\-IF %@%
.br
%@% END\-IF %@%
.PP
Run this manual page through latex2man
with e.g.
\fB\-C\fP\fI\&'abc XYZ\&'\fP
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
abc NOT set
.br
xyz OR !XYZ set
.br
.PP
To check the conditional text feature, when latex2man
is called with
.TP
\fB\-C\fP\fIHTML\fP
the lines 1a, 2b, 3b, and 4b;
.TP
\fB\-C\fP\fITEXI\fP
the lines 1b, 2a, 3b, and 4b;
.TP
\fB\-C\fP\fIMAN\fP
the lines 1b, 2b, 3a, and 4b;
.TP
\fB\-C\fP\fILATEX\fP
the lines 1b, 2b, 3b, and 4a;
.TP
calling LaTeX without preprocessing
all lines
.PP
should be shown:
.PP
1b. The HTML conditional was not set.
.PP
2b. The TEXI conditional was not set.
.PP
3a. This text occurs only when viewing the MAN output
.PP
4b. The LATEX conditional was not set.
.PP
.SS TRANSLATION OF USER DEFINED MACROS
.PP
The user macro translation file (given by the [\fB\-t\fP\fItransfile\fP])
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:
.PP
.TP
.B *
Comments start with a # up to the end of the line.
.TP
.B *
For a macro \\foo with no arguments, the following code must be
specified:
.RS
.TP
Translation to Man\-Pages
$manMacro{'foo'} = '...';
.TP
Translation to HTML
$htmlMacro{'foo'} = '...';
.TP
Translation to TexInfo
$texiMacro{'foo'} = '...';
.RE
.RS
.PP
where \&... is the translation.
.PP
.RE
.TP
.B *
For a macro \\foo{..} with one argument, the following code must be
specified:
.RS
.TP
Translation to Man\-Pages
$manMacro1a{'foo'} = '...';
.br
$manMacro1b{'foo'} = '...';
.TP
Translation to HTML
$htmlMacro1a{'foo'} = '...';
.br
$htmlMacro1b{'foo'} = '...';
.RS
.PP
.RE
.TP
Translation to TexInfo
$texiMacro1a{'foo'} = '...';
.br
$texiMacro1b{'foo'} = '...';
.RE
.RS
.PP
where \&... is the translation. The 1a code is used before the
argument, while 1b is typeset after the argument is set.
.PP
.RE
.TP
.B *
For a macro \\foo{..}{..} with two arguments, the following code
must be specified:
.RS
.TP
Translation to Man\-Pages
$manMacro2a{'foo'} = '...';
.br
$manMacro2b{'foo'} = '...';
.br
$manMacro2c{'foo'} = '...';
.TP
Translation to HTML
$htmlMacro2a{'foo'} = '...';
.br
$htmlMacro2b{'foo'} = '...';
.br
$htmlMacro2c{'foo'} = '...';
.TP
Translation to TexInfo
$texiMacro2a{'foo'} = '...';
.br
$texiMacro2b{'foo'} = '...';
.br
$texiMacro2c{'foo'} = '...';
.RE
.RS
.PP
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.
.RE
.TP
.B *
The file latex2man.trans contains some example code.
.PP
.SS VERBATIM ENVIRONMENT
.PP
.Vb
This
{is}
\\texttt{a}
$test$
_of_
verbatim
<this is no HTML tag> and no @* TexInfo command
.Ve
.PP
.SS SUBSECTION WORKS
.PP
This is a \\subsection\&.
.PP
.SS Subsubsection works
.PP
This is a \\subsubsection\&.
.PP
.SS Subsubsection still works
.PP
This is another \\subsubsection\&.
.PP
.SS GENERAL REMARKS
.PP
.TP
1.
Empty lines are typeset as paragraph separators.
.TP
2.
The arguments of the LaTeX commands must not be split over several
lines.
.TP
3.
Do not nest calls to macros.
.TP
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.
.TP
5.
latex2man requires Perl version >= 5.0004_03.
.TP
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.
.PP
.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 \&'
Now leading \&. and \&' in generation troff output should work propperly,
since a \\& is added. Therfore the \\Dot macro has been deleted.
.br
Thanks to \fBFrank.Schilder@Mathematik.Tu\-Ilmenau.De\fP\&.
.br
Testcase 1:
.RS
.TP
\&'\\n\&'
\&.\&.\&.
.RE
.RS
.PP
Testcase 2:
.br
\&.foobar
Testcase 3:
.br
\&...
.PP
abc \&...
abc \&. efg \&' 123
.PP
.RE
.TP
%in verbatim
A % in a \\verb and verbatim\-environment was not
emitted correctly. Thanks to Aleksey Nogin \fBnogin@cs.caltech.edu\fP
for the bug report and bug fix.
.PP
% abc
.PP
.Vb
% abc %
.Ve
.PP
but ignore comments following this:
.PP
.SH REQUIREMENTS
.PP
.TP
Perl
latex2man
requires Perl version >= 5.0004_03.
.TP
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.
.TP
LaTeX LaTeX2e is required.
.PP
.\" *********************************** start of \input{latex2man.inc}
.SH CHANGES
Please check the file \fBlatex2man\-CHANGES\fP
for the list of changes and
acknowledgment to people contributing bugfixes or enhancements.
.PP
.\" *********************************** end of \input{latex2man.inc}
.SH VERSION
.PP
Version: 1.29 of 2018/11/25\&.
.PP
.SH LICENSE AND COPYRIGHT
.PP
.TP
Copyright
(C)1998, Dr. Jrgen Vollmer, Am Rennbuckel 21,
D\-76185 Karlsruhe, Germany,
.br
\fBJuergen.Vollmer@informatik\-vollmer.de\fP
.PP
The most recent version of Latex2man
may be found on my homepage
.br
\fBhttp://www.informatik\-vollmer.de/software/latex2man.html\fP\&.
.PP
.TP
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.
.PP
.TP
Misc
If you find this software useful, please send me a postcard from
the place where you are living.
.PP
.SH AUTHOR
.PP
Dr. Jrgen Vollmer
.br
Am Rennbuckel 21
.br
D\-76185 Karlsruhe
.br
Email: \fBJuergen.Vollmer@informatik\-vollmer.de\fP
.br
WWW: \fBhttp://www.informatik\-vollmer.de\fP\&.
.PP
.\" NOTE: This file is generated, DO NOT EDIT.
|