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.
23 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
24 .\" 4. Neither the name of the University nor the names of its contributors
25 .\" may be used to endorse or promote products derived from this software
26 .\" without specific prior written permission.
28 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 .\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
42 .\" This reference invokes every macro in the package several
43 .\" times and is guaranteed to give a worst case performance
44 .\" for an already extremely slow package.
55 .Nd reference for groff's mdoc implementation
60 .Nm groff Fl m Ns Cm doc Ar
65 A complete reference for writing
73 formatting package for
78 package, addressed page layout leaving the manipulation of fonts and other
79 typesetting details to the individual author.
82 page layout macros make up the
83 .Em "page structure domain"
84 which consists of macros for titles, section headers, displays and lists
85 \- essentially items which affect the physical position of text on a
87 In addition to the page structure domain, there are two more domains, the
92 The general text domain is defined as macros which perform tasks such as
93 quoting or emphasizing pieces of text.
94 The manual domain is defined as macros that are a subset of the day to day
95 informal language used to describe commands, routines and related
98 Macros in the manual domain handle command names, command line arguments and
99 options, function names, function parameters, pathnames, variables, cross
100 references to other manual pages, and so on.
101 These domain items have value for both the author and the future user of the
103 Hopefully, the consistency gained across the manual set will provide easier
104 translation to future documentation tools.
108 manual pages, a manual entry is simply referred to as a man page, regardless
109 of actual length and without sexist intention.
112 .Sh "GETTING STARTED"
114 The material presented in the remainder of this document is outlined
117 .Bl -enum -width 3n -offset indent
119 . Tn "TROFF IDIOSYNCRASIES"
121 . Bl -tag -width 2n -compact
123 . It "Passing Space Characters in an Argument"
124 . It "Trailing Blank Space Characters"
125 . It "Escaping Special Characters"
126 . It "Other Possible Pitfalls"
130 . Tn "A MANUAL PAGE TEMPLATE"
139 . Tn "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
141 . Bl -tag -width 2n -compact
142 . It "What's in a Name" Ns ...
143 . It "General Syntax"
149 . Bl -tag -width 2n -compact
153 . It "Configuration Declarations (Section Four Only)"
154 . It "Command Modifiers"
155 . It "Defined Variables"
157 . It "Environment Variables"
159 . It "Function Declarations"
160 . It "Function Types"
161 . It "Functions (Library Routines)"
162 . It "Function Arguments"
165 . \" .It "Header File (including source code)"
166 . It "Interactive Commands"
173 . It "Variable Types"
175 . It "Manual Page Cross References"
179 . Tn "GENERAL TEXT DOMAIN"
181 . Bl -tag -width 2n -compact
186 . It "DragonFly Macro"
190 . It "Emphasis Macro"
192 . It "Enclosure and Quoting Macros"
193 . It "No-Op or Normal Text Macro"
194 . It "No-Space Macro"
195 . It "Section Cross References"
197 . It "Mathematical Symbols"
198 . It "References and Citations"
199 . It "Trade Names (or Acronyms and Type Names)"
200 . It "Extended Arguments"
204 . Tn "PAGE STRUCTURE DOMAIN"
206 . Bl -tag -width 2n -compact
207 . It "Section Headers"
208 . It "Subsection Headers"
209 . It "Paragraphs and Line Spacing"
211 . It "Examples and Displays"
212 . It "Lists and Columns"
216 . Tn "MISCELLANEOUS MACROS"
219 . Tn "PREDEFINED STRINGS"
225 . Tn "FORMATTING WITH GROFF, TROFF, AND NROFF"
242 .Sh "TROFF IDIOSYNCRASIES"
246 package attempts to simplify the process of writing a man page.
247 Theoretically, one should not have to learn the tricky details of
252 however, there are a few limitations which are unavoidable and best gotten
254 And, too, be forewarned, this package is
263 a macro is called by placing a
265 (dot character) at the beginning of a line followed by the two-character
266 (or three-character) name for the macro.
267 There can be space or tab characters between the dot and the macro name.
268 Arguments may follow the macro separated by spaces (but
271 It is the dot character at the beginning of the line which causes
274 to interpret the next two (or more) characters as a macro name.
275 A single starting dot followed by nothing is ignored.
278 (dot character) at the beginning of an input line in some context other than
279 a macro invocation, precede the
283 escape sequence which translates literally to a zero-width space, and is
284 never displayed in the output.
289 macros accept an unlimited number of arguments (contrary to other versions
290 of troff which can't handle more than nine arguments).
291 In limited cases, arguments may be continued or extended on the next
293 .Sx Extended Arguments
295 Almost all macros handle quoted arguments (see
296 .Sx Passing Space Characters in an Argument
301 general text domain and manual domain macros are special in that their
304 for callable macro names.
305 This means an argument on the argument list which matches a general text or
306 manual domain macro name (and which is defined to be callable) will be
307 executed or called when it is processed.
308 In this case the argument, although the name of a macro, is not preceded by
312 This makes it possible to nest macros; for example the option macro,
316 the flag and argument macros,
320 to specify an optional flag with an argument:
322 .Bl -tag -width ".Op Fl s Ar bytes" -offset indent
325 .Ql ".Op Fl s Ar bytes"
329 To prevent a string from being interpreted as a macro name, precede the
330 string with the escape sequence
333 .Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent
334 .It Op \&Fl s \&Ar bytes
336 .Ql ".Op \e&Fl s \e&Ar bytes"
344 are not interpreted as macros.
345 Macros whose argument lists are parsed for callable arguments are referred
348 and macros which may be called from an argument list are referred to as
350 throughout this document.
353 as almost all of the macros in
355 are parsed, but as it was cumbersome to constantly refer to macros as
356 being callable and being able to call other macros, the term parsed
360 In the following, we call an
362 macro which starts a line (with a leading dot) a
364 if this distinction is necessary.
366 .Ss "Passing Space Characters in an Argument"
368 Sometimes it is desirable to give as an argument a string containing one or
369 more blank space characters, say, to specify arguments to commands which
370 expect particular arrangement of items in the argument list.
371 Additionally, it makes
374 For example, the function command
376 expects the first argument to be the name of a function and any remaining
377 arguments to be function parameters.
380 stipulates the declaration of function parameters in the parenthesized
381 parameter list, each parameter is guaranteed to be at minimum a two word
386 There are two possible ways to pass an argument which contains
388 One way of passing a string containing blank spaces is to use the hard or
389 unpaddable space character
391 that is, a blank space preceded by the escape character
393 This method may be used with any macro but has the side effect of
394 interfering with the adjustment of text over the length of a line.
396 sees the hard space as if it were any other printable character and cannot
397 split the string into blank or newline separated pieces as one would expect.
398 This method is useful for strings which are not expected to overlap a line
400 An alternative is to use
402 a paddable (i.e.\& stretchable), unbreakable space (this is a
406 The second method is to enclose the string with double quotes.
410 .Bl -tag -width ".Fn fetch char\ *str" -offset indent
411 .It Fn fetch char\ *str
413 .Ql ".Fn fetch char\e *str"
414 .It Fn fetch "char *str"
415 can also be created by
416 .Ql ".Fn fetch \*[q]char *str\*[q]"
422 before the space in the first example
423 or double quotes in the second example
426 would see three arguments, and the result would be:
428 .Dl Fn fetch char *str
430 .\" For an example of what happens when the parameter list overlaps a newline
431 .\" boundary, see the
435 .Ss "Trailing Blank Space Characters"
438 can be confused by blank space characters at the end of a line.
439 It is a wise preventive measure to globally remove all blank spaces
441 .Ao blank-space Ac Ns Ao end-of-line Ac
443 Should the need arise to use a blank character at the end of a line, it
444 may be forced with an unpaddable space and the
450 .Ss "Escaping Special Characters"
452 Special characters like the newline character
454 are handled by replacing the
460 to preserve the backslash.
462 .Ss "Other Possible Pitfalls"
464 A warning is emitted when an empty input line is found outside of displays
469 (Well, it is even better to use
471 macros to avoid the usage of low-level commands.)
473 Leading spaces will cause a break and are output directly.
474 Avoid this behaviour if possible.
475 Similarly, do not use more than one space character between words in an
476 ordinary text line; contrary to other text formatters, they are
478 replaced with a single space.
482 directly as an argument.
491 inserts two space characters after a punctuation mark closing a sentence;
496 are treated transparently, not influencing the sentence-ending behaviour.
497 To change this, insert
499 before or after the dot:
501 .Bd -literal -offset indent
520 .Bd -filled -offset indent
537 As can be seen in the first and third line,
539 handles punctuation characters specially in macro arguments.
540 This will be explained in section
543 In the same way, you have to protect trailing full stops of abbreviations
544 with a trailing zero-width space:
547 A comment in the source file of a man page can be either started with
553 anywhere (the latter is a
556 extension); the rest of such a line is ignored.
559 .Sh "A MANUAL PAGE TEMPLATE"
561 The body of a man page is easily constructed from a basic template:
563 .Bd -literal -offset indent
564 \&.\e" The following commands are required for all man pages.
565 \&.Dd Month day, year
566 \&.Os [OPERATING_SYSTEM] [version/release]
567 \&.Dt DOCUMENT_TITLE [section number] [architecture/volume]
570 \&.Nd one line description of name
571 \&.\e" This next command is for sections 2 and 3 only.
575 \&.\e" The following commands should be uncommented and
576 \&.\e" used where appropriate.
577 \&.\e" .Sh IMPLEMENTATION NOTES
578 \&.\e" This next command is for sections 2, 3 and 9 function
579 \&.\e" return values only.
580 \&.\e" .Sh RETURN VALUES
581 \&.\e" This next command is for sections 1, 6, 7 and 8 only.
582 \&.\e" .Sh ENVIRONMENT
585 \&.\e" This next command is for sections 1, 6, 7, 8 and 9 only
586 \&.\e" (command return values (to shell) and
587 \&.\e" fprintf/stderr type diagnostics).
588 \&.\e" .Sh DIAGNOSTICS
589 \&.\e" .Sh COMPATIBILITY
590 \&.\e" This next command is for sections 2, 3 and 9 error
591 \&.\e" and signal handling only.
601 The first items in the template are the commands
606 the document date, the operating system the man page or subject source is
607 developed or modified for, and the man page title (in
609 along with the section of the manual the page belongs in.
610 These commands identify the page and are discussed below in
613 The remaining items in the template are section headers
621 The headers are discussed in
622 .Sx "PAGE STRUCTURE DOMAIN" ,
623 after presentation of
624 .Sx "MANUAL DOMAIN" .
625 Several content macros are used to demonstrate page layout macros; reading
626 about content macros before page layout macros is recommended.
631 In the description of all macros below, optional arguments are put into
635 represents zero or more additional arguments.
636 Alternative values for a parameter are separated with
638 If there are alternative values for a mandatory parameter, braces are used
641 to enclose the value set.
642 Meta-variables are specified within angles.
646 .Bl -tag -width 6n -offset indent
650 .Op \-test1 Op \-test2 | \-test3
656 Except stated explicitly, all macros are parsed and callable.
658 Note that a macro takes effect up to the next nested macro.
665 Consequently, a warning message is emitted for most commands if the first
666 argument is a macro itself since it cancels the effect of the calling
668 Another consequence is that quoting macros never insert literal quotes;
671 .Ql ".Ic \*[q]foo <bar>\*[q]" .
673 Most macros have a default width value which can be used to specify a label
683 It is recommended not to use this rather obscure feature to avoid
684 dependencies on local modifications of the
691 The title macros are part of the page structure domain but are presented
692 first and separately for someone who wishes to start writing a man page
694 Three header macros designate the document title or manual page title, the
695 operating system, and the date of authorship.
696 These macros are called once at the very beginning of the document and are
697 used to construct headers and footers only.
701 .Op Aq document title
702 .Op Aq section number
705 The document title is the subject of the man page and must be in
707 due to troff limitations.
711 The section number may be a number in the range
712 .No 1,\~ Ns ... Ns ,\~9
718 If it is specified, and no volume name is given, a default volume name is
723 .Tn \*[operating-system] ,
724 the following sections are defined:
726 .Bl -column LOCAL -offset indent -compact
727 .It Li 1 Ta "\*[volume-operating-system] \*[volume-ds-1]"
728 .It Li 2 Ta "\*[volume-operating-system] \*[volume-ds-2]"
729 .It Li 3 Ta "\*[volume-operating-system] \*[volume-ds-3]"
730 .It Li 4 Ta "\*[volume-operating-system] \*[volume-ds-4]"
731 .It Li 5 Ta "\*[volume-operating-system] \*[volume-ds-5]"
732 .It Li 6 Ta "\*[volume-operating-system] \*[volume-ds-6]"
733 .It Li 7 Ta "\*[volume-operating-system] \*[volume-ds-7]"
734 .It Li 8 Ta "\*[volume-operating-system] \*[volume-ds-8]"
735 .It Li 9 Ta "\*[volume-operating-system] \*[volume-ds-9]"
739 A volume name may be arbitrary or one of the following:
742 .Bl -column LOCAL -offset indent -compact
743 .It Li USD Ta "\*[volume-ds-USD]"
744 .It Li PS1 Ta "\*[volume-ds-PS1]"
745 .It Li AMD Ta "\*[volume-ds-AMD]"
746 .It Li SMM Ta "\*[volume-ds-SMM]"
747 .It Li URM Ta "\*[volume-ds-URM]"
748 .It Li PRM Ta "\*[volume-ds-PRM]"
749 .It Li KM Ta "\*[volume-ds-KM]"
750 .It Li IND Ta "\*[volume-ds-IND]"
751 .It Li LOCAL Ta "\*[volume-ds-LOCAL]"
752 .It Li CON Ta "\*[volume-ds-CON]"
764 Values from the previous table will specify a new volume name.
765 If the third parameter is a keyword designating a computer architecture,
766 its value is prepended to the default volume name as specified by the
768 By default, the following architecture keywords are defined:
770 \# we use `No' to avoid hyphenation
771 .Bd -ragged -offset indent
772 .No alpha , acorn26 , acorn32 , algor , amd64 , amiga , arc , arm26 ,
773 .No arm32 , atari , bebox , cats , cesfic , cobalt , dreamcast , evbarm ,
774 .No evbmips , evbppc , evbsh3 , hp300 , hp700 , hpcmips , i386 , luna68k ,
775 .No m68k , mac68k , macppc , mips , mmeye , mvme68k , mvmeppc , netwinder ,
776 .No news68k , newsmips , next68k , ofppc , pc532 , pmax , pmppc , powerpc ,
777 .No prep , sandpoint , sgimips , sh3 , shark , sparc , sparc64 , sun3 ,
778 .No tahoe , vax , x68k , x86_64
782 If the section number is neither a numeric expression in the range 1 to\~9
783 nor one of the above described keywords, the third parameter is used
784 verbatim as the volume name.
786 In the following examples, the left (which is identical to the right) and
787 the middle part of the manual page header strings are shown.
790 prevents the digit\~7 from being a valid numeric expression.
793 .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
796 .Ql \*[volume-operating-system] \*[volume-ds-7]
797 .It Li ".Dt FOO 7 bar"
799 .Ql \*[volume-operating-system] \*[volume-ds-7]
800 .It Li ".Dt FOO \e&7 bar"
803 .It Li ".Dt FOO 2 i386"
805 .Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2]
806 .It Li ".Dt FOO \*[q]\*[q] bar"
813 Local, OS-specific additions might be found in the file
815 look for strings named
817 (for the former type) and
819 (for the latter type);
821 then denotes the keyword to be used with the
825 This macro is neither callable nor parsed.
828 .Op Aq operating system
831 If the first parameter is empty,
833 .Sq Tn "\*[operating-system]"
835 This may be overridden in the local configuration file,
837 In general, the name of the operating system should be the common acronym,
842 The release should be the standard release nomenclature for the system
844 In the following table, the possible second arguments for some predefined
845 operating systems are listed.
848 local additions might be defined in
850 look for strings named
851 .Ql operating\-system\-XXX\-YYY ,
854 is the acronym for the operating system and
859 .Bl -tag -width ".No FreeBSD" -offset indent
861 7th, 7, III, 3, V, V.2, V.3, V.4
863 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
865 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,
866 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,
867 1.6.2, 2.0, 2.0.1, 2.0.2, 2.1, 3.0
869 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,
870 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,
871 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,
872 5.2, 5.2.1, 5.3, 5.4, 5.5, 6.0, 6.1, 6.2, 7.0
874 1.0, 1.1, 1.2, 1.3, 1.4, 1.5
876 8.0.0, 8.1.0, 8.2.0, 8.3.0, 8.4.0, 8.5.0
883 an unknown second parameter will be replaced with the string
885 for the other predefined acronyms it will be ignored and a warning message
887 Unrecognized arguments are displayed as given in the page footer.
888 For instance, a typical footer might be:
893 .Ql 4.3\~Berkeley Distribution ,
894 or for a locally produced set
896 .Dl .Os CS Department
903 macro is not present, the bottom left corner of the manual page will be
906 This macro is neither callable nor parsed.
917 is used for the date string.
918 If it has exactly three arguments, they are concatenated, separated with
921 .Dl .Dd January 25, 2001
923 The month's name shall not be abbreviated.
925 With any other number of arguments, the current date is used, ignoring
928 This macro is neither callable nor parsed.
932 .Sh "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
934 .Ss "What's in a Name" Ns ...
936 The manual domain macro names are derived from the day to day informal
937 language used to describe commands, subroutines and related files.
938 Slightly different variations of this language are used to describe the
939 three different aspects of writing a man page.
940 First, there is the description of
943 Second is the description of a
948 macros, and third, the description of a command to a user in the verbal
949 sense; that is, discussion of a command in the text of a man page.
953 macros are themselves a type of command; the general syntax for a troff
956 .Bd -filled -offset indent
957 .Li ".Xx argument1 argument2" ...
962 is a macro command, and anything following it are arguments to
964 In the second case, the description of a
966 command using the content macros is a bit more involved; a typical
968 command line might be displayed as:
970 .Bd -filled -offset indent
973 .Ao Ar infile Ac Ao Ar outfile Ac
979 is the command name and the
984 argument designated as optional by the option brackets.
993 in this example, the user has to replace the meta expressions given in angle
994 brackets with real file names.
995 Note that in this document meta arguments are used to describe
997 commands; in most man pages, meta variables are not specifically written
999 The macros which formatted the above example:
1001 .Bd -literal -offset indent
1004 \&.Ao Ar infile Ac Ao Ar outfile Ac
1008 In the third case, discussion of commands and command syntax includes both
1009 examples above, but may add more detail.
1014 from the example above might be referred to as
1017 .Em file arguments .
1018 Some command line argument lists are quite long:
1021 .Bl -tag -width ".Nm make" -offset indent -compact
1024 .Op Fl D Ar variable
1026 .Op Fl f Ar makefile
1027 .Op Fl I Ar directory
1028 .Op Fl j Ar max_jobs
1029 .Op Ar variable Ns = Ns Ar value
1037 Here one might talk about the command
1039 and qualify the argument,
1041 as an argument to the flag,
1043 or discuss the optional file operand
1045 In the verbal context, such detail can prevent confusion, however the
1047 package does not have a macro for an argument
1052 argument macro is used for an operand or file argument like
1054 as well as an argument to a flag like
1056 The make command line was produced from:
1058 .Bd -literal -offset indent
1061 \&.Op Fl D Ar variable
1063 \&.Op Fl f Ar makefile
1064 \&.Op Fl I Ar directory
1065 \&.Op Fl j Ar max_jobs
1066 \&.Op Ar variable Ns = Ns Ar value
1077 macros are explained in
1080 .Ss "General Syntax"
1082 The manual domain and general text domain macros share a similar syntax with
1083 a few minor deviations; most notably,
1089 differ only when called without arguments; and
1093 impose an order on their argument lists.
1094 All content macros are capable of recognizing and properly handling
1095 punctuation, provided each punctuation character is separated by a leading
1097 If a command is given:
1099 .Dl \&.Ar sptr, ptr),
1105 The punctuation is not recognized and all is output in the
1108 If the punctuation is separated by a leading white space:
1110 .Dl \&.Ar "sptr , ptr ) ,"
1114 .Dl Ar sptr , ptr ) ,
1116 The punctuation is now recognized and output in the default font
1117 distinguishing it from the argument strings.
1118 To remove the special meaning from a punctuation character escape it with
1121 The following punctuation characters are recognized by
1124 .Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX
1125 .It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\&
1126 .It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\&
1131 is limited as a macro language, and has difficulty when presented with a
1132 string containing a member of the mathematical, logical or quotation set:
1134 .Bd -literal -offset indent-two
1135 {+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
1141 may assume it is supposed to actually perform the operation or evaluation
1142 suggested by the characters.
1143 To prevent the accidental evaluation of these characters, escape them with
1145 Typical syntax is shown in the first content macro displayed below,
1153 The address macro identifies an address construct.
1155 .Dl Usage: .Ad Ao address Ac ...
1157 .Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
1160 .It Li ".Ad addr1 ."
1162 .It Li ".Ad addr1 , file2"
1164 .It Li ".Ad f1 , f2 , f3 :"
1166 .It Li ".Ad addr ) ) ,"
1171 The default width is 12n.
1177 macro is used to specify the name of the author of the item being
1178 documented, or the name of the author of the actual manual page.
1180 .Dl Usage: .An Ao author name Ac ...
1182 .Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n
1183 .It Li ".An \*[q]Joe Author\*[q]"
1185 .It Li ".An \*[q]Joe Author\*[q] ,"
1187 .It Li ".An \*[q]Joe Author\*[q] Aq nobody@FreeBSD.org"
1188 .An "Joe Author" Aq nobody@FreeBSD.org
1189 .It Li ".An \*[q]Joe Author\*[q] ) ) ,"
1190 .An "Joe Author" ) ) ,
1194 The default width is 12n.
1200 command causes a line break allowing each new name to appear on its own
1202 If this is not desirable,
1204 .Bd -literal -offset indent
1209 call will turn this off.
1210 To turn splitting back on, write
1212 .Bd -literal -offset indent
1220 argument macro may be used whenever an argument is referenced.
1221 If called without arguments, the
1225 .Dl Usage: .Ar Oo Ao argument Ac Oc ...
1227 .Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
1232 .It Li ".Ar file1 ."
1234 .It Li ".Ar file1 file2"
1236 .It Li ".Ar f1 f2 f3 :"
1238 .It Li ".Ar file ) ) ,"
1243 The default width is 12n.
1245 .Ss "Configuration Declaration (Section Four Only)"
1249 macro is used to demonstrate a
1251 declaration for a device interface in a section four manual.
1253 .Dl Usage: .Cd Ao argument Ac ...
1255 .Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
1256 .It Li ".Cd \*[q]device le0 at scode?\*[q]"
1257 .Cd "device le0 at scode?"
1264 command causes a line break before and after its arguments are printed.
1267 The default width is 12n.
1269 .Ss "Command Modifiers"
1271 The command modifier is identical to the
1273 (flag) command with the exception that the
1275 macro does not assert a dash in front of every argument.
1276 Traditionally flags are marked by the preceding dash, however, some commands
1277 or subsets of commands do not use them.
1278 Command modifiers may also be specified in conjunction with interactive
1279 commands such as editor commands.
1283 The default width is 10n.
1285 .Ss "Defined Variables"
1287 A variable (or constant) which is defined in an include file
1288 is specified by the macro
1291 .Dl Usage: .Dv Ao defined variable Ac ...
1293 .Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
1294 .It Li ".Dv MAXHOSTNAMELEN"
1296 .It Li ".Dv TIOCGPGRP )"
1301 The default width is 12n.
1307 errno macro specifies the error return value for section 2, 3, and\~9 library
1309 The second example below shows
1313 general text domain macro, as it would be used in a section two manual page.
1315 .Dl Usage: .Er Ao errno type Ac ...
1317 .Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n
1320 .It Li ".Er ENOENT ) ;"
1322 .It Li ".Bq Er ENOTDIR"
1327 The default width is 17n.
1329 .Ss "Environment Variables"
1333 macro specifies an environment variable.
1335 .Dl Usage: .Ev Ao argument Ac ...
1337 .Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n
1338 .It Li ".Ev DISPLAY"
1342 .It Li ".Ev PRINTER ) ) ,"
1347 The default width is 15n.
1353 macro handles command line flags.
1357 For interactive command flags, which are not prepended with a dash, the
1360 macro is identical, but without the dash.
1362 .Dl Usage: .Fl Ao argument Ac ...
1364 .Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n
1377 .It Li ".Fl xyz ) ,"
1385 macro without any arguments results in a dash representing stdin/stdout.
1388 a single dash will result in two dashes.
1390 The default width is 12n.
1392 .Ss "Function Declarations"
1396 macro is used in the
1398 section with section two or three functions.
1399 It is neither callable nor parsed.
1401 .Dl Usage: .Fd Ao argument Ac ...
1403 .Bl -tag -width ".Li .Fd\ X#include\ <sys/types.h>X" -compact -offset 15n
1404 .It Li ".Fd \*[q]#include <sys/types.h>\*[q]"
1405 .Fd "#include <sys/types.h>"
1412 command causes a line break if a function has already been presented and a
1413 break has not occurred.
1414 This leaves a nice vertical space in between the previous function call and
1415 the declaration for the next function.
1422 section, represents the
1424 statement, and is the short form of the above example.
1425 It specifies the C\~header file as being included in a C\~program.
1426 It also causes a line break.
1430 section, it represents the header file enclosed in angle brackets.
1432 .Dl Usage: .In Ao header file Ac
1434 .Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n
1435 .nr in-synopsis-section 1
1436 .It Li ".In stdio.h"
1438 .nr in-synopsis-section 0
1439 .It Li ".In stdio.h"
1443 .Ss "Function Types"
1445 This macro is intended for the
1448 It may be used anywhere else in the man page without problems, but its main
1449 purpose is to present the function type in kernel normal form for the
1451 of sections two and three (it causes a line break, allowing the function
1452 name to appear on the next line).
1454 .Dl Usage: .Ft Ao type Ac ...
1456 .Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n
1457 .It Li ".Ft struct stat"
1461 .Ss "Functions (Library Routines)"
1469 .Dl Usage: .Fn Ao function Ac Oo Ao parameter Ac Oc ...
1471 .Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n
1472 .It Li ".Fn getchar"
1474 .It Li ".Fn strlen ) ,"
1476 .It Li ".Fn align \*[q]char *ptr\*[q] ,"
1477 .Fn align "char *ptr" ,
1480 Note that any call to another macro signals the end of the
1482 call (it will insert a closing parenthesis at that point).
1484 For functions with many parameters (which is rare), the macros
1492 (function argument).
1496 .Bd -literal -offset indent
1505 \&.Fa "struct rrec *newrr"
1514 .Bd -ragged -offset indent
1523 .Fa "struct rrec *newrr"
1532 section, the function will always begin at the beginning of line.
1533 If there is more than one function presented in the
1535 section and a function type has not been given, a line break will occur,
1536 leaving a nice vertical space between the current function name and the one
1539 The default width values of
1543 are 12n and 16n, respectively.
1545 .Ss "Function Arguments"
1549 macro is used to refer to function arguments (parameters) outside of the
1551 section of the manual or inside the
1553 section if the enclosure macros
1561 may also be used to refer to structure members.
1563 .Dl Usage: .Fa Ao function argument Ac ...
1565 .Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n
1566 .It Li ".Fa d_namlen ) ) ,"
1568 .It Li ".Fa iov_len"
1573 The default width is 12n.
1579 macro generates text for use in the
1583 .Dl Usage: .Rv Oo \-std Oc Op Ao function Ac ...
1586 .Ql ".Rv \-std atexit"
1589 .Bd -ragged -offset -indent
1590 \# a small hack to suppress a warning message
1591 .ds section-old "\*[section]
1594 .ds section "\*[section-old]
1600 option is valid only for manual page sections\~2 and\~3.
1601 Currently, this macro does nothing if used without the
1609 macro generates text for use in the
1613 .Dl Usage: .Ex Oo \-std Oc Op Ao utility Ac ...
1619 .Bd -ragged -offset -indent
1620 \# a small hack to suppress a warning message
1621 .ds section-old "\*[section]
1624 .ds section "\*[section-old]
1630 option is valid only for manual page sections 1, 6 and\~8.
1631 Currently, this macro does nothing if used without the
1635 .Ss "Interactive Commands"
1639 macro designates an interactive or internal command.
1641 .Dl Usage: .Ic Ao argument Ac ...
1643 .Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n
1646 .It Li ".Ic \*[q]do while {...}\*[q]"
1647 .Ic "do while {...}"
1648 .It Li ".Ic setenv , unsetenv"
1649 .Ic setenv , unsetenv
1653 The default width is 12n.
1659 macro is used to specify the library where a particular function is compiled
1662 .Dl Usage: .Lb Ao argument Ac ...
1664 Available arguments to
1666 and their results are:
1669 .Bl -tag -width ".Li libossaudio" -compact -offset indent
1737 Local, OS-specific additions might be found in the file
1739 look for strings named
1742 then denotes the keyword to be used with the
1750 command causes a line break before and after its arguments are printed.
1757 literal macro may be used for special characters, variable constants, etc.\&
1758 \- anything which should be displayed as it would be typed.
1760 .Dl Usage: .Li Ao argument Ac ...
1762 .Bl -tag -width ".Li .Li\ cntrl\-D\ )\ ," -compact -offset 15n
1765 .It Li ".Li M1 M2 M3 ;"
1767 .It Li ".Li cntrl\-D ) ,"
1769 .It Li ".Li 1024 ..."
1774 The default width is 16n.
1780 macro is used for the document title or subject name.
1781 It has the peculiarity of remembering the first argument it was called with,
1782 which should always be the subject name of the page.
1783 When called without arguments,
1785 regurgitates this initial name for the sole purpose of making less work for
1787 Note: A section two or three document function name is addressed with the
1795 and remaining sections.
1796 For interactive commands, such as the
1802 macro should be used.
1808 it can not recall the first argument it was invoked with.
1810 .Dl Usage: .Nm Oo Ao argument Ac Oc ...
1812 .Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
1813 .It Li ".Nm groff_mdoc"
1815 .It Li ".Nm \e\-mdoc"
1817 .It Li ".Nm foo ) ) ,"
1824 The default width is 10n.
1830 macro places option brackets around any remaining arguments on the
1831 command line, and places any trailing punctuation outside the brackets.
1836 (which produce an opening and a closing option bracket respectively) may be used
1837 across one or more lines or to specify the exact position of the closing
1840 .Dl Usage: .Op Oo Ao option Ac Oc ...
1842 .Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n
1847 .It Li ".Op Fl k ) ."
1849 .It Li ".Op Fl k Ar kookfile"
1850 .Op Fl k Ar kookfile
1851 .It Li ".Op Fl k Ar kookfile ,"
1852 .Op Fl k Ar kookfile ,
1853 .It Li ".Op Ar objfil Op Ar corfil"
1854 .Op Ar objfil Op Ar corfil
1855 .It Li ".Op Fl c Ar objfil Op Ar corfil ,"
1856 .Op Fl c Ar objfil Op Ar corfil ,
1857 .It Li ".Op word1 word2"
1859 .It Li ".Li .Op Oo Ao option Ac Oc ..."
1860 .Li .Op Oo Ao option Ac Oc ...
1863 Here a typical example of the
1869 .Bd -literal -offset indent
1871 \&.Op Fl k Ar kilobytes
1872 \&.Op Fl i Ar interval
1880 .Bd -filled -offset indent
1882 .Op Fl k Ar kilobytes
1883 .Op Fl i Ar interval
1889 The default width values of
1893 are 14n and 10n, respectively.
1899 macro formats path or file names.
1900 If called without arguments, the
1902 string is output, which represents the current user's home directory.
1904 .Dl Usage: .Pa Oo Ao pathname Ac Oc ...
1906 .Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n
1909 .It Li ".Pa /usr/share"
1911 .It Li ".Pa /tmp/fooXXXXX ) ."
1912 .Pa /tmp/fooXXXXX ) .
1916 The default width is 32n.
1922 macro replaces standard abbreviations with their formal names.
1924 .Dl Usage: .St Ao abbreviation Ac ...
1927 .Dq Abbreviation/Formal Name
1933 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1950 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1951 .It Li \-iso9945\-1\-90
1953 .It Li \-iso9945\-1\-96
1957 .It Li \-p1003.1\-88
1959 .It Li \-p1003.1\-90
1961 .It Li \-p1003.1\-96
1963 .It Li \-p1003.1b\-93
1965 .It Li \-p1003.1c\-95
1967 .It Li \-p1003.1g\-2000
1969 .It Li \-p1003.1i\-95
1971 .It Li \-p1003.1\-2001
1973 .It Li \-p1003.1\-2004
1979 Part 2: Shell and Utilities
1981 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
1982 .It Li \-iso9945\-2\-93
1986 .It Li \-p1003.2\-92
1988 .It Li \-p1003.2a\-92
1994 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
2025 .Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
2032 .Ss "Variable Types"
2036 macro may be used whenever a type is referenced.
2039 section, it causes a line break (useful for old style variable declarations).
2041 .Dl Usage: .Vt Ao type Ac ...
2043 .Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n
2044 .It Li ".Vt extern char *optarg ;"
2045 .Vt extern char *optarg ;
2052 Generic variable reference.
2054 .Dl Usage: .Va Ao variable Ac ...
2056 .Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n
2059 .It Li ".Va settimer ,"
2061 .It Li ".Va \*[q]int *prt\*[q] ) :"
2063 .It Li ".Va \*[q]char s\*[q] ] ) ) ,"
2064 .Va "char s" ] ) ) ,
2068 The default width is 12n.
2070 .Ss "Manual Page Cross References"
2074 macro expects the first argument to be a manual page name.
2075 The optional second argument, if a string (defining the manual section), is
2076 put into parentheses.
2078 .Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
2080 .Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
2087 .It Li ".Xr xinit 1x ;"
2092 The default width is 10n.
2095 .Sh "GENERAL TEXT DOMAIN"
2100 .Dl Usage: .At Oo Ao version Ac Oc ...
2102 .Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n
2109 The following values for
2113 .Dl 32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4
2118 .Dl "Usage: .Bx" Bro \-alpha | \-beta | \-devel Brc ...
2119 .Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
2121 .Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
2126 .It Li ".Bx \-devel"
2131 will be prepended to the string
2133 The following values for
2137 .Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
2142 .Dl Usage: .Nx Oo Ao version Ac Oc ...
2144 .Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n
2151 For possible values of
2153 see the description of the
2155 command above in section
2156 .Sx "TITLE MACROS" .
2161 .Dl Usage: .Fx Oo Ao version Ac Oc ...
2163 .Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n
2170 For possible values of
2172 see the description of the
2174 command above in section
2175 .Sx "TITLE MACROS" .
2177 .Ss "DragonFly Macro"
2180 .Dl Usage: .Dx Oo Ao version Ac Oc ...
2182 .Bl -tag -width ".Li .Dx\ 1.4\ ." -compact -offset 15n
2189 For possible values of
2191 see the description of the
2193 command above in section
2194 .Sx "TITLE MACROS" .
2199 .Dl Usage: .Ox Oo Ao version Ac Oc ...
2201 .Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n
2209 .Dl Usage: .Bsx Oo Ao version Ac Oc ...
2211 .Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n
2221 .Bl -tag -width ".Li .Ux" -compact -offset 15n
2226 .Ss "Emphasis Macro"
2228 Text may be stressed or emphasized with the
2231 The usual font for emphasis is italic.
2233 .Dl Usage: .Em Ao argument Ac ...
2235 .Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n
2236 .It Li ".Em does not"
2238 .It Li ".Em exceed 1024 ."
2240 .It Li ".Em vide infra ) ) ,"
2241 .Em vide infra ) ) ,
2245 The default width is 10n.
2251 font mode must be ended with the
2253 macro (the latter takes no arguments).
2254 Font modes may be nested within other font modes.
2257 has the following syntax:
2259 .Dl .Bf Ao font mode Ac
2262 must be one of the following three types:
2264 .Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent
2265 .It Sy \&Em | Fl emphasis
2268 macro was used for the entire block of text.
2269 .It Sy \&Li | Fl literal
2272 macro was used for the entire block of text.
2273 .It Sy \&Sy | Fl symbolic
2276 macro was used for the entire block of text.
2279 Both macros are neither callable nor parsed.
2281 .Ss "Enclosure and Quoting Macros"
2283 The concept of enclosure is similar to quoting.
2284 The object being to enclose one or more strings between a pair of characters
2285 like quotes or parentheses.
2286 The terms quoting and enclosure are used interchangeably throughout this
2288 Most of the one-line enclosure macros end in small letter
2290 to give a hint of quoting, but there are a few irregularities.
2291 For each enclosure macro there is also a pair of open and close macros which
2292 end in small letters
2302 .Bd -filled -offset 4n
2303 .Bl -column "quote" "close" "open" "Angle Bracket Enclosure" "`string' or string"
2304 .Em Quote Ta Em Open Ta Em Close Ta Em Function Ta Em Result
2305 .No .Aq Ta .Ao Ta .Ac Ta "Angle Bracket Enclosure" Ta Ao string Ac
2306 .No .Bq Ta .Bo Ta .Bc Ta "Bracket Enclosure" Ta Bo string Bc
2307 .No .Brq Ta .Bro Ta .Brc Ta "Brace Enclosure" Ta Bro string Brc
2308 .No .Dq Ta .Do Ta .Dc Ta "Double Quote" Ta Do string Dc
2309 .No .Eq Ta .Eo Ta .Ec Ta "Enclose String (in XX)" Ta XXstringXX
2310 .No .Pq Ta .Po Ta .Pc Ta "Parenthesis Enclosure" Ta Po string Pc
2311 .No .Ql Ta Ta Ta "Quoted Literal" Ta So string Sc or Li string
2312 .No .Qq Ta .Qo Ta .Qc Ta "Straight Double Quote" Ta Qo string Qc
2313 .No .Sq Ta .So Ta .Sc Ta "Single Quote" Ta So string Sc
2317 All macros ending with
2321 have a default width value of 12n.
2323 .Bl -tag -width ".Li .Ec , .Eo"
2325 These macros expect the first argument to be the opening and closing strings
2328 Due to the nine-argument limit in the original troff program two other
2329 macros have been implemented which are now rather obsolete:
2331 takes the first and second parameter as the left and right enclosure string,
2332 which are then used to enclose the arguments of
2334 The default width value is 12n for both macros.
2336 The first and second arguments of this macro are the opening and
2337 closing strings respectively, followed by the arguments to be enclosed.
2339 The quoted literal macro behaves differently in troff and nroff mode.
2342 a quoted literal is always quoted.
2343 If formatted with troff, an item is only quoted if the width of the item is
2344 less than three constant width characters.
2345 This is to make short strings more visible where the font change to literal
2346 (constant width) is less noticeable.
2348 The default width is 16n.
2350 The prefix macro suppresses the whitespace between its first and second
2353 .Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent
2354 .It Li ".Pf ( Fa name2"
2359 The default width is 12n.
2363 macro (see below) performs the analogous suffix function.
2367 macro inserts an apostrophe and exits any special text modes, continuing in
2373 Examples of quoting:
2376 .Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent
2379 .It Li ".Aq Pa ctype.h ) ,"
2383 .It Li ".Bq Em Greek , French ."
2384 .Bq Em Greek , French .
2387 .It Li ".Dq string abc ."
2389 .It Li ".Dq \'^[A\-Z]\'"
2391 .It Li ".Ql man mdoc"
2395 .It Li ".Qq string ) ,"
2397 .It Li ".Qq string Ns ),"
2403 .It Li ".Em or Ap ing"
2408 For a good example of nested enclosure macros, see the
2411 It was created from the same underlying enclosure macros as those presented
2417 extended argument list macros are discussed below.
2419 .Ss "No-Op or Normal Text Macro"
2423 macro can be used in a macro command line for parameters which should
2430 if you really want that English word (and not the macro) as a parameter.
2432 .Dl Usage: .No Ao argument Ac ...
2434 .Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n
2435 .It Li ".No test Ta with Ta tabs"
2436 .No test Ta with Ta tabs
2440 The default width is 12n.
2442 .Ss "No-Space Macro"
2446 macro suppresses insertion of a space between the current position and its
2448 For example, it is useful for old style argument lists where there is no
2449 space between the flag and argument:
2451 .Dl "Usage:" ... Ao argument Ac \&Ns Oo Ao argument Ac Oc ...
2452 .Dl " " .Ns Ao argument Ac ...
2454 .Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n
2455 .It Li ".Op Fl I Ns Ar directory"
2456 .Op Fl I Ns Ar directory
2461 macro always invokes the
2463 macro after eliminating the space unless another macro name follows it.
2464 If used as a command (i.e., the second form above in the
2471 .Ss "Section Cross References"
2475 macro designates a reference to a section header within the same document.
2477 .Dl Usage: .Sx Ao section reference Ac ...
2479 .Bl -tag -width ".Li .Sx\ FILES" -offset 15n
2485 The default width is 16n.
2489 The symbolic emphasis macro is generally a boldface macro in either the
2490 symbolic sense or the traditional English usage.
2492 .Dl Usage: .Sy Ao symbol Ac ...
2494 .Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n
2495 .It Li ".Sy Important Notice"
2496 .Sy Important Notice
2500 The default width is 6n.
2502 .Ss Mathematical Symbols
2504 Use this macro for mathematical symbols and similar things.
2506 .Dl Usage: .Ms Ao math symbol Ac ...
2508 .Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n
2514 The default width is 6n.
2516 .Ss "References and Citations"
2518 The following macros make a modest attempt to handle references.
2519 At best, the macros make it convenient to manually drop in a subset of
2523 .Bl -tag -width 6n -offset indent -compact
2525 Reference start (does not take arguments).
2526 Causes a line break in the
2528 section and begins collection of reference information until the reference
2531 Reference end (does not take arguments).
2532 The reference is printed.
2534 Reference author name; one name per invocation.
2538 City/place (not implemented yet).
2542 Issuer/publisher name.
2548 Optional information.
2552 Corporate or foreign author.
2561 Macros beginning with
2563 are not callable but accept multiple arguments in the usual way.
2566 macro is handled properly as a parameter; other macros will cause strange
2571 can be used outside of the
2577 .Bd -literal -offset indent
2581 \&.%T "Implementation Notes on foobar(1)"
2582 \&.%R "Technical Report ABC\-DE\-12\-345"
2583 \&.%Q "Drofnats College, Nowhere"
2590 .Bd -ragged -offset indent
2594 .%T "Implementation Notes on foobar(1)"
2595 .%R "Technical Report ABC-DE-12-345"
2596 .%Q "Drofnats College, Nowhere"
2601 .Ss "Trade Names (or Acronyms and Type Names)"
2603 The trade name macro prints its arguments in a smaller font.
2604 Its intended use is to imitate a small caps fonts for uppercase acronyms.
2606 .Dl Usage: .Tn Ao symbol Ac ...
2608 .Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n
2616 The default width is 10n.
2618 .Ss "Extended Arguments"
2624 macros allow one to extend an argument list on a macro boundary for the
2631 are implemented similarly to all other macros opening and closing an
2632 enclosure (without inserting characters, of course).
2633 This means that the following is true for those macros also.
2635 Here is an example of
2637 using the space mode macro to turn spacing off:
2639 .Bd -literal -offset indent
2641 \&.It Xo Sy I Ar operation
2642 \&.No \een Ar count No \een
2650 .Bd -filled -offset indent
2653 .It Xo Sy I Ar operation
2654 .No \en Ar count No \en
2663 .Bd -literal -offset indent
2665 \&.It Cm S No / Ar old_pattern Xo
2666 \&.No / Ar new_pattern
2675 .Bd -filled -offset indent
2678 .It Cm S No \&/ Ar old_pattern Xo
2679 .No \&/ Ar new_pattern
2689 and enclosure macros: Test the value of a variable.
2691 .Bd -literal -offset indent
2694 \&.Oo \e&! Oc Ns Ar variable Oo
2695 \&.Ar operator variable ...
2702 .Bd -filled -offset indent
2703 .Bl -tag -width flag -compact
2706 .Oo \&! Oc Ns Ar variable Oo
2707 .Ar operator variable ...
2714 .Sh "PAGE STRUCTURE DOMAIN"
2716 .Ss "Section Headers"
2720 section header macros are required in every man page.
2721 The remaining section headers are recommended at the discretion of the
2722 author writing the manual page.
2725 macro is parsed but not generally callable.
2726 It can be used as an argument in a call to
2728 only; it then reactivates the default font for
2731 The default width is 8n.
2733 .Bl -tag -width ".Li .Sh\ RETURN\ VALUES"
2738 If not specified, headers, footers and page layout defaults will not be set
2739 and things will be rather unpleasant.
2742 section consists of at least three items.
2745 name macro naming the subject of the man page.
2746 The second is the name description macro,
2748 which separates the subject name from the third item, which is the
2750 The description should be the most terse and lucid possible, as the space
2756 then all its arguments.
2758 .It Li ".Sh LIBRARY"
2759 This section is for section two and three function calls.
2760 It should consist of a single
2764 .Sx "Library Names" .
2766 .It Li ".Sh SYNOPSIS"
2769 section describes the typical usage of the subject of a man page.
2770 The macros required are either
2781 The function name macro
2783 is required for manual page sections\~2 and\~3; the command and general name
2786 is required for sections 1, 5, 6, 7, and\~8.
2787 Section\~4 manuals require a
2792 configuration device usage macro.
2793 Several other macros may be necessary to produce the synopsis line as shown
2796 .Bd -filled -offset indent
2804 The following macros were used:
2807 .Dl ".Op Fl benstuv"
2811 .It Li ".Sh DESCRIPTION"
2812 In most cases the first text in the
2814 section is a brief paragraph on the command, function or file, followed by a
2815 lexical list of options and respective explanations.
2816 To create such a list, the
2823 macros are used (see
2824 .Sx Lists and Columns
2827 .It Li ".Sh IMPLEMENTATION NOTES"
2828 Implementation specific information should be placed here.
2830 .It Li ".Sh RETURN VALUES"
2831 Sections 2, 3 and\~9 function return values should go here.
2834 macro may be used to generate text for use in the
2836 section for most section 2 and 3 library functions;
2838 .Sx "Return Values" .
2844 section headers are part of the preferred manual page layout and must be
2845 used appropriately to maintain consistency.
2846 They are listed in the order in which they would be used.
2848 .Bl -tag -width ".Li .Sh\ COMPATIBILITY"
2849 .It Li ".Sh ENVIRONMENT"
2852 section should reveal any related environment variables and clues to their
2853 behavior and/or usage.
2856 Files which are used or created by the man page subject should be listed via
2863 .It Li ".Sh EXAMPLES"
2864 There are several ways to create examples.
2867 section below for details.
2869 .It Li ".Sh DIAGNOSTICS"
2870 Diagnostic messages from a command should be placed in this section.
2873 macro may be used to generate text for use in the
2875 section for most section 1, 6 and\~8 commands;
2879 .It Li ".Sh COMPATIBILITY"
2880 Known compatibility issues (e.g. deprecated options or parameters)
2881 should be listed here.
2884 Specific error handling, especially from library functions (man page
2885 sections 2, 3, and\~9) should go here.
2888 macro is used to specify an error (errno).
2890 .It Li ".Sh SEE ALSO"
2891 References to other material on the man page topic and cross references to
2892 other relevant man pages should be placed in the
2895 Cross references are specified using the
2900 style references are not accommodated.
2902 It is recommended that the cross references are sorted on the section
2903 number, then alphabetically on the names within a section, and placed
2904 in that order and comma separated.
2912 .It Li ".Sh STANDARDS"
2913 If the command, library function or file adheres to a specific
2914 implementation such as
2918 this should be noted here.
2919 If the command does not adhere to any standard, its history should be noted
2924 .It Li ".Sh HISTORY"
2925 Any command which does not adhere to any specific standards should be
2926 outlined historically in this section.
2928 .It Li ".Sh AUTHORS"
2929 Credits should be placed here.
2932 macro for names and the
2934 macro for e-mail addresses within optional contact information.
2935 Explicitly indicate whether the person authored the initial manual page
2936 or the software or whatever the person is being credited for.
2938 Blatant problems with the topic go here.
2944 sections may be added; for example, this section was set with:
2946 .Bd -literal -offset 15n
2947 \&.Sh "PAGE STRUCTURE DOMAIN"
2950 .Ss "Subsection Headers"
2952 Subsection headers have exactly the same syntax as section headers:
2954 is parsed but not generally callable.
2955 It can be used as an argument in a call to
2957 only; it then reactivates the default font for
2960 The default width is 8n.
2962 .Ss "Paragraphs and Line Spacing"
2964 .Bl -tag -width ".Li .Pp"
2968 paragraph command may be used to specify a line space where necessary.
2969 The macro is not necessary after a
2977 macro (which both assert a vertical distance unless the
2981 The macro is neither callable nor parsed and takes no arguments; an
2988 .\" This worked with version one, need to redo for version three
2991 .\" .Cw (ax+bx+c) \ is\ produced\ by\ \&
2992 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
3009 .\" .Em is produced by
3025 .\" This example shows the same equation in a different format.
3029 .\" signs were forced with
3033 .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
3034 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
3045 .\" .Li \&.Cx \e\ +\e\ \e&
3056 .\" .Em is produced by
3064 .\" .Li \&.Cx \e\ +\e\ \e&
3075 .\" The incantation below was
3081 .\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
3083 .\" .Li \&.Cx Op Sy ?/
3093 .\" .Em is produced by
3095 .\" .Li \&.Ar \e\ b1 e1 f1
3109 The only keep that is implemented at this time is for words.
3116 The only option that
3118 accepts currently is
3120 (this is also the default if no option is given) which is useful for
3121 preventing line breaks in the middle of options.
3122 In the example for the make command line arguments (see
3123 .Sx What's in a Name ) ,
3126 from placing up the flag and the argument on separate lines.
3128 Both macros are neither callable nor parsed.
3130 More work needs to be done with the keep macros; specifically, a
3132 option should be added.
3134 .Ss "Examples and Displays"
3136 There are seven types of displays.
3138 .Bl -tag -width ".Li .D1"
3141 Display one line of indented text.
3142 This macro is parsed but not callable.
3146 The above was produced by:
3147 .Li ".D1 Fl ldghfstru" .
3151 Display one line of indented
3156 example macro has been used throughout this file.
3157 It allows the indentation (display) of one line of text.
3158 Its default font is set to constant width (literal).
3160 is parsed but not callable.
3162 .Dl % ls \-ldg /usr/local/bin
3164 The above was produced by:
3165 .Li ".Dl % ls \e\-ldg /usr/local/bin" .
3171 display must be ended with the
3174 It has the following syntax:
3176 .Bd -ragged -compact
3177 .Bl -tag -width ".Li .Bd" -offset indent
3179 .Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc
3180 .Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
3185 .Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
3187 Fill, but do not adjust the right margin (only left-justify).
3189 Center lines between the current left and right margin.
3190 Note that each single line is centered.
3192 Do not fill; display a block of text as typed, using line breaks as
3193 specified by the user.
3194 This can produce overlong lines without warning messages.
3196 Display a filled block.
3197 The block of text is formatted (i.e., the text is justified on both the left
3200 Display block with literal font (usually fixed-width).
3201 Useful for source code or simple tabbed or spaced text.
3202 .It Fl file Ao Ar file name Ac
3203 The file whose name follows the
3205 flag is read and displayed before any data enclosed with
3209 using the selected display type.
3211 .Xr troff/ Ns Nm \-mdoc
3212 commands in the file will be processed.
3213 .It Fl offset Ao Ar string Ac
3216 is specified with one of the following strings, the string is interpreted to
3217 indicate the level of indentation for the forthcoming block of text:
3220 .Bl -tag -width ".Ar indent-two" -compact
3222 Align block on the current left margin; this is the default mode of
3225 Supposedly center the block.
3226 At this time unfortunately, the block merely gets left aligned about an
3227 imaginary center margin.
3229 Indent by one default indent value or tab.
3230 The default indent value is also used for the
3234 macros, so one is guaranteed the two types of displays will line up.
3235 The indentation value is normally set to\~6n or about two thirds of an inch
3236 (six constant width characters).
3238 Indent two times the default indent value.
3242 aligns the block about two inches from the right side of the page.
3243 This macro needs work and perhaps may never do the right thing within
3250 is a valid numeric expression instead
3251 .Pf ( Em with a scale indicator other than
3253 use that value for indentation.
3254 The most useful scale indicators are
3258 specifying the so-called
3262 This is approximately the width of the letters
3267 of the current font (for nroff output, both scale indicators give the same
3271 isn't a numeric expression, it is tested whether it is an
3273 macro name, and the default offset value associated with this macro is used.
3274 Finally, if all tests fail,
3277 (typeset with a fixed-width font) is taken as the offset.
3279 Suppress insertion of vertical space before begin of display.
3283 End display (takes no arguments).
3286 .Ss "Lists and Columns"
3288 There are several types of lists which may be initiated with the
3291 Items within the list are specified with the
3293 item macro, and each list must end with the
3296 Lists may be nested within themselves and within displays.
3297 The use of columns inside of lists or lists inside of columns is unproven.
3299 In addition, several list attributes may be specified such as the width of a
3300 tag, the list offset, and compactness (blank lines between items allowed or
3302 Most of this document has been formatted with a tag style list
3305 It has the following syntax forms:
3308 .Bd -ragged -compact
3309 .Bl -tag -width ".Li .Bl" -offset indent -compact
3311 .Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc
3312 .Oo \-width Ao string Ac Oc
3313 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3315 .No \-column Oo \-offset Ao string Ac Oc
3316 .Ao string1 Ac Ao string2 Ac ... Xc
3318 .Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc
3319 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3324 And now a detailed description of the list types.
3327 .Bl -tag -width ".Fl column" -compact
3331 .Bd -literal -offset indent
3332 \&.Bl \-bullet \-offset indent \-compact
3334 Bullet one goes here.
3344 .Bl -bullet -offset indent -compact
3346 Bullet one goes here.
3352 .It Fl dash No ( or Fl hyphen )
3355 .Bd -literal -offset indent
3356 \&.Bl \-dash \-offset indent \-compact
3368 .Bl -dash -offset indent -compact
3379 .Bd -literal -offset indent
3380 \&.Bl \-enum \-offset indent \-compact
3392 .Bl -enum -offset indent -compact
3400 If you want to nest enumerated lists, use the
3402 flag (starting with the second-level list):
3404 .Bd -literal -offset indent
3405 \&.Bl \-enum \-offset indent \-compact
3408 \&.Bl \-enum \-nested \-compact
3412 And item three here.
3423 .Bl -enum -offset indent -compact
3426 .Bl -enum -nested -compact
3430 And item three here.
3440 without list markers.
3442 .Bd -literal -offset indent
3443 \&.Bl \-item \-offset indent
3459 .Bl -item -offset indent
3475 to specify the tag width.
3478 .Bl -tag -width "PPID" -compact -offset indent
3480 sleep time of the process (seconds blocked)
3484 resulting from references by the process
3485 to pages not loaded in core.
3487 numerical user-id of process owner
3489 numerical id of parent of process priority
3490 (non-positive when in non-interruptible wait)
3496 .Bd -literal -offset indent
3497 \&.Bl \-tag \-width "PPID" \-compact \-offset indent
3499 sleep time of the process (seconds blocked)
3503 resulting from references by the process
3504 to pages not loaded in core.
3506 numerical user\-id of process owner
3508 numerical id of parent of process priority
3509 (non\-positive when in non\-interruptible wait)
3515 Diag lists create section four diagnostic lists and are similar to inset
3516 lists except callable macros are ignored.
3519 flag is not meaningful in this context.
3523 .Bd -literal -offset indent
3525 \&.It You can't use Sy here.
3526 The message says all.
3534 .It You can't use Sy here.
3535 The message says all.
3540 A list with hanging tags.
3542 .Bl -hang -offset indent
3544 labels appear similar to tagged lists when the
3545 label is smaller than the label width.
3546 .It Em Longer hanged list labels
3547 blend into the paragraph unlike
3548 tagged paragraph labels.
3551 And the unformatted text which created it:
3553 .Bd -literal -offset indent
3554 \&.Bl \-hang \-offset indent
3556 labels appear similar to tagged lists when the
3557 label is smaller than the label width.
3558 \&.It Em Longer hanged list labels
3559 blend into the paragraph unlike
3560 tagged paragraph labels.
3566 Lists with overhanging tags do not use indentation for the items; tags are
3567 written to a separate line.
3569 .Bl -ohang -offset indent
3571 sleep time of the process (seconds blocked)
3575 resulting from references by the process
3576 to pages not loaded in core.
3578 numerical user-id of process owner
3580 numerical id of parent of process priority
3581 (non-positive when in non-interruptible wait)
3587 .Bd -literal -offset indent
3588 \&.Bl \-ohang \-offset indent
3590 sleep time of the process (seconds blocked)
3594 resulting from references by the process
3595 to pages not loaded in core.
3597 numerical user\-id of process owner
3599 numerical id of parent of process priority
3600 (non\-positive when in non\-interruptible wait)
3606 Here is an example of inset labels:
3607 .Bl -inset -offset indent
3609 The tagged list (also called a tagged paragraph)
3610 is the most common type of list used in the
3614 attribute as described below.
3616 Diag lists create section four diagnostic lists
3617 and are similar to inset lists except callable
3620 Hanged labels are a matter of taste.
3622 Overhanging labels are nice when space is constrained.
3624 Inset labels are useful for controlling blocks of
3625 paragraphs and are valuable for converting
3627 manuals to other formats.
3630 Here is the source text which produced the above example:
3632 .Bd -literal -offset indent
3633 \&.Bl \-inset \-offset indent
3635 The tagged list (also called a tagged paragraph)
3636 is the most common type of list used in the
3639 Diag lists create section four diagnostic lists
3640 and are similar to inset lists except callable
3643 Hanged labels are a matter of taste.
3645 Overhanging labels are nice when space is constrained.
3647 Inset labels are useful for controlling blocks of
3648 paragraphs and are valuable for converting
3650 manuals to other formats.
3656 This list type generates multiple columns.
3657 The number of columns and the width of each column is determined by the
3668 (dot) immediately followed by a valid
3670 macro name, interpret
3672 and use the width of the result.
3673 Otherwise, the width of
3675 (typeset with a fixed-width font) is taken as the
3681 argument is parsed to make a row, each column within the row is a separate
3682 argument separated by a tab or the
3688 .Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3689 .It Sy String Ta Sy Nroff Ta Sy Troff
3690 .It Li <= Ta <= Ta \*(<=
3691 .It Li >= Ta >= Ta \*(>=
3698 \&.Bl \-column \-offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3699 \&.It Sy String Ta Sy Nroff Ta Sy Troff
3700 \&.It Li <= Ta <= Ta \e*(<=
3701 \&.It Li >= Ta >= Ta \e*(>=
3706 Don't abuse this list type!
3707 For more complicated cases it might be far better and easier to use
3709 the table preprocessor.
3715 .Bl -tag -width ".Fl indent Ao Ar string Ac"
3716 .It Fl width Ao Ar string Ac
3721 (dot) immediately followed by a valid
3723 macro name, interpret
3725 and use the width of the result.
3726 Almost all lists in this document use this option.
3730 .Bd -literal -offset indent
3731 \&.Bl \-tag \-width ".Fl test Ao Ar string Ac"
3732 \&.It Fl test Ao Ar string Ac
3733 This is a longer sentence to show how the
3735 flag works in combination with a tag list.
3742 .Bl -tag -width ".Fl test Ao Ar string Ac"
3743 .It Fl test Ao Ar string Ac
3744 This is a longer sentence to show how the
3746 flag works in combination with a tag list.
3750 (Note that the current state of
3754 is interpreted; afterwards, all variables are restored again.
3755 However, boxes (used for enclosures) can't be saved in
3758 as a consequence, arguments must always be
3760 to avoid nasty errors.
3761 For example, do not write
3764 .Ql ".Ao Ar string Xc"
3765 instead if you really need only an opening angle bracket.)
3769 is a valid numeric expression
3770 .Em ( with a scale indicator other than
3772 use that value for indentation.
3773 The most useful scale indicators are
3777 specifying the so-called
3781 This is approximately the width of the letters
3786 of the current font (for nroff output, both scale indicators give the same
3790 isn't a numeric expression, it is tested whether it is an
3792 macro name, and the default width value associated with this macro is used.
3793 Finally, if all tests fail,
3796 (typeset with a fixed-width font) is taken as the width.
3798 If a width is not specified for the tag list type, every time
3800 is invoked, an attempt is made to determine an appropriate width.
3801 If the first argument to
3803 is a callable macro, the default width for that macro will be used;
3804 otherwise, the default width of
3807 .It Fl offset Ao Ar string Ac
3812 a default indent value (normally set to\~6n, similar to the value used in
3819 is a valid numeric expression instead
3820 .Pf ( Em with a scale indicator other than
3822 use that value for indentation.
3823 The most useful scale indicators are
3827 specifying the so-called
3831 This is approximately the width of the letters
3836 of the current font (for nroff output, both scale indicators give the same
3840 isn't a numeric expression, it is tested whether it is an
3842 macro name, and the default offset value associated with this macro is used.
3843 Finally, if all tests fail,
3846 (typeset with a fixed-width font) is taken as the offset.
3848 Suppress insertion of vertical space before the list and between list items.
3852 .Sh "MISCELLANEOUS MACROS"
3854 Here a list of the remaining macros which do not fit well into one of the
3856 We couldn't find real examples for the following macros:
3860 They are documented here for completeness \- if you know how to use them
3861 properly please send a mail to
3862 .Mt bug-groff@gnu.org
3863 (including an example).
3865 .Bl -tag -width ".Li .Bt"
3869 .Bd -ragged -offset indent
3873 It is neither callable nor parsed and takes no arguments.
3877 .Dl Usage: .Fr Ao function return value Ac ...
3879 Don't use this macro.
3880 It allows a break right before the return value (usually a single digit)
3881 which is bad typographical behaviour.
3884 to tie the return value to the previous word.
3887 Use this macro to include a (header) file literally.
3890 followed by the file name, then the contents of
3893 .Dl Usage: .Hf Ao file Ac
3895 It is neither callable nor parsed.
3901 Exact usage unknown.
3902 The documentation in the
3904 source file describes it as a macro for
3905 .Dq "menu entries" .
3907 Its default width is 6n.
3913 Exact usage unknown.
3914 The documentation in the
3916 source file describes it as
3917 .Dq old function type (fortran) .
3920 Activate (toggle) space mode.
3922 .Dl Usage: .Sm Oo on | off Oc ...
3924 If space mode is off, no spaces between macro arguments are inserted.
3925 If called without a parameter (or if the next parameter is neither
3935 .Bd -ragged -offset indent
3939 It is neither callable nor parsed and takes no arguments.
3943 .Sh "PREDEFINED STRINGS"
3945 The following strings are predefined:
3947 .Bl -column String infinity "Troff " "straight double quote" -offset indent
3948 .It Sy String Ta Sy Nroff Ta Sy Troff Ta Sy Meaning
3949 .It Li <= Ta <= Ta \*[<=] Ta "less equal"
3950 .It Li >= Ta >= Ta \*[>=] Ta "greater equal"
3951 .It Li Rq Ta '' Ta \*[Rq] Ta "right double quote"
3952 .It Li Lq Ta `` Ta \*[Lq] Ta "left double quote"
3953 .It Li ua Ta ^ Ta \*[ua] Ta "upwards arrow"
3954 .It Li aa Ta \' Ta \*[aa] Ta "acute accent"
3955 .It Li ga Ta \` Ta \*[ga] Ta "grave accent"
3956 .It Li q Ta \&" Ta \*[q] Ta "straight double quote"
3957 .It Li Pi Ta pi Ta \*[Pi] Ta "greek pi"
3958 .It Li Ne Ta != Ta \*[Ne] Ta "not equal"
3959 .It Li Le Ta <= Ta \*[Le] Ta "less equal"
3960 .It Li Ge Ta >= Ta \*[Ge] Ta "greater equal"
3961 .It Li Lt Ta < Ta \*[Lt] Ta "less than"
3962 .It Li Gt Ta > Ta \*[Gt] Ta "greater than"
3963 .It Li Pm Ta +\- Ta \*[Pm] Ta "plus minus"
3964 .It Li If Ta infinity Ta \*[If] Ta "infinity"
3965 .It Li Am Ta \*[Am] Ta \*[Am] Ta "ampersand"
3966 .It Li Na Ta \*[Na] Ta \*[Na] Ta "not a number"
3967 .It Li Ba Ta \*[Ba] Ta \*[Ba] Ta "vertical bar"
3970 The names of the columns
3974 are a bit misleading;
3978 representation, while
3980 gives the best glyph form available.
3981 For example, a Unicode enabled
3983 device will have proper glyph representations for all strings, whereas the
3984 enhancement for a Latin1
3986 device is only the plus-minus sign.
3988 String names which consist of two characters can be written as
3990 string names which consist of one character can be written as
3992 A generic syntax for a string name of any length is
4001 \#=====================================================================
4007 available in previous versions of
4009 has been removed since
4012 provides better facilities to check parameters; additionally, many error and
4013 warning messages have been added to this macro package, making it both more
4016 The only remaining debugging macro is
4018 which yields a register dump of all global registers and strings.
4019 A normal user will never need it.
4022 .Sh "FORMATTING WITH GROFF, TROFF, AND NROFF"
4024 By default, the package inhibits page breaks, headers, and footers if
4031 to make the manual more efficient for viewing on-line.
4032 This behaviour can be changed (e.g.\& to create a hardcopy of the
4034 output) by setting the register
4036 to zero while calling
4038 resulting in multiple pages instead of a single, very long page:
4040 .Dl groff \-Tlatin1 \-rcR=0 \-mdoc foo.man > foo.txt
4042 For double-sided printing, set register
4046 .Dl groff \-Tps \-rD1 \-mdoc foo.man > foo.ps
4048 To change the document font size to 11pt or 12pt, set register
4052 .Dl groff \-Tdvi \-rS11 \-mdoc foo.man > foo.dvi
4060 The line and title length can be changed by setting the registers
4066 .Dl groff \-Tutf8 \-rLL=100n \-rLT=100n \-mdoc foo.man | less
4068 If not set, both registers default to 78n for TTY devices and 6.5i
4074 .Bl -tag -width mdoc/doc-ditroff -compact
4076 The main manual macro package.
4078 A wrapper file to call
4080 .It Pa mdoc/doc-common
4081 Common strings, definitions, stuff related typographic output.
4082 .It Pa mdoc/doc-nroff
4083 Definitions used for a
4086 .It Pa mdoc/doc-ditroff
4087 Definitions used for all other devices.
4089 Local additions and customizations.
4091 This file checks whether the
4095 package should be used.
4109 Section 3f has not been added to the header routines.
4112 font should be changed in
4117 needs to have a check to prevent splitting up
4118 if the line length is too short.
4120 separates the last parenthesis, and sometimes
4121 looks ridiculous if a line is in fill mode.
4123 The list and display macros do not do any keeps
4124 and certainly should be able to.
4125 .\" Note what happens if the parameter list overlaps a newline
4127 .\" to make sure a line boundary is crossed:
4129 .\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
4132 .\" produces, nudge nudge,
4133 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4134 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4136 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
4138 .\" If double quotes are used, for example:
4140 .\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
4143 .\" produces, nudge nudge,
4144 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4146 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4148 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
4150 .\" Not a pretty sight...
4151 .\" In a paragraph, a long parameter containing unpaddable spaces as
4152 .\" in the former example will cause
4154 .\" to break the line and spread
4155 .\" the remaining words out.
4156 .\" The latter example will adjust nicely to
4157 .\" justified margins, but may break in between an argument and its
4161 .\" the right margin adjustment is normally ragged and the problem is
4164 .\" Local Variables: