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
|
.\" -*- nroff -*-
.TH GROFF_MAN 7 "7 November 2018" "Groff Version 1.22.3"
.SH NAME
groff_man \- groff man macros to support generation of man pages
.
.
.\" --------------------------------------------------------------------
.\" Legal Terms
.\" --------------------------------------------------------------------
.
.de co
Copyright \[co] 1999-2014 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
..
.
.de au
This manual page was originally written for the Debian GNU/Linux
system by
.MT sgk@debian.org
Susan G.\& Kleinmann
.ME .
It was corrected and updated by
.MT wl@gnu.org
Werner Lemberg
.ME .
The extension macros were documented (and partly designed) by
.MT esr@thyrsus.com
Eric S.\& Raymond
.ME ;
he also wrote the portability advice.
..
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.SY "groff\ \-man"
.RI [ options
.IR .\|.\|.\& ]
.RI [ files
.IR .\|.\|.\& ]
.
.SY "groff\ \-m\ man"
.RI [ options
.IR .\|.\|.\& ]
.RI [ files
.IR .\|.\|.\& ]
.YS
.
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
.\" --------------------------------------------------------------------
.
The
.B man
macros used to generate
.I man\~pages
with
.I groff
were written by James Clark.
.
This document provides a brief summary of the use of each macro in that
package.
.
.
.\" --------------------------------------------------------------------
.SH OPTIONS
.\" --------------------------------------------------------------------
.
The
.B man
macros understand the following command line options (which define
various registers).
.
.
.TP
.B \-rcR=1
This option (the default if in nroff mode) creates a single, very
long page instead of multiple pages.
.
Say
.B \-rcR=0
to disable it.
.
.
.TP
.B \-rC1
If more than one manual page is given on the command line, number the
pages continuously, rather than starting each at\~1.
.
.
.TP
.B \-rD1
Double-sided printing.
.
Footers for even and odd pages are formatted differently.
.
.
.TP
.BI \-rFT= dist
Set distance of the footer relative to the bottom of the page if
negative or relative to the top if positive.
.
The default is \-0.5i.
.
.
.TP
.BI \-rHY= flags
Set hyphenation flags.
.
Possible values are 1\~to hyphenate without restrictions, 2\~to not
hyphenate the last word on a page, 4\~to not hyphenate the last two
characters of a word, and 8\~to not hyphenate the first two characters
of a word.
.
These values are additive; the default is\~14.
.
.
.TP
.BI \-rIN= width
Set body text indentation to
.IR width .
.
The default is 7n for
.IR nroff ,
7.2n for
.IR troff .
.
For
.IR nroff ,
this value should always be an integer multiple of unit \[oq]n\[cq] to
get consistent indentation.
.
.
.TP
.BI \-rLL= line-length
Set line length.
.
If this option is not given, the line length is set to respect any
value set by a prior \[oq].ll\[cq] request (which
.I must
be in effect when the \[oq].TH\[cq] macro is invoked),
if this differs from the built\-in default for the formatter;
otherwise it defaults to 78n in
.I nroff
mode and 6.5i in
.I troff
mode.
.
.
.IP
Note that the use of a \[oq].ll\[cq] request to initialize the line
length is supported for backward compatibility with some versions of
the
.B man
program;
direct initialization of the \[oq]LL\[cq] register should
.I always
be preferred to the use of such a request.
.
In particular, note that a \[oq].ll\ 65n\[cq] request does
.I not
preserve the normal
.I nroff
default line length,
(the
.B man
default initialization to 78n prevails), whereas, the
\[oq]\-rLL=65n\[cq] option, or an equivalent \[oq].nr\ LL\ 65n\[cq]
request preceding the use of the \[oq]TH\[cq] macro,
.I does
set a line length of 65n.
.
.
.TP
.BI \-rLT= title-length
Set title length.
.
If this option is not given, the title length defaults to the line
length.
.
.
.TP
.BI \-rP nnn
Enumeration of pages start with
.I nnn
rather than with\~1.
.
.
.TP
.BI \-rS xx
Base document font size is
.I xx
points
.RI ( xx
can be 10, 11, or\~12) rather than 10\~points.
.
.
.TP
.BI \-rSN= width
Set sub-subheading indentation to
.IR width .
The default is 3n.
.
.
.TP
.BI \-rX nnn
After page\~\c
.IR nnn ,
number pages as
.IR nnn a,
.IR nnn b,
.IR nnn c,
etc.
.
For example, the option \[oq]\-rX2\[cq] produces the following page
numbers: 1, 2, 2a, 2b, 2c, etc.
.
.
.\" --------------------------------------------------------------------
.SH USAGE
.\" --------------------------------------------------------------------
.
This section describes the available macros for manual pages.
.
For further customization, put additional macros and requests into the
file
.BR man.local ,
which is loaded immediately after the
.B man
package.
.
.
.TP
.B .EX
.TQ
.B .EE
Example/End Example.
.
After
.BR .EX ,
filling is disabled and the font is set to constant-width.
.
This is useful for formatting code, command, and configuration-file
examples.
.
The
.B EE
macro restores filling and restores the previous font.
.
.
.IP
These macros are defined on many (but not all) legacy Unix systems
running classic troff.
.
To be certain your page will be portable to those systems, copy
their definitions from the
.B \%an-ext.tmac
file of a
.BR groff
installation.
.
.
.TP
.BI .HP " \fR[\fPnnn\fR]\fP"
Set up a paragraph with hanging left indentation.
.
The indentation is set to
.I nnn
if that argument is supplied (the default unit is \[oq]n\[cq] if
omitted), otherwise it is set to the previous indentation value
specified with
.BR .TP ,
.BR .IP ,
or
.B .HP
(or to the default value if none of them have been used yet).
.
Font size and face are reset to its default values.
.
The following paragraph illustrates the effect of this macro with
hanging indentation set to\~4 (enclosed by
.B .RS
and
.B .RE
to set the left margin temporarily to the current indentation):
.
.
.RS
.HP 4
This is a paragraph following an invocation of the
.B HP
macro.
.
As you can see, it produces a paragraph where all lines but the first
are indented.
.RE
.
.
.IP
Use of this presentation-level macro is deprecated.
.
While it is universally portable to legacy Unix systems, a hanging
indentation cannot be expressed naturally under HTML, and many
HTML-based manual viewers simply interpret it as a starter for a
normal paragraph.
.
Thus, any information or distinction you tried to express with the
indentation may be lost.
.
.
.TP
.BI .IP " \fR[\fPdesignator\fR]\fP \fR[\fPnnn\fR]\fP"
Set up an indented paragraph, using
.I designator
as a tag to mark its beginning.
.
The indentation is set to
.I nnn
if that argument is supplied (the default unit is \[oq]n\[cq] if
omitted), otherwise it is set to the previous indentation value
specified with
.BR .TP ,
.BR .IP ,
or
.B .HP
(or to the default value if none of them have been used yet).
.
Font size and face of the paragraph (but not the designator) are reset
to its default values.
.
.
.IP
To start an indented paragraph with a particular indentation but
without a designator, use \[oq]""\[cq] (two doublequotes) as the
second argument.
.
.
.IP
For example, the following paragraphs were all set up with bullets as
the designator, using \[oq].IP\ \\(bu\ 4\[cq].
.
The whole block has been enclosed with
.B .RS
and
.B .RE
to set the left margin temporarily to the current indentation value.
.
.
.RS
.IP \(bu 4
.B IP
is one of the three macros used in the
.B man
package to format lists.
.
.
.IP \(bu 4
.B HP
is another.
.
This macro produces a paragraph with a left hanging indentation.
.
.
.IP \(bu 4
.B TP
is another.
.
This macro produces an unindented label followed by an indented
paragraph.
.RE
.
.
.TP
.B .LP
.TQ
.B .PP
.TQ
.B .P
These macros are mutual aliases.
.
Any of them causes a line break at the current position, followed by a
vertical space downwards by the amount specified by the
.B PD
macro.
.
The font size and shape are reset to the default value (normally 10pt
Roman).
.
Finally, the current left margin and the indentation is reset to the
default values.
.
.
.TP
.BI .RE " \fR[\fPnnn\fR]\fP"
This macro moves the left margin back to level
.IR nnn ,
restoring the previous left margin.
.
If no argument is given, it moves one level back.
.
The first level (i.e., no call to
.B .RS
yet) has number\~1, and each call to
.B .RS
increases the level by\~1.
.
.
.TP
.BI .RS " \fR[\fPnnn\fR]\fP"
This macro moves the left margin to the right by the value
.I nnn
if specified (default unit is \[oq]n\[cq]); otherwise it is set to the
previous indentation value specified with
.BR .TP ,
.BR .IP ,
or
.B .HP
(or to the default value if none of them have been used yet).
.
The indentation value is then set to the default.
.
.
.IP
Calls to the
.B RS
macro can be nested.
.
.
.TP
.BI .SH " \fR[\fPtext for a heading\fR]\fP"
Set up an unnumbered section heading sticking out to the left.
.
Prints out all the text following
.B .SH
up to the end of the line (or the text in the next input line if there
is no argument to
.BR .SH )
in bold face
(or the font specified by the string
.BR HF ),
one size larger than the base document size.
.
Additionally, the left margin and the indentation for the following
text is reset to the default values.
.
.
.TP
.BI .SS " \fR[\fPtext for a heading\fR]\fP"
Set up a secondary, unnumbered section heading.
.
Prints out all the text following
.B .SS
up to the end of the line (or the text in the next input line if there
is no argument to
.BR .SS )
in bold face
(or the font specified by the string
.BR HF ),
at the same size as the base document size.
.
Additionally, the left margin and the indentation for the following
text is reset to the default values.
.
.
.TP
.BI .TH " title section \fR[\fPextra1\fR]\fP \fR[\fPextra2\fR]\fP \fR[\fPextra3\fR]"
Set the title of the
.I man\~page
to
.I title
and the section to
.IR section ,
which must take on a value between 1 and\~8.
.
The value
.I section
may also have a string appended, e.g.\& \[oq].pm\[cq], to indicate a
specific subsection of the
.IR \%man\~pages .
.
Both
.I title
and
.I section
are positioned at the left and right in the header line (with
.I section
in parentheses immediately appended to
.IR title .
.
.I extra1
is positioned in the middle of the footer line.
.
.I extra2
is positioned at the left in the footer line (or at the left on
even pages and at the right on odd pages if double-sided printing is
active).
.
.I extra3
is centered in the header line.
.
.
.IP
For HTML output, headers and footers are completely suppressed.
.
.
.IP
Additionally, this macro starts a new page; the new line number is\~1
again (except if the \[oq]\-rC1\[cq] option is given on the command
line) -- this feature is intended only for formatting multiple
.IR \%man\~pages ;
a single
.I \%man\~page
should contain exactly one
.B TH
macro at the beginning of the file.
.
.
.TP
.BI .TP " \fR[\fPnnn\fR]\fP"
Set up an indented paragraph with label.
.
The indentation is set to
.I nnn
if that argument is supplied (the default unit is \[oq]n\[cq] if omitted),
otherwise it is set to the previous indentation value specified with
.BR .TP ,
.BR .IP ,
or
.B .HP
(or to the default value if none of them have been used yet).
.
.
.IP
The first input line of text following this macro is interpreted as a
string to be printed flush-left, as it is appropriate for a label.
.
It is not interpreted as part of a paragraph, so there is no attempt
to fill the first line with text from the following input lines.
.
Nevertheless, if the label is not as wide as the indentation the
paragraph starts at the same line (but indented), continuing on the
following lines.
.
If the label is wider than the indentation the descriptive part of the
paragraph begins on the line following the label, entirely indented.
.
Note that neither font shape nor font size of the label is set to a
default value; on the other hand, the rest of the text has default
font settings.
.
.
.IP
The
.B TP
macro is the macro used for the explanations you are just reading.
.
.
.TP
.B .TQ
The
.B TQ
macro sets up header continuation for a
.B TP
macro.
.
With it, you can stack up any number of labels (such as in a
glossary, or list of commands) before beginning the indented
paragraph.
.
For an example, look up the documentation of the
.BR LP ,
.BR PP ,
and
.BR P
macros.
.
.
.IP
This macro is not defined on legacy Unix systems running classic
troff.
.
To be certain your page will be portable to those systems,
copy its definition from the
.B \%an-ext.tmac
file of a
.BR groff
installation.
.
.
.PP
To summarize, the following macros cause a line break with the
insertion of vertical space (which amount can be changed with the
.B PD
macro):
.BR SH ,
.BR SS ,
.BR TP ,
.BR TQ ,
.B LP
.RB ( PP ,
.BR P ),
.BR IP ,
and
.BR HP .
The macros
.BR RS ,
.BR RE ,
.BR EX ,
and
.B EE
also cause a break but no insertion of vertical space.
.
.
.\" --------------------------------------------------------------------
.SH "MACROS TO SET FONTS"
.\" --------------------------------------------------------------------
.
The standard font is Roman; the default text size is 10\~point.
.
.
.TP
.BI .B " \fR[\fPtext\fR]\fP"
Causes
.I text
to appear in bold face.
.
If no text is present on the line where the macro is called the text
of the next input line appears in bold face.
.
.
.TP
.BI ".BI " text
Causes text on the same line to appear alternately in bold face and
italic.
.
The text must be on the same line as the macro call.
.
Thus
.
.
.RS
.IP
\&.BI this "word and" that
.
.
.PP
would cause \[oq]this\[cq] and \[oq]that\[cq] to appear in bold face,
while \[oq]word and\[cq] appears in italics.
.RE
.
.
.TP
.BI ".BR " text
Causes text on the same line to appear alternately in bold face and
roman.
.
The text must be on the same line as the macro call.
.
.
.TP
.BI .I " \fR[\fPtext\fR]\fP"
Causes
.I text
to appear in italic.
.
If no text is present on the line where the macro is called the text
of the next input line appears in italic.
.
.
.TP
.BI ".IB " text
Causes text to appear alternately in italic and bold face.
.
The text must be on the same line as the macro call.
.
.
.TP
.BI ".IR " text
Causes text on the same line to appear alternately in italic and
roman.
.
The text must be on the same line as the macro call.
.
.
.TP
.BI ".RB " text
Causes text on the same line to appear alternately in roman and bold
face.
.
The text must be on the same line as the macro call.
.
.
.TP
.BI ".RI " text
Causes text on the same line to appear alternately in roman and
italic.
.
The text must be on the same line as the macro call.
.
.
.TP
.BI .SB " \fR[\fPtext\fR]\fP"
Causes the text on the same line or the text on the next input line to
appear in boldface font, one point size smaller than the default font.
.
.
.TP
.BI .SM " \fR[\fPtext\fR]\fP"
Causes the text on the same line or the text on the next input line to
appear in a font that is one point size smaller than the default font.
.
.
.\" --------------------------------------------------------------------
.SH "MACROS TO DESCRIBE HYPERLINKS AND EMAIL ADDRESSES"
.\" --------------------------------------------------------------------
.
The following macros are not defined on legacy Unix systems
running classic troff.
.
To be certain your page will be portable to those systems, copy
their definitions from the
.B \%an-ext.tmac
file of a
.BR groff
installation.
.
.
.PP
Using these macros helps ensure that you get hyperlinks when your
manual page is rendered in a browser or other program that is
Web-enabled.
.
.
.TP
.BI .MT " address"
.TQ
.BI .ME " \fR[\fPpunctuation\fR]\fP"
Wrap an email address.
.
The argument of
.B .MT
is the address; text following, until
.BR .ME ,
is a name to be associated with the address.
.
Any argument to the
.B ME
macro is pasted to the end of the link text.
.
On a device that is not a browser,
.
.
.RS
.IP
.EX
contact
\&.MT fred.foonly@\e:fubar.net
Fred Foonly
\&.ME
for more information
.EE
.RE
.
.
.IP
usually displays like this: \[lq]contact Fred Foonly
<fred.foonly@\:fubar.net> for more information\[rq].
.
.
.IP
The use of
.B \e:
to insert hyphenless breakpoints is a groff extension and can
be omitted.
.
.
.TP
.BI .UR " URL"
.TQ
.BI .UE " \fR[\fPpunctuation\fR]\fP"
Wrap a World Wide Web hyperlink.
.
The argument to
.B .UR
is the URL; thereafter, lines until
.B .UE
are collected and used as the link text.
.
Any argument to the
.B UE
macro is pasted to the end of the text.
.
On a device that is not a browser,
.
.
.RS
.IP
.EX
this is a link to
\&.UR http://\e:randomsite.org/\e:fubar
some random site
\&.UE ,
given as an example
.EE
.RE
.
.
.IP
usually displays like this: \[lq]this is a link to some random
site <http://\:randomsite.org/\:fubar>, given as an example\[rq].
.
.
.IP
The use of
.B \e:
to insert hyphenless breakpoints is a groff extension and can be
omitted.
.
.
.\" --------------------------------------------------------------------
.SH "MACROS TO DESCRIBE COMMAND SYNOPSES"
.\" --------------------------------------------------------------------
.
The following macros are not defined on legacy Unix systems
running classic troff.
.
To be certain your page will be portable to those systems, copy their
definitions from the
.B \%an-ext.tmac
file of a
.BR groff
installation.
.
.
.PP
These macros are a convenience for authors.
.
They also assist automated translation tools and help browsers in
recognizing command synopses and treating them differently from
running text.
.
.
.TP
.BI .OP " key value"
Describe an optional command argument.
.
The arguments of this macro are set surrounded by option braces
in the default Roman font; the first argument is printed with
a bold face, while the second argument is typeset as italic.
.
.
.TP
.BI .SY " command"
Begin synopsis.
.
Takes a single argument, the name of a command.
.
Text following, until closed by
.BR .YS ,
is set with a hanging indentation with the width of
.I command
plus a space.
.
This produces the traditional look of a Unix command synopsis.
.
.
.TP
.B .YS
This macro restores normal indentation at the end of a command
synopsis.
.
.
.PP
Here is a real example:
.
.
.IP
.EX
\&.SY groff
\&.OP \e-abcegiklpstzCEGNRSUVXZ
\&.OP \e-d cs
\&.OP \e-f fam
\&.OP \e-F dir
\&.OP \e-I dir
\&.OP \e-K arg
\&.OP \e-L arg
\&.OP \e-m name
\&.OP \e-M dir
\&.OP \e-n num
\&.OP \e-o list
\&.OP \e-P arg
\&.OP \e-r cn
\&.OP \e-T dev
\&.OP \e-w name
\&.OP \e-W name
\&.RI [ file
\&.IR .\e|.\e|. ]
\&.YS
.EE
.
.
.PP
produces the following output:
.
.
.RS
.PP
.SY groff
.OP \-abcegiklpstzCEGNRSUVXZ
.OP \-d cs
.OP \-f fam
.OP \-F dir
.OP \-I dir
.OP \-K arg
.OP \-L arg
.OP \-m name
.OP \-M dir
.OP \-n num
.OP \-o list
.OP \-P arg
.OP \-r cn
.OP \-T dev
.OP \-w name
.OP \-W name
.RI [ file
.IR .\|.\|. ]
.YS
.RE
.
.
.PP
If necessary, you might use
.B br
requests to control line breaking.
.
You can insert plain text as well; this looks like the traditional
(unornamented) syntax for a required command argument or filename.
.
.
.\" --------------------------------------------------------------------
.SH "MISCELLANEOUS"
.\" --------------------------------------------------------------------
.
The default indentation is 7.2n in troff mode and 7n in nroff mode
except for
.BR grohtml ,
which ignores indentation.
.
.
.TP
.BI .AT " \fR[\fPsystem \fR[\fPrelease\fR]]\fP"
Alter the footer for use with \f[CR]AT&T\f[]
.IR \%man\~pages .
This command exists only for compatibility; don\[aq]t use it.
.
See the
.I groff
info manual for more.
.
.
.TP
.B .BT
Print the footer string.
.
Redefine this macro to get control of the footer.
.
.
.TP
.B .DT
Set tabs every 0.5\~inches.
.
Since this macro is always called during a
.B TH
macro, it makes sense to call it only if the tab positions have been
changed.
.
.
.IP
Use of this presentation-level macro is deprecated.
.
It translates poorly to HTML, under which exact whitespace control
and tabbing are not readily available.
.
Thus, information or distinctions that you use
.B .DT
to express are likely to be lost.
.
If you feel tempted to use it, you should probably be composing a
table using
.BR tbl (1)
markup instead.
.
.
.TP
.BI .PD " \fR[\fPnnn\fR]\fP"
Adjust the empty space before a new paragraph or section.
.
The optional argument gives the amount of space (default unit is
\[oq]v\[cq]); without parameter, the value is reset to its default
value (1\~line in nroff mode, 0.4v\~otherwise).
.
This affects the macros
.BR SH ,
.BR SS ,
.BR TP ,
.B LP
(resp.\&
.B PP
and
.BR P ),
.BR IP ,
and
.BR HP .
.
.
.IP
Use of this presentation-level macro is deprecated.
.
It translates poorly to HTML, under which exact control of
inter-paragraph spacing is not readily available.
.
Thus, information or distinctions that you use
.B .PD
to express are likely to be lost.
.
.
.TP
.B .PT
Print the header string.
.
Redefine this macro to get control of the header.
.
.
.TP
.BI .UC " \fR[\fPversion\fR]\fP"
Alter the footer for use with \f[CR]BSD\f[]
.IR man\~pages .
This command exists only for compatibility; don\[aq]t use it.
.
See the
.I groff
info manual for more.
.
.
.PP
The following strings are defined:
.
.
.TP
.B \e*R
The \[oq]registered\[cq] sign.
.
.
.TP
.B \e*S
Switch back to the default font size.
.
.
.TP
.B \e*(lq
.TQ
.B \e*(rq
Left and right quote.
.
This is equal to \[oq]\e(lq\[cq] and \[oq]\e(rq\\[cq], respectively.
.
.
.TP
.B \e*(HF
The typeface used to print headings and subheadings.
.
The default is \[oq]B\[cq].
.
.
.TP
.B \e*(Tm
The \[oq]trademark\[cq] sign.
.
.
.PP
If a preprocessor like
.B tbl
or
.B eqn
is needed, it has become common to make the first line of the
.I \%man\~page
look like this:
.
.
.PP
.RS
.BI '\e"\ word\""
.RE
.
.
.PP
Note the single space character after the double quote.
.I word
consists of letters for the needed preprocessors: \[oq]e\[cq] for
.BR eqn ,
\[oq]r\[cq] for
.BR refer ,
and \[oq]t\[cq] for
.BR tbl .
.
Modern implementations of the
.B man
program read this first line and automatically call the right
preprocessor(s).
.
.
.\" --------------------------------------------------------------------
.SH "PORTABILITY AND TROFF REQUESTS"
.\" --------------------------------------------------------------------
.
Since the
.B man
macros consist of groups of
.I groff
requests, one can, in principle, supplement the functionality of the
.B man
macros with individual
.I groff
requests where necessary.
.
See the
.I groff
info pages for a complete reference of all requests.
.
.
.PP
Note, however, that using raw troff requests is likely to make your
page render poorly on the (increasingly common) class of viewers that
render it to HTML.
.
Troff requests make implicit assumptions about things like character
and page sizes that may break in an HTML environment; also, many of
these viewers don\[aq]t interpret the full troff vocabulary, a problem
that can lead to portions of your text being silently dropped.
.
.
.PP
For portability to modern viewers, it is best to write your page
entirely in the requests described on this page.
.
Further, it is best to completely avoid those we have described as
\[oq]presentation-level\[cq]
.RB ( .HP ,
.BR .PD ,
and
.BR .DT ).
.
.
.PP
The macros we have described as extensions
.RB ( .EX / .EE ,
.BR .SY / .OP / .YS ,
.BR .UR / .UE ,
and
.BR .MT / .ME )
should be used with caution, as they may not yet be built in to
some viewer that is important to your audience.
.
If in doubt, copy the implementation onto your page.
.
.
.\" --------------------------------------------------------------------
.SH FILES
.\" --------------------------------------------------------------------
.
.TP
.B man.tmac
.TQ
.B an.tmac
These are wrapper files to call
.BR andoc.tmac .
.
.
.TP
.B andoc.tmac
Use this file in case you don\[aq]t know whether the
.B man
macros or the
.B mdoc
package should be used.
Multiple man pages (in either format) can be handled.
.
.
.TP
.B an-old.tmac
Most
.B man
macros are contained in this file.
.
.
.TP
.B an-ext.tmac
The extension macro definitions for
.BR .SY ,
.BR .OP ,
.BR .YS ,
.BR .TQ ,
.BR .EX/.EE ,
.BR .UR/.UE ,
and
.BR .MT/.ME
are contained in this file.
.
It is written in classic troff, and released for free re-use,
and not copylefted; manual page authors concerned about
portability to legacy Unix systems are encouraged to copy these
definitions into their pages, and maintainers of troff
or its workalikes are encouraged to re-use them.
.
.
.IP
Note that the definitions for these macros are read after the call of
.BR TH ,
so they will replace macros of the same names given at the beginning of
your file.
.
If you must use your own definitions for these macros, they must be
given after calling
.BR TH .
.
.
.TP
.B man.local
Local changes and customizations should be put into this file.
.
.
.ad l
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
.\" --------------------------------------------------------------------
.BR tbl (1),
.BR eqn (1),
.BR refer (1),
.BR man (1),
.BR man (7),
.BR groff_mdoc (7)
.
.
.\" --------------------------------------------------------------------
.SH COPYING
.\" --------------------------------------------------------------------
.co
.\" --------------------------------------------------------------------
.SH AUTHORS
.\" --------------------------------------------------------------------
.au
.
.
.\" --------------------------------------------------------------------
.\" ### Emacs settings:
.\" Local Variables:
.\" mode: nroff
.\" End:
|