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 In the following examples, the left (which is identical to the right) and
782 the middle part of the manual page header strings are shown.
785 .Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
788 .Ql \*[volume-operating-system] \*[volume-ds-7]
789 .It Li ".Dt FOO 2 i386"
791 .Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2]
792 .It Li ".Dt FOO \*[q]\*[q] bar"
799 Local, OS-specific additions might be found in the file
801 look for strings named
803 (for the former type) and
805 (for the latter type);
807 then denotes the keyword to be used with the
811 This macro is neither callable nor parsed.
814 .Op Aq operating system
817 If the first parameter is empty,
819 .Sq Tn "\*[operating-system]"
821 This may be overridden in the local configuration file,
823 In general, the name of the operating system should be the common acronym,
828 The release should be the standard release nomenclature for the system
830 In the following table, the possible second arguments for some predefined
831 operating systems are listed.
834 local additions might be defined in
836 look for strings named
837 .Ql operating-system-XXX-YYY ,
840 is the acronym for the operating system and
845 .Bl -tag -width ".No FreeBSD" -offset indent
847 7th, 7, III, 3, V, V.2, V.3, V.4
849 3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
851 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,
852 1.3, 1.3a, 1.4, 1.5, 1.6
854 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,
855 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,
856 4.2, 4.3, 4.4, 4.5, 5.0
863 an unknown second parameter will be replaced with the string
865 for the other predefined acronyms it will be ignored and a warning message
867 Unrecognized arguments are displayed as given in the page footer.
868 For instance, a typical footer might be:
873 .Ql 4.3\~Berkeley Distribution ,
874 or for a locally produced set
876 .Dl .Os CS Department
883 macro is not present, the bottom left corner of the manual page will be
886 This macro is neither callable nor parsed.
897 is used for the date string.
898 If it has exactly three arguments, they are concatenated, separated with
901 .Dl .Dd January 25, 2001
903 Otherwise, the current date is used, ignoring the parameters.
905 This macro is neither callable nor parsed.
909 .Sh "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
911 .Ss "What's in a Name" Ns ...
913 The manual domain macro names are derived from the day to day informal
914 language used to describe commands, subroutines and related files.
915 Slightly different variations of this language are used to describe the
916 three different aspects of writing a man page.
917 First, there is the description of
920 Second is the description of a
925 macros, and third, the description of a command to a user in the verbal
926 sense; that is, discussion of a command in the text of a man page.
930 macros are themselves a type of command; the general syntax for a troff
933 .Bd -filled -offset indent
934 .Li ".Xx argument1 argument2" ...
939 is a macro command, and anything following it are arguments to
941 In the second case, the description of a
943 command using the content macros is a bit more involved; a typical
945 command line might be displayed as:
947 .Bd -filled -offset indent
950 .Ao Ar infile Ac Ao Ar outfile Ac
956 is the command name and the
961 argument designated as optional by the option brackets.
970 in this example, the user has to replace the meta expressions given in angle
971 brackets with real file names.
972 Note that in this document meta arguments are used to describe
974 commands; in most man pages, meta variables are not specifically written
976 The macros which formatted the above example:
978 .Bd -literal -offset indent
981 \&.Ao Ar infile Ac Ao Ar outfile Ac
985 In the third case, discussion of commands and command syntax includes both
986 examples above, but may add more detail.
991 from the example above might be referred to as
995 Some command line argument lists are quite long:
998 .Bl -tag -width ".Nm make" -offset indent -compact
1001 .Op Fl D Ar variable
1003 .Op Fl f Ar makefile
1004 .Op Fl I Ar directory
1005 .Op Fl j Ar max_jobs
1006 .Op Ar variable Ns = Ns Ar value
1014 Here one might talk about the command
1016 and qualify the argument,
1018 as an argument to the flag,
1020 or discuss the optional file operand
1022 In the verbal context, such detail can prevent confusion, however the
1024 package does not have a macro for an argument
1029 argument macro is used for an operand or file argument like
1031 as well as an argument to a flag like
1033 The make command line was produced from:
1035 .Bd -literal -offset indent
1038 \&.Op Fl D Ar variable
1040 \&.Op Fl f Ar makefile
1041 \&.Op Fl I Ar directory
1042 \&.Op Fl j Ar max_jobs
1043 \&.Op Ar variable Ns = Ns Ar value
1054 macros are explained in
1057 .Ss "General Syntax"
1059 The manual domain and general text domain macros share a similar syntax with
1060 a few minor deviations; most notably,
1066 differ only when called without arguments; and
1070 impose an order on their argument lists.
1071 All content macros are capable of recognizing and properly handling
1072 punctuation, provided each punctuation character is separated by a leading
1074 If a command is given:
1076 .Dl \&.Ar sptr, ptr),
1082 The punctuation is not recognized and all is output in the
1085 If the punctuation is separated by a leading white space:
1087 .Dl \&.Ar "sptr , ptr ) ,"
1091 .Dl Ar sptr , ptr ) ,
1093 The punctuation is now recognized and output in the default font
1094 distinguishing it from the argument strings.
1095 To remove the special meaning from a punctuation character escape it with
1099 is limited as a macro language, and has difficulty when presented with a
1100 string containing a member of the mathematical, logical or quotation set:
1102 .Bd -literal -offset indent-two
1103 {+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
1109 may assume it is supposed to actually perform the operation or evaluation
1110 suggested by the characters.
1111 To prevent the accidental evaluation of these characters, escape them with
1113 Typical syntax is shown in the first content macro displayed below,
1121 The address macro identifies an address construct.
1123 .Dl Usage: .Ad Ao address Ac ...
1125 .Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
1128 .It Li ".Ad addr1 ."
1130 .It Li ".Ad addr1 , file2"
1132 .It Li ".Ad f1 , f2 , f3 :"
1134 .It Li ".Ad addr ) ) ,"
1139 The default width is 12n.
1145 macro is used to specify the name of the author of the item being
1146 documented, or the name of the author of the actual manual page.
1148 .Dl Usage: .An Ao author name Ac ...
1150 .Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n
1151 .It Li ".An \*[q]Joe Author\*[q]"
1153 .It Li ".An \*[q]Joe Author\*[q] ,"
1155 .It Li ".An \*[q]Joe Author\*[q] Aq nobody@FreeBSD.org"
1156 .An "Joe Author" Aq nobody@FreeBSD.org
1157 .It Li ".An \*[q]Joe Author\*[q] ) ) ,"
1158 .An "Joe Author" ) ) ,
1162 The default width is 12n.
1168 command causes a line break allowing each new name to appear on its own
1170 If this is not desirable,
1172 .Bd -literal -offset indent
1177 call will turn this off.
1178 To turn splitting back on, write
1180 .Bd -literal -offset indent
1188 argument macro may be used whenever an argument is referenced.
1189 If called without arguments, the
1193 .Dl Usage: .Ar Oo Ao argument Ac Oc ...
1195 .Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
1200 .It Li ".Ar file1 ."
1202 .It Li ".Ar file1 file2"
1204 .It Li ".Ar f1 f2 f3 :"
1206 .It Li ".Ar file ) ) ,"
1211 The default width is 12n.
1213 .Ss "Configuration Declaration (Section Four Only)"
1217 macro is used to demonstrate a
1219 declaration for a device interface in a section four manual.
1221 .Dl Usage: .Cd Ao argument Ac ...
1223 .Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
1224 .It Li ".Cd \*[q]device le0 at scode?\*[q]"
1225 .Cd "device le0 at scode?"
1232 command causes a line break before and after its arguments are printed.
1235 The default width is 12n.
1237 .Ss "Command Modifiers"
1239 The command modifier is identical to the
1241 (flag) command with the exception that the
1243 macro does not assert a dash in front of every argument.
1244 Traditionally flags are marked by the preceding dash, however, some commands
1245 or subsets of commands do not use them.
1246 Command modifiers may also be specified in conjunction with interactive
1247 commands such as editor commands.
1251 The default width is 10n.
1253 .Ss "Defined Variables"
1255 A variable (or constant) which is defined in an include file
1256 is specified by the macro
1259 .Dl Usage: .Dv Ao defined variable Ac ...
1261 .Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
1262 .It Li ".Dv MAXHOSTNAMELEN"
1264 .It Li ".Dv TIOCGPGRP )"
1269 The default width is 12n.
1275 errno macro specifies the error return value for section 2, 3, and\~9 library
1277 The second example below shows
1281 general text domain macro, as it would be used in a section two manual page.
1283 .Dl Usage: .Er Ao errno type Ac ...
1285 .Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n
1288 .It Li ".Er ENOENT ) ;"
1290 .It Li ".Bq Er ENOTDIR"
1295 The default width is 17n.
1297 .Ss "Environment Variables"
1301 macro specifies an environment variable.
1303 .Dl Usage: .Ev Ao argument Ac ...
1305 .Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n
1306 .It Li ".Ev DISPLAY"
1310 .It Li ".Ev PRINTER ) ) ,"
1315 The default width is 15n.
1321 macro handles command line flags.
1325 For interactive command flags, which are not prepended with a dash, the
1328 macro is identical, but without the dash.
1330 .Dl Usage: .Fl Ao argument Ac ...
1332 .Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n
1345 .It Li ".Fl xyz ) ,"
1353 macro without any arguments results in a dash representing stdin/stdout.
1356 a single dash will result in two dashes.
1358 The default width is 12n.
1360 .Ss "Function Declarations"
1364 macro is used in the
1366 section with section two or three functions.
1367 It is neither callable nor parsed.
1369 .Dl Usage: .Fd Ao argument Ac ...
1371 .Bl -tag -width ".Li .Fd\ X#include\ <sys/types.h>X" -compact -offset 15n
1372 .It Li ".Fd \*[q]#include <sys/types.h>\*[q]"
1373 .Fd "#include <sys/types.h>"
1380 command causes a line break if a function has already been presented and a
1381 break has not occurred.
1382 This leaves a nice vertical space in between the previous function call and
1383 the declaration for the next function.
1390 macro is the short form of the above example.
1391 It specifies the C\~header file as being included in a C\~program.
1392 It also causes a line break, and is neither callable nor parsed.
1394 .Dl Usage: .In Ao header file Ac
1396 .Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n
1397 .It Li ".In stdio.h"
1401 .Ss "Function Types"
1403 This macro is intended for the
1406 It may be used anywhere else in the man page without problems, but its main
1407 purpose is to present the function type in kernel normal form for the
1409 of sections two and three (it causes a line break, allowing the function
1410 name to appear on the next line).
1412 .Dl Usage: .Ft Ao type Ac ...
1414 .Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n
1415 .It Li ".Ft struct stat"
1419 .Ss "Functions (Library Routines)"
1427 .Dl Usage: .Fn Ao function Ac Oo Ao parameter Ac Oc ...
1429 .Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n
1430 .It Li ".Fn getchar"
1432 .It Li ".Fn strlen ) ,"
1434 .It Li ".Fn align \*[q]char *ptr\*[q] ,"
1435 .Fn align "char *ptr" ,
1438 Note that any call to another macro signals the end of the
1440 call (it will insert a closing parenthesis at that point).
1442 For functions with many parameters (which is rare), the macros
1450 (function argument).
1454 .Bd -literal -offset indent
1463 \&.Fa "struct rrec *newrr"
1472 .Bd -ragged -offset indent
1481 .Fa "struct rrec *newrr"
1490 section, the function will always begin at the beginning of line.
1491 If there is more than one function presented in the
1493 section and a function type has not been given, a line break will occur,
1494 leaving a nice vertical space between the current function name and the one
1497 The default width values of
1501 are 12n and 16n, respectively.
1503 .Ss "Function Arguments"
1507 macro is used to refer to function arguments (parameters) outside of the
1509 section of the manual or inside the
1511 section if the enclosure macros
1519 may also be used to refer to structure members.
1521 .Dl Usage: .Fa Ao function argument Ac ...
1523 .Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n
1524 .It Li ".Fa d_namlen ) ) ,"
1526 .It Li ".Fa iov_len"
1531 The default width is 12n.
1537 macro generates text for use in the
1541 .Dl Usage: .Rv Oo -std Oc Op Ao function Ac ...
1544 .Ql ".Rv -std atexit"
1547 .Bd -ragged -offset -indent
1548 \# a small hack to suppress a warning message
1549 .ds section-old "\*[section]
1552 .ds section "\*[section-old]
1558 option is valid only for manual page sections\~2 and\~3.
1559 Currently, this macro does nothing if used without the
1567 macro generates text for use in the
1571 .Dl Usage: .Ex Oo -std Oc Op Ao utility Ac ...
1577 .Bd -ragged -offset -indent
1578 \# a small hack to suppress a warning message
1579 .ds section-old "\*[section]
1582 .ds section "\*[section-old]
1588 option is valid only for manual page sections 1, 6 and\~8.
1589 Currently, this macro does nothing if used without the
1593 .Ss "Interactive Commands"
1597 macro designates an interactive or internal command.
1599 .Dl Usage: .Ic Ao argument Ac ...
1601 .Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n
1604 .It Li ".Ic \*[q]do while {...}\*[q]"
1605 .Ic "do while {...}"
1606 .It Li ".Ic setenv , unsetenv"
1607 .Ic setenv , unsetenv
1611 The default width is 12n.
1617 macro is used to specify the library where a particular function is compiled
1620 .Dl Usage: .Lb Ao argument Ac ...
1622 Available arguments to
1624 and their results are:
1627 .Bl -tag -width ".Li libossaudio" -compact -offset indent
1665 Local, OS-specific additions might be found in the file
1667 look for strings named
1670 then denotes the keyword to be used with the
1678 literal macro may be used for special characters, variable constants, etc.\&
1679 -- anything which should be displayed as it would be typed.
1681 .Dl Usage: .Li Ao argument Ac ...
1683 .Bl -tag -width ".Li .Li\ cntrl-D\ )\ ," -compact -offset 15n
1686 .It Li ".Li M1 M2 M3 ;"
1688 .It Li ".Li cntrl-D ) ,"
1690 .It Li ".Li 1024 ..."
1695 The default width is 16n.
1701 macro is used for the document title or subject name.
1702 It has the peculiarity of remembering the first argument it was called with,
1703 which should always be the subject name of the page.
1704 When called without arguments,
1706 regurgitates this initial name for the sole purpose of making less work for
1708 Note: A section two or three document function name is addressed with the
1716 and remaining sections.
1717 For interactive commands, such as the
1723 macro should be used.
1729 it can not recall the first argument it was invoked with.
1731 .Dl Usage: .Nm Oo Ao argument Ac Oc ...
1733 .Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
1734 .It Li ".Nm groff_mdoc"
1736 .It Li ".Nm \e-mdoc"
1738 .It Li ".Nm foo ) ) ,"
1745 The default width is 10n.
1751 macro places option brackets around any remaining arguments on the
1752 command line, and places any trailing punctuation outside the brackets.
1757 (which produce an opening and a closing option bracket respectively) may be used
1758 across one or more lines or to specify the exact position of the closing
1761 .Dl Usage: .Op Oo Ao option Ac Oc ...
1763 .Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n
1768 .It Li ".Op Fl k ) ."
1770 .It Li ".Op Fl k Ar kookfile"
1771 .Op Fl k Ar kookfile
1772 .It Li ".Op Fl k Ar kookfile ,"
1773 .Op Fl k Ar kookfile ,
1774 .It Li ".Op Ar objfil Op Ar corfil"
1775 .Op Ar objfil Op Ar corfil
1776 .It Li ".Op Fl c Ar objfil Op Ar corfil ,"
1777 .Op Fl c Ar objfil Op Ar corfil ,
1778 .It Li ".Op word1 word2"
1780 .It Li ".Li .Op Oo Ao option Ac Oc ..."
1781 .Li .Op Oo Ao options Ac Oc ...
1784 Here a typical example of the
1790 .Bd -literal -offset indent
1792 \&.Op Fl k Ar kilobytes
1793 \&.Op Fl i Ar interval
1801 .Bd -filled -offset indent
1803 .Op Fl k Ar kilobytes
1804 .Op Fl i Ar interval
1810 The default width values of
1814 are 14n and 10n, respectively.
1820 macro formats path or file names.
1821 If called without arguments, the
1823 string is output, which represents the current user's home directory.
1825 .Dl Usage: .Pa Oo Ao pathname Ac Oc ...
1827 .Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n
1830 .It Li ".Pa /usr/share"
1832 .It Li ".Pa /tmp/fooXXXXX ) ."
1833 .Pa /tmp/fooXXXXX ) .
1837 The default width is 32n.
1843 macro replaces standard abbreviations with their formal names.
1845 .Dl Usage: .St Ao abbreviation Ac ...
1848 .Dq Abbreviation/Formal Name
1854 .Bl -tag -width ".Li -iso9945-1-90" -compact -offset indent
1869 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1870 .It Li -iso9945-1-90
1872 .It Li -iso9945-1-96
1886 .It Li -p1003.1g-2000
1894 Part 2: Shell and Utilities
1896 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1897 .It Li -iso9945-2-93
1909 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1938 .Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
1945 .Ss "Variable Types"
1949 macro may be used whenever a type is referenced.
1952 section, it causes a line break (useful for old style variable declarations).
1954 .Dl Usage: .Vt Ao type Ac ...
1956 .Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n
1957 .It Li ".Vt extern char *optarg ;"
1958 .Vt extern char *optarg ;
1965 Generic variable reference.
1967 .Dl Usage: .Va Ao variable Ac ...
1969 .Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n
1972 .It Li ".Va settimer ,"
1974 .It Li ".Va \*[q]int *prt\*[q] ) :"
1976 .It Li ".Va \*[q]char s\*[q] ] ) ) ,"
1977 .Va "char s" ] ) ) ,
1981 The default width is 12n.
1983 .Ss "Manual Page Cross References"
1987 macro expects the first argument to be a manual page name.
1988 The optional second argument, if a string (defining the manual section), is
1989 put into parentheses.
1991 .Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
1993 .Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
2000 .It Li ".Xr xinit 1x ;"
2005 The default width is 10n.
2008 .Sh "GENERAL TEXT DOMAIN"
2013 .Dl Usage: .At Oo Ao version Ac Oc ...
2015 .Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n
2022 The following values for
2026 .Dl 32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4
2031 .Dl "Usage: .Bx" Bro -alpha | -beta | -devel Brc ...
2032 .Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
2034 .Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
2039 .It Li ".Bx \-devel"
2044 will be prepended to the string
2046 The following values for
2050 .Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
2055 .Dl Usage: .Nx Oo Ao version Ac Oc ...
2057 .Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n
2064 For possible values of
2066 see the description of the
2068 command above in section
2069 .Sx "TITLE MACROS" .
2074 .Dl Usage: .Fx Oo Ao version Ac Oc ...
2076 .Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n
2083 For possible values of
2085 see the description of the
2087 command above in section
2088 .Sx "TITLE MACROS" .
2093 .Dl Usage: .Ox Oo Ao version Ac Oc ...
2095 .Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n
2103 .Dl Usage: .Bsx Oo Ao version Ac Oc ...
2105 .Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n
2115 .Bl -tag -width ".Li .Ux" -compact -offset 15n
2120 .Ss "Emphasis Macro"
2122 Text may be stressed or emphasized with the
2125 The usual font for emphasis is italic.
2127 .Dl Usage: .Em Ao argument Ac ...
2129 .Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n
2130 .It Li ".Em does not"
2132 .It Li ".Em exceed 1024 ."
2134 .It Li ".Em vide infra ) ) ,"
2135 .Em vide infra ) ) ,
2139 The default width is 10n.
2145 font mode must be ended with the
2147 macro (the latter takes no arguments).
2148 Font modes may be nested within other font modes.
2151 has the following syntax:
2153 .Dl .Bf Ao font mode Ac
2156 must be one of the following three types:
2158 .Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent
2159 .It Sy \&Em | Fl emphasis
2162 macro was used for the entire block of text.
2163 .It Sy \&Li | Fl literal
2166 macro was used for the entire block of text.
2167 .It Sy \&Sy | Fl symbolic
2170 macro was used for the entire block of text.
2173 Both macros are neither callable nor parsed.
2175 .Ss "Enclosure and Quoting Macros"
2177 The concept of enclosure is similar to quoting.
2178 The object being to enclose one or more strings between a pair of characters
2179 like quotes or parentheses.
2180 The terms quoting and enclosure are used interchangeably throughout this
2182 Most of the one-line enclosure macros end in small letter
2184 to give a hint of quoting, but there are a few irregularities.
2185 For each enclosure macro there is also a pair of open and close macros which
2186 end in small letters
2196 .Bd -filled -offset 4n
2197 .Bl -column "quote" "close" "open" "Angle Bracket Enclosure" "`string' or string"
2198 .Em Quote Ta Em Open Ta Em Close Ta Em Function Ta Em Result
2199 .No .Aq Ta .Ao Ta .Ac Ta "Angle Bracket Enclosure" Ta Ao string Ac
2200 .No .Bq Ta .Bo Ta .Bc Ta "Bracket Enclosure" Ta Bo string Bc
2201 .No .Brq Ta .Bro Ta .Brc Ta "Brace Enclosure" Ta Bro string Brc
2202 .No .Dq Ta .Do Ta .Dc Ta "Double Quote" Ta Do string Dc
2203 .No .Eq Ta .Eo Ta .Ec Ta "Enclose String (in XX)" Ta XXstringXX
2204 .No .Pq Ta .Po Ta .Pc Ta "Parenthesis Enclosure" Ta Po string Pc
2205 .No .Ql Ta Ta Ta "Quoted Literal" Ta So string Sc or Li string
2206 .No .Qq Ta .Qo Ta .Qc Ta "Straight Double Quote" Ta Qo string Qc
2207 .No .Sq Ta .So Ta .Sc Ta "Single Quote" Ta So string Sc
2211 All macros ending with
2215 have a default width value of 12n.
2217 .Bl -tag -width ".Li .Ec , .Eo"
2219 These macros expect the first argument to be the opening and closing strings
2222 Due to the nine-argument limit in the original troff program two other
2223 macros have been implemented which are now rather obsolete:
2225 takes the first and second parameter as the left and right enclosure string,
2226 which are then used to enclose the arguments of
2228 The default width value is 12n for both macros.
2230 The first and second arguments of this macro are the opening and
2231 closing strings respectively, followed by the arguments to be enclosed.
2233 The quoted literal macro behaves differently in troff and nroff mode.
2236 a quoted literal is always quoted.
2237 If formatted with troff, an item is only quoted if the width of the item is
2238 less than three constant width characters.
2239 This is to make short strings more visible where the font change to literal
2240 (constant width) is less noticeable.
2242 The default width is 16n.
2244 The prefix macro suppresses the whitespace between its first and second
2247 .Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent
2248 .It Li ".Pf ( Fa name2"
2253 The default width is 12n.
2257 macro (see below) performs the analogous suffix function.
2261 macro inserts an apostrophe and exits any special text modes, continuing in
2267 Examples of quoting:
2270 .Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent
2273 .It Li ".Aq Pa ctype.h ) ,"
2277 .It Li ".Bq Em Greek , French ."
2278 .Bq Em Greek , French .
2281 .It Li ".Dq string abc ."
2283 .It Li ".Dq \'^[A-Z]\'"
2285 .It Li ".Ql man mdoc"
2289 .It Li ".Qq string ) ,"
2291 .It Li ".Qq string Ns ),"
2297 .It Li ".Em or Ap ing"
2302 For a good example of nested enclosure macros, see the
2305 It was created from the same underlying enclosure macros as those presented
2311 extended argument list macros are discussed below.
2313 .Ss "No-Op or Normal Text Macro"
2317 macro can be used in a macro command line for parameters which should
2324 if you really want that English word (and not the macro) as a parameter.
2326 .Dl Usage: .No Ao argument Ac ...
2328 .Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n
2329 .It Li ".No test Ta with Ta tabs"
2330 .No test Ta with Ta tabs
2334 The default width is 12n.
2336 .Ss "No-Space Macro"
2340 macro suppresses insertion of a space between the current position and its
2342 For example, it is useful for old style argument lists where there is no
2343 space between the flag and argument:
2345 .Dl "Usage:" ... Ao argument Ac \&Ns Oo Ao argument Ac Oc ...
2346 .Dl " " .Ns Ao argument Ac ...
2348 .Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n
2349 .It Li ".Op Fl I Ns Ar directory"
2350 .Op Fl I Ns Ar directory
2355 macro always invokes the
2357 macro after eliminating the space unless another macro name follows it.
2358 If used as a command (i.e., the second form above in the
2365 .Ss "Section Cross References"
2369 macro designates a reference to a section header within the same document.
2371 .Dl Usage: .Sx Ao section reference Ac ...
2373 .Bl -tag -width ".Li .Sx\ FILES" -offset 15n
2379 The default width is 16n.
2383 The symbolic emphasis macro is generally a boldface macro in either the
2384 symbolic sense or the traditional English usage.
2386 .Dl Usage: .Sy Ao symbol Ac ...
2388 .Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n
2389 .It Li ".Sy Important Notice"
2390 .Sy Important Notice
2394 The default width is 6n.
2396 .Ss Mathematical Symbols
2398 Use this macro for mathematical symbols and similar things.
2400 .Dl Usage: .Ms Ao math symbol Ac ...
2402 .Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n
2408 The default width is 6n.
2410 .Ss "References and Citations"
2412 The following macros make a modest attempt to handle references.
2413 At best, the macros make it convenient to manually drop in a subset of
2417 .Bl -tag -width 6n -offset indent -compact
2419 Reference start (does not take arguments).
2420 Causes a line break in the
2422 section and begins collection of reference information until the reference
2425 Reference end (does not take arguments).
2426 The reference is printed.
2428 Reference author name; one name per invocation.
2432 City/place (not implemented yet).
2436 Issuer/publisher name.
2442 Optional information.
2446 Corporate or foreign author.
2455 Macros beginning with
2457 are not callable but accept multiple arguments in the usual way.
2460 macro is handled properly as a parameter; other macros will cause strange
2465 can be used outside of the
2471 .Bd -literal -offset indent
2475 \&.%T "Implementation Notes on foobar(1)"
2476 \&.%R "Technical Report ABC-DE-12-345"
2477 \&.%Q "Drofnats College, Nowhere"
2484 .Bd -ragged -offset indent
2488 .%T "Implementation Notes on foobar(1)"
2489 .%R "Technical Report ABC-DE-12-345"
2490 .%Q "Drofnats College, Nowhere"
2495 .Ss "Trade Names (or Acronyms and Type Names)"
2497 The trade name macro prints its arguments in a smaller font.
2498 Its intended use is to imitate a small caps fonts for uppercase acronyms.
2500 .Dl Usage: .Tn Ao symbol Ac ...
2502 .Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n
2510 The default width is 10n.
2512 .Ss "Extended Arguments"
2518 macros allow one to extend an argument list on a macro boundary for the
2525 are implemented similarly to all other macros opening and closing an
2526 enclosure (without inserting characters, of course).
2527 This means that the following is true for those macros also.
2529 Here is an example of
2531 using the space mode macro to turn spacing off:
2533 .Bd -literal -offset indent
2535 \&.It Xo Sy I Ar operation
2536 \&.No \een Ar count No \een
2544 .Bd -filled -offset indent
2547 .It Xo Sy I Ar operation
2548 .No \en Ar count No \en
2557 .Bd -literal -offset indent
2559 \&.It Cm S No / Ar old_pattern Xo
2560 \&.No / Ar new_pattern
2569 .Bd -filled -offset indent
2572 .It Cm S No \&/ Ar old_pattern Xo
2573 .No \&/ Ar new_pattern
2583 and enclosure macros: Test the value of a variable.
2585 .Bd -literal -offset indent
2588 \&.Oo \e&! Oc Ns Ar variable Oo
2589 \&.Ar operator variable ...
2596 .Bd -filled -offset indent
2597 .Bl -tag -width flag -compact
2600 .Oo \&! Oc Ns Ar variable Oo
2601 .Ar operator variable ...
2608 .Sh "PAGE STRUCTURE DOMAIN"
2610 .Ss "Section Headers"
2614 section header macros are required in every man page.
2615 The remaining section headers are recommended at the discretion of the
2616 author writing the manual page.
2619 macro is parsed but not generally callable.
2620 It can be used as an argument in a call to
2622 only; it then reactivates the default font for
2625 The default width is 8n.
2627 .Bl -tag -width ".Li .Sh\ RETURN\ VALUES"
2632 If not specified, headers, footers and page layout defaults will not be set
2633 and things will be rather unpleasant.
2636 section consists of at least three items.
2639 name macro naming the subject of the man page.
2640 The second is the name description macro,
2642 which separates the subject name from the third item, which is the
2644 The description should be the most terse and lucid possible, as the space
2650 then all its arguments.
2652 .It Li ".Sh LIBRARY"
2653 This section is for section two and three function calls.
2654 It should consist of a single
2658 .Sx "Library Names" .
2660 .It Li ".Sh SYNOPSIS"
2663 section describes the typical usage of the subject of a man page.
2664 The macros required are either
2675 The function name macro
2677 is required for manual page sections\~2 and\~3; the command and general name
2680 is required for sections 1, 5, 6, 7, and\~8.
2681 Section\~4 manuals require a
2686 configuration device usage macro.
2687 Several other macros may be necessary to produce the synopsis line as shown
2690 .Bd -filled -offset indent
2698 The following macros were used:
2701 .Dl ".Op Fl benstuv"
2705 .It Li ".Sh DESCRIPTION"
2706 In most cases the first text in the
2708 section is a brief paragraph on the command, function or file, followed by a
2709 lexical list of options and respective explanations.
2710 To create such a list, the
2717 macros are used (see
2718 .Sx Lists and Columns
2721 .It Li ".Sh IMPLEMENTATION NOTES"
2722 Implementation specific information should be placed here.
2724 .It Li ".Sh RETURN VALUES"
2725 Sections 2, 3 and\~9 function return values should go here.
2728 macro may be used to generate text for use in the
2730 section for most section 2 and 3 library functions;
2732 .Sx "Return Values" .
2738 section headers are part of the preferred manual page layout and must be
2739 used appropriately to maintain consistency.
2740 They are listed in the order in which they would be used.
2742 .Bl -tag -width ".Li .Sh\ COMPATIBILITY"
2743 .It Li ".Sh ENVIRONMENT"
2746 section should reveal any related environment variables and clues to their
2747 behavior and/or usage.
2750 Files which are used or created by the man page subject should be listed via
2757 .It Li ".Sh EXAMPLES"
2758 There are several ways to create examples.
2761 section below for details.
2763 .It Li ".Sh DIAGNOSTICS"
2764 Diagnostic messages from a command should be placed in this section.
2767 macro may be used to generate text for use in the
2769 section for most section 1, 6 and\~8 commands;
2773 .It Li ".Sh COMPATIBILITY"
2774 Known compatibility issues (e.g. deprecated options or parameters)
2775 should be listed here.
2778 Specific error handling, especially from library functions (man page
2779 sections 2, 3, and\~9) should go here.
2782 macro is used to specify an error (errno).
2784 .It Li ".Sh SEE ALSO"
2785 References to other material on the man page topic and cross references to
2786 other relevant man pages should be placed in the
2789 Cross references are specified using the
2794 style references are not accommodated.
2796 It is recommended that the cross references are sorted on the section
2797 number, then alphabetically on the names within a section, and placed
2798 in that order and comma separated.
2806 .It Li ".Sh STANDARDS"
2807 If the command, library function or file adheres to a specific
2808 implementation such as
2812 this should be noted here.
2813 If the command does not adhere to any standard, its history should be noted
2818 .It Li ".Sh HISTORY"
2819 Any command which does not adhere to any specific standards should be
2820 outlined historically in this section.
2822 .It Li ".Sh AUTHORS"
2823 Credits should be placed here.
2826 macro should be used to specify the name(s) of the person(s).
2829 Blatant problems with the topic go here.
2835 sections may be added; for example, this section was set with:
2837 .Bd -literal -offset 15n
2838 \&.Sh "PAGE STRUCTURE DOMAIN"
2841 .Ss "Subsection Headers"
2843 Subsection headers have exactly the same syntax as section headers:
2845 is parsed but not generally callable.
2846 It can be used as an argument in a call to
2848 only; it then reactivates the default font for
2851 The default width is 8n.
2853 .Ss "Paragraphs and Line Spacing"
2855 .Bl -tag -width ".Li .Pp"
2859 paragraph command may be used to specify a line space where necessary.
2860 The macro is not necessary after a
2868 macro (which both assert a vertical distance unless the
2872 The macro is neither callable nor parsed and takes no arguments; an
2879 .\" This worked with version one, need to redo for version three
2882 .\" .Cw (ax+bx+c) \ is\ produced\ by\ \&
2883 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
2900 .\" .Em is produced by
2916 .\" This example shows the same equation in a different format.
2920 .\" signs were forced with
2924 .\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
2925 .\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
2936 .\" .Li \&.Cx \e\ +\e\ \e&
2947 .\" .Em is produced by
2955 .\" .Li \&.Cx \e\ +\e\ \e&
2966 .\" The incantation below was
2972 .\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
2974 .\" .Li \&.Cx Op Sy ?/
2984 .\" .Em is produced by
2986 .\" .Li \&.Ar \e\ b1 e1 f1
3000 The only keep that is implemented at this time is for words.
3007 The only option that
3009 accepts currently is
3011 (this is also the default if no option is given) which is useful for
3012 preventing line breaks in the middle of options.
3013 In the example for the make command line arguments (see
3014 .Sx What's in a Name ) ,
3017 from placing up the flag and the argument on separate lines.
3019 Both macros are neither callable nor parsed.
3021 More work needs to be done with the keep macros; specifically, a
3023 option should be added.
3025 .Ss "Examples and Displays"
3027 There are seven types of displays.
3029 .Bl -tag -width ".Li .D1"
3032 Display one line of indented text.
3033 This macro is parsed but not callable.
3037 The above was produced by:
3038 .Li ".D1 Fl ldghfstru" .
3042 Display one line of indented
3047 example macro has been used throughout this file.
3048 It allows the indentation (display) of one line of text.
3049 Its default font is set to constant width (literal).
3051 is parsed but not callable.
3053 .Dl % ls -ldg /usr/local/bin
3055 The above was produced by:
3056 .Li ".Dl % ls -ldg /usr/local/bin" .
3062 display must be ended with the
3065 It has the following syntax:
3067 .Bl -tag -width ".Li .Bd" -offset indent
3069 .Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc
3070 .Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
3074 .Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
3076 Fill, but do not adjust the right margin (only left-justify).
3078 Center lines between the current left and right margin.
3079 Note that each single line is centered.
3081 Do not fill; display a block of text as typed, using line breaks as
3082 specified by the user.
3083 This can produce overlong lines without warning messages.
3085 Display a filled block.
3086 The block of text is formatted (i.e., the text is justified on both the left
3089 Display block with literal font (usually fixed-width).
3090 Useful for source code or simple tabbed or spaced text.
3091 .It Fl file Ao Ar file name Ac
3092 The file whose name follows the
3094 flag is read and displayed before any data enclosed with
3098 using the selected display type.
3100 .Xr troff/ Ns Nm \-mdoc
3101 commands in the file will be processed.
3102 .It Fl offset Ao Ar string Ac
3105 is specified with one of the following strings, the string is interpreted to
3106 indicate the level of indentation for the forthcoming block of text:
3109 .Bl -tag -width ".Ar indent-two" -compact
3111 Align block on the current left margin; this is the default mode of
3114 Supposedly center the block.
3115 At this time unfortunately, the block merely gets left aligned about an
3116 imaginary center margin.
3118 Indent by one default indent value or tab.
3119 The default indent value is also used for the
3123 macros, so one is guaranteed the two types of displays will line up.
3124 The indentation value is normally set to\~6n or about two thirds of an inch
3125 (six constant width characters).
3127 Indent two times the default indent value.
3131 aligns the block about two inches from the right side of the page.
3132 This macro needs work and perhaps may never do the right thing within
3139 is a valid numeric expression instead
3140 .Pf ( Em with a scale indicator other than
3142 use that value for indentation.
3143 The most useful scale indicators are
3147 specifying the so-called
3151 This is approximately the width of the letters
3156 of the current font (for nroff output, both scale indicators give the same
3160 isn't a numeric expression, it is tested whether it is an
3162 macro name, and the default offset value associated with this macro is used.
3163 Finally, if all tests fail,
3166 (typeset with a fixed-width font) is taken as the offset.
3168 Suppress insertion of vertical space before begin of display.
3172 End display (takes no arguments).
3175 .Ss "Lists and Columns"
3177 There are several types of lists which may be initiated with the
3180 Items within the list are specified with the
3182 item macro, and each list must end with the
3185 Lists may be nested within themselves and within displays.
3186 The use of columns inside of lists or lists inside of columns is unproven.
3188 In addition, several list attributes may be specified such as the width of a
3189 tag, the list offset, and compactness (blank lines between items allowed or
3191 Most of this document has been formatted with a tag style list
3194 It has the following syntax forms:
3197 .Bl -tag -width ".Li .Bl" -offset indent -compact
3199 .Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc
3200 .Oo \-width Ao string Ac Oc
3201 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3203 .No \-column Oo \-offset Ao string Ac Oc
3204 .Ao string1 Ac Ao string2 Ac ... Xc
3206 .Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc
3207 .Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
3211 And now a detailed description of the list types.
3214 .Bl -tag -width ".Fl column" -compact
3218 .Bd -literal -offset indent
3219 \&.Bl -bullet -offset indent -compact
3221 Bullet one goes here.
3231 .Bl -bullet -offset indent -compact
3233 Bullet one goes here.
3239 .It Fl dash No ( or Fl hyphen )
3242 .Bd -literal -offset indent
3243 \&.Bl -dash -offset indent -compact
3255 .Bl -dash -offset indent -compact
3266 .Bd -literal -offset indent
3267 \&.Bl -enum -offset indent -compact
3279 .Bl -enum -offset indent -compact
3287 If you want to nest enumerated lists, use the
3289 flag (starting with the second-level list):
3291 .Bd -literal -offset indent
3292 \&.Bl -enum -offset indent -compact
3295 \&.Bl -enum -nested -compact
3299 And item three here.
3310 .Bl -enum -offset indent -compact
3313 .Bl -enum -nested -compact
3317 And item three here.
3327 without list markers.
3329 .Bd -literal -offset indent
3330 \&.Bl -item -offset indent
3346 .Bl -item -offset indent
3362 to specify the tag width.
3365 .Bl -tag -width "PPID" -compact -offset indent
3367 sleep time of the process (seconds blocked)
3371 resulting from references by the process
3372 to pages not loaded in core.
3374 numerical user-id of process owner
3376 numerical id of parent of process priority
3377 (non-positive when in non-interruptible wait)
3383 .Bd -literal -offset indent
3384 \&.Bl -tag -width "PPID" -compact -offset indent
3386 sleep time of the process (seconds blocked)
3390 resulting from references by the process
3391 to pages not loaded in core.
3393 numerical user-id of process owner
3395 numerical id of parent of process priority
3396 (non-positive when in non-interruptible wait)
3402 Diag lists create section four diagnostic lists and are similar to inset
3403 lists except callable macros are ignored.
3406 flag is not meaningful in this context.
3410 .Bd -literal -offset indent
3412 \&.It You can't use Sy here.
3413 The message says all.
3421 .It You can't use Sy here.
3422 The message says all.
3427 A list with hanging tags.
3429 .Bl -hang -offset indent
3431 labels appear similar to tagged lists when the
3432 label is smaller than the label width.
3433 .It Em Longer hanged list labels
3434 blend into the paragraph unlike
3435 tagged paragraph labels.
3438 And the unformatted text which created it:
3440 .Bd -literal -offset indent
3441 \&.Bl -hang -offset indent
3443 labels appear similar to tagged lists when the
3444 label is smaller than the label width.
3445 \&.It Em Longer hanged list labels
3446 blend into the paragraph unlike
3447 tagged paragraph labels.
3453 Lists with overhanging tags do not use indentation for the items; tags are
3454 written to a separate line.
3456 .Bl -ohang -offset indent
3458 sleep time of the process (seconds blocked)
3462 resulting from references by the process
3463 to pages not loaded in core.
3465 numerical user-id of process owner
3467 numerical id of parent of process priority
3468 (non-positive when in non-interruptible wait)
3474 .Bd -literal -offset indent
3475 \&.Bl -ohang -offset indent
3477 sleep time of the process (seconds blocked)
3481 resulting from references by the process
3482 to pages not loaded in core.
3484 numerical user-id of process owner
3486 numerical id of parent of process priority
3487 (non-positive when in non-interruptible wait)
3493 Here is an example of inset labels:
3494 .Bl -inset -offset indent
3496 The tagged list (also called a tagged paragraph)
3497 is the most common type of list used in the
3501 attribute as described below.
3503 Diag lists create section four diagnostic lists
3504 and are similar to inset lists except callable
3507 Hanged labels are a matter of taste.
3509 Overhanging labels are nice when space is constrained.
3511 Inset labels are useful for controlling blocks of
3512 paragraphs and are valuable for converting
3514 manuals to other formats.
3517 Here is the source text which produced the above example:
3519 .Bd -literal -offset indent
3520 \&.Bl -inset -offset indent
3522 The tagged list (also called a tagged paragraph)
3523 is the most common type of list used in the
3526 Diag lists create section four diagnostic lists
3527 and are similar to inset lists except callable
3530 Hanged labels are a matter of taste.
3532 Overhanging labels are nice when space is constrained.
3534 Inset labels are useful for controlling blocks of
3535 paragraphs and are valuable for converting
3537 manuals to other formats.
3543 This list type generates multiple columns.
3544 The number of columns and the width of each column is determined by the
3555 (dot) immediately followed by a valid
3557 macro name, interpret
3559 and use the width of the result.
3560 Otherwise, the width of
3562 (typeset with a fixed-width font) is taken as the
3568 argument is parsed to make a row, each column within the row is a separate
3569 argument separated by a tab or the
3575 .Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3576 .It Sy String Ta Sy Nroff Ta Sy Troff
3577 .It Li <= Ta <= Ta \*(<=
3578 .It Li >= Ta >= Ta \*(>=
3585 \&.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
3586 \&.It Sy String Ta Sy Nroff Ta Sy Troff
3587 \&.It Li <= Ta <= Ta \e*(<=
3588 \&.It Li >= Ta >= Ta \e*(>=
3596 .Bl -tag -width ".Fl indent Ao Ar string Ac"
3597 .It Fl width Ao Ar string Ac
3602 (dot) immediately followed by a valid
3604 macro name, interpret
3606 and use the width of the result.
3607 Almost all lists in this document use this option.
3611 .Bd -literal -offset indent
3612 \&.Bl -tag -width ".Fl test Ao Ar string Ac"
3613 \&.It Fl test Ao Ar string Ac
3614 This is a longer sentence to show how the
3616 flag works in combination with a tag list.
3623 .Bl -tag -width ".Fl test Ao Ar string Ac"
3624 .It Fl test Ao Ar string Ac
3625 This is a longer sentence to show how the
3627 flag works in combination with a tag list.
3631 (Note that the current state of
3635 is interpreted; afterwards, all variables are restored again.
3636 However, boxes (used for enclosures) can't be saved in
3639 as a consequence, arguments must always be
3641 to avoid nasty errors.
3642 For example, do not write
3645 .Ql ".Ao Ar string Xc"
3646 instead if you really need only an opening angle bracket.)
3650 is a valid numeric expression
3651 .Em ( with a scale indicator other than
3653 use that value for indentation.
3654 The most useful scale indicators are
3658 specifying the so-called
3662 This is approximately the width of the letters
3667 of the current font (for nroff output, both scale indicators give the same
3671 isn't a numeric expression, it is tested whether it is an
3673 macro name, and the default width value associated with this macro is used.
3674 Finally, if all tests fail,
3677 (typeset with a fixed-width font) is taken as the width.
3679 If a width is not specified for the tag list type, every time
3681 is invoked, an attempt is made to determine an appropriate width.
3682 If the first argument to
3684 is a callable macro, the default width for that macro will be used;
3685 otherwise, the default width of
3688 .It Fl offset Ao Ar string Ac
3693 a default indent value (normally set to\~6n, similar to the value used in
3700 is a valid numeric expression instead
3701 .Pf ( Em with a scale indicator other than
3703 use that value for indentation.
3704 The most useful scale indicators are
3708 specifying the so-called
3712 This is approximately the width of the letters
3717 of the current font (for nroff output, both scale indicators give the same
3721 isn't a numeric expression, it is tested whether it is an
3723 macro name, and the default offset value associated with this macro is used.
3724 Finally, if all tests fail,
3727 (typeset with a fixed-width font) is taken as the offset.
3729 Suppress insertion of vertical space before the list and between list items.
3733 .Sh "MISCELLANEOUS MACROS"
3735 Here a list of the remaining macros which do not fit well into one of the
3737 We couldn't find real examples for the following macros:
3741 They are documented here for completeness \- if you know how to use them
3742 properly please send a mail to
3743 .Mt bug-groff@gnu.org
3744 (including an example).
3746 .Bl -tag -width ".Li .Bt"
3750 .Bd -ragged -offset indent
3754 It is neither callable nor parsed and takes no arguments.
3758 .Dl Usage: .Fr Ao function return value Ac ...
3760 Don't use this macro.
3761 It allows a break right before the return value (usually a single digit)
3762 which is bad typographical behaviour.
3765 to tie the return value to the previous word.
3768 Use this macro to include a (header) file literally.
3771 followed by the file name, then the contents of
3774 .Dl Usage: .Hf Ao file Ac
3776 It is neither callable nor parsed.
3782 Exact usage unknown.
3783 The documentation in the
3785 source file describes it as a macro for
3786 .Dq "menu entries" .
3788 Its default width is 6n.
3794 Exact usage unknown.
3795 The documentation in the
3797 source file describes it as
3798 .Dq old function type (fortran) .
3801 Activate (toggle) space mode.
3803 .Dl Usage: .Sm Oo on | off Oc ...
3805 If space mode is off, no spaces between macro arguments are inserted.
3806 If called without a parameter (or if the next parameter is neither
3816 .Bd -ragged -offset indent
3820 It is neither callable nor parsed and takes no arguments.
3824 .Sh "PREDEFINED STRINGS"
3826 The following strings are predefined:
3828 .Bl -column String infinity "Troff " "straight double quote" -offset indent
3829 .It Sy String Ta Sy Nroff Ta Sy Troff Ta Sy Meaning
3830 .It Li <= Ta <= Ta \*[<=] Ta "less equal"
3831 .It Li >= Ta >= Ta \*[>=] Ta "greater equal"
3832 .It Li Rq Ta '' Ta \*[Rq] Ta "right double quote"
3833 .It Li Lq Ta `` Ta \*[Lq] Ta "left double quote"
3834 .It Li ua Ta ^ Ta \*[ua] Ta "upwards arrow"
3835 .It Li aa Ta \' Ta \*[aa] Ta "acute accent"
3836 .It Li ga Ta \` Ta \*[ga] Ta "grave accent"
3837 .It Li q Ta \&" Ta \*[q] Ta "straight double quote"
3838 .It Li Pi Ta pi Ta \*[Pi] Ta "greek pi"
3839 .It Li Ne Ta != Ta \*[Ne] Ta "not equal"
3840 .It Li Le Ta <= Ta \*[Le] Ta "less equal"
3841 .It Li Ge Ta >= Ta \*[Ge] Ta "greater equal"
3842 .It Li Lt Ta < Ta \*[Lt] Ta "less than"
3843 .It Li Gt Ta > Ta \*[Gt] Ta "greater than"
3844 .It Li Pm Ta +\- Ta \*[Pm] Ta "plus minus"
3845 .It Li If Ta infinity Ta \*[If] Ta "infinity"
3846 .It Li Am Ta \*[Am] Ta \*[Am] Ta "ampersand"
3847 .It Li Na Ta \*[Na] Ta \*[Na] Ta "not a number"
3848 .It Li Ba Ta \*[Ba] Ta \*[Ba] Ta "vertical bar"
3851 The names of the columns
3855 are a bit misleading;
3859 representation, while
3861 gives the best glyph form available.
3862 For example, a Unicode enabled
3864 device will have proper glyph representations for all strings, whereas the
3865 enhancement for a Latin1
3867 device is only the plus-minus sign.
3869 String names which consist of two characters can be written as
3871 string names which consist of one character can be written as
3873 A generic syntax for a string name of any length is
3882 \#=====================================================================
3888 available in previous versions of
3890 has been removed since
3893 provides better facilities to check parameters; additionally, many error and
3894 warning messages have been added to this macro package, making it both more
3897 The only remaining debugging macro is
3899 which yields a register dump of all global registers and strings.
3900 A normal user will never need it.
3903 .Sh "FORMATTING WITH GROFF, TROFF, AND NROFF"
3905 By default, the package inhibits page breaks, headers, and footers if
3912 to make the manual more efficient for viewing on-line.
3913 This behaviour can be changed (e.g.\& to create a hardcopy of the
3915 output) by setting the register
3917 to zero while calling
3920 .Dl groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt
3922 For double-sided printing, set register
3926 .Dl groff -Tps -rD1 -mdoc foo.man > foo.ps
3928 To change the document font size to 11pt or 12pt, set register
3932 .Dl groff -Tdvi -rS11 -mdoc foo.man > foo.dvi
3940 The line and title length can be changed by setting the registers
3946 .Dl groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less
3948 If not set, both registers default to 78n for TTY devices and 6.5i
3954 .Bl -tag -width mdoc/doc-ditroff -compact
3956 The main manual macro package.
3958 A wrapper file to call
3960 .It Pa mdoc/doc-common
3961 Common strings, definitions, stuff related typographic output.
3962 .It Pa mdoc/doc-nroff
3963 Definitions used for a
3966 .It Pa mdoc/doc-ditroff
3967 Definitions used for all other devices.
3969 Local additions and customizations.
3971 This file checks whether the
3975 package should be used.
3989 Section 3f has not been added to the header routines.
3992 font should be changed in
3997 needs to have a check to prevent splitting up
3998 if the line length is too short.
4000 separates the last parenthesis, and sometimes
4001 looks ridiculous if a line is in fill mode.
4003 The list and display macros do not do any keeps
4004 and certainly should be able to.
4005 .\" Note what happens if the parameter list overlaps a newline
4007 .\" to make sure a line boundary is crossed:
4009 .\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
4012 .\" produces, nudge nudge,
4013 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4014 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
4016 .\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
4018 .\" If double quotes are used, for example:
4020 .\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
4023 .\" produces, nudge nudge,
4024 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4026 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
4028 .\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
4030 .\" Not a pretty sight...
4031 .\" In a paragraph, a long parameter containing unpaddable spaces as
4032 .\" in the former example will cause
4034 .\" to break the line and spread
4035 .\" the remaining words out.
4036 .\" The latter example will adjust nicely to
4037 .\" justified margins, but may break in between an argument and its
4041 .\" the right margin adjustment is normally ragged and the problem is
4044 .\" Local Variables: