version 1.192, 2011/07/31 17:30:33 |
version 1.204, 2011/08/19 12:55:33 |
Line 30 language is used to format |
|
Line 30 language is used to format |
|
manuals. |
manuals. |
This reference document describes its syntax, structure, and |
This reference document describes its syntax, structure, and |
usage. |
usage. |
The reference implementation is |
The reference implementation for |
|
.Nm |
|
formatting is |
.Xr mandoc 1 ; |
.Xr mandoc 1 ; |
the |
the |
.Sx COMPATIBILITY |
.Sx COMPATIBILITY |
section describes compatibility with other troff \-mdoc implementations. |
section describes compatibility with other implementations. |
.Pp |
.Pp |
An |
An |
.Nm |
.Nm |
Line 42 document follows simple rules: lines beginning with th |
|
Line 44 document follows simple rules: lines beginning with th |
|
character |
character |
.Sq \&. |
.Sq \&. |
are parsed for macros. |
are parsed for macros. |
Text lines, those not beginning with the control character, are |
Lines not beginning with the control character are |
interpreted within the scope of prior macros: |
interpreted within the scope of prior macros: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Sh Macro lines change control state. |
\&.Sh Macro lines change control state. |
Line 52 Text lines are interpreted within the current state. |
|
Line 54 Text lines are interpreted within the current state. |
|
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters, the space |
documents may contain only graphable 7-bit ASCII characters, the space |
character, and, in certain circumstances, the tab character. |
character, and, in certain circumstances, the tab character. |
.Pp |
The back-space character |
If the first character of a text line is a space, that line is printed |
.Sq \e |
with a leading newline. |
indicates the start of an escape sequence for |
|
.Sx Comments , |
|
.Sx Predefined Strings , |
|
and |
|
.Sx Special Characters . |
.Ss Comments |
.Ss Comments |
Text following a |
Text following an escaped double-quote |
.Sq \e\*q , |
.Sq \e\(dq , |
whether in a macro or text line, is ignored to the end of |
whether in a macro or text line, is ignored to the end of |
line. |
line. |
A macro line with only a control character and comment escape, |
A macro line beginning with a control character and comment escape |
.Sq \&.\e\*q , |
.Sq \&.\e\(dq |
is also ignored. |
is also ignored. |
Macro lines with only a control character and optional whitespace are |
Furthermore, |
|
macro lines with only a control character and optional trailing |
|
whitespace are |
stripped from input. |
stripped from input. |
.Ss Reserved Terms |
|
Within a macro line, the following terms are reserved: |
|
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
Examples: |
.It \&. |
.Bd -literal -offset indent -compact |
.Pq period |
\&.\e\(dq This is a comment line. |
.It \e. |
\&.\e\(dq The next line is ignored: |
.Pq escaped period |
\&. |
.It \&, |
\&.Em Emphasis \e\(dq This is also a comment. |
.Pq comma |
.Ed |
.It \&: |
|
.Pq colon |
|
.It \&; |
|
.Pq semicolon |
|
.It \&( |
|
.Pq left-parenthesis |
|
.It \&) |
|
.Pq right-parenthesis |
|
.It \&[ |
|
.Pq left-bracket |
|
.It \&] |
|
.Pq right-bracket |
|
.It \&? |
|
.Pq question |
|
.It \&! |
|
.Pq exclamation |
|
.It \&| |
|
.Pq vertical bar |
|
.It \e*(Ba |
|
.Pq reserved-word vertical bar |
|
.El |
|
.Pp |
|
For general use in macro lines, these can be escaped with a non-breaking |
|
space |
|
.Pq Sq \e& . |
|
In text lines, these may be used as normal punctuation. |
|
.Ss Special Characters |
.Ss Special Characters |
Special characters may occur in both macro and text lines. |
Special characters are used to encode special glyphs and are rendered |
|
differently across output media. |
|
They may occur in both macro and text lines. |
Sequences begin with the escape character |
Sequences begin with the escape character |
.Sq \e |
.Sq \e |
followed by either an open-parenthesis |
followed by either an open-parenthesis |
Line 112 for two-character sequences; an open-bracket |
|
Line 94 for two-character sequences; an open-bracket |
|
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
.Sq \&] ) ; |
.Sq \&] ) ; |
or a single one character sequence. |
or a single one character sequence. |
|
.Pp |
|
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li \e(em |
|
Two-letter em dash escape. |
|
.It Li \ee |
|
One-letter backslash escape. |
|
.El |
|
.Pp |
See |
See |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
for a complete list. |
for a complete list. |
Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
.Ss Text Decoration |
.Ss Text Decoration |
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I (italic), R (Roman), or P |
escape followed by an indicator: B (bold), I (italic), R (regular), or P |
(revert to previous mode): |
(revert to previous mode). |
.Pp |
A numerical representation 3, 2, or 1 (bold, italic, and regular, |
.Dl \efBbold\efR \efIitalic\efP |
|
.Pp |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. |
respectively) may be used instead. |
If a macro opens a font scope after calling |
If a macro opens a font scope after calling |
.Sq \ef , |
.Sq \ef , |
Line 141 mode will be restored upon exiting the |
|
Line 123 mode will be restored upon exiting the |
|
.Sx \&Bf |
.Sx \&Bf |
scope. |
scope. |
.Pp |
.Pp |
Note this form is |
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li \efBbold\efR |
|
Write in bold, then switch to regular font mode. |
|
.It Li \efIitalic\efP |
|
Write in italic, then return to previous font mode. |
|
.El |
|
.Pp |
|
Text decoration is |
.Em not |
.Em not |
recommended for |
recommended for |
.Nm , |
.Nm , |
which encourages semantic annotation. |
which encourages semantic annotation. |
.Ss Predefined Strings |
.Ss Predefined Strings |
Historically, |
Predefined strings, like |
troff |
|
also defined a set of package-specific |
|
.Dq predefined strings , |
|
which, like |
|
.Sx Special Characters , |
.Sx Special Characters , |
mark special output characters and strings by way of input codes. |
mark special output glyphs. |
Predefined strings are escaped with the slash-asterisk, |
Predefined strings are escaped with the slash-asterisk, |
.Sq \e* : |
.Sq \e* : |
single-character |
single-character |
|
|
.Sq \e*(XX , |
.Sq \e*(XX , |
and N-character |
and N-character |
.Sq \e*[N] . |
.Sq \e*[N] . |
See |
.Pp |
.Xr mandoc_char 7 |
Examples: |
for a complete list. |
.Bl -tag -width Ds -offset indent -compact |
Examples include |
.It Li \e*(Am |
.Sq \e*(Am |
Two-letter ampersand predefined string. |
.Pq ampersand |
.It Li \e*q |
and |
One-letter double-quote predefined string. |
.Sq \e*(Ba |
.El |
.Pq vertical bar . |
.Pp |
|
These strings are set using |
|
.Xr roff 7 , |
|
although |
|
.Nm |
|
consists of several pre-set escapes listed in |
|
.Xr mandoc_char 7 . |
.Ss Whitespace |
.Ss Whitespace |
Whitespace consists of the space character. |
Whitespace consists of the space character. |
In text lines, whitespace is preserved within a line; unescaped |
In text lines, whitespace is preserved within a line. |
trailing spaces are stripped from input (unless in a literal context). |
In macro lines, whitespace delimits arguments and is discarded. |
|
.Pp |
|
Unescaped trailing spaces are stripped from text line input unless in a |
|
literal context. |
|
In general, trailing whitespace on any input line is discouraged for |
|
reasons of portability. |
|
In the rare case that a blank character is needed at the end of an |
|
input line, it may be forced by |
|
.Sq \e\ \e& . |
|
.Pp |
|
In general, space characters can be considered as non-whitespace |
|
characters by using non-breaking space escapes or |
|
.Sx Quotation . |
|
.Pp |
Blank text lines, which may include whitespace, are only permitted |
Blank text lines, which may include whitespace, are only permitted |
within literal contexts. |
within literal contexts. |
.Pp |
If the first character of a text line is a space, that line is printed |
In macro lines, whitespace delimits arguments and is discarded. |
with a leading newline. |
If arguments are quoted, whitespace within the quotes is retained. |
|
.Ss Quotation |
.Ss Quotation |
Macro arguments may be quoted with double-quotes to group |
Macro arguments may be quoted with double-quotes to so that the |
space-delimited terms or to retain blocks of whitespace. |
enclosed text is one literal term. |
|
Quoted text, even if whitespace or if it would cause a macro invocation |
|
when unquoted, is considered literal text. |
|
.Pp |
A quoted argument begins with a double-quote preceded by whitespace. |
A quoted argument begins with a double-quote preceded by whitespace. |
The next double-quote not pairwise adjacent to another double-quote |
The next double-quote not pairwise adjacent to another double-quote |
terminates the literal, regardless of surrounding whitespace. |
terminates the literal, regardless of surrounding whitespace. |
.Pp |
.Pp |
Note that any quoted text, even if it would cause a macro invocation |
Examples: |
when unquoted, is considered literal text. |
.Bl -tag -width Ds -offset indent -compact |
Thus, the following produces |
.It Li .Fn strlen \(dqconst char *s\(dq |
.Sq Op "Fl a" : |
Group arguments |
.Bd -literal -offset indent |
.Qq const char *s |
\&.Op "Fl a" |
into one functinon argument. |
.Ed |
If unspecified, |
.Pp |
.Qq const , |
In text lines, quotes are regarded as opaque text. |
.Qq char , |
|
and |
|
.Qq *s |
|
would be considered separate arguments. |
|
.Pq See Sx \&Fn . |
|
.It Li .Op \(dqFl a\(dq |
|
Consider |
|
.Qq \&Fl a |
|
as literal text instead of a flag macro. |
|
.Pq Aee Sx \&Op , \&Fl . |
|
.El |
.Ss Scaling Widths |
.Ss Scaling Widths |
Many macros support scaled widths for their arguments, such as |
Many macros support scaled widths for their arguments. |
stipulating a two-inch list indentation with the following: |
The syntax for a scaled width is |
.Bd -literal -offset indent |
|
\&.Bl -tag -width 2i |
|
.Ed |
|
.Pp |
|
The syntax for scaled widths is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , |
where a decimal must be preceded or proceeded by at least one digit. |
where a decimal must be preceded or proceeded by at least one digit. |
Negative numbers, while accepted, are truncated to zero. |
Negative numbers, while accepted, are truncated to zero. |
|
.Pp |
The following scaling units are accepted: |
The following scaling units are accepted: |
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
|
|
is necessarily non-portable across output media. |
is necessarily non-portable across output media. |
See |
See |
.Sx COMPATIBILITY . |
.Sx COMPATIBILITY . |
|
.Pp |
|
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li \&.Bl -tag -width 2i |
|
two-inch tagged list indentation |
|
.Pq see Sx \&Bl |
|
.It Li \&.sp 2v |
|
two vertical spaces |
|
.Pq see Sx \&sp |
|
.El |
.Ss Sentence Spacing |
.Ss Sentence Spacing |
When composing a manual, make sure that sentences end at the end of |
Sentences should terminate at the end of an input line. |
a line. |
By doing this, a formatter will be able to apply the proper amount of |
By doing so, front-ends will be able to apply the proper amount of |
|
spacing after the end of sentence (unescaped) period, exclamation mark, |
spacing after the end of sentence (unescaped) period, exclamation mark, |
or question mark followed by zero or more non-sentence closing |
or question mark followed by zero or more non-sentence closing |
delimiters |
delimiters |
|
|
.Pp |
.Pp |
The proper spacing is also intelligently preserved if a sentence ends at |
The proper spacing is also intelligently preserved if a sentence ends at |
the boundary of a macro line. |
the boundary of a macro line. |
For example: |
|
.Pp |
.Pp |
.Dl \&.Xr mandoc 1 \&. |
Examples: |
.Dl \&.Fl T \&Ns \&Cm ascii \&. |
.Bd -literal -offset indent -compact |
|
Do not end sentences mid-line like this. Instead, |
|
end a sentence like this. |
|
A macro would end like this: |
|
\&.Xr mandoc 1 \&. |
|
.Ed |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
A well-formed |
A well-formed |
.Nm |
.Nm |
Line 304 file for a utility |
|
Line 330 file for a utility |
|
\&.Os |
\&.Os |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm progname |
\&.Nm progname |
\&.Nd a description goes here |
\&.Nd one line about what it does |
\&.\e\*q .Sh LIBRARY |
\&.\e\(dq .Sh LIBRARY |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\(dq For sections 2, 3, & 9 only. |
\&.\e\*q Not used in OpenBSD. |
\&.\e\(dq Not used in OpenBSD. |
\&.Sh SYNOPSIS |
\&.Sh SYNOPSIS |
\&.Nm progname |
\&.Nm progname |
\&.Op Fl options |
\&.Op Fl options |
Line 316 file for a utility |
|
Line 342 file for a utility |
|
The |
The |
\&.Nm |
\&.Nm |
utility processes files ... |
utility processes files ... |
\&.\e\*q .Sh IMPLEMENTATION NOTES |
\&.\e\(dq .Sh IMPLEMENTATION NOTES |
\&.\e\*q Not used in OpenBSD. |
\&.\e\(dq Not used in OpenBSD. |
\&.\e\*q .Sh RETURN VALUES |
\&.\e\(dq .Sh RETURN VALUES |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\(dq For sections 2, 3, & 9 only. |
\&.\e\*q .Sh ENVIRONMENT |
\&.\e\(dq .Sh ENVIRONMENT |
\&.\e\*q For sections 1, 6, 7, & 8 only. |
\&.\e\(dq For sections 1, 6, 7, & 8 only. |
\&.\e\*q .Sh FILES |
\&.\e\(dq .Sh FILES |
\&.\e\*q .Sh EXIT STATUS |
\&.\e\(dq .Sh EXIT STATUS |
\&.\e\*q For sections 1, 6, & 8 only. |
\&.\e\(dq For sections 1, 6, & 8 only. |
\&.\e\*q .Sh EXAMPLES |
\&.\e\(dq .Sh EXAMPLES |
\&.\e\*q .Sh DIAGNOSTICS |
\&.\e\(dq .Sh DIAGNOSTICS |
\&.\e\*q For sections 1, 4, 6, 7, & 8 only. |
\&.\e\(dq For sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .Sh ERRORS |
\&.\e\(dq .Sh ERRORS |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\(dq For sections 2, 3, & 9 only. |
\&.\e\*q .Sh SEE ALSO |
\&.\e\(dq .Sh SEE ALSO |
\&.\e\*q .Xr foobar 1 |
\&.\e\(dq .Xr foobar 1 |
\&.\e\*q .Sh STANDARDS |
\&.\e\(dq .Sh STANDARDS |
\&.\e\*q .Sh HISTORY |
\&.\e\(dq .Sh HISTORY |
\&.\e\*q .Sh AUTHORS |
\&.\e\(dq .Sh AUTHORS |
\&.\e\*q .Sh CAVEATS |
\&.\e\(dq .Sh CAVEATS |
\&.\e\*q .Sh BUGS |
\&.\e\(dq .Sh BUGS |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
\&.\e\(dq .Sh SECURITY CONSIDERATIONS |
\&.\e\*q Not used in OpenBSD. |
\&.\e\(dq Not used in OpenBSD. |
.Ed |
.Ed |
.Pp |
.Pp |
The sections in an |
The sections in an |
Line 419 macros should follow C header-file conventions. |
|
Line 445 macros should follow C header-file conventions. |
|
.Pp |
.Pp |
And for the third, configurations (section 4): |
And for the third, configurations (section 4): |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Cd \*qit* at isa? port 0x2e\*q |
\&.Cd \(dqit* at isa? port 0x2e\(dq |
\&.Cd \*qit* at isa? port 0x4e\*q |
\&.Cd \(dqit* at isa? port 0x4e\(dq |
.Ed |
.Ed |
.Pp |
.Pp |
Manuals not in these sections generally don't need a |
Manuals not in these sections generally don't need a |
Line 484 Print verbose information. |
|
Line 510 Print verbose information. |
|
.Ed |
.Ed |
.Pp |
.Pp |
Manuals not documenting a command won't include the above fragment. |
Manuals not documenting a command won't include the above fragment. |
|
.Pp |
|
Since the |
|
.Em DESCRIPTION |
|
section usually contains most of the text of a manual, longer manuals |
|
often use the |
|
.Sx \&Ss |
|
macro to form subsections. |
|
In very long manuals, the |
|
.Em DESCRIPTION |
|
may be split into multiple sections, each started by an |
|
.Sx \&Sh |
|
macro followed by a non-standard section name, and each having |
|
several subsections, like in the present |
|
.Nm |
|
manual. |
.It Em IMPLEMENTATION NOTES |
.It Em IMPLEMENTATION NOTES |
Implementation-specific notes should be kept here. |
Implementation-specific notes should be kept here. |
This is useful when implementing standard functions that may have side |
This is useful when implementing standard functions that may have side |
Line 545 This section should exist for most manuals. |
|
Line 586 This section should exist for most manuals. |
|
Cross-references should conventionally be ordered first by section, then |
Cross-references should conventionally be ordered first by section, then |
alphabetically. |
alphabetically. |
.Pp |
.Pp |
|
References to other documentation concerning the topic of the manual page, |
|
for example authoritative books or journal articles, may also be |
|
provided in this section. |
|
.Pp |
See |
See |
|
.Sx \&Rs |
|
and |
.Sx \&Xr . |
.Sx \&Xr . |
.It Em STANDARDS |
.It Em STANDARDS |
References any standards implemented or used. |
References any standards implemented or used. |
Line 556 section should be used instead. |
|
Line 603 section should be used instead. |
|
See |
See |
.Sx \&St . |
.Sx \&St . |
.It Em HISTORY |
.It Em HISTORY |
A brief history of the subject, including where support first appeared. |
A brief history of the subject, including where it was first implemented, |
|
and when it was ported to or reimplemented for the operating system at hand. |
.It Em AUTHORS |
.It Em AUTHORS |
Credits to the person or persons who wrote the code and/or documentation. |
Credits to the person or persons who wrote the code and/or documentation. |
Authors should generally be noted by both name and email address. |
Authors should generally be noted by both name and email address. |
|
|
.Em Callable |
.Em Callable |
column indicates that the macro may also be called by passing its name |
column indicates that the macro may also be called by passing its name |
as an argument to another macro. |
as an argument to another macro. |
|
For example, |
|
.Sq \&.Op \&Fl O \&Ar file |
|
produces |
|
.Sq Op Fl O Ar file . |
|
To prevent a macro call and render the macro name literally, |
|
escape it by prepending a zero-width space, |
|
.Sq \e& . |
|
For example, |
|
.Sq \&Op \e&Fl O |
|
produces |
|
.Sq Op \&Fl O . |
If a macro is not callable but its name appears as an argument |
If a macro is not callable but its name appears as an argument |
to another macro, it is interpreted as opaque text. |
to another macro, it is interpreted as opaque text. |
For example, |
For example, |
Line 666 has multiple heads. |
|
Line 725 has multiple heads. |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" |
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss |
.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Sh Ta \&No Ta Yes Ta closed by Sx \&Sh |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.It Sx \&Ss Ta \&No Ta Yes Ta closed by Sx \&Sh , Sx \&Ss |
.El |
.El |
.Pp |
.Pp |
Note that the |
Note that the |
|
|
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.El |
.El |
.Ss Block partial-implicit |
.Ss Block partial-implicit |
Like block full-implicit, but with single-line scope closed by |
Like block full-implicit, but with single-line scope closed by the |
.Sx Reserved Terms |
end of the line. |
or end of line. |
|
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.Ed |
.Ed |
Line 776 these blocks have bodies, but no heads. |
|
Line 834 these blocks have bodies, but no heads. |
|
.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It |
.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It |
.El |
.El |
.Ss In-line |
.Ss In-line |
Closed by |
Closed by the end of the line, fixed argument lengths, |
.Sx Reserved Terms , |
and/or subsequent macros. |
end of line, fixed argument lengths, and/or subsequent macros. |
|
In-line macros have only text children. |
In-line macros have only text children. |
If a number (or inequality) of arguments is |
If a number (or inequality) of arguments is |
.Pq n , |
.Pq n , |
Line 868 then the macro accepts an arbitrary number of argument |
|
Line 925 then the macro accepts an arbitrary number of argument |
|
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
|
.Ss Delimiters |
|
When a macro argument consists of one single input character |
|
considered as a delimiter, the argument gets special handling. |
|
This does not apply when delimiters appear in arguments containing |
|
more than one character. |
|
Consequently, to prevent special handling and just handle it |
|
like any other argument, a delimiter can be escaped by prepending |
|
a zero-width space |
|
.Pq Sq \e& . |
|
In text lines, delimiters never need escaping, but may be used |
|
as normal punctuation. |
|
.Pp |
|
For many macros, when the leading arguments are opening delimiters, |
|
these delimiters are put before the macro scope, |
|
and when the trailing arguments are closing delimiters, |
|
these delimiters are put after the macro scope. |
|
For example, |
|
.Pp |
|
.D1 Pf \. \&Aq "( [ word ] ) ." |
|
.Pp |
|
renders as: |
|
.Pp |
|
.D1 Aq ( [ word ] ) . |
|
.Pp |
|
Opening delimiters are: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&( |
|
left parenthesis |
|
.It \&[ |
|
left bracket |
|
.El |
|
.Pp |
|
Closing delimiters are: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&. |
|
period |
|
.It \&, |
|
comma |
|
.It \&: |
|
colon |
|
.It \&; |
|
semicolon |
|
.It \&) |
|
right parenthesis |
|
.It \&] |
|
right bracket |
|
.It \&? |
|
question mark |
|
.It \&! |
|
exclamation mark |
|
.El |
|
.Pp |
|
Note that even a period preceded by a backslash |
|
.Pq Sq \e.\& |
|
gets this special handling; use |
|
.Sq \e&. |
|
to prevent that. |
|
.Pp |
|
Many in-line macros interrupt their scope when they encounter |
|
delimiters, and resume their scope when more arguments follow that |
|
are not delimiters. |
|
For example, |
|
.Pp |
|
.D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e" |
|
.Pp |
|
renders as: |
|
.Pp |
|
.D1 Fl a ( b | c \*(Ba d ) e |
|
.Pp |
|
This applies to both opening and closing delimiters, |
|
and also to the middle delimiter: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It \&| |
|
vertical bar |
|
.El |
|
.Pp |
|
As a special case, the predefined string \e*(Ba is handled and rendered |
|
in the same way as a plain |
|
.Sq \&| |
|
character. |
|
Using this predefined string is not recommended in new manuals. |
.Sh REFERENCE |
.Sh REFERENCE |
This section is a canonical reference of all macros, arranged |
This section is a canonical reference of all macros, arranged |
alphabetically. |
alphabetically. |
|
|
.Dl \&.Ad 0x00000000 |
.Dl \&.Ad 0x00000000 |
.Ss \&An |
.Ss \&An |
Author name. |
Author name. |
|
Can be used both for the authors of the program, function, or driver |
|
documented in the manual, or for the authors of the manual itself. |
Requires either the name of an author or one of the following arguments: |
Requires either the name of an author or one of the following arguments: |
.Pp |
.Pp |
.Bl -tag -width "-nosplitX" -offset indent -compact |
.Bl -tag -width "-nosplitX" -offset indent -compact |
Line 1027 If an argument is not provided, the string |
|
Line 1170 If an argument is not provided, the string |
|
is used as a default. |
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Fl o \&Ns \&Ar file1 |
.Dl ".Fl o Ar file" |
.Dl \&.Ar |
.Dl ".Ar" |
.Dl \&.Ar arg1 , arg2 . |
.Dl ".Ar arg1 , arg2 ." |
|
.Pp |
|
The arguments to the |
|
.Sx \&Ar |
|
macro are names and placeholders for command arguments; |
|
for fixed strings to be passed verbatim as arguments, use |
|
.Sx \&Fl |
|
or |
|
.Sx \&Cm . |
.Ss \&At |
.Ss \&At |
Formats an AT&T version. |
Formats an AT&T version. |
Accepts one optional argument: |
Accepts one optional argument: |
|
|
must be one of the following: |
must be one of the following: |
.Bl -tag -width 13n -offset indent |
.Bl -tag -width 13n -offset indent |
.It Fl centered |
.It Fl centered |
Centre-justify each line. |
Produce one output line from each input line, and centre-justify each line. |
Using this display type is not recommended; many |
Using this display type is not recommended; many |
.Nm |
.Nm |
implementations render it poorly. |
implementations render it poorly. |
.It Fl filled |
.It Fl filled |
Left- and right-justify the block. |
Change the positions of line breaks to fill each line, and left- and |
|
right-justify the resulting block. |
.It Fl literal |
.It Fl literal |
Do not justify the block at all. |
Produce one output line from each input line, |
|
and do not justify the block at all. |
Preserve white space as it appears in the input. |
Preserve white space as it appears in the input. |
|
Always use a constant-width font. |
|
Use this for displaying source code. |
.It Fl ragged |
.It Fl ragged |
Only left-justify the block. |
Change the positions of line breaks to fill each line, and left-justify |
|
the resulting block. |
.It Fl unfilled |
.It Fl unfilled |
An alias for |
The same as |
.Fl literal . |
.Fl literal , |
|
but using the same font as for normal text, which is a variable width font |
|
if supported by the output device. |
.El |
.El |
.Pp |
.Pp |
The |
The |
Line 1115 which may be one of the following: |
|
Line 1273 which may be one of the following: |
|
.It |
.It |
One of the pre-defined strings |
One of the pre-defined strings |
.Cm indent , |
.Cm indent , |
the width of standard indentation; |
the width of a standard indentation (six constant width characters); |
.Cm indent-two , |
.Cm indent-two , |
twice |
twice |
.Cm indent ; |
.Cm indent ; |
Line 1292 except that dashes are used in place of bullets. |
|
Line 1450 except that dashes are used in place of bullets. |
|
Like |
Like |
.Fl inset , |
.Fl inset , |
except that item heads are not parsed for macro invocations. |
except that item heads are not parsed for macro invocations. |
.\" but with additional formatting to the head. |
Most often used in the |
|
.Em DIAGNOSTICS |
|
section with error constants in the item heads. |
.It Fl enum |
.It Fl enum |
A numbered list. |
A numbered list. |
|
No item heads can be specified. |
Formatted like |
Formatted like |
.Fl bullet , |
.Fl bullet , |
except that cardinal numbers are used in place of bullets, |
except that cardinal numbers are used in place of bullets, |
Line 1334 this head on the same output line. |
|
Line 1495 this head on the same output line. |
|
Otherwise, the body starts on the output line following the head. |
Otherwise, the body starts on the output line following the head. |
.El |
.El |
.Pp |
.Pp |
|
Lists may be nested within lists and displays. |
|
Nesting of |
|
.Fl column |
|
and |
|
.Fl enum |
|
lists may not be portable. |
|
.Pp |
See also |
See also |
.Sx \&El |
.Sx \&El |
and |
and |
|
|
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Bt |
.Ss \&Bt |
Prints |
Prints |
.Dq is currently in beta test . |
.Dq is currently in beta test. |
.Ss \&Bx |
.Ss \&Bx |
Format the BSD version provided as an argument, or a default value if no |
Format the BSD version provided as an argument, or a default value if no |
argument is provided. |
argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
|
.Dl \&.Bx 4.3 Tahoe |
.Dl \&.Bx 4.4 |
.Dl \&.Bx 4.4 |
.Dl \&.Bx |
.Dl \&.Bx |
.Pp |
.Pp |
|
|
Kernel configuration declaration. |
Kernel configuration declaration. |
This denotes strings accepted by |
This denotes strings accepted by |
.Xr config 8 . |
.Xr config 8 . |
|
It is most often used in section 4 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Cd device le0 at scode? |
.Dl \&.Cd device le0 at scode? |
|
|
This practise is discouraged. |
This practise is discouraged. |
.Ss \&Cm |
.Ss \&Cm |
Command modifiers. |
Command modifiers. |
Useful when specifying configuration options or keys. |
Typically used for fixed strings passed as arguments, unless |
|
.Sx \&Fl |
|
is more appropriate. |
|
Also useful when specifying configuration options or keys. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Cm ControlPath |
.Dl ".Nm mt Fl f Ar device Cm rewind" |
.Dl \&.Cm ControlMaster |
.Dl ".Nm ps Fl o Cm pid , Ns Cm command" |
.Pp |
.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2" |
See also |
.Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa" |
.Sx \&Fl . |
.Dl ".Cm LogLevel Dv DEBUG" |
.Ss \&D1 |
.Ss \&D1 |
One-line indented display. |
One-line indented display. |
This is formatted by the default rules and is useful for simple indented |
This is formatted by the default rules and is useful for simple indented |
|
|
and |
and |
.Sx \&It . |
.Sx \&It . |
.Ss \&Em |
.Ss \&Em |
Denotes text that should be emphasised. |
Denotes text that should be |
|
.Em emphasised . |
Note that this is a presentation term and should not be used for |
Note that this is a presentation term and should not be used for |
stylistically decorating technical terms. |
stylistically decorating technical terms. |
|
Depending on the output device, this is usually represented |
|
using an italic font or underlined characters. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Em Warnings! |
.Dl \&.Em Warnings! |
|
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
.Sx \&Sy , |
.Sx \&Li , |
|
.Sx \&No , |
and |
and |
.Sx \&Li . |
.Sx \&Sy . |
.Ss \&En |
.Ss \&En |
This macro is obsolete and not implemented in |
This macro is obsolete and not implemented in |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
|
|
Error constants for definitions of the |
Error constants for definitions of the |
.Va errno |
.Va errno |
libc global variable. |
libc global variable. |
|
This is most often used in section 2 and 3 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Er EPERM |
.Dl \&.Er EPERM |
Line 1826 for general constants. |
|
Line 2004 for general constants. |
|
.Ss \&Ex |
.Ss \&Ex |
Insert a standard sentence regarding command exit values of 0 on success |
Insert a standard sentence regarding command exit values of 0 on success |
and >0 on failure. |
and >0 on failure. |
|
This is most often used in section 1, 6, and 8 manual pages. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Ex Fl std Op Ar utility... |
.D1 Pf \. Sx \&Ex Fl std Op Ar utility ... |
.Pp |
.Pp |
If |
If |
.Ar utility |
.Ar utility |
|
|
and |
and |
.Sx \&In . |
.Sx \&In . |
.Ss \&Fl |
.Ss \&Fl |
Command-line flag. |
Command-line flag or option. |
Used when listing arguments to command-line utilities. |
Used when listing arguments to command-line utilities. |
Prints a fixed-width hyphen |
Prints a fixed-width hyphen |
.Sq \- |
.Sq \- |
Line 1896 If the argument is a macro, a hyphen is prefixed to th |
|
Line 2075 If the argument is a macro, a hyphen is prefixed to th |
|
output. |
output. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Fl a b c |
.Dl ".Fl R Op Fl H | L | P" |
.Dl \&.Fl \&Pf a b |
.Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" |
.Dl \&.Fl |
.Dl ".Fl type Cm d Fl name Pa CVS" |
.Dl \&.Op \&Fl o \&Ns \&Ar file |
.Dl ".Fl Ar signal_number" |
|
.Dl ".Fl o Fl" |
.Pp |
.Pp |
See also |
See also |
.Sx \&Cm . |
.Sx \&Cm . |
Line 1916 Its syntax is as follows: |
|
Line 2096 Its syntax is as follows: |
|
Function arguments are surrounded in parenthesis and |
Function arguments are surrounded in parenthesis and |
are delimited by commas. |
are delimited by commas. |
If no arguments are specified, blank parenthesis are output. |
If no arguments are specified, blank parenthesis are output. |
|
In the |
|
.Em SYNOPSIS |
|
section, this macro starts a new output line, |
|
and a blank line is automatically inserted between function definitions. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q |
.Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq |
.Dl \&.Fn funcname \*qint arg0\*q |
.Dl \&.Fn funcname \(dqint arg0\(dq |
.Dl \&.Fn funcname arg0 |
.Dl \&.Fn funcname arg0 |
|
.Pp |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
Line 1930 When referring to a function documented in another man |
|
Line 2115 When referring to a function documented in another man |
|
.Sx \&Xr |
.Sx \&Xr |
instead. |
instead. |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE , |
|
.Sx \&Fo , |
and |
and |
.Sx \&Ft . |
.Sx \&Ft . |
.Ss \&Fo |
.Ss \&Fo |
Line 1957 Invocations usually occur in the following context: |
|
Line 2143 Invocations usually occur in the following context: |
|
A |
A |
.Sx \&Fo |
.Sx \&Fo |
scope is closed by |
scope is closed by |
|
.Sx \&Fc . |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE , |
.Sx MANUAL STRUCTURE , |
|
|
and |
and |
.Sx \&Ft . |
.Sx \&Ft . |
.Ss \&Fr |
.Ss \&Fr |
This macro is obsolete and not implemented. |
This macro is obsolete and not implemented in |
|
.Xr mandoc 1 . |
|
.Pp |
|
It was used to show function return values. |
|
The syntax was: |
|
.Pp |
|
.Dl Pf . Sx \&Fr Ar value |
.Ss \&Ft |
.Ss \&Ft |
A function type. |
A function type. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Ft Ar functype |
.D1 Pf \. Sx \&Ft Ar functype |
.Pp |
.Pp |
|
In the |
|
.Em SYNOPSIS |
|
section, a new output line is started after this macro. |
|
.Pp |
Examples: |
Examples: |
.Dl \&.Ft int |
.Dl \&.Ft int |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Hf |
.Ss \&Hf |
This macro is obsolete and not implemented. |
This macro is not implemented in |
|
.Xr mandoc 1 . |
|
.Pp |
|
It was used to include the contents of a (header) file literally. |
|
The syntax was: |
|
.Pp |
|
.Dl Pf . Sx \&Hf Ar filename |
.Ss \&Ic |
.Ss \&Ic |
Designate an internal or interactive command. |
Designate an internal or interactive command. |
This is similar to |
This is similar to |
Line 2012 This is similar to |
|
Line 2215 This is similar to |
|
but used for instructions rather than values. |
but used for instructions rather than values. |
.Pp |
.Pp |
Examples: |
Examples: |
|
.Dl \&.Ic :wq |
.Dl \&.Ic hash |
.Dl \&.Ic hash |
.Dl \&.Ic alias |
.Dl \&.Ic alias |
.Pp |
.Pp |
Line 2026 macro is used when referring to specific instructions. |
|
Line 2230 macro is used when referring to specific instructions. |
|
An |
An |
.Dq include |
.Dq include |
file. |
file. |
In the |
When invoked as the first macro on an input line in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section (only if invoked as the line macro), the first argument is |
section, the argument is displayed in angle brackets |
preceded by |
and preceded by |
.Dq #include , |
.Dq #include , |
the arguments is enclosed in angle brackets. |
and a blank line is inserted in front if there is a preceding |
|
function declaration. |
|
This is most often used in section 2, 3, and 9 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.In sys/types |
.Dl \&.In sys/types.h |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
Line 2125 The syntax is as follows: |
|
Line 2331 The syntax is as follows: |
|
The |
The |
.Ar library |
.Ar library |
parameter may be a system library, such as |
parameter may be a system library, such as |
.Ar libz |
.Cm libz |
or |
or |
.Ar libpam , |
.Cm libpam , |
in which case a small library description is printed next to the linker |
in which case a small library description is printed next to the linker |
invocation; or a custom library, in which case the library name is |
invocation; or a custom library, in which case the library name is |
printed in quotes. |
printed in quotes. |
|
|
.Dl \&.Lb libz |
.Dl \&.Lb libz |
.Dl \&.Lb mdoc |
.Dl \&.Lb mdoc |
.Ss \&Li |
.Ss \&Li |
Denotes text that should be in a literal font mode. |
Denotes text that should be in a |
|
.Li literal |
|
font mode. |
Note that this is a presentation term and should not be used for |
Note that this is a presentation term and should not be used for |
stylistically decorating technical terms. |
stylistically decorating technical terms. |
.Pp |
.Pp |
|
On terminal output devices, this is often indistinguishable from |
|
normal text. |
|
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
.Sx \&Sy , |
.Sx \&Em , |
|
.Sx \&No , |
and |
and |
.Sx \&Em . |
.Sx \&Sy . |
.Ss \&Lk |
.Ss \&Lk |
Format a hyperlink. |
Format a hyperlink. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 2156 Its syntax is as follows: |
|
Line 2368 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Lk Ar uri Op Ar name |
.D1 Pf \. Sx \&Lk Ar uri Op Ar name |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q |
.Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq |
.Dl \&.Lk http://bsd.lv |
.Dl \&.Lk http://bsd.lv |
.Pp |
.Pp |
See also |
See also |
Line 2192 section subsequent the |
|
Line 2404 section subsequent the |
|
macro. |
macro. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Sx \&Nd mdoc language reference |
.Dl Pf . Sx \&Nd mdoc language reference |
.Dl \&.Sx \&Nd format and display UNIX manuals |
.Dl Pf . Sx \&Nd format and display UNIX manuals |
.Pp |
.Pp |
The |
The |
.Sx \&Nd |
.Sx \&Nd |
Line 2245 macro rather than |
|
Line 2457 macro rather than |
|
.Sx \&Nm |
.Sx \&Nm |
to mark up the name of the manual page. |
to mark up the name of the manual page. |
.Ss \&No |
.Ss \&No |
A |
Normal text. |
.Dq noop |
Closes the scope of any preceding in-line macro. |
macro used to terminate prior macro contexts. |
When used after physical formatting macros like |
|
.Sx \&Em |
|
or |
|
.Sx \&Sy , |
|
switches back to the standard font face and weight. |
|
Can also be used to embed plain text strings in macro lines |
|
using semantic annotation macros. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Sx \&Fl ab \&No cd \&Fl ef |
.Dl ".Em italic , Sy bold , No and roman" |
|
.Pp |
|
.Bd -literal -offset indent -compact |
|
\&.Sm off |
|
\&.Cm :C No / Ar pattern No / Ar replacement No / |
|
\&.Sm on |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Em , |
|
.Sx \&Li , |
|
and |
|
.Sx \&Sy . |
.Ss \&Ns |
.Ss \&Ns |
Suppress a space. |
Suppress a space between the output of the preceding macro |
Following invocation, text is interpreted as free-form text until a |
and the following text or macro. |
macro is encountered. |
Following invocation, input is interpreted as normal text |
|
just like after an |
|
.Sx \&No |
|
macro. |
.Pp |
.Pp |
This has no effect when invoked at the start of a macro line. |
This has no effect when invoked at the start of a macro line. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Fl o \&Ns \&Ar output |
.Dl ".Ar name Ns = Ns Ar value" |
|
.Dl ".Cm :M Ns Ar pattern" |
|
.Dl ".Fl o Ns Ar output" |
.Pp |
.Pp |
See also |
See also |
.Sx \&No |
.Sx \&No |
|
|
\&.Oc |
\&.Oc |
.Ed |
.Ed |
.Ss \&Op |
.Ss \&Op |
Command-line option. |
Optional part of a command line. |
Used when listing options to command-line utilities. |
|
Prints the argument(s) in brackets. |
Prints the argument(s) in brackets. |
|
This is most often used in the |
|
.Em SYNOPSIS |
|
section of section 1 and 8 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Op \&Fl a \&Ar b |
.Dl \&.Op \&Fl a \&Ar b |
|
|
and |
and |
.Sx \&Dt . |
.Sx \&Dt . |
.Ss \&Ot |
.Ss \&Ot |
Unknown usage. |
This macro is obsolete and not implemented in |
|
.Xr mandoc 1 . |
.Pp |
.Pp |
.Em Remarks : |
Historical |
this macro has been deprecated. |
.Xr mdoc 7 |
|
packages described it as |
|
.Dq "old function type (FORTRAN)" . |
.Ss \&Ox |
.Ss \&Ox |
Format the |
Format the |
.Ox |
.Ox |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Pa |
.Ss \&Pa |
A file-system path. |
An absolute or relative file system path, or a file or directory name. |
If an argument is not provided, the string |
If an argument is not provided, the character |
.Dq \(ti |
.Sq \(ti |
is used as a default. |
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
Close parenthesised context opened by |
Close parenthesised context opened by |
.Sx \&Po . |
.Sx \&Po . |
.Ss \&Pf |
.Ss \&Pf |
Removes the space |
Removes the space between its argument |
.Pq Dq prefix |
.Pq Dq prefix |
between its arguments. |
and the following macro. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. \&Pf Ar prefix suffix |
.D1 .Pf Ar prefix macro arguments ... |
.Pp |
.Pp |
The |
This is equivalent to: |
.Ar suffix |
|
argument may be a macro. |
|
.Pp |
.Pp |
|
.D1 .No Ar prefix No \&Ns Ar macro arguments ... |
|
.Pp |
Examples: |
Examples: |
.Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix |
.Dl ".Pf $ Ar variable_name" |
|
.Dl ".Pf 0x Ar hex_digits" |
|
.Pp |
|
See also |
|
.Sx \&Ns |
|
and |
|
.Sx \&Sm . |
.Ss \&Po |
.Ss \&Po |
Multi-line version of |
Multi-line version of |
.Sx \&Pq . |
.Sx \&Pq . |
Line 2394 Multi-line version of |
|
Line 2640 Multi-line version of |
|
Break a paragraph. |
Break a paragraph. |
This will assert vertical space between prior and subsequent macros |
This will assert vertical space between prior and subsequent macros |
and/or text. |
and/or text. |
|
.Pp |
|
Paragraph breaks are not needed before or after |
|
.Sx \&Sh |
|
or |
|
.Sx \&Ss |
|
macros or before displays |
|
.Pq Sx \&Bd |
|
or lists |
|
.Pq Sx \&Bl |
|
unless the |
|
.Fl compact |
|
flag is given. |
.Ss \&Pq |
.Ss \&Pq |
Parenthesised enclosure. |
Parenthesised enclosure. |
.Pp |
.Pp |
Line 2413 Multi-line version of |
|
Line 2671 Multi-line version of |
|
.Sx \&Qq . |
.Sx \&Qq . |
.Ss \&Qq |
.Ss \&Qq |
Encloses its arguments in |
Encloses its arguments in |
.Dq typewriter |
.Qq typewriter |
double-quotes. |
double-quotes. |
Consider using |
Consider using |
.Sx \&Dq . |
.Sx \&Dq . |
Line 2469 block is used within a SEE ALSO section, a vertical sp |
|
Line 2727 block is used within a SEE ALSO section, a vertical sp |
|
before the rendered output, else the block continues on the current |
before the rendered output, else the block continues on the current |
line. |
line. |
.Ss \&Rv |
.Ss \&Rv |
Insert a standard sentence regarding a system call's return value of 0 |
Insert a standard sentence regarding a function call's return value of 0 |
on success and \-1 on error, with the |
on success and \-1 on error, with the |
.Va errno |
.Va errno |
libc global variable set on error. |
libc global variable set on error. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Rv Fl std Op Ar function... |
.D1 Pf \. Sx \&Rv Fl std Op Ar function ... |
.Pp |
.Pp |
If |
If |
.Ar function |
.Ar function |
Line 2500 custom sections be used. |
|
Line 2758 custom sections be used. |
|
.Pp |
.Pp |
Section names should be unique so that they may be keyed by |
Section names should be unique so that they may be keyed by |
.Sx \&Sx . |
.Sx \&Sx . |
|
Although this macro is parsed, it should not consist of child node or it |
|
may not be linked with |
|
.Sx \&Sx . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Pp , |
.Sx \&Pp , |
Line 2513 Its syntax is as follows: |
|
Line 2774 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Sm Cm on | off |
.D1 Pf \. Sx \&Sm Cm on | off |
.Pp |
.Pp |
By default, spacing is |
By default, spacing is |
.Ar on . |
.Cm on . |
When switched |
When switched |
.Ar off , |
.Cm off , |
no white space is inserted between macro arguments and between the |
no white space is inserted between macro arguments and between the |
output generated from adjacent macros, but text lines |
output generated from adjacent macros, but text lines |
still get normal spacing between words and sentences. |
still get normal spacing between words and sentences. |
Line 2524 Multi-line version of |
|
Line 2785 Multi-line version of |
|
.Sx \&Sq . |
.Sx \&Sq . |
.Ss \&Sq |
.Ss \&Sq |
Encloses its arguments in |
Encloses its arguments in |
.Dq typewriter |
.Sq typewriter |
single-quotes. |
single-quotes. |
.Pp |
.Pp |
See also |
See also |
|
|
and |
and |
.Sx \&So . |
.Sx \&So . |
.Ss \&Ss |
.Ss \&Ss |
Begin a new sub-section. |
Begin a new subsection. |
Unlike with |
Unlike with |
.Sx \&Sh , |
.Sx \&Sh , |
there's no convention for sub-sections. |
there is no convention for the naming of subsections. |
Conventional sections, as described in |
Except |
.Sx MANUAL STRUCTURE , |
.Em DESCRIPTION , |
rarely have sub-sections. |
the conventional sections described in |
|
.Sx MANUAL STRUCTURE |
|
rarely have subsections. |
.Pp |
.Pp |
Sub-section names should be unique so that they may be keyed by |
Sub-section names should be unique so that they may be keyed by |
.Sx \&Sx . |
.Sx \&Sx . |
|
Although this macro is parsed, it should not consist of child node or it |
|
may not be linked with |
|
.Sx \&Sx . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Pp , |
.Sx \&Pp , |
Line 2624 The following standards are recognised: |
|
Line 2890 The following standards are recognised: |
|
.St -xpg4 |
.St -xpg4 |
.It \-xpg4.2 |
.It \-xpg4.2 |
.St -xpg4.2 |
.St -xpg4.2 |
|
.It \-xpg4.3 |
.St -xpg4.3 |
.St -xpg4.3 |
.It \-xbd5 |
.It \-xbd5 |
.St -xbd5 |
.St -xbd5 |
Line 2647 The following standards are recognised: |
|
Line 2914 The following standards are recognised: |
|
.St -svid4 |
.St -svid4 |
.El |
.El |
.Ss \&Sx |
.Ss \&Sx |
Reference a section or sub-section. |
Reference a section or subsection in the same manual page. |
The referenced section or sub-section name must be identical to the |
The referenced section or subsection name must be identical to the |
enclosed argument, including whitespace. |
enclosed argument, including whitespace. |
.Pp |
.Pp |
Examples: |
Examples: |
Line 2666 stylistically decorating technical terms. |
|
Line 2933 stylistically decorating technical terms. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
|
.Sx \&Em , |
.Sx \&Li , |
.Sx \&Li , |
and |
and |
.Sx \&Em . |
.Sx \&No . |
.Ss \&Ta |
.Ss \&Ta |
Table cell separator in |
Table cell separator in |
.Sx \&Bl Fl column |
.Sx \&Bl Fl column |
Line 2677 lists; can only be used below |
|
Line 2945 lists; can only be used below |
|
.Ss \&Tn |
.Ss \&Tn |
Format a tradename. |
Format a tradename. |
.Pp |
.Pp |
|
Since this macro is often implemented to use a small caps font, |
|
it has historically been used for acronyms (like ASCII) as well. |
|
Such usage is not recommended because it would use the same macro |
|
sometimes for semantical annotation, sometimes for physical formatting. |
|
.Pp |
Examples: |
Examples: |
.Dl \&.Tn IBM |
.Dl \&.Tn IBM |
.Ss \&Ud |
.Ss \&Ud |
Prints out |
Prints out |
.Dq currently under development . |
.Dq currently under development. |
.Ss \&Ux |
.Ss \&Ux |
Format the UNIX name. |
Format the UNIX name. |
Accepts no argument. |
Accepts no argument. |
Line 2711 This is also used for indicating global variables in t |
|
Line 2984 This is also used for indicating global variables in t |
|
section, in which case a variable name is also specified. |
section, in which case a variable name is also specified. |
Note that it accepts |
Note that it accepts |
.Sx Block partial-implicit |
.Sx Block partial-implicit |
syntax when invoked as the first macro in the |
syntax when invoked as the first macro on an input line in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section, else it accepts ordinary |
section, else it accepts ordinary |
.Sx In-line |
.Sx In-line |
syntax. |
syntax. |
|
In the former case, this macro starts a new output line, |
|
and a blank line is inserted in front if there is a preceding |
|
function definition or include directive. |
.Pp |
.Pp |
Note that this should not be confused with |
Note that this should not be confused with |
.Sx \&Ft , |
.Sx \&Ft , |
Line 2883 In new groff and mandoc, any list may be nested by def |
|
Line 3159 In new groff and mandoc, any list may be nested by def |
|
lists will restart the sequence only for the sub-list. |
lists will restart the sequence only for the sub-list. |
.It |
.It |
.Sx \&Li |
.Sx \&Li |
followed by a reserved character is incorrectly used in some manuals |
followed by a delimiter is incorrectly used in some manuals |
instead of properly quoting that character, which sometimes works with |
instead of properly quoting that character, which sometimes works with |
historic groff. |
historic groff. |
.It |
.It |
Line 2974 This is not supported by mandoc. |
|
Line 3250 This is not supported by mandoc. |
|
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr eqn 7 , |
.Xr eqn 7 , |
.Xr man 7 , |
.Xr man 7 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 , |
.Xr roff 7 , |
.Xr roff 7 , |
.Xr tbl 7 |
.Xr tbl 7 |
.Sh HISTORY |
.Sh HISTORY |
Line 2992 utility written by Kristaps Dzonsons appeared in |
|
Line 3268 utility written by Kristaps Dzonsons appeared in |
|
The |
The |
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons , |
|
.Mt kristaps@bsd.lv . |