1 '\" t -- preprocess: tbl(1)
4 .\" A complete reference of the mdoc macro package for GNU troff.
6 .\" Based on NetBSD's mdoc.samples.7, version 1.21.
8 .\" Warning: You can't format this file with the old mdoc macros!
10 .\" Copyright (c) 1990, 1993
11 .\" The Regents of the University of California. All rights reserved.
13 .\" Redistribution and use in source and binary forms, with or without
14 .\" modification, are permitted provided that the following conditions
16 .\" 1. Redistributions of source code must retain the above copyright
17 .\" notice, this list of conditions and the following disclaimer.
18 .\" 2. Redistributions in binary form must reproduce the above copyright
19 .\" notice, this list of conditions and the following disclaimer in the
20 .\" documentation and/or other materials provided with the distribution.
22 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\" may be used to endorse or promote products derived from this software
25 .\" without specific prior written permission.
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 .\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
41 .\" This reference invokes every macro in the package several
42 .\" times and is guaranteed to give a worst case performance
43 .\" for an already extremely slow package.
54 .Nd reference for @L_ROFF@'s mdoc implementation
59 .Nm @L_ROFF@ Fl m Ns Cm doc Ar
64 A complete reference for writing
75 package, addressed page layout leaving the manipulation of fonts and other
76 typesetting details to the individual author.
79 page layout macros make up the
80 .Em "page structure domain"
81 which consists of macros for titles, section headers, displays and lists
82 \(en essentially items which affect the physical position of text on a
84 In addition to the page structure domain, there are two more domains, the
89 The general text domain is defined as macros which perform tasks such as
90 quoting or emphasizing pieces of text.
91 The manual domain is defined as macros that are a subset of the day to day
92 informal language used to describe commands, routines and related
95 Macros in the manual domain handle command names, command line arguments and
96 options, function names, function parameters, pathnames, variables, cross
97 references to other manual pages, and so on.
98 These domain items have value for both the author and the future user of the
100 Hopefully, the consistency gained across the manual set will provide easier
101 translation to future documentation tools.
105 manual pages, a manual entry is simply referred to as a man page, regardless
106 of actual length and without sexist intention.
109 .Mx -toc -tree html xhtml pdf ps tty
116 .Sh "TROFF IDIOSYNCRASIES"
120 package attempts to simplify the process of writing a man page.
121 Theoretically, one should not have to learn the tricky details of
125 however, there are a few limitations which are unavoidable and best gotten
127 And, too, be forewarned, this package is
135 a macro is called by placing a
137 (dot character) at the beginning of a line followed by the two-character
138 (or three-character) name for the macro.
139 There can be space or tab characters between the dot and the macro name.
140 Arguments may follow the macro separated by spaces (but
143 It is the dot character at the beginning of the line which causes
145 to interpret the next two (or more) characters as a macro name.
146 A single starting dot followed by nothing is ignored.
149 (dot character) at the beginning of an input line in some context other than
150 a macro invocation, precede the
154 escape sequence which translates literally to a zero-width space, and is
155 never displayed in the output.
159 macros accept an unlimited number of arguments (contrary to other versions
160 of troff which can't handle more than nine arguments).
161 In limited cases, arguments may be continued or extended on the next
163 .Sx Extended Arguments
165 Almost all macros handle quoted arguments (see
166 .Sx Passing Space Characters in an Argument
171 general text domain and manual domain macros are special in that their
174 for callable macro names.
175 This means an argument on the argument list which matches a general text or
176 manual domain macro name (and which is defined to be callable) will be
177 executed or called when it is processed.
178 In this case the argument, although the name of a macro, is not preceded by
182 This makes it possible to nest macros; for example the option macro,
186 the flag and argument macros,
190 to specify an optional flag with an argument:
192 .Bl -tag -width ".Op Fl s Ar bytes" -offset indent
195 .Ql ".Op Fl s Ar bytes"
199 To prevent a string from being interpreted as a macro name, precede the
200 string with the escape sequence
203 .Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent
204 .It Op \&Fl s \&Ar bytes
206 .Ql ".Op \e&Fl s \e&Ar bytes"
214 are not interpreted as macros.
215 Macros whose argument lists are parsed for callable arguments are referred
218 and macros which may be called from an argument list are referred to as
220 throughout this document.
223 as almost all of the macros in
225 are parsed, but as it was cumbersome to constantly refer to macros as
226 being callable and being able to call other macros, the term parsed
230 In the following, we call an
232 macro which starts a line (with a leading dot) a
234 if this distinction is necessary.
236 .Ss "Passing Space Characters in an Argument"
238 Sometimes it is desirable to give as an argument a string containing one or
239 more blank space characters, say, to specify arguments to commands which
240 expect particular arrangement of items in the argument list.
241 Additionally, it makes
244 For example, the function command
246 expects the first argument to be the name of a function and any remaining
247 arguments to be function parameters.
250 stipulates the declaration of function parameters in the parenthesized
251 parameter list, each parameter is guaranteed to be at minimum a two word
256 There are two possible ways to pass an argument which contains
258 One way of passing a string containing blank spaces is to use the hard or
259 unpaddable space character
261 that is, a blank space preceded by the escape character
263 This method may be used with any macro but has the side effect of
264 interfering with the adjustment of text over the length of a line.
266 sees the hard space as if it were any other printable character and cannot
267 split the string into blank or newline separated pieces as one would expect.
268 This method is useful for strings which are not expected to overlap a line
270 An alternative is to use
272 a paddable (i.e.\& stretchable), unbreakable space (this is a
275 The second method is to enclose the string with double quotes.
279 .Bl -tag -width ".Fn fetch char\ *str" -offset indent
280 .It Fn fetch char\ *str
282 .Ql ".Fn fetch char\e *str"
283 .It Fn fetch "char *str"
284 can also be created by
285 .Ql ".Fn fetch \*[q]char *str\*[q]"
291 before the space in the first example
292 or double quotes in the second example
295 would see three arguments, and the result would be:
297 .Dl Fn fetch char *str
299 .\" For an example of what happens when the parameter list overlaps a newline
300 .\" boundary, see the
304 .Ss "Trailing Blank Space Characters"
307 can be confused by blank space characters at the end of a line.
308 It is a wise preventive measure to globally remove all blank spaces
310 .Ao blank-space Ac Ns Ao end-of-line Ac
312 Should the need arise to use a blank character at the end of a line, it
313 may be forced with an unpaddable space and the
319 .Ss "Escaping Special Characters"
321 Special characters like the newline character
323 are handled by replacing the
329 to preserve the backslash.
331 .Ss "Other Possible Pitfalls"
333 A warning is emitted when an empty input line is found outside of displays
338 (Well, it is even better to use
340 macros to avoid the usage of low-level commands.)
342 Leading spaces will cause a break and are output directly.
343 Avoid this behaviour if possible.
344 Similarly, do not use more than one space character between words in an
345 ordinary text line; contrary to other text formatters, they are
347 replaced with a single space.
351 directly as an argument.
360 inserts two space characters after a punctuation mark closing a sentence;
365 are treated transparently, not influencing the sentence-ending behaviour.
366 To change this, insert
368 before or after the dot:
370 .Bd -literal -offset indent
389 .Bd -filled -offset indent
406 As can be seen in the first and third line,
408 handles punctuation characters specially in macro arguments.
409 This will be explained in section
412 In the same way, you have to protect trailing full stops of abbreviations
413 with a trailing zero-width space:
416 A comment in the source file of a man page can be either started with
422 anywhere (the latter is a
424 extension); the rest of such a line is ignored.
427 .Sh "A MANUAL PAGE TEMPLATE"
429 The body of a man page is easily constructed from a basic template:
431 .Bd -literal -offset indent
432 \&.\e" The following commands are required for all man pages.
433 \&.Dd Month day, year
434 \&.Dt DOCUMENT_TITLE [section number] [architecture/volume]
435 \&.Os [OPERATING_SYSTEM] [version/release]
438 \&.Nd one line description of name
439 \&.\e" This next command is for sections 2 and 3 only.
443 \&.\e" The following commands should be uncommented and
444 \&.\e" used where appropriate.
445 \&.\e" .Sh IMPLEMENTATION NOTES
446 \&.\e" This next command is for sections 2, 3, and 9 only
447 \&.\e" (function return values).
448 \&.\e" .Sh RETURN VALUES
449 \&.\e" This next command is for sections 1, 6, 7, and 8 only.
450 \&.\e" .Sh ENVIRONMENT
452 \&.\e" This next command is for sections 1, 6, and 8 only
453 \&.\e" (command return values to the shell).
454 \&.\e" .Sh EXIT STATUS
456 \&.\e" This next command is for sections 1, 4, 6, 7, 8, and 9 only
457 \&.\e" (fprintf/stderr type diagnostics).
458 \&.\e" .Sh DIAGNOSTICS
459 \&.\e" .Sh COMPATIBILITY
460 \&.\e" This next command is for sections 2, 3, 4, and 9 only
461 \&.\e" (settings of the errno variable).
472 The first items in the template are the commands
477 the document date, the operating system the man page or subject source is
478 developed or modified for, and the man page title (in
480 along with the section of the manual the page belongs in.
481 These commands identify the page and are discussed below in
484 The remaining items in the template are section headers
492 The headers are discussed in
493 .Sx "PAGE STRUCTURE DOMAIN" ,
494 after presentation of
495 .Sx "MANUAL DOMAIN" .
496 Several content macros are used to demonstrate page layout macros; reading
497 about content macros before page layout macros is recommended.
502 In the description of all macros below, optional arguments are put into
506 represents zero or more additional arguments.
507 Alternative values for a parameter are separated with
509 If there are alternative values for a mandatory parameter, braces are used
512 to enclose the value set.
513 Meta-variables are specified within angles.
517 .Bl -tag -width 6n -offset indent
521 .Op \-test1 Op \-test2 | \-test3
527 Except stated explicitly, all macros are parsed and callable.
529 Note that a macro takes effect up to the next nested macro.
536 Consequently, a warning message is emitted for most commands if the first
537 argument is a macro itself since it cancels the effect of the calling
539 Another consequence is that quoting macros never insert literal quotes;
542 .Ql ".Ic \*[q]foo <bar>\*[q]" .
544 Most macros have a default width value which can be used to specify a label
554 It is recommended not to use this rather obscure feature to avoid
555 dependencies on local modifications of the
562 The title macros are part of the page structure domain but are presented
563 first and separately for someone who wishes to start writing a man page
565 Three header macros designate the document title or manual page title, the
566 operating system, and the date of authorship.
567 These macros are called once at the very beginning of the document and are
568 used to construct headers and footers only.
572 .Op Aq document title
573 .Op Aq section number
576 The document title is the subject of the man page and must be in
578 due to troff limitations.
582 The section number may be a number in the range
583 .No 1,\~ Ns ... Ns ,\~9
589 If it is specified, and no volume name is given, a default volume name is
594 .Tn \*[operating-system] ,
595 the following sections are defined:
599 1 \*[volume-operating-system] \*[volume-ds-1]
600 2 \*[volume-operating-system] \*[volume-ds-2]
601 3 \*[volume-operating-system] \*[volume-ds-3]
602 4 \*[volume-operating-system] \*[volume-ds-4]
603 5 \*[volume-operating-system] \*[volume-ds-5]
604 6 \*[volume-operating-system] \*[volume-ds-6]
605 7 \*[volume-operating-system] \*[volume-ds-7]
606 8 \*[volume-operating-system] \*[volume-ds-8]
607 9 \*[volume-operating-system] \*[volume-ds-9]
611 A volume name may be arbitrary or one of the following:
616 USD \*[volume-ds-USD]
617 PS1 \*[volume-ds-PS1]
618 AMD \*[volume-ds-AMD]
619 SMM \*[volume-ds-SMM]
620 URM \*[volume-ds-URM]
621 PRM \*[volume-ds-PRM]
623 IND \*[volume-ds-IND]
624 LOCAL \*[volume-ds-LOCAL]
625 CON \*[volume-ds-CON]
637 Values from the previous table will specify a new volume name.
638 If the third parameter is a keyword designating a computer architecture,
639 its value is prepended to the default volume name as specified by the
641 By default, the following architecture keywords are defined:
643 \# we use `No' to avoid hyphenation
644 .Bd -ragged -offset indent
645 .No acorn26 , acorn32 , algor , alpha , amd64 , amiga , amigappc ,
646 .No arc , arm , arm26 , arm32 , armish , atari , aviion ,
647 .No beagle , bebox , cats , cesfic , cobalt , dreamcast ,
648 .No emips , evbarm , evbmips , evbppc , evbsh3 , ews4800mips ,
649 .No hp300 , hp700 , hpcarm , hpcmips , hpcsh , hppa , hppa64 ,
650 .No i386 , ia64 , ibmnws , iyonix , landisk , loongson , luna68k , luna88k ,
651 .No m68k , mac68k , macppc , mips , mips64 , mipsco , mmeye ,
652 .No mvme68k , mvme88k , mvmeppc , netwinder , news68k , newsmips , next68k ,
653 .No ofppc , palm , pc532 , playstation2 , pmax , pmppc , powerpc , prep ,
654 .No rs6000 , sandpoint , sbmips , sgi , sgimips , sh3 , shark ,
655 .No socppc , solbourne , sparc , sparc64 , sun2 , sun3 ,
656 .No tahoe , vax , x68k , x86_64 , xen , zaurus
660 If the section number is neither a numeric expression in the range 1 to\~9
661 nor one of the above described keywords, the third parameter is used
662 verbatim as the volume name.
664 In the following examples, the left (which is identical to the right) and
665 the middle part of the manual page header strings are shown.
668 prevents the digit\~7 from being a valid numeric expression.
671 .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
674 .Ql \*[volume-operating-system] \*[volume-ds-7]
675 .It Li ".Dt FOO 7 bar"
677 .Ql \*[volume-operating-system] \*[volume-ds-7]
678 .It Li ".Dt FOO \e&7 bar"
681 .It Li ".Dt FOO 2 i386"
683 .Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2]
684 .It Li ".Dt FOO \*[q]\*[q] bar"
691 Local, OS-specific additions might be found in the file
693 look for strings named
695 (for the former type) and
697 (for the latter type);
699 then denotes the keyword to be used with the
703 This macro is neither callable nor parsed.
706 .Op Aq operating system
709 If the first parameter is empty,
711 .Sq Tn "\*[operating-system]"
713 This may be overridden in the local configuration file,
715 In general, the name of the operating system should be the common acronym,
720 The release should be the standard release nomenclature for the system
722 In the following table, the possible second arguments for some predefined
723 operating systems are listed.
726 local additions might be defined in
728 look for strings named
729 .Ql operating\-system\-XXX\-YYY ,
732 is the acronym for the operating system and
737 .Bl -tag -width ".No DragonFly" -offset indent
739 7th, 7, III, 3, V, V.2, V.3, V.4
741 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
743 0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e,
744 1.3, 1.3a, 1.4, 1.4.1, 1.4.2, 1.4.3, 1.5, 1.5.1, 1.5.2, 1.5.3, 1.6, 1.6.1,
745 1.6.2, 1.6.3, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 3.0, 3.0.1, 3.0.2, 3.0.3,
746 3.1, 3.1.1, 4.0, 4.0.1, 5.0, 5.0.1, 5.0.2, 5.1, 5.1.2, 5.1.3, 5.1.4,
747 5.2, 5.2.1, 5.2.2, 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.1, 6.1.1,
750 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1,
751 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1,
752 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, 4.8, 4.9, 4.10, 4.11, 5.0, 5.1,
753 5.2, 5.2.1, 5.3, 5.4, 5.5, 6.0, 6.1, 6.2, 6.3, 6.4, 7.0, 7.1, 7.2, 7.3, 7.4,
754 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, 9.2, 9.3, 10.0
756 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0, 3.1, 3.2, 3.3, 3.4,
757 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9,
758 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6
760 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.8, 1.8.1, 1.9, 1.10, 1.12, 1.12.2,
761 1.13, 2.0, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.9.1, 2.10, 2.10.1,
762 2.11, 2.12, 2.13, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8
764 8.0.0, 8.1.0, 8.2.0, 8.3.0, 8.4.0, 8.5.0, 8.6.0, 8.7.0, 8.8.0, 8.9.0,
765 8.10.0, 8.11.0, 9.0.0, 9.1.0, 9.2.0, 9.3.0, 9.4.0, 9.5.0, 9.6.0, 9.7.0,
766 9.8.0, 10.1.0, 10.2.0, 10.3.0, 10.4.0, 10.5.0, 10.6.0, 10.7.0, 10.8.0,
767 11.0.0, 11.1.0, 11.2.0, 11.3.0, 11.4.0, 11.5.0, 12.0.0, 12.1.0, 12.2.0,
768 13.0.0, 13.1.0, 13.2.0, 13.3.0, 13.4.0, 14.0.0
775 an unknown second parameter will be replaced with the string
777 for the other predefined acronyms it will be ignored and a warning message
779 Unrecognized arguments are displayed as given in the page footer.
780 For instance, a typical footer might be:
785 .Ql 4.3\~Berkeley Distribution ,
786 or for a locally produced set
788 .Dl .Os CS Department
795 macro is not present, the bottom left corner of the manual page will be
798 This macro is neither callable nor parsed.
809 is used for the date string.
810 If it has exactly three arguments, they are concatenated, separated with
813 .Dl .Dd January 25, 2001
815 The month's name shall not be abbreviated.
817 With any other number of arguments, the current date is used, ignoring
820 As a special exception, the format
821 .Bd -filled -offset indent
832 manuals to automatically insert the current date when committing.
834 This macro is neither callable nor parsed.
838 .Sh "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
840 .Ss "What's in a Name" Ns ...
842 The manual domain macro names are derived from the day to day informal
843 language used to describe commands, subroutines and related files.
844 Slightly different variations of this language are used to describe the
845 three different aspects of writing a man page.
846 First, there is the description of
849 Second is the description of a
854 macros, and third, the description of a command to a user in the verbal
855 sense; that is, discussion of a command in the text of a man page.
859 macros are themselves a type of command; the general syntax for a troff
862 .Bd -filled -offset indent
863 .Li ".Xx argument1 argument2" ...
868 is a macro command, and anything following it are arguments to
870 In the second case, the description of a
872 command using the content macros is a bit more involved; a typical
874 command line might be displayed as:
876 .Bd -filled -offset indent
879 .Ao Ar infile Ac Ao Ar outfile Ac
885 is the command name and the
890 argument designated as optional by the option brackets.
899 in this example, the user has to replace the meta expressions given in angle
900 brackets with real file names.
901 Note that in this document meta arguments are used to describe
903 commands; in most man pages, meta variables are not specifically written
905 The macros which formatted the above example:
907 .Bd -literal -offset indent
910 \&.Ao Ar infile Ac Ao Ar outfile Ac
914 In the third case, discussion of commands and command syntax includes both
915 examples above, but may add more detail.
920 from the example above might be referred to as
924 Some command line argument lists are quite long:
927 .Bl -tag -width ".Nm make" -offset indent -compact
933 .Op Fl I Ar directory
935 .Op Ar variable Ns = Ns Ar value
943 Here one might talk about the command
945 and qualify the argument,
947 as an argument to the flag,
949 or discuss the optional file operand
951 In the verbal context, such detail can prevent confusion, however the
953 package does not have a macro for an argument
958 argument macro is used for an operand or file argument like
960 as well as an argument to a flag like
962 The make command line was produced from:
964 .Bd -literal -offset indent
967 \&.Op Fl D Ar variable
969 \&.Op Fl f Ar makefile
970 \&.Op Fl I Ar directory
971 \&.Op Fl j Ar max_jobs
972 \&.Op Ar variable Ns = Ns Ar value
983 macros are explained in
988 The manual domain and general text domain macros share a similar syntax with
989 a few minor deviations; most notably,
995 differ only when called without arguments; and
999 impose an order on their argument lists.
1000 All content macros are capable of recognizing and properly handling
1001 punctuation, provided each punctuation character is separated by a leading
1003 If a command is given:
1005 .Dl \&.Ar sptr, ptr),
1011 The punctuation is not recognized and all is output in the
1014 If the punctuation is separated by a leading white space:
1016 .Dl \&.Ar "sptr , ptr ) ,"
1020 .Dl Ar sptr , ptr ) ,
1022 The punctuation is now recognized and output in the default font
1023 distinguishing it from the argument strings.
1024 To remove the special meaning from a punctuation character escape it with
1027 The following punctuation characters are recognized by
1030 .Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX
1031 .It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\&
1032 .It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\&
1037 is limited as a macro language, and has difficulty when presented with a
1038 string containing a member of the mathematical, logical or quotation set:
1040 .Bd -literal -offset indent-two
1041 {+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
1047 may assume it is supposed to actually perform the operation or evaluation
1048 suggested by the characters.
1049 To prevent the accidental evaluation of these characters, escape them with
1051 Typical syntax is shown in the first content macro displayed below,
1059 The address macro identifies an address construct.
1061 .Dl Usage: .Ad Ao address Ac ...
1063 .Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
1066 .It Li ".Ad addr1 ."
1068 .It Li ".Ad addr1 , file2"
1070 .It Li ".Ad f1 , f2 , f3 :"
1072 .It Li ".Ad addr ) ) ,"
1077 The default width is 12n.
1083 macro is used to specify the name of the author of the item being
1084 documented, or the name of the author of the actual manual page.
1086 .Dl Usage: .An Ao author name Ac ...
1088 .Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n
1089 .It Li ".An \*[q]Joe Author\*[q]"
1091 .It Li ".An \*[q]Joe Author\*[q] ,"
1093 .It Li ".An \*[q]Joe Author\*[q] Aq nobody@FreeBSD.org"
1094 .An "Joe Author" Aq nobody@FreeBSD.org
1095 .It Li ".An \*[q]Joe Author\*[q] ) ) ,"
1096 .An "Joe Author" ) ) ,
1100 The default width is 12n.
1106 command causes a line break allowing each new name to appear on its own
1108 If this is not desirable,
1110 .Bd -literal -offset indent
1115 call will turn this off.
1116 To turn splitting back on, write
1118 .Bd -literal -offset indent
1126 argument macro may be used whenever an argument is referenced.
1127 If called without arguments, the
1131 .Dl Usage: .Ar Oo Ao argument Ac Oc ...
1133 .Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
1138 .It Li ".Ar file1 ."
1140 .It Li ".Ar file1 file2"
1142 .It Li ".Ar f1 f2 f3 :"
1144 .It Li ".Ar file ) ) ,"
1149 The default width is 12n.
1151 .Ss "Configuration Declaration (Section Four Only)"
1155 macro is used to demonstrate a
1157 declaration for a device interface in a section four manual.
1159 .Dl Usage: .Cd Ao argument Ac ...
1161 .Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
1162 .It Li ".Cd \*[q]device le0 at scode?\*[q]"
1163 .Cd "device le0 at scode?"
1170 command causes a line break before and after its arguments are printed.
1173 The default width is 12n.
1175 .Ss "Command Modifiers"
1177 The command modifier is identical to the
1179 (flag) command with the exception that the
1181 macro does not assert a dash in front of every argument.
1182 Traditionally flags are marked by the preceding dash, however, some commands
1183 or subsets of commands do not use them.
1184 Command modifiers may also be specified in conjunction with interactive
1185 commands such as editor commands.
1189 The default width is 10n.
1191 .Ss "Defined Variables"
1193 A variable (or constant) which is defined in an include file
1194 is specified by the macro
1197 .Dl Usage: .Dv Ao defined variable Ac ...
1199 .Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
1200 .It Li ".Dv MAXHOSTNAMELEN"
1202 .It Li ".Dv TIOCGPGRP )"
1206 The default width is 12n.
1212 errno macro specifies the error return value for section 2, 3, and\~9 library
1214 The second example below shows
1218 general text domain macro, as it would be used in a section two manual page.
1220 .Dl Usage: .Er Ao errno type Ac ...
1222 .Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n
1225 .It Li ".Er ENOENT ) ;"
1227 .It Li ".Bq Er ENOTDIR"
1232 The default width is 17n.
1234 .Ss "Environment Variables"
1238 macro specifies an environment variable.
1240 .Dl Usage: .Ev Ao argument Ac ...
1242 .Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n
1243 .It Li ".Ev DISPLAY"
1247 .It Li ".Ev PRINTER ) ) ,"
1251 The default width is 15n.
1257 macro handles command line flags.
1261 For interactive command flags, which are not prepended with a dash, the
1264 macro is identical, but without the dash.
1266 .Dl Usage: .Fl Ao argument Ac ...
1268 .Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n
1281 .It Li ".Fl xyz ) ,"
1289 macro without any arguments results in a dash representing stdin/stdout.
1292 a single dash will result in two dashes.
1294 The default width is 12n.
1296 .Ss "Function Declarations"
1300 macro is used in the
1302 section with section two or three functions.
1303 It is neither callable nor parsed.
1305 .Dl Usage: .Fd Ao argument Ac ...
1307 .Bl -tag -width ".Li .Fd\ X#include\ <sys/types.h>X" -compact -offset 15n
1308 .It Li ".Fd \*[q]#include <sys/types.h>\*[q]"
1309 .Fd "#include <sys/types.h>"
1316 command causes a line break if a function has already been presented and a
1317 break has not occurred.
1318 This leaves a nice vertical space in between the previous function call and
1319 the declaration for the next function.
1326 section, represents the
1328 statement, and is the short form of the above example.
1329 It specifies the C\~header file as being included in a C\~program.
1330 It also causes a line break.
1334 section, it represents the header file enclosed in angle brackets.
1336 .Dl Usage: .In Ao header file Ac
1338 .Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n
1339 .nr in-synopsis-section 1
1340 .It Li ".In stdio.h"
1342 .nr in-synopsis-section 0
1343 .It Li ".In stdio.h"
1347 .Ss "Function Types"
1349 This macro is intended for the
1352 It may be used anywhere else in the man page without problems, but its main
1353 purpose is to present the function type in kernel normal form for the
1355 of sections two and three (it causes a line break, allowing the function
1356 name to appear on the next line).
1358 .Dl Usage: .Ft Ao type Ac ...
1360 .Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n
1361 .It Li ".Ft struct stat"
1365 .Ss "Functions (Library Routines)"
1373 .Dl Usage: .Fn Ao function Ac Oo Ao parameter Ac Oc ...
1375 .Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n
1376 .It Li ".Fn getchar"
1378 .It Li ".Fn strlen ) ,"
1380 .It Li ".Fn align \*[q]char *ptr\*[q] ,"
1381 .Fn align "char *ptr" ,
1384 Note that any call to another macro signals the end of the
1386 call (it will insert a closing parenthesis at that point).
1388 For functions with many parameters (which is rare), the macros
1396 (function argument).
1400 .Bd -literal -offset indent
1409 \&.Fa "struct rrec *newrr"
1417 .Bd -ragged -offset indent
1426 .Fa "struct rrec *newrr"
1435 section, the function will always begin at the beginning of line.
1436 If there is more than one function presented in the
1438 section and a function type has not been given, a line break will occur,
1439 leaving a nice vertical space between the current function name and the one
1442 The default width values of
1446 are 12n and 16n, respectively.
1448 .Ss "Function Arguments"
1452 macro is used to refer to function arguments (parameters) outside of the
1454 section of the manual or inside the
1456 section if the enclosure macros
1464 may also be used to refer to structure members.
1466 .Dl Usage: .Fa Ao function argument Ac ...
1468 .Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n
1469 .It Li ".Fa d_namlen ) ) ,"
1471 .It Li ".Fa iov_len"
1475 The default width is 12n.
1481 macro generates text for use in the
1485 .Dl Usage: .Rv Oo \-std Oc Op Ao function Ac ...
1488 .Ql ".Rv \-std atexit"
1491 .Bd -ragged -offset indent
1492 \# a small hack to suppress a warning message
1493 .ds section-old "\*[section]
1496 .ds section "\*[section-old]
1501 option is valid only for manual page sections\~2 and\~3.
1502 Currently, this macro does nothing if used without the
1510 macro generates text for use in the
1514 .Dl Usage: .Ex Oo \-std Oc Op Ao utility Ac ...
1520 .Bd -ragged -offset indent
1521 \# a small hack to suppress a warning message
1522 .ds section-old "\*[section]
1525 .ds section "\*[section-old]
1530 option is valid only for manual page sections 1, 6 and\~8.
1531 Currently, this macro does nothing if used without the
1535 .Ss "Interactive Commands"
1539 macro designates an interactive or internal command.
1541 .Dl Usage: .Ic Ao argument Ac ...
1543 .Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n
1546 .It Li ".Ic \*[q]do while {...}\*[q]"
1547 .Ic "do while {...}"
1548 .It Li ".Ic setenv , unsetenv"
1549 .Ic setenv , unsetenv
1552 The default width is 12n.
1558 macro is used to specify the library where a particular function is compiled
1561 .Dl Usage: .Lb Ao argument Ac ...
1563 Available arguments to
1565 and their results are:
1568 .Bl -tag -width ".Li librpcsec_gss" -compact -offset indent
1675 .It Li librpcsec_gss
1711 Local, OS-specific additions might be found in the file
1713 look for strings named
1716 then denotes the keyword to be used with the
1724 command causes a line break before and after its arguments are printed.
1731 literal macro may be used for special characters, variable constants, etc.\&
1732 \- anything which should be displayed as it would be typed.
1734 .Dl Usage: .Li Ao argument Ac ...
1736 .Bl -tag -width ".Li .Li\ cntrl\-D\ )\ ," -compact -offset 15n
1739 .It Li ".Li M1 M2 M3 ;"
1741 .It Li ".Li cntrl\-D ) ,"
1743 .It Li ".Li 1024 ..."
1747 The default width is 16n.
1753 macro is used for the document title or subject name.
1754 It has the peculiarity of remembering the first argument it was called with,
1755 which should always be the subject name of the page.
1756 When called without arguments,
1758 regurgitates this initial name for the sole purpose of making less work for
1761 causes a line break within the
1765 Note: A section two or three document function name is addressed with the
1773 and remaining sections.
1774 For interactive commands, such as the
1780 macro should be used.
1786 it can not recall the first argument it was invoked with.
1788 .Dl Usage: .Nm Oo Ao argument Ac Oc ...
1790 .Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
1791 .It Li ".Nm groff_mdoc"
1793 .It Li ".Nm \e\-mdoc"
1795 .It Li ".Nm foo ) ) ,"
1801 The default width is 10n.
1807 macro places option brackets around any remaining arguments on the
1808 command line, and places any trailing punctuation outside the brackets.
1813 (which produce an opening and a closing option bracket respectively) may be used
1814 across one or more lines or to specify the exact position of the closing
1817 .Dl Usage: .Op Oo Ao option Ac Oc ...
1819 .Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n
1824 .It Li ".Op Fl k ) ."
1826 .It Li ".Op Fl k Ar kookfile"
1827 .Op Fl k Ar kookfile
1828 .It Li ".Op Fl k Ar kookfile ,"
1829 .Op Fl k Ar kookfile ,
1830 .It Li ".Op Ar objfil Op Ar corfil"
1831 .Op Ar objfil Op Ar corfil
1832 .It Li ".Op Fl c Ar objfil Op Ar corfil ,"
1833 .Op Fl c Ar objfil Op Ar corfil ,
1834 .It Li ".Op word1 word2"
1836 .It Li ".Li .Op Oo Ao option Ac Oc ..."
1837 .Li .Op Oo Ao option Ac Oc ...
1840 Here a typical example of the
1846 .Bd -literal -offset indent
1848 \&.Op Fl k Ar kilobytes
1849 \&.Op Fl i Ar interval
1856 .Bd -filled -offset indent
1858 .Op Fl k Ar kilobytes
1859 .Op Fl i Ar interval
1864 The default width values of
1868 are 14n and 10n, respectively.
1874 macro formats path or file names.
1875 If called without arguments, the
1877 string is output, which represents the current user's home directory.
1879 .Dl Usage: .Pa Oo Ao pathname Ac Oc ...
1881 .Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n
1884 .It Li ".Pa /usr/share"
1886 .It Li ".Pa /tmp/fooXXXXX ) ."
1887 .Pa /tmp/fooXXXXX ) .
1890 The default width is 32n.
1896 macro replaces standard abbreviations with their formal names.
1898 .Dl Usage: .St Ao abbreviation Ac ...
1901 .Dq Abbreviation/Formal Name
1907 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1925 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1926 .It Li \-iso9945\-1\-90
1928 .It Li \-iso9945\-1\-96
1932 .It Li \-p1003.1\-88
1934 .It Li \-p1003.1\-90
1936 .It Li \-p1003.1\-96
1938 .It Li \-p1003.1b\-93
1940 .It Li \-p1003.1c\-95
1942 .It Li \-p1003.1g\-2000
1944 .It Li \-p1003.1i\-95
1946 .It Li \-p1003.1\-2001
1948 .It Li \-p1003.1\-2004
1950 .It Li \-p1003.1\-2008
1955 Part 2: Shell and Utilities
1957 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1958 .It Li \-iso9945\-2\-93
1962 .It Li \-p1003.2\-92
1964 .It Li \-p1003.2a\-92
1970 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1999 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
2008 .Ss "Variable Types"
2012 macro may be used whenever a type is referenced.
2015 section, it causes a line break (useful for old style variable declarations).
2017 .Dl Usage: .Vt Ao type Ac ...
2019 .Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n
2020 .It Li ".Vt extern char *optarg ;"
2021 .Vt extern char *optarg ;
2028 Generic variable reference.
2030 .Dl Usage: .Va Ao variable Ac ...
2032 .Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n
2035 .It Li ".Va settimer ,"
2037 .It Li ".Va \*[q]int *prt\*[q] ) :"
2039 .It Li ".Va \*[q]char s\*[q] ] ) ) ,"
2040 .Va "char s" ] ) ) ,
2043 The default width is 12n.
2045 .Ss "Manual Page Cross References"
2049 macro expects the first argument to be a manual page name.
2050 The optional second argument, if a string (defining the manual section), is
2051 put into parentheses.
2053 .Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
2055 .Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
2062 .It Li ".Xr xinit 1x ;"
2066 The default width is 10n.
2069 .Sh "GENERAL TEXT DOMAIN"
2074 .Dl Usage: .At Oo Ao version Ac Oc ...
2076 .Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n
2083 The following values for
2087 .Dl 32v, v1, v2, v3, v4, v5, v6, v7, III, V, V.1, V.2, V.3, V.4
2092 .Dl "Usage: .Bx" Bro \-alpha | \-beta | \-devel Brc ...
2093 .Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
2095 .Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
2100 .It Li ".Bx \-devel"
2105 will be prepended to the string
2107 The following values for
2111 .Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
2116 .Dl Usage: .Nx Oo Ao version Ac Oc ...
2118 .Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n
2125 For possible values of
2127 see the description of the
2129 command above in section
2130 .Sx "TITLE MACROS" .
2135 .Dl Usage: .Fx Oo Ao version Ac Oc ...
2137 .Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n
2144 For possible values of
2146 see the description of the
2148 command above in section
2149 .Sx "TITLE MACROS" .
2151 .Ss "DragonFly Macro"
2154 .Dl Usage: .Dx Oo Ao version Ac Oc ...
2156 .Bl -tag -width ".Li .Dx\ 1.4\ ." -compact -offset 15n
2163 For possible values of
2165 see the description of the
2167 command above in section
2168 .Sx "TITLE MACROS" .
2173 .Dl Usage: .Ox Oo Ao version Ac Oc ...
2175 .Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n
2183 .Dl Usage: .Bsx Oo Ao version Ac Oc ...
2185 .Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n
2195 .Bl -tag -width ".Li .Ux" -compact -offset 15n
2200 .Ss "Emphasis Macro"
2202 Text may be stressed or emphasized with the
2205 The usual font for emphasis is italic.
2207 .Dl Usage: .Em Ao argument Ac ...
2209 .Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n
2210 .It Li ".Em does not"
2212 .It Li ".Em exceed 1024 ."
2214 .It Li ".Em vide infra ) ) ,"
2215 .Em vide infra ) ) ,
2218 The default width is 10n.
2224 font mode must be ended with the
2226 macro (the latter takes no arguments).
2227 Font modes may be nested within other font modes.
2230 has the following syntax:
2232 .Dl .Bf Ao font mode Ac
2235 must be one of the following three types:
2237 .Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent
2238 .It Sy \&Em | Fl emphasis
2241 macro was used for the entire block of text.
2242 .It Sy \&Li | Fl literal
2245 macro was used for the entire block of text.
2246 .It Sy \&Sy | Fl symbolic
2249 macro was used for the entire block of text.
2252 Both macros are neither callable nor parsed.
2254 .Ss "Enclosure and Quoting Macros"
2256 The concept of enclosure is similar to quoting.
2257 The object being to enclose one or more strings between a pair of characters
2258 like quotes or parentheses.
2259 The terms quoting and enclosure are used interchangeably throughout this
2261 Most of the one-line enclosure macros end in small letter
2263 to give a hint of quoting, but there are a few irregularities.
2264 For each enclosure macro there is also a pair of open and close macros which
2265 end in small letters
2278 Quote Open Close Function Result
2279 \&.Aq .Ao .Ac Angle Bracket Enclosure <string>
2280 \&.Bq .Bo .Bc Bracket Enclosure [string]
2281 \&.Brq .Bro .Brc Brace Enclosure {string}
2282 \&.Dq .Do .Dc Double Quote "string"
2283 \&.Eq .Eo .Ec Enclose String (in XX) XXstring
2284 \&.Pq .Po .Pc Parenthesis Enclosure (string)
2285 \&.Ql Quoted Literal \*[Lq]string\*[Rq] or string
2286 \&.Qq .Qo .Qc Straight Double Quote "string"
2287 \&.Sq .So .Sc Single Quote 'string'
2290 All macros ending with
2294 have a default width value of 12n.
2296 .Bl -tag -width ".Li .Ec , .Eo"
2298 These macros expect the first argument to be the opening and closing strings
2301 Due to the nine-argument limit in the original troff program two other
2302 macros have been implemented which are now rather obsolete:
2304 takes the first and second parameter as the left and right enclosure string,
2305 which are then used to enclose the arguments of
2307 The default width value is 12n for both macros.
2309 The first and second arguments of this macro are the opening and
2310 closing strings respectively, followed by the arguments to be enclosed.
2312 The quoted literal macro behaves differently in troff and nroff mode.
2315 a quoted literal is always quoted.
2316 If formatted with troff, an item is only quoted if the width of the item is
2317 less than three constant width characters.
2318 This is to make short strings more visible where the font change to literal
2319 (constant width) is less noticeable.
2321 The default width is 16n.
2323 The prefix macro suppresses the whitespace between its first and second
2326 .Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent
2327 .It Li ".Pf ( Fa name2"
2331 The default width is 12n.
2335 macro (see below) performs the analogous suffix function.
2339 macro inserts an apostrophe and exits any special text modes, continuing in
2345 Examples of quoting:
2348 .Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent
2351 .It Li ".Aq Pa ctype.h ) ,"
2355 .It Li ".Bq Em Greek , French ."
2356 .Bq Em Greek , French .
2359 .It Li ".Dq string abc ."
2361 .It Li ".Dq \'^[A\-Z]\'"
2363 .It Li ".Ql man mdoc"
2367 .It Li ".Qq string ) ,"
2369 .It Li ".Qq string Ns ),"
2375 .It Li ".Em or Ap ing"
2379 For a good example of nested enclosure macros, see the
2382 It was created from the same underlying enclosure macros as those presented
2388 extended argument list macros are discussed below.
2390 .Ss "No-Op or Normal Text Macro"
2394 macro can be used in a macro command line for parameters which should
2401 if you really want that English word (and not the macro) as a parameter.
2403 .Dl Usage: .No Ao argument Ac ...
2405 .Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n
2406 .It Li ".No test Ta with Ta tabs"
2407 .No test Ta with Ta tabs
2410 The default width is 12n.
2412 .Ss "No-Space Macro"
2416 macro suppresses insertion of a space between the current position and its
2418 For example, it is useful for old style argument lists where there is no
2419 space between the flag and argument:
2421 .Dl "Usage:" ... Ao argument Ac \&Ns Oo Ao argument Ac Oc ...
2422 .Dl " " .Ns Ao argument Ac ...
2424 .Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n
2425 .It Li ".Op Fl I Ns Ar directory"
2426 .Op Fl I Ns Ar directory
2431 macro always invokes the
2433 macro after eliminating the space unless another macro name follows it.
2434 If used as a command (i.e., the second form above in the
2441 .Ss "Section Cross References"
2445 macro designates a reference to a section header within the same document.
2447 .Dl Usage: .Sx Ao section reference Ac ...
2449 .Bl -tag -width ".Li .Sx\ FILES" -offset 15n
2454 The default width is 16n.
2458 The symbolic emphasis macro is generally a boldface macro in either the
2459 symbolic sense or the traditional English usage.
2461 .Dl Usage: .Sy Ao symbol Ac ...
2463 .Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n
2464 .It Li ".Sy Important Notice"
2465 .Sy Important Notice
2468 The default width is 6n.
2470 .Ss Mathematical Symbols
2472 Use this macro for mathematical symbols and similar things.
2474 .Dl Usage: .Ms Ao math symbol Ac ...
2476 .Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n
2481 The default width is 6n.
2483 .Ss "References and Citations"
2485 The following macros make a modest attempt to handle references.
2486 At best, the macros make it convenient to manually drop in a subset of
2490 .Bl -tag -width 6n -offset indent -compact
2492 Reference start (does not take arguments).
2493 Causes a line break in the
2495 section and begins collection of reference information until the reference
2498 Reference end (does not take arguments).
2499 The reference is printed.
2501 Reference author name; one name per invocation.
2509 Issuer/publisher name.
2515 Optional information.
2519 Corporate or foreign author.
2525 Optional hypertext reference.
2530 Macros beginning with
2532 are not callable but accept multiple arguments in the usual way.
2535 macro is handled properly as a parameter; other macros will cause strange
2540 can be used outside of the
2546 .Bd -literal -offset indent
2550 \&.%T "Implementation Notes on foobar(1)"
2551 \&.%R "Technical Report ABC\-DE\-12\-345"
2552 \&.%Q "Drofnats College"
2560 .Bd -ragged -offset indent
2564 .%T "Implementation Notes on foobar(1)"
2565 .%R "Technical Report ABC-DE-12-345"
2566 .%Q "Drofnats College"
2572 .Ss "Trade Names (or Acronyms and Type Names)"
2574 The trade name macro prints its arguments in a smaller font.
2575 Its intended use is to imitate a small caps fonts for uppercase acronyms.
2577 .Dl Usage: .Tn Ao symbol Ac ...
2579 .Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n
2586 The default width is 10n.
2588 .Ss "Extended Arguments"
2594 macros allow one to extend an argument list on a macro boundary for the
2601 are implemented similarly to all other macros opening and closing an
2602 enclosure (without inserting characters, of course).
2603 This means that the following is true for those macros also.
2605 Here is an example of
2607 using the space mode macro to turn spacing off:
2609 .Bd -literal -offset indent
2611 \&.It Xo Sy I Ar operation
2612 \&.No \een Ar count No \een
2619 .Bd -filled -offset indent
2622 .It Xo Sy I Ar operation
2623 .No \en Ar count No \en
2632 .Bd -literal -offset indent
2634 \&.It Cm S No / Ar old_pattern Xo
2635 \&.No / Ar new_pattern
2643 .Bd -filled -offset indent
2646 .It Cm S No \&/ Ar old_pattern Xo
2647 .No \&/ Ar new_pattern
2656 and enclosure macros: Test the value of a variable.
2658 .Bd -literal -offset indent
2661 \&.Oo \e&! Oc Ns Ar variable Oo
2662 \&.Ar operator variable ...
2668 .Bd -filled -offset indent
2669 .Bl -tag -width flag -compact
2672 .Oo \&! Oc Ns Ar variable Oo
2673 .Ar operator variable ...
2679 .Sh "PAGE STRUCTURE DOMAIN"
2681 .Ss "Section Headers"
2685 section header macros are required in every man page.
2686 The remaining section headers are recommended at the discretion of the
2687 author writing the manual page.
2690 macro is parsed but not generally callable.
2691 It can be used as an argument in a call to
2693 only; it then reactivates the default font for
2696 The default width is 8n.
2698 .Bl -tag -width ".Li .Sh\ RETURN\ VALUES"
2703 If not specified, headers, footers and page layout defaults will not be set
2704 and things will be rather unpleasant.
2707 section consists of at least three items.
2710 name macro naming the subject of the man page.
2711 The second is the name description macro,
2713 which separates the subject name from the third item, which is the
2715 The description should be the most terse and lucid possible, as the space
2721 then all its arguments.
2723 .It Li ".Sh LIBRARY"
2724 This section is for section two and three function calls.
2725 It should consist of a single
2729 .Sx "Library Names" .
2731 .It Li ".Sh SYNOPSIS"
2734 section describes the typical usage of the subject of a man page.
2735 The macros required are either
2746 The function name macro
2748 is required for manual page sections\~2 and\~3; the command and general name
2751 is required for sections 1, 5, 6, 7, and\~8.
2752 Section\~4 manuals require a
2757 configuration device usage macro.
2758 Several other macros may be necessary to produce the synopsis line as shown
2761 .Bd -filled -offset indent
2768 The following macros were used:
2771 .Dl ".Op Fl benstuv"
2775 .It Li ".Sh DESCRIPTION"
2776 In most cases the first text in the
2778 section is a brief paragraph on the command, function or file, followed by a
2779 lexical list of options and respective explanations.
2780 To create such a list, the
2787 macros are used (see
2788 .Sx Lists and Columns
2791 .It Li ".Sh IMPLEMENTATION NOTES"
2792 Implementation specific information should be placed here.
2794 .It Li ".Sh RETURN VALUES"
2795 Sections 2, 3 and\~9 function return values should go here.
2798 macro may be used to generate text for use in the
2800 section for most section 2 and 3 library functions;
2802 .Sx "Return Values" .
2807 section headers are part of the preferred manual page layout and must be
2808 used appropriately to maintain consistency.
2809 They are listed in the order in which they would be used.
2811 .Bl -tag -width ".Li .Sh\ COMPATIBILITY"
2812 .It Li ".Sh ENVIRONMENT"
2815 section should reveal any related environment variables and clues to their
2816 behavior and/or usage.
2819 Files which are used or created by the man page subject should be listed via
2826 .It Li ".Sh EXAMPLES"
2827 There are several ways to create examples.
2830 section below for details.
2832 .It Li ".Sh DIAGNOSTICS"
2833 Diagnostic messages from a command should be placed in this section.
2836 macro may be used to generate text for use in the
2838 section for most section 1, 6 and\~8 commands;
2842 .It Li ".Sh COMPATIBILITY"
2843 Known compatibility issues (e.g.\& deprecated options or parameters)
2844 should be listed here.
2847 Specific error handling, especially from library functions (man page
2848 sections 2, 3, and\~9) should go here.
2851 macro is used to specify an error (errno).
2853 .It Li ".Sh SEE ALSO"
2854 References to other material on the man page topic and cross references to
2855 other relevant man pages should be placed in the
2858 Cross references are specified using the
2863 style references are not accommodated.
2865 It is recommended that the cross references are sorted on the section
2866 number, then alphabetically on the names within a section, and placed
2867 in that order and comma separated.
2875 .It Li ".Sh STANDARDS"
2876 If the command, library function or file adheres to a specific
2877 implementation such as
2881 this should be noted here.
2882 If the command does not adhere to any standard, its history should be noted
2887 .It Li ".Sh HISTORY"
2888 Any command which does not adhere to any specific standards should be
2889 outlined historically in this section.
2891 .It Li ".Sh AUTHORS"
2892 Credits should be placed here.
2895 macro for names and the
2897 macro for e-mail addresses within optional contact information.
2898 Explicitly indicate whether the person authored the initial manual page
2899 or the software or whatever the person is being credited for.
2901 Blatant problems with the topic go here.
2906 sections may be added; for example, this section was set with:
2908 .Bd -literal -offset 15n
2909 \&.Sh "PAGE STRUCTURE DOMAIN"
2912 .Ss "Subsection Headers"
2914 Subsection headers have exactly the same syntax as section headers:
2916 is parsed but not generally callable.
2917 It can be used as an argument in a call to
2919 only; it then reactivates the default font for
2922 The default width is 8n.
2924 .Ss "Paragraphs and Line Spacing"
2926 .Bl -tag -width ".Li .Pp"
2930 paragraph command may be used to specify a line space where necessary.
2931 The macro is not necessary after a
2939 macro (which both assert a vertical distance unless the
2943 The macro is neither callable nor parsed and takes no arguments; an
2950 .\" This worked with version one, need to redo for version three
2953 .\" .Cw (ax+bx+c) \ is\ produced\ by\ \&
2954 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
2971 .\" .Em is produced by
2987 .\" This example shows the same equation in a different format.
2991 .\" signs were forced with
2995 .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
2996 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
3007 .\" .Li \&.Cx \e\ +\e\ \e&
3018 .\" .Em is produced by
3026 .\" .Li \&.Cx \e\ +\e\ \e&
3037 .\" The incantation below was
3043 .\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
3045 .\" .Li \&.Cx Op Sy ?/
3055 .\" .Em is produced by
3057 .\" .Li \&.Ar \e\ b1 e1 f1
3071 The only keep that is implemented at this time is for words.
3078 The only option that
3080 accepts currently is
3082 (this is also the default if no option is given) which is useful for
3083 preventing line breaks in the middle of options.
3084 In the example for the make command line arguments (see
3085 .Sx What's in a Name ) ,
3088 from placing up the flag and the argument on separate lines.
3090 Both macros are neither callable nor parsed.
3092 More work needs to be done with the keep macros; specifically, a
3094 option should be added.
3096 .Ss "Examples and Displays"
3098 There are seven types of displays.
3100 .Bl -tag -width ".Li .D1"
3103 Display one line of indented text.
3104 This macro is parsed but not callable.
3108 The above was produced by:
3109 .Li ".D1 Fl ldghfstru" .
3113 Display one line of indented
3118 example macro has been used throughout this file.
3119 It allows the indentation (display) of one line of text.
3120 Its default font is set to constant width (literal).
3122 is parsed but not callable.
3124 .Dl % ls \-ldg /usr/local/bin
3126 The above was produced by:
3127 .Li ".Dl % ls \e\-ldg /usr/local/bin" .
3133 display must be ended with the
3136 It has the following syntax:
3138 .Bd -ragged -compact
3139 .Bl -tag -width ".Li .Bd" -offset indent
3141 .Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc
3142 .Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
3146 .Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
3148 Fill, but do not adjust the right margin (only left-justify).
3150 Center lines between the current left and right margin.
3151 Note that each single line is centered.
3153 Do not fill; display a block of text as typed, using line breaks as
3154 specified by the user.
3155 This can produce overlong lines without warning messages.
3157 Display a filled block.
3158 The block of text is formatted (i.e., the text is justified on both the left
3161 Display block with literal font (usually fixed-width).
3162 Useful for source code or simple tabbed or spaced text.
3163 .It Fl file Ao Ar file name Ac
3164 The file whose name follows the
3166 flag is read and displayed before any data enclosed with
3170 using the selected display type.
3172 .Xr troff/ Ns Nm \-mdoc
3173 commands in the file will be processed.
3174 .It Fl offset Ao Ar string Ac
3177 is specified with one of the following strings, the string is interpreted to
3178 indicate the level of indentation for the forthcoming block of text:
3181 .Bl -tag -width ".Ar indent-two" -compact
3183 Align block on the current left margin; this is the default mode of
3186 Supposedly center the block.
3187 At this time unfortunately, the block merely gets left aligned about an
3188 imaginary center margin.
3190 Indent by one default indent value or tab.
3191 The default indent value is also used for the
3195 macros, so one is guaranteed the two types of displays will line up.
3196 The indentation value is normally set to\~6n or about two thirds of an inch
3197 (six constant width characters).
3199 Indent two times the default indent value.
3203 aligns the block about two inches from the right side of the page.
3204 This macro needs work and perhaps may never do the right thing within
3210 is a valid numeric expression instead
3211 .Pf ( Em with a scale indicator other than
3213 use that value for indentation.
3214 The most useful scale indicators are
3218 specifying the so-called
3222 This is approximately the width of the letters
3227 of the current font (for nroff output, both scale indicators give the same
3231 isn't a numeric expression, it is tested whether it is an
3233 macro name, and the default offset value associated with this macro is used.
3234 Finally, if all tests fail,
3237 (typeset with a fixed-width font) is taken as the offset.
3239 Suppress insertion of vertical space before begin of display.
3243 End display (takes no arguments).
3246 .Ss "Lists and Columns"
3248 There are several types of lists which may be initiated with the
3251 Items within the list are specified with the
3253 item macro, and each list must end with the
3256 Lists may be nested within themselves and within displays.
3257 The use of columns inside of lists or lists inside of columns is unproven.
3259 In addition, several list attributes may be specified such as the width of a
3260 tag, the list offset, and compactness (blank lines between items allowed or
3262 Most of this document has been formatted with a tag style list
3265 It has the following syntax forms:
3267 .Bd -ragged -compact
3268 .Bl -tag -width ".Li .Bl" -offset indent -compact
3270 .Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc
3271 .Oo \-width Ao string Ac Oc
3272 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3274 .No \-column Oo \-offset Ao string Ac Oc
3275 .Ao string1 Ac Ao string2 Ac ... Xc
3277 .Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc
3278 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3282 And now a detailed description of the list types.
3284 .Bl -tag -width ".Fl column" -compact
3288 .Bd -literal -offset indent
3289 \&.Bl \-bullet \-offset indent \-compact
3291 Bullet one goes here.
3299 .Bl -bullet -offset indent -compact
3301 Bullet one goes here.
3306 .It Fl dash No ( or Fl hyphen )
3309 .Bd -literal -offset indent
3310 \&.Bl \-dash \-offset indent \-compact
3320 .Bl -dash -offset indent -compact
3330 .Bd -literal -offset indent
3331 \&.Bl \-enum \-offset indent \-compact
3341 .Bl -enum -offset indent -compact
3348 If you want to nest enumerated lists, use the
3350 flag (starting with the second-level list):
3352 .Bd -literal -offset indent
3353 \&.Bl \-enum \-offset indent \-compact
3356 \&.Bl \-enum \-nested \-compact
3360 And item three here.
3369 .Bl -enum -offset indent -compact
3372 .Bl -enum -nested -compact
3376 And item three here.
3385 without list markers.
3387 .Bd -literal -offset indent
3388 \&.Bl \-item \-offset indent
3402 .Bl -item -offset indent
3417 to specify the tag width.
3419 .Bl -tag -width "PPID" -compact -offset indent
3421 sleep time of the process (seconds blocked)
3425 resulting from references by the process
3426 to pages not loaded in core.
3428 numerical user-id of process owner
3430 numerical id of parent of process priority
3431 (non-positive when in non-interruptible wait)
3436 .Bd -literal -offset indent
3437 \&.Bl \-tag \-width "PPID" \-compact \-offset indent
3439 sleep time of the process (seconds blocked)
3443 resulting from references by the process
3444 to pages not loaded in core.
3446 numerical user\-id of process owner
3448 numerical id of parent of process priority
3449 (non\-positive when in non\-interruptible wait)
3454 Diag lists create section four diagnostic lists and are similar to inset
3455 lists except callable macros are ignored.
3458 flag is not meaningful in this context.
3462 .Bd -literal -offset indent
3464 \&.It You can't use Sy here.
3465 The message says all.
3472 .It You can't use Sy here.
3473 The message says all.
3477 A list with hanging tags.
3479 .Bl -hang -offset indent
3481 labels appear similar to tagged lists when the
3482 label is smaller than the label width.
3483 .It Em Longer hanged list labels
3484 blend into the paragraph unlike
3485 tagged paragraph labels.
3488 And the unformatted text which created it:
3490 .Bd -literal -offset indent
3491 \&.Bl \-hang \-offset indent
3493 labels appear similar to tagged lists when the
3494 label is smaller than the label width.
3495 \&.It Em Longer hanged list labels
3496 blend into the paragraph unlike
3497 tagged paragraph labels.
3502 Lists with overhanging tags do not use indentation for the items; tags are
3503 written to a separate line.
3505 .Bl -ohang -offset indent
3507 sleep time of the process (seconds blocked)
3511 resulting from references by the process
3512 to pages not loaded in core.
3514 numerical user-id of process owner
3516 numerical id of parent of process priority
3517 (non-positive when in non-interruptible wait)
3522 .Bd -literal -offset indent
3523 \&.Bl \-ohang \-offset indent
3525 sleep time of the process (seconds blocked)
3529 resulting from references by the process
3530 to pages not loaded in core.
3532 numerical user\-id of process owner
3534 numerical id of parent of process priority
3535 (non\-positive when in non\-interruptible wait)
3540 Here is an example of inset labels:
3542 .Bl -inset -offset indent
3544 The tagged list (also called a tagged paragraph)
3545 is the most common type of list used in the
3549 attribute as described below.
3551 Diag lists create section four diagnostic lists
3552 and are similar to inset lists except callable
3555 Hanged labels are a matter of taste.
3557 Overhanging labels are nice when space is constrained.
3559 Inset labels are useful for controlling blocks of
3560 paragraphs and are valuable for converting
3562 manuals to other formats.
3565 Here is the source text which produced the above example:
3567 .Bd -literal -offset indent
3568 \&.Bl \-inset \-offset indent
3570 The tagged list (also called a tagged paragraph)
3571 is the most common type of list used in the
3574 Diag lists create section four diagnostic lists
3575 and are similar to inset lists except callable
3578 Hanged labels are a matter of taste.
3580 Overhanging labels are nice when space is constrained.
3582 Inset labels are useful for controlling blocks of
3583 paragraphs and are valuable for converting
3585 manuals to other formats.
3590 This list type generates multiple columns.
3591 The number of columns and the width of each column is determined by the
3602 (dot) immediately followed by a valid
3604 macro name, interpret
3606 and use the width of the result.
3607 Otherwise, the width of
3609 (typeset with a fixed-width font) is taken as the
3615 argument is parsed to make a row, each column within the row is a separate
3616 argument separated by a tab or the
3622 .Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3623 .It Sy String Ta Sy Nroff Ta Sy Troff
3624 .It Li <= Ta <= Ta \*(<=
3625 .It Li >= Ta >= Ta \*(>=
3631 \&.Bl \-column \-offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3632 \&.It Sy String Ta Sy Nroff Ta Sy Troff
3633 \&.It Li <= Ta <= Ta \e*(<=
3634 \&.It Li >= Ta >= Ta \e*(>=
3638 Don't abuse this list type!
3639 For more complicated cases it might be far better and easier to use
3641 the table preprocessor.
3646 .Bl -tag -width ".Fl indent Ao Ar string Ac"
3647 .It Fl width Ao Ar string Ac
3652 (dot) immediately followed by a valid
3654 macro name, interpret
3656 and use the width of the result.
3657 Almost all lists in this document use this option.
3661 .Bd -literal -offset indent
3662 \&.Bl \-tag \-width ".Fl test Ao Ar string Ac"
3663 \&.It Fl test Ao Ar string Ac
3664 This is a longer sentence to show how the
3666 flag works in combination with a tag list.
3672 .Bl -tag -width ".Fl test Ao Ar string Ac"
3673 .It Fl test Ao Ar string Ac
3674 This is a longer sentence to show how the
3676 flag works in combination with a tag list.
3679 (Note that the current state of
3683 is interpreted; afterwards, all variables are restored again.
3684 However, boxes (used for enclosures) can't be saved in
3686 as a consequence, arguments must always be
3688 to avoid nasty errors.
3689 For example, do not write
3692 .Ql ".Ao Ar string Xc"
3693 instead if you really need only an opening angle bracket.)
3697 is a valid numeric expression
3698 .Em ( with a scale indicator other than
3700 use that value for indentation.
3701 The most useful scale indicators are
3705 specifying the so-called
3709 This is approximately the width of the letters
3714 of the current font (for nroff output, both scale indicators give the same
3718 isn't a numeric expression, it is tested whether it is an
3720 macro name, and the default width value associated with this macro is used.
3721 Finally, if all tests fail,
3724 (typeset with a fixed-width font) is taken as the width.
3726 If a width is not specified for the tag list type, every time
3728 is invoked, an attempt is made to determine an appropriate width.
3729 If the first argument to
3731 is a callable macro, the default width for that macro will be used;
3732 otherwise, the default width of
3735 .It Fl offset Ao Ar string Ac
3740 a default indent value (normally set to\~6n, similar to the value used in
3747 is a valid numeric expression instead
3748 .Pf ( Em with a scale indicator other than
3750 use that value for indentation.
3751 The most useful scale indicators are
3755 specifying the so-called
3759 This is approximately the width of the letters
3764 of the current font (for nroff output, both scale indicators give the same
3768 isn't a numeric expression, it is tested whether it is an
3770 macro name, and the default offset value associated with this macro is used.
3771 Finally, if all tests fail,
3774 (typeset with a fixed-width font) is taken as the offset.
3776 Suppress insertion of vertical space before the list and between list items.
3780 .Sh "MISCELLANEOUS MACROS"
3782 Here a list of the remaining macros which do not fit well into one of the
3784 We couldn't find real examples for the following macros:
3788 They are documented here for completeness \- if you know how to use them
3789 properly please send a mail to
3791 (including an example).
3793 .Bl -tag -width ".Li .Bt"
3797 .Bd -ragged -offset indent
3801 It is neither callable nor parsed and takes no arguments.
3805 .Dl Usage: .Fr Ao function return value Ac ...
3807 Don't use this macro.
3808 It allows a break right before the return value (usually a single digit)
3809 which is bad typographical behaviour.
3812 to tie the return value to the previous word.
3815 Use this macro to include a (header) file literally.
3818 followed by the file name, then the contents of
3821 .Dl Usage: .Hf Ao file Ac
3823 It is neither callable nor parsed.
3829 Exact usage unknown.
3830 The documentation in the
3832 source file describes it as a macro for
3833 .Dq "menu entries" .
3835 Its default width is 6n.
3841 Exact usage unknown.
3842 The documentation in the
3844 source file describes it as
3845 .Dq old function type (fortran) .
3848 Activate (toggle) space mode.
3850 .Dl Usage: .Sm Oo on | off Oc ...
3852 If space mode is off, no spaces between macro arguments are inserted.
3853 If called without a parameter (or if the next parameter is neither
3863 .Bd -ragged -offset indent
3867 It is neither callable nor parsed and takes no arguments.
3871 .Sh "PREDEFINED STRINGS"
3873 The following strings are predefined:
3878 String Nroff Troff Meaning
3879 <= <= \*[<=] less equal
3880 >= >= \*[>=] greater equal
3881 Rq '' \*[Rq] right double quote
3882 Lq `` \*[Lq] left double quote
3883 ua ^ \*[ua] upwards arrow
3884 aa \' \*[aa] acute accent
3885 ga \` \*[ga] grave accent
3886 q \&" \*[q] straight double quote
3887 Pi pi \*[Pi] greek pi
3888 Ne != \*[Ne] not equal
3889 Le <= \*[Le] less equal
3890 Ge >= \*[Ge] greater equal
3891 Lt < \*[Lt] less than
3892 Gt > \*[Gt] greater than
3893 Pm +\- \*[Pm] plus minus
3894 If infinity \*[If] infinity
3895 Am \*[Am] \*[Am] ampersand
3896 Na \*[Na] \*[Na] not a number
3897 Ba \*[Ba] \*[Ba] vertical bar
3900 The names of the columns
3904 are a bit misleading;
3908 representation, while
3910 gives the best glyph form available.
3911 For example, a Unicode enabled
3913 device will have proper glyph representations for all strings, whereas the
3914 enhancement for a Latin1
3916 device is only the plus-minus sign.
3918 String names which consist of two characters can be written as
3920 string names which consist of one character can be written as
3922 A generic syntax for a string name of any length is
3933 available in previous versions of
3935 has been removed since
3937 provides better facilities to check parameters; additionally, many error and
3938 warning messages have been added to this macro package, making it both more
3941 The only remaining debugging macro is
3943 which yields a register dump of all global registers and strings.
3944 A normal user will never need it.
3947 .Sh "FORMATTING WITH @U_ROFF@, TROFF, AND NROFF"
3949 By default, the package inhibits page breaks, headers, and footers if
3956 to make the manual more efficient for viewing on-line.
3957 This behaviour can be changed (e.g.\& to create a hardcopy of the
3959 output) by setting the register
3961 to zero while calling
3963 resulting in multiple pages instead of a single, very long page:
3965 .Dl @L_ROFF@ \-Tlatin1 \-rcR=0 \-mdoc foo.man > foo.txt
3967 For double-sided printing, set register
3971 .Dl @L_ROFF@ \-Tps \-rD1 \-mdoc foo.man > foo.ps
3973 To change the document font size to 11pt or 12pt, set register
3977 .Dl @L_ROFF@ \-Tdvi \-rS11 \-mdoc foo.man > foo.dvi
3985 The line and title length can be changed by setting the registers
3991 .Dl @L_ROFF@ \-Tutf8 \-rLL=100n \-rLT=100n \-mdoc foo.man | less
3993 If not set, both registers default to 78n for TTY devices and 6.5i
3999 .Bl -tag -width mdoc-ditroff -compact
4001 The main manual macro package.
4003 A wrapper file to call
4006 Common strings, definitions, stuff related typographic output.
4008 Definitions used for a
4012 Definitions used for all other devices.
4014 Local additions and customizations.
4016 Use this file if you don't know whether the
4020 package should be used.
4021 Multiple man pages (in either format) can be handled.
4035 Section 3f has not been added to the header routines.
4038 font should be changed in
4043 needs to have a check to prevent splitting up
4044 if the line length is too short.
4046 separates the last parenthesis, and sometimes
4047 looks ridiculous if a line is in fill mode.
4049 The list and display macros do not do any keeps
4050 and certainly should be able to.
4051 .\" Note what happens if the parameter list overlaps a newline
4053 .\" to make sure a line boundary is crossed:
4055 .\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
4058 .\" produces, nudge nudge,
4059 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4060 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4062 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
4064 .\" If double quotes are used, for example:
4066 .\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
4069 .\" produces, nudge nudge,
4070 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4072 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4074 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
4076 .\" Not a pretty sight...
4077 .\" In a paragraph, a long parameter containing unpaddable spaces as
4078 .\" in the former example will cause
4080 .\" to break the line and spread
4081 .\" the remaining words out.
4082 .\" The latter example will adjust nicely to
4083 .\" justified margins, but may break in between an argument and its
4087 .\" the right margin adjustment is normally ragged and the problem is