3 .\" A complete reference of the mdoc macro package for GNU troff.
5 .\" Based on NetBSD's mdoc.samples.7, version 1.21.
8 .\" Warning: You can't format this file with the old mdoc macros!
11 .\" Copyright (c) 1990, 1993
12 .\" The Regents of the University of California. All rights reserved.
14 .\" Redistribution and use in source and binary forms, with or without
15 .\" modification, are permitted provided that the following conditions
17 .\" 1. Redistributions of source code must retain the above copyright
18 .\" notice, this list of conditions and the following disclaimer.
19 .\" 2. Redistributions in binary form must reproduce the above copyright
20 .\" notice, this list of conditions and the following disclaimer in the
21 .\" documentation and/or other materials provided with the distribution.
22 .\" 3. All advertising materials mentioning features or use of this software
23 .\" must display the following acknowledgement:
24 .\" This product includes software developed by the University of
25 .\" California, Berkeley and its contributors.
26 .\" 4. Neither the name of the University nor the names of its contributors
27 .\" may be used to endorse or promote products derived from this software
28 .\" without specific prior written permission.
30 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 .\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
44 .\" This reference invokes every macro in the package several
45 .\" times and is guaranteed to give a worst case performance
46 .\" for an already extremely slow package.
57 .Nd reference for groff's mdoc implementation
62 .Nm groff Fl m Ns Cm doc Ar
67 A complete reference for writing
75 formatting package for
80 package, addressed page layout leaving the manipulation of fonts and other
81 typesetting details to the individual author.
84 page layout macros make up the
85 .Em "page structure domain"
86 which consists of macros for titles, section headers, displays and lists
87 \- essentially items which affect the physical position of text on a
89 In addition to the page structure domain, there are two more domains, the
94 The general text domain is defined as macros which perform tasks such as
95 quoting or emphasizing pieces of text.
96 The manual domain is defined as macros that are a subset of the day to day
97 informal language used to describe commands, routines and related
100 Macros in the manual domain handle command names, command line arguments and
101 options, function names, function parameters, pathnames, variables, cross
102 references to other manual pages, and so on.
103 These domain items have value for both the author and the future user of the
105 Hopefully, the consistency gained across the manual set will provide easier
106 translation to future documentation tools.
110 manual pages, a manual entry is simply referred to as a man page, regardless
111 of actual length and without sexist intention.
114 .Sh "GETTING STARTED"
116 The material presented in the remainder of this document is outlined
119 .Bl -enum -width 3n -offset indent
121 . Tn "TROFF IDIOSYNCRASIES"
123 . Bl -tag -width 2n -compact
125 . It "Passing Space Characters in an Argument"
126 . It "Trailing Blank Space Characters"
127 . It "Escaping Special Characters"
128 . It "Other Possible Pitfalls"
132 . Tn "A MANUAL PAGE TEMPLATE"
141 . Tn "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
143 . Bl -tag -width 2n -compact
144 . It "What's in a Name" Ns ...
145 . It "General Syntax"
151 . Bl -tag -width 2n -compact
155 . It "Configuration Declarations (Section Four Only)"
156 . It "Command Modifiers"
157 . It "Defined Variables"
159 . It "Environment Variables"
161 . It "Function Declarations"
162 . It "Function Types"
163 . It "Functions (Library Routines)"
164 . It "Function Arguments"
167 . \" .It "Header File (including source code)"
168 . It "Interactive Commands"
175 . It "Variable Types"
177 . It "Manual Page Cross References"
181 . Tn "GENERAL TEXT DOMAIN"
183 . Bl -tag -width 2n -compact
191 . It "Emphasis Macro"
193 . It "Enclosure and Quoting Macros"
194 . It "No-Op or Normal Text Macro"
195 . It "No-Space Macro"
196 . It "Section Cross References"
198 . It "Mathematical Symbols"
199 . It "References and Citations"
200 . It "Trade Names (or Acronyms and Type Names)"
201 . It "Extended Arguments"
205 . Tn "PAGE STRUCTURE DOMAIN"
207 . Bl -tag -width 2n -compact
208 . It "Section Headers"
209 . It "Subsection Headers"
210 . It "Paragraphs and Line Spacing"
212 . It "Examples and Displays"
213 . It "Lists and Columns"
217 . Tn "MISCELLANEOUS MACROS"
220 . Tn "PREDEFINED STRINGS"
226 . Tn "FORMATTING WITH GROFF, TROFF, AND NROFF"
243 .Sh "TROFF IDIOSYNCRASIES"
247 package attempts to simplify the process of writing a man page.
248 Theoretically, one should not have to learn the tricky details of
253 however, there are a few limitations which are unavoidable and best gotten
255 And, too, be forewarned, this package is
264 a macro is called by placing a
266 (dot character) at the beginning of a line followed by the two-character
267 (or three-character) name for the macro.
268 There can be space or tab characters between the dot and the macro name.
269 Arguments may follow the macro separated by spaces (but
272 It is the dot character at the beginning of the line which causes
275 to interpret the next two (or more) characters as a macro name.
276 A single starting dot followed by nothing is ignored.
279 (dot character) at the beginning of an input line in some context other than
280 a macro invocation, precede the
284 escape sequence which translates literally to a zero-width space, and is
285 never displayed in the output.
290 macros accept an unlimited number of arguments (contrary to other versions
291 of troff which can't handle more than nine arguments).
292 In limited cases, arguments may be continued or extended on the next
294 .Sx Extended Arguments
296 Almost all macros handle quoted arguments (see
297 .Sx Passing Space Characters in an Argument
302 general text domain and manual domain macros are special in that their
305 for callable macro names.
306 This means an argument on the argument list which matches a general text or
307 manual domain macro name (and which is defined to be callable) will be
308 executed or called when it is processed.
309 In this case the argument, although the name of a macro, is not preceded by
313 This makes it possible to nest macros; for example the option macro,
317 the flag and argument macros,
321 to specify an optional flag with an argument:
323 .Bl -tag -width ".Op Fl s Ar bytes" -offset indent
326 .Ql ".Op Fl s Ar bytes"
330 To prevent a string from being interpreted as a macro name, precede the
331 string with the escape sequence
334 .Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent
335 .It Op \&Fl s \&Ar bytes
337 .Ql ".Op \e&Fl s \e&Ar bytes"
345 are not interpreted as macros.
346 Macros whose argument lists are parsed for callable arguments are referred
349 and macros which may be called from an argument list are referred to as
351 throughout this document.
354 as almost all of the macros in
356 are parsed, but as it was cumbersome to constantly refer to macros as
357 being callable and being able to call other macros, the term parsed
361 In the following, we call an
363 macro which starts a line (with a leading dot) a
365 if this distinction is necessary.
367 .Ss "Passing Space Characters in an Argument"
369 Sometimes it is desirable to give as an argument a string containing one or
370 more blank space characters, say, to specify arguments to commands which
371 expect particular arrangement of items in the argument list.
372 Additionally, it makes
375 For example, the function command
377 expects the first argument to be the name of a function and any remaining
378 arguments to be function parameters.
381 stipulates the declaration of function parameters in the parenthesized
382 parameter list, each parameter is guaranteed to be at minimum a two word
387 There are two possible ways to pass an argument which contains
389 One way of passing a string containing blank spaces is to use the hard or
390 unpaddable space character
392 that is, a blank space preceded by the escape character
394 This method may be used with any macro but has the side effect of
395 interfering with the adjustment of text over the length of a line.
397 sees the hard space as if it were any other printable character and cannot
398 split the string into blank or newline separated pieces as one would expect.
399 This method is useful for strings which are not expected to overlap a line
401 An alternative is to use
403 a paddable (i.e.\& stretchable), unbreakable space (this is a
407 The second method is to enclose the string with double quotes.
411 .Bl -tag -width ".Fn fetch char\ *str" -offset indent
412 .It Fn fetch char\ *str
414 .Ql ".Fn fetch char\e *str"
415 .It Fn fetch "char *str"
416 can also be created by
417 .Ql ".Fn fetch \*[q]char *str\*[q]"
423 before the space in the first example
424 or double quotes in the second example
427 would see three arguments, and the result would be:
429 .Dl Fn fetch char *str
431 .\" For an example of what happens when the parameter list overlaps a newline
432 .\" boundary, see the
436 .Ss "Trailing Blank Space Characters"
439 can be confused by blank space characters at the end of a line.
440 It is a wise preventive measure to globally remove all blank spaces
442 .Ao blank-space Ac Ns Ao end-of-line Ac
444 Should the need arise to use a blank character at the end of a line, it
445 may be forced with an unpaddable space and the
451 .Ss "Escaping Special Characters"
453 Special characters like the newline character
455 are handled by replacing the
461 to preserve the backslash.
463 .Ss "Other Possible Pitfalls"
465 A warning is emitted when an empty input line is found outside of displays
470 (Well, it is even better to use
472 macros to avoid the usage of low-level commands.)
474 Leading spaces will cause a break and are output directly.
475 Avoid this behaviour if possible.
476 Similarly, do not use more than one space character between words in an
477 ordinary text line; contrary to other text formatters, they are
479 replaced with a single space.
483 directly as an argument.
492 inserts two space characters after a punctuation mark closing a sentence;
497 are treated transparently, not influencing the sentence-ending behaviour.
498 To change this, insert
500 before or after the dot:
502 .Bd -literal -offset indent
521 .Bd -filled -offset indent
538 As can be seen in the first and third line,
540 handles punctuation characters specially in macro arguments.
541 This will be explained in section
544 In the same way, you have to protect trailing full stops of abbreviations
545 with a trailing zero-width space:
548 A comment in the source file of a man page can be either started with
554 anywhere (the latter is a
557 extension); the rest of such a line is ignored.
560 .Sh "A MANUAL PAGE TEMPLATE"
562 The body of a man page is easily constructed from a basic template:
564 .Bd -literal -offset indent
565 \&.\e" The following commands are required for all man pages.
566 \&.Dd Month day, year
567 \&.Os [OPERATING_SYSTEM] [version/release]
568 \&.Dt DOCUMENT_TITLE [section number] [architecture/volume]
571 \&.Nd one line description of name
572 \&.\e" This next command is for sections 2 and 3 only.
576 \&.\e" The following commands should be uncommented and
577 \&.\e" used where appropriate.
578 \&.\e" .Sh IMPLEMENTATION NOTES
579 \&.\e" This next command is for sections 2, 3 and 9 function
580 \&.\e" return values only.
581 \&.\e" .Sh RETURN VALUES
582 \&.\e" This next command is for sections 1, 6, 7 and 8 only.
583 \&.\e" .Sh ENVIRONMENT
586 \&.\e" This next command is for sections 1, 6, 7, 8 and 9 only
587 \&.\e" (command return values (to shell) and
588 \&.\e" fprintf/stderr type diagnostics).
589 \&.\e" .Sh DIAGNOSTICS
590 \&.\e" .Sh COMPATIBILITY
591 \&.\e" This next command is for sections 2, 3 and 9 error
592 \&.\e" and signal handling only.
602 The first items in the template are the commands
607 the document date, the operating system the man page or subject source is
608 developed or modified for, and the man page title (in
610 along with the section of the manual the page belongs in.
611 These commands identify the page and are discussed below in
614 The remaining items in the template are section headers
622 The headers are discussed in
623 .Sx "PAGE STRUCTURE DOMAIN" ,
624 after presentation of
625 .Sx "MANUAL DOMAIN" .
626 Several content macros are used to demonstrate page layout macros; reading
627 about content macros before page layout macros is recommended.
632 In the description of all macros below, optional arguments are put into
636 represents zero or more additional arguments.
637 Alternative values for a parameter are separated with
639 If there are alternative values for a mandatory parameter, braces are used
642 to enclose the value set.
643 Meta-variables are specified within angles.
647 .Bl -tag -width 6n -offset indent
651 .Op \-test1 Op \-test2 | \-test3
657 Except stated explicitly, all macros are parsed and callable.
659 Note that a macro takes effect up to the next nested macro.
666 Consequently, a warning message is emitted for most commands if the first
667 argument is a macro itself since it cancels the effect of the calling
669 Another consequence is that quoting macros never insert literal quotes;
672 .Ql ".Ic \*[q]foo <bar>\*[q]" .
674 Most macros have a default width value which can be used to specify a label
684 It is recommended not to use this rather obscure feature to avoid
685 dependencies on local modifications of the
692 The title macros are part of the page structure domain but are presented
693 first and separately for someone who wishes to start writing a man page
695 Three header macros designate the document title or manual page title, the
696 operating system, and the date of authorship.
697 These macros are called once at the very beginning of the document and are
698 used to construct headers and footers only.
702 .Op Aq document title
703 .Op Aq section number
706 The document title is the subject of the man page and must be in
708 due to troff limitations.
712 The section number may be a number in the range
713 .No 1,\~ Ns ... Ns ,\~9
719 If it is specified, and no volume name is given, a default volume name is
724 .Tn \*[operating-system] ,
725 the following sections are defined:
727 .Bl -column LOCAL -offset indent -compact
728 .It Li 1 Ta "\*[volume-operating-system] \*[volume-ds-1]"
729 .It Li 2 Ta "\*[volume-operating-system] \*[volume-ds-2]"
730 .It Li 3 Ta "\*[volume-operating-system] \*[volume-ds-3]"
731 .It Li 4 Ta "\*[volume-operating-system] \*[volume-ds-4]"
732 .It Li 5 Ta "\*[volume-operating-system] \*[volume-ds-5]"
733 .It Li 6 Ta "\*[volume-operating-system] \*[volume-ds-6]"
734 .It Li 7 Ta "\*[volume-operating-system] \*[volume-ds-7]"
735 .It Li 8 Ta "\*[volume-operating-system] \*[volume-ds-8]"
736 .It Li 9 Ta "\*[volume-operating-system] \*[volume-ds-9]"
740 A volume name may be arbitrary or one of the following:
743 .Bl -column LOCAL -offset indent -compact
744 .It Li USD Ta "\*[volume-ds-USD]"
745 .It Li PS1 Ta "\*[volume-ds-PS1]"
746 .It Li AMD Ta "\*[volume-ds-AMD]"
747 .It Li SMM Ta "\*[volume-ds-SMM]"
748 .It Li URM Ta "\*[volume-ds-URM]"
749 .It Li PRM Ta "\*[volume-ds-PRM]"
750 .It Li KM Ta "\*[volume-ds-KM]"
751 .It Li IND Ta "\*[volume-ds-IND]"
752 .It Li LOCAL Ta "\*[volume-ds-LOCAL]"
753 .It Li CON Ta "\*[volume-ds-CON]"
765 Values from the previous table will specify a new volume name.
766 If the third parameter is a keyword designating a computer architecture,
767 its value is prepended to the default volume name as specified by the
769 By default, the following architecture keywords are defined:
771 \# we use `No' to avoid hyphenation
772 .Bd -ragged -offset indent
773 .No alpha , amiga , arc , arm26 , arm32 , atari , bebox , cobalt , evbsh3 ,
774 .No hp300 , hpcmips , i386 , luna68k , m68k , mac68k , macppc , mips ,
775 .No mmeye , mvme68k , news68k , newsmips , next68k , ofppc , pc532 , pmax ,
776 .No powerpc , prep , sgimips , sh3 , sparc , sparc64 , sun3 , tahoe , vax ,
781 If the section number is neither a numeric expression in the range 1 to\~9
782 nor one of the above described keywords, the third parameter is used
783 verbatim as the volume name.
785 In the following examples, the left (which is identical to the right) and
786 the middle part of the manual page header strings are shown.
789 prevents the digit\~1 from being a valid numeric expression.
792 .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
795 .Ql \*[volume-operating-system] \*[volume-ds-7]
796 .It Li ".Dt FOO 7 bar"
798 .Ql \*[volume-operating-system] \*[volume-ds-7]
799 .It Li ".Dt FOO \e&7 bar"
802 .It Li ".Dt FOO 2 i386"
804 .Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2]
805 .It Li ".Dt FOO \*[q]\*[q] bar"
812 Local, OS-specific additions might be found in the file
814 look for strings named
816 (for the former type) and
818 (for the latter type);
820 then denotes the keyword to be used with the
824 This macro is neither callable nor parsed.
827 .Op Aq operating system
830 If the first parameter is empty,
832 .Sq Tn "\*[operating-system]"
834 This may be overridden in the local configuration file,
836 In general, the name of the operating system should be the common acronym,
841 The release should be the standard release nomenclature for the system
843 In the following table, the possible second arguments for some predefined
844 operating systems are listed.
847 local additions might be defined in
849 look for strings named
850 .Ql operating-system-XXX-YYY ,
853 is the acronym for the operating system and
858 .Bl -tag -width ".No FreeBSD" -offset indent
860 7th, 7, III, 3, V, V.2, V.3, V.4
862 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
864 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,
865 1.3, 1.3a, 1.4, 1.5, 1.6
867 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,
868 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,
869 4.2, 4.3, 4.4, 4.5, 5.0
876 an unknown second parameter will be replaced with the string
878 for the other predefined acronyms it will be ignored and a warning message
880 Unrecognized arguments are displayed as given in the page footer.
881 For instance, a typical footer might be:
886 .Ql 4.3\~Berkeley Distribution ,
887 or for a locally produced set
889 .Dl .Os CS Department
896 macro is not present, the bottom left corner of the manual page will be
899 This macro is neither callable nor parsed.
910 is used for the date string.
911 If it has exactly three arguments, they are concatenated, separated with
914 .Dl .Dd January 25, 2001
916 Otherwise, the current date is used, ignoring the parameters.
918 This macro is neither callable nor parsed.
922 .Sh "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
924 .Ss "What's in a Name" Ns ...
926 The manual domain macro names are derived from the day to day informal
927 language used to describe commands, subroutines and related files.
928 Slightly different variations of this language are used to describe the
929 three different aspects of writing a man page.
930 First, there is the description of
933 Second is the description of a
938 macros, and third, the description of a command to a user in the verbal
939 sense; that is, discussion of a command in the text of a man page.
943 macros are themselves a type of command; the general syntax for a troff
946 .Bd -filled -offset indent
947 .Li ".Xx argument1 argument2" ...
952 is a macro command, and anything following it are arguments to
954 In the second case, the description of a
956 command using the content macros is a bit more involved; a typical
958 command line might be displayed as:
960 .Bd -filled -offset indent
963 .Ao Ar infile Ac Ao Ar outfile Ac
969 is the command name and the
974 argument designated as optional by the option brackets.
983 in this example, the user has to replace the meta expressions given in angle
984 brackets with real file names.
985 Note that in this document meta arguments are used to describe
987 commands; in most man pages, meta variables are not specifically written
989 The macros which formatted the above example:
991 .Bd -literal -offset indent
994 \&.Ao Ar infile Ac Ao Ar outfile Ac
998 In the third case, discussion of commands and command syntax includes both
999 examples above, but may add more detail.
1004 from the example above might be referred to as
1007 .Em file arguments .
1008 Some command line argument lists are quite long:
1011 .Bl -tag -width ".Nm make" -offset indent -compact
1014 .Op Fl D Ar variable
1016 .Op Fl f Ar makefile
1017 .Op Fl I Ar directory
1018 .Op Fl j Ar max_jobs
1019 .Op Ar variable Ns = Ns Ar value
1027 Here one might talk about the command
1029 and qualify the argument,
1031 as an argument to the flag,
1033 or discuss the optional file operand
1035 In the verbal context, such detail can prevent confusion, however the
1037 package does not have a macro for an argument
1042 argument macro is used for an operand or file argument like
1044 as well as an argument to a flag like
1046 The make command line was produced from:
1048 .Bd -literal -offset indent
1051 \&.Op Fl D Ar variable
1053 \&.Op Fl f Ar makefile
1054 \&.Op Fl I Ar directory
1055 \&.Op Fl j Ar max_jobs
1056 \&.Op Ar variable Ns = Ns Ar value
1067 macros are explained in
1070 .Ss "General Syntax"
1072 The manual domain and general text domain macros share a similar syntax with
1073 a few minor deviations; most notably,
1079 differ only when called without arguments; and
1083 impose an order on their argument lists.
1084 All content macros are capable of recognizing and properly handling
1085 punctuation, provided each punctuation character is separated by a leading
1087 If a command is given:
1089 .Dl \&.Ar sptr, ptr),
1095 The punctuation is not recognized and all is output in the
1098 If the punctuation is separated by a leading white space:
1100 .Dl \&.Ar "sptr , ptr ) ,"
1104 .Dl Ar sptr , ptr ) ,
1106 The punctuation is now recognized and output in the default font
1107 distinguishing it from the argument strings.
1108 To remove the special meaning from a punctuation character escape it with
1111 The following punctuation characters are recognized by
1114 .Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX
1115 .It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\&
1116 .It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\&
1121 is limited as a macro language, and has difficulty when presented with a
1122 string containing a member of the mathematical, logical or quotation set:
1124 .Bd -literal -offset indent-two
1125 {+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
1131 may assume it is supposed to actually perform the operation or evaluation
1132 suggested by the characters.
1133 To prevent the accidental evaluation of these characters, escape them with
1135 Typical syntax is shown in the first content macro displayed below,
1143 The address macro identifies an address construct.
1145 .Dl Usage: .Ad Ao address Ac ...
1147 .Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
1150 .It Li ".Ad addr1 ."
1152 .It Li ".Ad addr1 , file2"
1154 .It Li ".Ad f1 , f2 , f3 :"
1156 .It Li ".Ad addr ) ) ,"
1161 The default width is 12n.
1167 macro is used to specify the name of the author of the item being
1168 documented, or the name of the author of the actual manual page.
1170 .Dl Usage: .An Ao author name Ac ...
1172 .Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n
1173 .It Li ".An \*[q]Joe Author\*[q]"
1175 .It Li ".An \*[q]Joe Author\*[q] ,"
1177 .It Li ".An \*[q]Joe Author\*[q] Aq nobody@FreeBSD.org"
1178 .An "Joe Author" Aq nobody@FreeBSD.org
1179 .It Li ".An \*[q]Joe Author\*[q] ) ) ,"
1180 .An "Joe Author" ) ) ,
1184 The default width is 12n.
1190 command causes a line break allowing each new name to appear on its own
1192 If this is not desirable,
1194 .Bd -literal -offset indent
1199 call will turn this off.
1200 To turn splitting back on, write
1202 .Bd -literal -offset indent
1210 argument macro may be used whenever an argument is referenced.
1211 If called without arguments, the
1215 .Dl Usage: .Ar Oo Ao argument Ac Oc ...
1217 .Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
1222 .It Li ".Ar file1 ."
1224 .It Li ".Ar file1 file2"
1226 .It Li ".Ar f1 f2 f3 :"
1228 .It Li ".Ar file ) ) ,"
1233 The default width is 12n.
1235 .Ss "Configuration Declaration (Section Four Only)"
1239 macro is used to demonstrate a
1241 declaration for a device interface in a section four manual.
1243 .Dl Usage: .Cd Ao argument Ac ...
1245 .Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
1246 .It Li ".Cd \*[q]device le0 at scode?\*[q]"
1247 .Cd "device le0 at scode?"
1254 command causes a line break before and after its arguments are printed.
1257 The default width is 12n.
1259 .Ss "Command Modifiers"
1261 The command modifier is identical to the
1263 (flag) command with the exception that the
1265 macro does not assert a dash in front of every argument.
1266 Traditionally flags are marked by the preceding dash, however, some commands
1267 or subsets of commands do not use them.
1268 Command modifiers may also be specified in conjunction with interactive
1269 commands such as editor commands.
1273 The default width is 10n.
1275 .Ss "Defined Variables"
1277 A variable (or constant) which is defined in an include file
1278 is specified by the macro
1281 .Dl Usage: .Dv Ao defined variable Ac ...
1283 .Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
1284 .It Li ".Dv MAXHOSTNAMELEN"
1286 .It Li ".Dv TIOCGPGRP )"
1291 The default width is 12n.
1297 errno macro specifies the error return value for section 2, 3, and\~9 library
1299 The second example below shows
1303 general text domain macro, as it would be used in a section two manual page.
1305 .Dl Usage: .Er Ao errno type Ac ...
1307 .Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n
1310 .It Li ".Er ENOENT ) ;"
1312 .It Li ".Bq Er ENOTDIR"
1317 The default width is 17n.
1319 .Ss "Environment Variables"
1323 macro specifies an environment variable.
1325 .Dl Usage: .Ev Ao argument Ac ...
1327 .Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n
1328 .It Li ".Ev DISPLAY"
1332 .It Li ".Ev PRINTER ) ) ,"
1337 The default width is 15n.
1343 macro handles command line flags.
1347 For interactive command flags, which are not prepended with a dash, the
1350 macro is identical, but without the dash.
1352 .Dl Usage: .Fl Ao argument Ac ...
1354 .Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n
1367 .It Li ".Fl xyz ) ,"
1375 macro without any arguments results in a dash representing stdin/stdout.
1378 a single dash will result in two dashes.
1380 The default width is 12n.
1382 .Ss "Function Declarations"
1386 macro is used in the
1388 section with section two or three functions.
1389 It is neither callable nor parsed.
1391 .Dl Usage: .Fd Ao argument Ac ...
1393 .Bl -tag -width ".Li .Fd\ X#include\ <sys/types.h>X" -compact -offset 15n
1394 .It Li ".Fd \*[q]#include <sys/types.h>\*[q]"
1395 .Fd "#include <sys/types.h>"
1402 command causes a line break if a function has already been presented and a
1403 break has not occurred.
1404 This leaves a nice vertical space in between the previous function call and
1405 the declaration for the next function.
1412 section, represents the
1414 statement, and is the short form of the above example.
1415 It specifies the C\~header file as being included in a C\~program.
1416 It also causes a line break.
1420 section, it represents the header file enclosed in angle brackets.
1422 .Dl Usage: .In Ao header file Ac
1424 .Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n
1425 .nr in-synopsis-section 1
1426 .It Li ".In stdio.h"
1428 .nr in-synopsis-section 0
1429 .It Li ".In stdio.h"
1433 .Ss "Function Types"
1435 This macro is intended for the
1438 It may be used anywhere else in the man page without problems, but its main
1439 purpose is to present the function type in kernel normal form for the
1441 of sections two and three (it causes a line break, allowing the function
1442 name to appear on the next line).
1444 .Dl Usage: .Ft Ao type Ac ...
1446 .Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n
1447 .It Li ".Ft struct stat"
1451 .Ss "Functions (Library Routines)"
1459 .Dl Usage: .Fn Ao function Ac Oo Ao parameter Ac Oc ...
1461 .Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n
1462 .It Li ".Fn getchar"
1464 .It Li ".Fn strlen ) ,"
1466 .It Li ".Fn align \*[q]char *ptr\*[q] ,"
1467 .Fn align "char *ptr" ,
1470 Note that any call to another macro signals the end of the
1472 call (it will insert a closing parenthesis at that point).
1474 For functions with many parameters (which is rare), the macros
1482 (function argument).
1486 .Bd -literal -offset indent
1495 \&.Fa "struct rrec *newrr"
1504 .Bd -ragged -offset indent
1513 .Fa "struct rrec *newrr"
1522 section, the function will always begin at the beginning of line.
1523 If there is more than one function presented in the
1525 section and a function type has not been given, a line break will occur,
1526 leaving a nice vertical space between the current function name and the one
1529 The default width values of
1533 are 12n and 16n, respectively.
1535 .Ss "Function Arguments"
1539 macro is used to refer to function arguments (parameters) outside of the
1541 section of the manual or inside the
1543 section if the enclosure macros
1551 may also be used to refer to structure members.
1553 .Dl Usage: .Fa Ao function argument Ac ...
1555 .Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n
1556 .It Li ".Fa d_namlen ) ) ,"
1558 .It Li ".Fa iov_len"
1563 The default width is 12n.
1569 macro generates text for use in the
1573 .Dl Usage: .Rv Oo -std Oc Op Ao function Ac ...
1576 .Ql ".Rv -std atexit"
1579 .Bd -ragged -offset -indent
1580 \# a small hack to suppress a warning message
1581 .ds section-old "\*[section]
1584 .ds section "\*[section-old]
1590 option is valid only for manual page sections\~2 and\~3.
1591 Currently, this macro does nothing if used without the
1599 macro generates text for use in the
1603 .Dl Usage: .Ex Oo -std Oc Op Ao utility Ac ...
1609 .Bd -ragged -offset -indent
1610 \# a small hack to suppress a warning message
1611 .ds section-old "\*[section]
1614 .ds section "\*[section-old]
1620 option is valid only for manual page sections 1, 6 and\~8.
1621 Currently, this macro does nothing if used without the
1625 .Ss "Interactive Commands"
1629 macro designates an interactive or internal command.
1631 .Dl Usage: .Ic Ao argument Ac ...
1633 .Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n
1636 .It Li ".Ic \*[q]do while {...}\*[q]"
1637 .Ic "do while {...}"
1638 .It Li ".Ic setenv , unsetenv"
1639 .Ic setenv , unsetenv
1643 The default width is 12n.
1649 macro is used to specify the library where a particular function is compiled
1652 .Dl Usage: .Lb Ao argument Ac ...
1654 Available arguments to
1656 and their results are:
1659 .Bl -tag -width ".Li libossaudio" -compact -offset indent
1697 Local, OS-specific additions might be found in the file
1699 look for strings named
1702 then denotes the keyword to be used with the
1710 literal macro may be used for special characters, variable constants, etc.\&
1711 -- anything which should be displayed as it would be typed.
1713 .Dl Usage: .Li Ao argument Ac ...
1715 .Bl -tag -width ".Li .Li\ cntrl-D\ )\ ," -compact -offset 15n
1718 .It Li ".Li M1 M2 M3 ;"
1720 .It Li ".Li cntrl-D ) ,"
1722 .It Li ".Li 1024 ..."
1727 The default width is 16n.
1733 macro is used for the document title or subject name.
1734 It has the peculiarity of remembering the first argument it was called with,
1735 which should always be the subject name of the page.
1736 When called without arguments,
1738 regurgitates this initial name for the sole purpose of making less work for
1740 Note: A section two or three document function name is addressed with the
1748 and remaining sections.
1749 For interactive commands, such as the
1755 macro should be used.
1761 it can not recall the first argument it was invoked with.
1763 .Dl Usage: .Nm Oo Ao argument Ac Oc ...
1765 .Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
1766 .It Li ".Nm groff_mdoc"
1768 .It Li ".Nm \e-mdoc"
1770 .It Li ".Nm foo ) ) ,"
1777 The default width is 10n.
1783 macro places option brackets around any remaining arguments on the
1784 command line, and places any trailing punctuation outside the brackets.
1789 (which produce an opening and a closing option bracket respectively) may be used
1790 across one or more lines or to specify the exact position of the closing
1793 .Dl Usage: .Op Oo Ao option Ac Oc ...
1795 .Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n
1800 .It Li ".Op Fl k ) ."
1802 .It Li ".Op Fl k Ar kookfile"
1803 .Op Fl k Ar kookfile
1804 .It Li ".Op Fl k Ar kookfile ,"
1805 .Op Fl k Ar kookfile ,
1806 .It Li ".Op Ar objfil Op Ar corfil"
1807 .Op Ar objfil Op Ar corfil
1808 .It Li ".Op Fl c Ar objfil Op Ar corfil ,"
1809 .Op Fl c Ar objfil Op Ar corfil ,
1810 .It Li ".Op word1 word2"
1812 .It Li ".Li .Op Oo Ao option Ac Oc ..."
1813 .Li .Op Oo Ao options Ac Oc ...
1816 Here a typical example of the
1822 .Bd -literal -offset indent
1824 \&.Op Fl k Ar kilobytes
1825 \&.Op Fl i Ar interval
1833 .Bd -filled -offset indent
1835 .Op Fl k Ar kilobytes
1836 .Op Fl i Ar interval
1842 The default width values of
1846 are 14n and 10n, respectively.
1852 macro formats path or file names.
1853 If called without arguments, the
1855 string is output, which represents the current user's home directory.
1857 .Dl Usage: .Pa Oo Ao pathname Ac Oc ...
1859 .Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n
1862 .It Li ".Pa /usr/share"
1864 .It Li ".Pa /tmp/fooXXXXX ) ."
1865 .Pa /tmp/fooXXXXX ) .
1869 The default width is 32n.
1875 macro replaces standard abbreviations with their formal names.
1877 .Dl Usage: .St Ao abbreviation Ac ...
1880 .Dq Abbreviation/Formal Name
1886 .Bl -tag -width ".Li -iso9945-1-90" -compact -offset indent
1901 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1902 .It Li -iso9945-1-90
1904 .It Li -iso9945-1-96
1918 .It Li -p1003.1g-2000
1926 Part 2: Shell and Utilities
1928 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1929 .It Li -iso9945-2-93
1941 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1970 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1977 .Ss "Variable Types"
1981 macro may be used whenever a type is referenced.
1984 section, it causes a line break (useful for old style variable declarations).
1986 .Dl Usage: .Vt Ao type Ac ...
1988 .Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n
1989 .It Li ".Vt extern char *optarg ;"
1990 .Vt extern char *optarg ;
1997 Generic variable reference.
1999 .Dl Usage: .Va Ao variable Ac ...
2001 .Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n
2004 .It Li ".Va settimer ,"
2006 .It Li ".Va \*[q]int *prt\*[q] ) :"
2008 .It Li ".Va \*[q]char s\*[q] ] ) ) ,"
2009 .Va "char s" ] ) ) ,
2013 The default width is 12n.
2015 .Ss "Manual Page Cross References"
2019 macro expects the first argument to be a manual page name.
2020 The optional second argument, if a string (defining the manual section), is
2021 put into parentheses.
2023 .Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
2025 .Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
2032 .It Li ".Xr xinit 1x ;"
2037 The default width is 10n.
2040 .Sh "GENERAL TEXT DOMAIN"
2045 .Dl Usage: .At Oo Ao version Ac Oc ...
2047 .Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n
2054 The following values for
2058 .Dl 32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4
2063 .Dl "Usage: .Bx" Bro -alpha | -beta | -devel Brc ...
2064 .Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
2066 .Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
2071 .It Li ".Bx \-devel"
2076 will be prepended to the string
2078 The following values for
2082 .Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
2087 .Dl Usage: .Nx Oo Ao version Ac Oc ...
2089 .Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n
2096 For possible values of
2098 see the description of the
2100 command above in section
2101 .Sx "TITLE MACROS" .
2106 .Dl Usage: .Fx Oo Ao version Ac Oc ...
2108 .Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n
2115 For possible values of
2117 see the description of the
2119 command above in section
2120 .Sx "TITLE MACROS" .
2125 .Dl Usage: .Ox Oo Ao version Ac Oc ...
2127 .Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n
2135 .Dl Usage: .Bsx Oo Ao version Ac Oc ...
2137 .Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n
2147 .Bl -tag -width ".Li .Ux" -compact -offset 15n
2152 .Ss "Emphasis Macro"
2154 Text may be stressed or emphasized with the
2157 The usual font for emphasis is italic.
2159 .Dl Usage: .Em Ao argument Ac ...
2161 .Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n
2162 .It Li ".Em does not"
2164 .It Li ".Em exceed 1024 ."
2166 .It Li ".Em vide infra ) ) ,"
2167 .Em vide infra ) ) ,
2171 The default width is 10n.
2177 font mode must be ended with the
2179 macro (the latter takes no arguments).
2180 Font modes may be nested within other font modes.
2183 has the following syntax:
2185 .Dl .Bf Ao font mode Ac
2188 must be one of the following three types:
2190 .Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent
2191 .It Sy \&Em | Fl emphasis
2194 macro was used for the entire block of text.
2195 .It Sy \&Li | Fl literal
2198 macro was used for the entire block of text.
2199 .It Sy \&Sy | Fl symbolic
2202 macro was used for the entire block of text.
2205 Both macros are neither callable nor parsed.
2207 .Ss "Enclosure and Quoting Macros"
2209 The concept of enclosure is similar to quoting.
2210 The object being to enclose one or more strings between a pair of characters
2211 like quotes or parentheses.
2212 The terms quoting and enclosure are used interchangeably throughout this
2214 Most of the one-line enclosure macros end in small letter
2216 to give a hint of quoting, but there are a few irregularities.
2217 For each enclosure macro there is also a pair of open and close macros which
2218 end in small letters
2228 .Bd -filled -offset 4n
2229 .Bl -column "quote" "close" "open" "Angle Bracket Enclosure" "`string' or string"
2230 .Em Quote Ta Em Open Ta Em Close Ta Em Function Ta Em Result
2231 .No .Aq Ta .Ao Ta .Ac Ta "Angle Bracket Enclosure" Ta Ao string Ac
2232 .No .Bq Ta .Bo Ta .Bc Ta "Bracket Enclosure" Ta Bo string Bc
2233 .No .Brq Ta .Bro Ta .Brc Ta "Brace Enclosure" Ta Bro string Brc
2234 .No .Dq Ta .Do Ta .Dc Ta "Double Quote" Ta Do string Dc
2235 .No .Eq Ta .Eo Ta .Ec Ta "Enclose String (in XX)" Ta XXstringXX
2236 .No .Pq Ta .Po Ta .Pc Ta "Parenthesis Enclosure" Ta Po string Pc
2237 .No .Ql Ta Ta Ta "Quoted Literal" Ta So string Sc or Li string
2238 .No .Qq Ta .Qo Ta .Qc Ta "Straight Double Quote" Ta Qo string Qc
2239 .No .Sq Ta .So Ta .Sc Ta "Single Quote" Ta So string Sc
2243 All macros ending with
2247 have a default width value of 12n.
2249 .Bl -tag -width ".Li .Ec , .Eo"
2251 These macros expect the first argument to be the opening and closing strings
2254 Due to the nine-argument limit in the original troff program two other
2255 macros have been implemented which are now rather obsolete:
2257 takes the first and second parameter as the left and right enclosure string,
2258 which are then used to enclose the arguments of
2260 The default width value is 12n for both macros.
2262 The first and second arguments of this macro are the opening and
2263 closing strings respectively, followed by the arguments to be enclosed.
2265 The quoted literal macro behaves differently in troff and nroff mode.
2268 a quoted literal is always quoted.
2269 If formatted with troff, an item is only quoted if the width of the item is
2270 less than three constant width characters.
2271 This is to make short strings more visible where the font change to literal
2272 (constant width) is less noticeable.
2274 The default width is 16n.
2276 The prefix macro suppresses the whitespace between its first and second
2279 .Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent
2280 .It Li ".Pf ( Fa name2"
2285 The default width is 12n.
2289 macro (see below) performs the analogous suffix function.
2293 macro inserts an apostrophe and exits any special text modes, continuing in
2299 Examples of quoting:
2302 .Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent
2305 .It Li ".Aq Pa ctype.h ) ,"
2309 .It Li ".Bq Em Greek , French ."
2310 .Bq Em Greek , French .
2313 .It Li ".Dq string abc ."
2315 .It Li ".Dq \'^[A-Z]\'"
2317 .It Li ".Ql man mdoc"
2321 .It Li ".Qq string ) ,"
2323 .It Li ".Qq string Ns ),"
2329 .It Li ".Em or Ap ing"
2334 For a good example of nested enclosure macros, see the
2337 It was created from the same underlying enclosure macros as those presented
2343 extended argument list macros are discussed below.
2345 .Ss "No-Op or Normal Text Macro"
2349 macro can be used in a macro command line for parameters which should
2356 if you really want that English word (and not the macro) as a parameter.
2358 .Dl Usage: .No Ao argument Ac ...
2360 .Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n
2361 .It Li ".No test Ta with Ta tabs"
2362 .No test Ta with Ta tabs
2366 The default width is 12n.
2368 .Ss "No-Space Macro"
2372 macro suppresses insertion of a space between the current position and its
2374 For example, it is useful for old style argument lists where there is no
2375 space between the flag and argument:
2377 .Dl "Usage:" ... Ao argument Ac \&Ns Oo Ao argument Ac Oc ...
2378 .Dl " " .Ns Ao argument Ac ...
2380 .Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n
2381 .It Li ".Op Fl I Ns Ar directory"
2382 .Op Fl I Ns Ar directory
2387 macro always invokes the
2389 macro after eliminating the space unless another macro name follows it.
2390 If used as a command (i.e., the second form above in the
2397 .Ss "Section Cross References"
2401 macro designates a reference to a section header within the same document.
2403 .Dl Usage: .Sx Ao section reference Ac ...
2405 .Bl -tag -width ".Li .Sx\ FILES" -offset 15n
2411 The default width is 16n.
2415 The symbolic emphasis macro is generally a boldface macro in either the
2416 symbolic sense or the traditional English usage.
2418 .Dl Usage: .Sy Ao symbol Ac ...
2420 .Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n
2421 .It Li ".Sy Important Notice"
2422 .Sy Important Notice
2426 The default width is 6n.
2428 .Ss Mathematical Symbols
2430 Use this macro for mathematical symbols and similar things.
2432 .Dl Usage: .Ms Ao math symbol Ac ...
2434 .Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n
2440 The default width is 6n.
2442 .Ss "References and Citations"
2444 The following macros make a modest attempt to handle references.
2445 At best, the macros make it convenient to manually drop in a subset of
2449 .Bl -tag -width 6n -offset indent -compact
2451 Reference start (does not take arguments).
2452 Causes a line break in the
2454 section and begins collection of reference information until the reference
2457 Reference end (does not take arguments).
2458 The reference is printed.
2460 Reference author name; one name per invocation.
2464 City/place (not implemented yet).
2468 Issuer/publisher name.
2474 Optional information.
2478 Corporate or foreign author.
2487 Macros beginning with
2489 are not callable but accept multiple arguments in the usual way.
2492 macro is handled properly as a parameter; other macros will cause strange
2497 can be used outside of the
2503 .Bd -literal -offset indent
2507 \&.%T "Implementation Notes on foobar(1)"
2508 \&.%R "Technical Report ABC-DE-12-345"
2509 \&.%Q "Drofnats College, Nowhere"
2516 .Bd -ragged -offset indent
2520 .%T "Implementation Notes on foobar(1)"
2521 .%R "Technical Report ABC-DE-12-345"
2522 .%Q "Drofnats College, Nowhere"
2527 .Ss "Trade Names (or Acronyms and Type Names)"
2529 The trade name macro prints its arguments in a smaller font.
2530 Its intended use is to imitate a small caps fonts for uppercase acronyms.
2532 .Dl Usage: .Tn Ao symbol Ac ...
2534 .Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n
2542 The default width is 10n.
2544 .Ss "Extended Arguments"
2550 macros allow one to extend an argument list on a macro boundary for the
2557 are implemented similarly to all other macros opening and closing an
2558 enclosure (without inserting characters, of course).
2559 This means that the following is true for those macros also.
2561 Here is an example of
2563 using the space mode macro to turn spacing off:
2565 .Bd -literal -offset indent
2567 \&.It Xo Sy I Ar operation
2568 \&.No \een Ar count No \een
2576 .Bd -filled -offset indent
2579 .It Xo Sy I Ar operation
2580 .No \en Ar count No \en
2589 .Bd -literal -offset indent
2591 \&.It Cm S No / Ar old_pattern Xo
2592 \&.No / Ar new_pattern
2601 .Bd -filled -offset indent
2604 .It Cm S No \&/ Ar old_pattern Xo
2605 .No \&/ Ar new_pattern
2615 and enclosure macros: Test the value of a variable.
2617 .Bd -literal -offset indent
2620 \&.Oo \e&! Oc Ns Ar variable Oo
2621 \&.Ar operator variable ...
2628 .Bd -filled -offset indent
2629 .Bl -tag -width flag -compact
2632 .Oo \&! Oc Ns Ar variable Oo
2633 .Ar operator variable ...
2640 .Sh "PAGE STRUCTURE DOMAIN"
2642 .Ss "Section Headers"
2646 section header macros are required in every man page.
2647 The remaining section headers are recommended at the discretion of the
2648 author writing the manual page.
2651 macro is parsed but not generally callable.
2652 It can be used as an argument in a call to
2654 only; it then reactivates the default font for
2657 The default width is 8n.
2659 .Bl -tag -width ".Li .Sh\ RETURN\ VALUES"
2664 If not specified, headers, footers and page layout defaults will not be set
2665 and things will be rather unpleasant.
2668 section consists of at least three items.
2671 name macro naming the subject of the man page.
2672 The second is the name description macro,
2674 which separates the subject name from the third item, which is the
2676 The description should be the most terse and lucid possible, as the space
2682 then all its arguments.
2684 .It Li ".Sh LIBRARY"
2685 This section is for section two and three function calls.
2686 It should consist of a single
2690 .Sx "Library Names" .
2692 .It Li ".Sh SYNOPSIS"
2695 section describes the typical usage of the subject of a man page.
2696 The macros required are either
2707 The function name macro
2709 is required for manual page sections\~2 and\~3; the command and general name
2712 is required for sections 1, 5, 6, 7, and\~8.
2713 Section\~4 manuals require a
2718 configuration device usage macro.
2719 Several other macros may be necessary to produce the synopsis line as shown
2722 .Bd -filled -offset indent
2730 The following macros were used:
2733 .Dl ".Op Fl benstuv"
2737 .It Li ".Sh DESCRIPTION"
2738 In most cases the first text in the
2740 section is a brief paragraph on the command, function or file, followed by a
2741 lexical list of options and respective explanations.
2742 To create such a list, the
2749 macros are used (see
2750 .Sx Lists and Columns
2753 .It Li ".Sh IMPLEMENTATION NOTES"
2754 Implementation specific information should be placed here.
2756 .It Li ".Sh RETURN VALUES"
2757 Sections 2, 3 and\~9 function return values should go here.
2760 macro may be used to generate text for use in the
2762 section for most section 2 and 3 library functions;
2764 .Sx "Return Values" .
2770 section headers are part of the preferred manual page layout and must be
2771 used appropriately to maintain consistency.
2772 They are listed in the order in which they would be used.
2774 .Bl -tag -width ".Li .Sh\ COMPATIBILITY"
2775 .It Li ".Sh ENVIRONMENT"
2778 section should reveal any related environment variables and clues to their
2779 behavior and/or usage.
2782 Files which are used or created by the man page subject should be listed via
2789 .It Li ".Sh EXAMPLES"
2790 There are several ways to create examples.
2793 section below for details.
2795 .It Li ".Sh DIAGNOSTICS"
2796 Diagnostic messages from a command should be placed in this section.
2799 macro may be used to generate text for use in the
2801 section for most section 1, 6 and\~8 commands;
2805 .It Li ".Sh COMPATIBILITY"
2806 Known compatibility issues (e.g. deprecated options or parameters)
2807 should be listed here.
2810 Specific error handling, especially from library functions (man page
2811 sections 2, 3, and\~9) should go here.
2814 macro is used to specify an error (errno).
2816 .It Li ".Sh SEE ALSO"
2817 References to other material on the man page topic and cross references to
2818 other relevant man pages should be placed in the
2821 Cross references are specified using the
2826 style references are not accommodated.
2828 It is recommended that the cross references are sorted on the section
2829 number, then alphabetically on the names within a section, and placed
2830 in that order and comma separated.
2838 .It Li ".Sh STANDARDS"
2839 If the command, library function or file adheres to a specific
2840 implementation such as
2844 this should be noted here.
2845 If the command does not adhere to any standard, its history should be noted
2850 .It Li ".Sh HISTORY"
2851 Any command which does not adhere to any specific standards should be
2852 outlined historically in this section.
2854 .It Li ".Sh AUTHORS"
2855 Credits should be placed here.
2858 macro should be used to specify the name(s) of the person(s).
2861 Blatant problems with the topic go here.
2867 sections may be added; for example, this section was set with:
2869 .Bd -literal -offset 15n
2870 \&.Sh "PAGE STRUCTURE DOMAIN"
2873 .Ss "Subsection Headers"
2875 Subsection headers have exactly the same syntax as section headers:
2877 is parsed but not generally callable.
2878 It can be used as an argument in a call to
2880 only; it then reactivates the default font for
2883 The default width is 8n.
2885 .Ss "Paragraphs and Line Spacing"
2887 .Bl -tag -width ".Li .Pp"
2891 paragraph command may be used to specify a line space where necessary.
2892 The macro is not necessary after a
2900 macro (which both assert a vertical distance unless the
2904 The macro is neither callable nor parsed and takes no arguments; an
2911 .\" This worked with version one, need to redo for version three
2914 .\" .Cw (ax+bx+c) \ is\ produced\ by\ \&
2915 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
2932 .\" .Em is produced by
2948 .\" This example shows the same equation in a different format.
2952 .\" signs were forced with
2956 .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
2957 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
2968 .\" .Li \&.Cx \e\ +\e\ \e&
2979 .\" .Em is produced by
2987 .\" .Li \&.Cx \e\ +\e\ \e&
2998 .\" The incantation below was
3004 .\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
3006 .\" .Li \&.Cx Op Sy ?/
3016 .\" .Em is produced by
3018 .\" .Li \&.Ar \e\ b1 e1 f1
3032 The only keep that is implemented at this time is for words.
3039 The only option that
3041 accepts currently is
3043 (this is also the default if no option is given) which is useful for
3044 preventing line breaks in the middle of options.
3045 In the example for the make command line arguments (see
3046 .Sx What's in a Name ) ,
3049 from placing up the flag and the argument on separate lines.
3051 Both macros are neither callable nor parsed.
3053 More work needs to be done with the keep macros; specifically, a
3055 option should be added.
3057 .Ss "Examples and Displays"
3059 There are seven types of displays.
3061 .Bl -tag -width ".Li .D1"
3064 Display one line of indented text.
3065 This macro is parsed but not callable.
3069 The above was produced by:
3070 .Li ".D1 Fl ldghfstru" .
3074 Display one line of indented
3079 example macro has been used throughout this file.
3080 It allows the indentation (display) of one line of text.
3081 Its default font is set to constant width (literal).
3083 is parsed but not callable.
3085 .Dl % ls -ldg /usr/local/bin
3087 The above was produced by:
3088 .Li ".Dl % ls -ldg /usr/local/bin" .
3094 display must be ended with the
3097 It has the following syntax:
3099 .Bd -ragged -compact
3100 .Bl -tag -width ".Li .Bd" -offset indent
3102 .Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc
3103 .Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
3108 .Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
3110 Fill, but do not adjust the right margin (only left-justify).
3112 Center lines between the current left and right margin.
3113 Note that each single line is centered.
3115 Do not fill; display a block of text as typed, using line breaks as
3116 specified by the user.
3117 This can produce overlong lines without warning messages.
3119 Display a filled block.
3120 The block of text is formatted (i.e., the text is justified on both the left
3123 Display block with literal font (usually fixed-width).
3124 Useful for source code or simple tabbed or spaced text.
3125 .It Fl file Ao Ar file name Ac
3126 The file whose name follows the
3128 flag is read and displayed before any data enclosed with
3132 using the selected display type.
3134 .Xr troff/ Ns Nm \-mdoc
3135 commands in the file will be processed.
3136 .It Fl offset Ao Ar string Ac
3139 is specified with one of the following strings, the string is interpreted to
3140 indicate the level of indentation for the forthcoming block of text:
3143 .Bl -tag -width ".Ar indent-two" -compact
3145 Align block on the current left margin; this is the default mode of
3148 Supposedly center the block.
3149 At this time unfortunately, the block merely gets left aligned about an
3150 imaginary center margin.
3152 Indent by one default indent value or tab.
3153 The default indent value is also used for the
3157 macros, so one is guaranteed the two types of displays will line up.
3158 The indentation value is normally set to\~6n or about two thirds of an inch
3159 (six constant width characters).
3161 Indent two times the default indent value.
3165 aligns the block about two inches from the right side of the page.
3166 This macro needs work and perhaps may never do the right thing within
3173 is a valid numeric expression instead
3174 .Pf ( Em with a scale indicator other than
3176 use that value for indentation.
3177 The most useful scale indicators are
3181 specifying the so-called
3185 This is approximately the width of the letters
3190 of the current font (for nroff output, both scale indicators give the same
3194 isn't a numeric expression, it is tested whether it is an
3196 macro name, and the default offset value associated with this macro is used.
3197 Finally, if all tests fail,
3200 (typeset with a fixed-width font) is taken as the offset.
3202 Suppress insertion of vertical space before begin of display.
3206 End display (takes no arguments).
3209 .Ss "Lists and Columns"
3211 There are several types of lists which may be initiated with the
3214 Items within the list are specified with the
3216 item macro, and each list must end with the
3219 Lists may be nested within themselves and within displays.
3220 The use of columns inside of lists or lists inside of columns is unproven.
3222 In addition, several list attributes may be specified such as the width of a
3223 tag, the list offset, and compactness (blank lines between items allowed or
3225 Most of this document has been formatted with a tag style list
3228 It has the following syntax forms:
3231 .Bd -ragged -compact
3232 .Bl -tag -width ".Li .Bl" -offset indent -compact
3234 .Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc
3235 .Oo \-width Ao string Ac Oc
3236 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3238 .No \-column Oo \-offset Ao string Ac Oc
3239 .Ao string1 Ac Ao string2 Ac ... Xc
3241 .Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc
3242 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3247 And now a detailed description of the list types.
3250 .Bl -tag -width ".Fl column" -compact
3254 .Bd -literal -offset indent
3255 \&.Bl -bullet -offset indent -compact
3257 Bullet one goes here.
3267 .Bl -bullet -offset indent -compact
3269 Bullet one goes here.
3275 .It Fl dash No ( or Fl hyphen )
3278 .Bd -literal -offset indent
3279 \&.Bl -dash -offset indent -compact
3291 .Bl -dash -offset indent -compact
3302 .Bd -literal -offset indent
3303 \&.Bl -enum -offset indent -compact
3315 .Bl -enum -offset indent -compact
3323 If you want to nest enumerated lists, use the
3325 flag (starting with the second-level list):
3327 .Bd -literal -offset indent
3328 \&.Bl -enum -offset indent -compact
3331 \&.Bl -enum -nested -compact
3335 And item three here.
3346 .Bl -enum -offset indent -compact
3349 .Bl -enum -nested -compact
3353 And item three here.
3363 without list markers.
3365 .Bd -literal -offset indent
3366 \&.Bl -item -offset indent
3382 .Bl -item -offset indent
3398 to specify the tag width.
3401 .Bl -tag -width "PPID" -compact -offset indent
3403 sleep time of the process (seconds blocked)
3407 resulting from references by the process
3408 to pages not loaded in core.
3410 numerical user-id of process owner
3412 numerical id of parent of process priority
3413 (non-positive when in non-interruptible wait)
3419 .Bd -literal -offset indent
3420 \&.Bl -tag -width "PPID" -compact -offset indent
3422 sleep time of the process (seconds blocked)
3426 resulting from references by the process
3427 to pages not loaded in core.
3429 numerical user-id of process owner
3431 numerical id of parent of process priority
3432 (non-positive when in non-interruptible wait)
3438 Diag lists create section four diagnostic lists and are similar to inset
3439 lists except callable macros are ignored.
3442 flag is not meaningful in this context.
3446 .Bd -literal -offset indent
3448 \&.It You can't use Sy here.
3449 The message says all.
3457 .It You can't use Sy here.
3458 The message says all.
3463 A list with hanging tags.
3465 .Bl -hang -offset indent
3467 labels appear similar to tagged lists when the
3468 label is smaller than the label width.
3469 .It Em Longer hanged list labels
3470 blend into the paragraph unlike
3471 tagged paragraph labels.
3474 And the unformatted text which created it:
3476 .Bd -literal -offset indent
3477 \&.Bl -hang -offset indent
3479 labels appear similar to tagged lists when the
3480 label is smaller than the label width.
3481 \&.It Em Longer hanged list labels
3482 blend into the paragraph unlike
3483 tagged paragraph labels.
3489 Lists with overhanging tags do not use indentation for the items; tags are
3490 written to a separate line.
3492 .Bl -ohang -offset indent
3494 sleep time of the process (seconds blocked)
3498 resulting from references by the process
3499 to pages not loaded in core.
3501 numerical user-id of process owner
3503 numerical id of parent of process priority
3504 (non-positive when in non-interruptible wait)
3510 .Bd -literal -offset indent
3511 \&.Bl -ohang -offset indent
3513 sleep time of the process (seconds blocked)
3517 resulting from references by the process
3518 to pages not loaded in core.
3520 numerical user-id of process owner
3522 numerical id of parent of process priority
3523 (non-positive when in non-interruptible wait)
3529 Here is an example of inset labels:
3530 .Bl -inset -offset indent
3532 The tagged list (also called a tagged paragraph)
3533 is the most common type of list used in the
3537 attribute as described below.
3539 Diag lists create section four diagnostic lists
3540 and are similar to inset lists except callable
3543 Hanged labels are a matter of taste.
3545 Overhanging labels are nice when space is constrained.
3547 Inset labels are useful for controlling blocks of
3548 paragraphs and are valuable for converting
3550 manuals to other formats.
3553 Here is the source text which produced the above example:
3555 .Bd -literal -offset indent
3556 \&.Bl -inset -offset indent
3558 The tagged list (also called a tagged paragraph)
3559 is the most common type of list used in the
3562 Diag lists create section four diagnostic lists
3563 and are similar to inset lists except callable
3566 Hanged labels are a matter of taste.
3568 Overhanging labels are nice when space is constrained.
3570 Inset labels are useful for controlling blocks of
3571 paragraphs and are valuable for converting
3573 manuals to other formats.
3579 This list type generates multiple columns.
3580 The number of columns and the width of each column is determined by the
3591 (dot) immediately followed by a valid
3593 macro name, interpret
3595 and use the width of the result.
3596 Otherwise, the width of
3598 (typeset with a fixed-width font) is taken as the
3604 argument is parsed to make a row, each column within the row is a separate
3605 argument separated by a tab or the
3611 .Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3612 .It Sy String Ta Sy Nroff Ta Sy Troff
3613 .It Li <= Ta <= Ta \*(<=
3614 .It Li >= Ta >= Ta \*(>=
3621 \&.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3622 \&.It Sy String Ta Sy Nroff Ta Sy Troff
3623 \&.It Li <= Ta <= Ta \e*(<=
3624 \&.It Li >= Ta >= Ta \e*(>=
3632 .Bl -tag -width ".Fl indent Ao Ar string Ac"
3633 .It Fl width Ao Ar string Ac
3638 (dot) immediately followed by a valid
3640 macro name, interpret
3642 and use the width of the result.
3643 Almost all lists in this document use this option.
3647 .Bd -literal -offset indent
3648 \&.Bl -tag -width ".Fl test Ao Ar string Ac"
3649 \&.It Fl test Ao Ar string Ac
3650 This is a longer sentence to show how the
3652 flag works in combination with a tag list.
3659 .Bl -tag -width ".Fl test Ao Ar string Ac"
3660 .It Fl test Ao Ar string Ac
3661 This is a longer sentence to show how the
3663 flag works in combination with a tag list.
3667 (Note that the current state of
3671 is interpreted; afterwards, all variables are restored again.
3672 However, boxes (used for enclosures) can't be saved in
3675 as a consequence, arguments must always be
3677 to avoid nasty errors.
3678 For example, do not write
3681 .Ql ".Ao Ar string Xc"
3682 instead if you really need only an opening angle bracket.)
3686 is a valid numeric expression
3687 .Em ( with a scale indicator other than
3689 use that value for indentation.
3690 The most useful scale indicators are
3694 specifying the so-called
3698 This is approximately the width of the letters
3703 of the current font (for nroff output, both scale indicators give the same
3707 isn't a numeric expression, it is tested whether it is an
3709 macro name, and the default width value associated with this macro is used.
3710 Finally, if all tests fail,
3713 (typeset with a fixed-width font) is taken as the width.
3715 If a width is not specified for the tag list type, every time
3717 is invoked, an attempt is made to determine an appropriate width.
3718 If the first argument to
3720 is a callable macro, the default width for that macro will be used;
3721 otherwise, the default width of
3724 .It Fl offset Ao Ar string Ac
3729 a default indent value (normally set to\~6n, similar to the value used in
3736 is a valid numeric expression instead
3737 .Pf ( Em with a scale indicator other than
3739 use that value for indentation.
3740 The most useful scale indicators are
3744 specifying the so-called
3748 This is approximately the width of the letters
3753 of the current font (for nroff output, both scale indicators give the same
3757 isn't a numeric expression, it is tested whether it is an
3759 macro name, and the default offset value associated with this macro is used.
3760 Finally, if all tests fail,
3763 (typeset with a fixed-width font) is taken as the offset.
3765 Suppress insertion of vertical space before the list and between list items.
3769 .Sh "MISCELLANEOUS MACROS"
3771 Here a list of the remaining macros which do not fit well into one of the
3773 We couldn't find real examples for the following macros:
3777 They are documented here for completeness \- if you know how to use them
3778 properly please send a mail to
3779 .Mt bug-groff@gnu.org
3780 (including an example).
3782 .Bl -tag -width ".Li .Bt"
3786 .Bd -ragged -offset indent
3790 It is neither callable nor parsed and takes no arguments.
3794 .Dl Usage: .Fr Ao function return value Ac ...
3796 Don't use this macro.
3797 It allows a break right before the return value (usually a single digit)
3798 which is bad typographical behaviour.
3801 to tie the return value to the previous word.
3804 Use this macro to include a (header) file literally.
3807 followed by the file name, then the contents of
3810 .Dl Usage: .Hf Ao file Ac
3812 It is neither callable nor parsed.
3818 Exact usage unknown.
3819 The documentation in the
3821 source file describes it as a macro for
3822 .Dq "menu entries" .
3824 Its default width is 6n.
3830 Exact usage unknown.
3831 The documentation in the
3833 source file describes it as
3834 .Dq old function type (fortran) .
3837 Activate (toggle) space mode.
3839 .Dl Usage: .Sm Oo on | off Oc ...
3841 If space mode is off, no spaces between macro arguments are inserted.
3842 If called without a parameter (or if the next parameter is neither
3852 .Bd -ragged -offset indent
3856 It is neither callable nor parsed and takes no arguments.
3860 .Sh "PREDEFINED STRINGS"
3862 The following strings are predefined:
3864 .Bl -column String infinity "Troff " "straight double quote" -offset indent
3865 .It Sy String Ta Sy Nroff Ta Sy Troff Ta Sy Meaning
3866 .It Li <= Ta <= Ta \*[<=] Ta "less equal"
3867 .It Li >= Ta >= Ta \*[>=] Ta "greater equal"
3868 .It Li Rq Ta '' Ta \*[Rq] Ta "right double quote"
3869 .It Li Lq Ta `` Ta \*[Lq] Ta "left double quote"
3870 .It Li ua Ta ^ Ta \*[ua] Ta "upwards arrow"
3871 .It Li aa Ta \' Ta \*[aa] Ta "acute accent"
3872 .It Li ga Ta \` Ta \*[ga] Ta "grave accent"
3873 .It Li q Ta \&" Ta \*[q] Ta "straight double quote"
3874 .It Li Pi Ta pi Ta \*[Pi] Ta "greek pi"
3875 .It Li Ne Ta != Ta \*[Ne] Ta "not equal"
3876 .It Li Le Ta <= Ta \*[Le] Ta "less equal"
3877 .It Li Ge Ta >= Ta \*[Ge] Ta "greater equal"
3878 .It Li Lt Ta < Ta \*[Lt] Ta "less than"
3879 .It Li Gt Ta > Ta \*[Gt] Ta "greater than"
3880 .It Li Pm Ta +\- Ta \*[Pm] Ta "plus minus"
3881 .It Li If Ta infinity Ta \*[If] Ta "infinity"
3882 .It Li Am Ta \*[Am] Ta \*[Am] Ta "ampersand"
3883 .It Li Na Ta \*[Na] Ta \*[Na] Ta "not a number"
3884 .It Li Ba Ta \*[Ba] Ta \*[Ba] Ta "vertical bar"
3887 The names of the columns
3891 are a bit misleading;
3895 representation, while
3897 gives the best glyph form available.
3898 For example, a Unicode enabled
3900 device will have proper glyph representations for all strings, whereas the
3901 enhancement for a Latin1
3903 device is only the plus-minus sign.
3905 String names which consist of two characters can be written as
3907 string names which consist of one character can be written as
3909 A generic syntax for a string name of any length is
3918 \#=====================================================================
3924 available in previous versions of
3926 has been removed since
3929 provides better facilities to check parameters; additionally, many error and
3930 warning messages have been added to this macro package, making it both more
3933 The only remaining debugging macro is
3935 which yields a register dump of all global registers and strings.
3936 A normal user will never need it.
3939 .Sh "FORMATTING WITH GROFF, TROFF, AND NROFF"
3941 By default, the package inhibits page breaks, headers, and footers if
3948 to make the manual more efficient for viewing on-line.
3949 This behaviour can be changed (e.g.\& to create a hardcopy of the
3951 output) by setting the register
3953 to zero while calling
3955 resulting in multiple pages instead of a single, very long page:
3957 .Dl groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt
3959 For double-sided printing, set register
3963 .Dl groff -Tps -rD1 -mdoc foo.man > foo.ps
3965 To change the document font size to 11pt or 12pt, set register
3969 .Dl groff -Tdvi -rS11 -mdoc foo.man > foo.dvi
3977 The line and title length can be changed by setting the registers
3983 .Dl groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less
3985 If not set, both registers default to 78n for TTY devices and 6.5i
3991 .Bl -tag -width mdoc/doc-ditroff -compact
3993 The main manual macro package.
3995 A wrapper file to call
3997 .It Pa mdoc/doc-common
3998 Common strings, definitions, stuff related typographic output.
3999 .It Pa mdoc/doc-nroff
4000 Definitions used for a
4003 .It Pa mdoc/doc-ditroff
4004 Definitions used for all other devices.
4006 Local additions and customizations.
4008 This file checks whether the
4012 package should be used.
4026 Section 3f has not been added to the header routines.
4029 font should be changed in
4034 needs to have a check to prevent splitting up
4035 if the line length is too short.
4037 separates the last parenthesis, and sometimes
4038 looks ridiculous if a line is in fill mode.
4040 The list and display macros do not do any keeps
4041 and certainly should be able to.
4042 .\" Note what happens if the parameter list overlaps a newline
4044 .\" to make sure a line boundary is crossed:
4046 .\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
4049 .\" produces, nudge nudge,
4050 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4051 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4053 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
4055 .\" If double quotes are used, for example:
4057 .\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
4060 .\" produces, nudge nudge,
4061 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4063 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4065 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
4067 .\" Not a pretty sight...
4068 .\" In a paragraph, a long parameter containing unpaddable spaces as
4069 .\" in the former example will cause
4071 .\" to break the line and spread
4072 .\" the remaining words out.
4073 .\" The latter example will adjust nicely to
4074 .\" justified margins, but may break in between an argument and its
4078 .\" the right margin adjustment is normally ragged and the problem is
4081 .\" Local Variables: