version 1.63, 2009/10/19 07:34:43 |
version 1.80, 2010/01/01 16:27:32 |
|
|
.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), or P and R |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(Roman, or reset). This form is not recommended for |
(revert to previous mode): |
|
.Pp |
|
.D1 \efBbold\efR \efIitalic\efP |
|
.Pp |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. A text decoration is valid within |
|
the current font scope only: if a macro opens a font scope alongside |
|
its own scope, such as |
|
.Sx \&Bf |
|
.Cm \&Sy , |
|
in-scope invocations of |
|
.Sq \ef |
|
are only valid within the font scope of the macro. If |
|
.Sq \ef |
|
is specified outside of any font scope, such as in unenclosed, free-form |
|
text, it will affect the remainder of the document. |
|
.Pp |
|
Text may also be sized with the |
|
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Note these forms are |
|
.Em not |
|
recommended for |
.Nm , |
.Nm , |
which encourages semantic, not presentation, annotation. |
which encourages semantic annotation. |
. |
. |
. |
. |
.Ss Predefined Strings |
.Ss Predefined Strings |
Line 210 considered literal text. Thus, the following produces |
|
Line 250 considered literal text. Thus, the following produces |
|
In free-form mode, quotes are regarded as opaque text. |
In free-form mode, quotes are regarded as opaque text. |
. |
. |
.Ss Dates |
.Ss Dates |
TODO. |
There are several macros in |
|
.Nm |
|
that require a date argument. The canonical form for dates is the |
|
American format: |
|
.Pp |
|
.D1 Cm Month Day , Year |
|
.Pp |
|
The |
|
.Cm Day |
|
value is an optionally zero-padded numeral. The |
|
.Cm Month |
|
value is the full month name. The |
|
.Cm Year |
|
value is the full four-digit year. |
|
.Pp |
|
Reduced form dates are broken-down canonical form dates: |
|
.Pp |
|
.D1 Cm Month , Year |
|
.D1 Cm Year |
|
.Pp |
|
Some examples of valid dates follow: |
|
.Pp |
|
.D1 "May, 2009" Pq reduced form |
|
.D1 "2009" Pq reduced form |
|
.D1 "May 20, 2009" Pq canonical form |
. |
. |
.Ss Scaling Widths |
.Ss Scaling Widths |
Many macros support scaled widths for their arguments, such as |
Many macros support scaled widths for their arguments, such as |
Line 267 is necessarily non-portable across output media. See |
|
Line 331 is necessarily non-portable across output media. See |
|
. |
. |
. |
. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
A well-formed |
.Nm |
.Nm |
document must begin with a document prologue, containing, in order, |
document consists of a document prologue followed by one or more |
.Sq \&Dd , |
sections. |
.Sq \&Dt , |
.Pp |
|
The prologue, which consists of (in order) the |
|
.Sx \&Dd , |
|
.Sx \&Dt , |
and |
and |
.Sq \&Os , |
.Sx \&Os |
then the NAME section containing at least one |
macros, is required for every document. |
.Sq \&Nm |
.Pp |
|
The first section (sections are denoted by |
|
.Sx \&Sh ) |
|
must be the NAME section, consisting of at least one |
|
.Sx \&Nm |
followed by |
followed by |
.Sq \&Nd : |
.Sx \&Nd . |
|
.Pp |
|
Following that, convention dictates specifying at least the SYNOPSIS and |
|
DESCRIPTION sections, although this varies between manual sections. |
|
.Pp |
|
The following is a well-formed skeleton |
|
.Nm |
|
file: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt mdoc 7 |
Line 320 utility processes files ... |
|
Line 398 utility processes files ... |
|
\&.\e\*q .Sh BUGS |
\&.\e\*q .Sh BUGS |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
.Ed |
.Ed |
|
.Pp |
|
The sections in a |
|
.Nm |
|
document are conventionally ordered as they appear above. Sections |
|
should be composed as follows: |
|
.Bl -ohang -offset Ds |
|
.It Em NAME |
|
The name(s) and a short description of the documented material. The |
|
syntax for this as follows: |
|
.Bd -literal -offset indent |
|
\&.Nm name0 |
|
\&.Nm name1 |
|
\&.Nm name2 |
|
\&.Nd a short description |
|
.Ed |
|
.Pp |
|
The |
|
.Sx \&Nm |
|
macro(s) must precede the |
|
.Sx \&Nd |
|
macro. |
|
.Pp |
|
See |
|
.Sx \&Nm |
|
and |
|
.Sx \&Nd . |
. |
. |
|
.It Em LIBRARY |
|
The name of the library containing the documented material, which is |
|
assumed to be a function in a section 2 or 3 manual. The syntax for |
|
this is as follows: |
|
.Bd -literal -offset indent |
|
\&.Lb libarm |
|
.Ed |
.Pp |
.Pp |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
See |
but non-compulsory. |
.Sx \&Lb . |
. |
. |
|
.It Em SYNOPSIS |
|
Documents the utility invocation syntax, function call syntax, or device |
|
configuration. |
|
.Pp |
|
For the first, utilities (sections 1, 6, and 8), this is |
|
generally structured as follows: |
|
.Bd -literal -offset indent |
|
\&.Nm foo |
|
\&.Op Fl v |
|
\&.Op Fl o Ar file |
|
\&.Op Ar |
|
\&.Nm bar |
|
\&.Op Fl v |
|
\&.Op Fl o Ar file |
|
\&.Op Ar |
|
.Ed |
|
.Pp |
|
For the second, function calls (sections 2, 3, 9): |
|
.Bd -literal -offset indent |
|
\&.Vt extern const char *global; |
|
\&.In header.h |
|
\&.Ft "char *" |
|
\&.Fn foo "const char *src" |
|
\&.Ft "char *" |
|
\&.Fn bar "const char *src" |
|
.Ed |
|
.Pp |
|
And for the third, configurations (section 4): |
|
.Bd -literal -offset indent |
|
\&.Cd \*qit* at isa? port 0x2e\*q |
|
\&.Cd \*qit* at isa? port 0x4e\*q |
|
.Ed |
|
.Pp |
|
Manuals not in these sections generally don't need a |
|
.Em SYNOPSIS . |
|
.Pp |
|
See |
|
.Sx \&Op , |
|
.Sx \&Cd , |
|
.Sx \&Fn , |
|
.Sx \&Ft , |
|
and |
|
.Sx \&Vt . |
. |
. |
|
.It Em DESCRIPTION |
|
This expands upon the brief, one-line description in |
|
.Em NAME . |
|
It usually contains a break-down of the options (if documenting a |
|
command), such as: |
|
.Bd -literal -offset indent |
|
The arguments are as follows: |
|
\&.Bl \-tag \-width Ds |
|
\&.It Fl v |
|
Print verbose information. |
|
\&.El |
|
.Ed |
|
.Pp |
|
Manuals not documenting a command won't include the above fragment. |
|
. |
|
.It Em IMPLEMENTATION NOTES |
|
Implementation-specific notes should be kept here. This is useful when |
|
implementing standard functions that may have side effects or notable |
|
algorithmic implications. |
|
. |
|
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. This section is |
|
the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. Historically, this information was |
|
described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
|
.Pp |
|
See |
|
.Sx \&Ex . |
|
. |
|
.It Em RETURN VALUES |
|
This section is the dual of |
|
.Em EXIT STATUS , |
|
which is used for commands. It documents the return values of functions |
|
in sections 2, 3, and 9. |
|
.Pp |
|
See |
|
.Sx \&Rv . |
|
. |
|
.It Em ENVIRONMENT |
|
Documents any usages of environment variables, e.g., |
|
.Xr environ 7 . |
|
.Pp |
|
See |
|
.Sx \&Ev . |
|
. |
|
.It Em FILES |
|
Documents files used. It's helpful to document both the file and a |
|
short description of how the file is used (created, modified, etc.). |
|
.Pp |
|
See |
|
.Sx \&Pa . |
|
. |
|
.It Em EXAMPLES |
|
Example usages. This often contains snippets of well-formed, |
|
well-tested invocations. Make doubly sure that your examples work |
|
properly! |
|
. |
|
.It Em DIAGNOSTICS |
|
Documents error conditions. This is most useful in section 4 manuals. |
|
Historically, this section was used in place of |
|
.Em EXIT STATUS |
|
for manuals in sections 1, 6, and 8; however, this practise is |
|
discouraged. |
|
.Pp |
|
See |
|
.Sx \&Bl |
|
.Fl diag . |
|
. |
|
.It Em ERRORS |
|
Documents error handling in sections 2, 3, and 9. |
|
.Pp |
|
See |
|
.Sx \&Er . |
|
. |
|
.It Em SEE ALSO |
|
References other manuals with related topics. This section should exist |
|
for most manuals. Cross-references should conventionally be ordered |
|
first by section, then alphabetically. |
|
.Pp |
|
See |
|
.Sx \&Xr . |
|
. |
|
.It Em STANDARDS |
|
References any standards implemented or used. If not adhering to any |
|
standards, the |
|
.Em HISTORY |
|
section should be used instead. |
|
.Pp |
|
See |
|
.Sx \&St . |
|
. |
|
.It Em HISTORY |
|
The history of any manual without a |
|
.Em STANDARDS |
|
section should be described in this section. |
|
. |
|
.It Em AUTHORS |
|
Credits to authors, if applicable, should appear in this section. |
|
Authors should generally be noted by both name and an e-mail address. |
|
.Pp |
|
See |
|
.Sx \&An . |
|
. |
|
.It Em CAVEATS |
|
Explanations of common misuses and misunderstandings should be explained |
|
in this section. |
|
. |
|
.It Em BUGS |
|
Extant bugs should be described in this section. |
|
. |
|
.It Em SECURITY CONSIDERATIONS |
|
Documents any security precautions that operators should consider. |
|
. |
|
.El |
|
. |
|
. |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Macros are one to three three characters in length and begin with a |
Macros are one to three three characters in length and begin with a |
control character , |
control character , |
.Sq \&. , |
.Sq \&. , |
at the beginning of the line. An arbitrary amount of whitespace may |
at the beginning of the line. An arbitrary amount of whitespace may |
sit between the control character and the macro name. Thus, |
sit between the control character and the macro name. Thus, the |
.Sq \&.Pp |
following are equivalent: |
and |
.Bd -literal -offset indent |
.Sq \&.\ \ \ \&Pp |
\&.Pp |
are equivalent. Macro names are two or three characters in length. |
\&.\ \ \ \&Pp |
|
.Ed |
. |
. |
.Pp |
.Pp |
The syntax of a macro depends on its classification. In this section, |
The syntax of a macro depends on its classification. In this section, |
Line 374 column, if applicable, describes closure rules. |
|
Line 648 column, if applicable, describes closure rules. |
|
.Ss Block full-explicit |
.Ss Block full-explicit |
Multi-line scope closed by an explicit closing macro. All macros |
Multi-line scope closed by an explicit closing macro. All macros |
contains bodies; only |
contains bodies; only |
.Pq Sq \&Bf |
.Sx \&Bf |
contains a head. |
contains a head. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
Line 385 contains a head. |
|
Line 659 contains a head. |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
.It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed |
.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
.It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef |
.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
.It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek |
.It \&Bl Ta \&No Ta \&No Ta closed by \&El |
.It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El |
.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
.It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd |
.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
.It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf |
.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
.It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk |
.It \&El Ta \&No Ta \&No Ta opened by \&Bl |
.It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl |
.El |
.El |
. |
. |
. |
. |
Line 400 contains a head. |
|
Line 674 contains a head. |
|
Multi-line scope closed by end-of-file or implicitly by another macro. |
Multi-line scope closed by end-of-file or implicitly by another macro. |
All macros have bodies; some |
All macros have bodies; some |
.Po |
.Po |
.Sq \&It \-bullet , |
.Sx \&It Fl bullet , |
.Sq \-hyphen , |
.Fl hyphen , |
.Sq \-dash , |
.Fl dash , |
.Sq \-enum , |
.Fl enum , |
.Sq \-item |
.Fl item |
.Pc |
.Pc |
don't have heads, while |
don't have heads; only one |
.Sq \&It \-column |
.Po |
may have multiple heads. |
.Sx \&It Fl column |
|
.Pc |
|
has multiple heads. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
Line 417 may have multiple heads. |
|
Line 693 may have multiple heads. |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It \&Sh Ta \&No Ta \&No Ta closed by \&Sh |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.El |
.El |
. |
. |
. |
. |
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Like block full-explicit, but also with single-line scope. Each |
Like block full-explicit, but also with single-line scope. Each |
has at least a body and, in limited circumstances, a head |
has at least a body and, in limited circumstances, a head |
.Pq So \&Fo Sc , So \&Eo Sc |
.Po |
|
.Sx \&Fo , |
|
.Sx \&Eo |
|
.Pc |
and/or tail |
and/or tail |
.Pq So \&Ec Sc . |
.Pq Sx \&Ec . |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
|
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao |
.It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao |
.It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac |
.It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac |
.It \&Bc Ta Yes Ta Yes Ta closed by \&Bo |
.It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo |
.It \&Bo Ta Yes Ta Yes Ta opened by \&Bc |
.It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc |
.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro |
.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc |
.It \&Dc Ta Yes Ta Yes Ta opened by \&Do |
.It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do |
.It \&Do Ta Yes Ta Yes Ta closed by \&Dc |
.It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc |
.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo |
.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
.It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec |
.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
.It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo |
.It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
.It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc |
.It \&Oc Ta Yes Ta Yes Ta closed by \&Oo |
.It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo |
.It \&Oo Ta Yes Ta Yes Ta opened by \&Oc |
.It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc |
.It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po |
.It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
.It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc |
.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo |
.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
.It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc |
.It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs |
.It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs |
.It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re |
.It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re |
.It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So |
.It \&So Ta Yes Ta Yes Ta closed by \&Sc |
.It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc |
.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
.It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo |
.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.El |
.El |
. |
. |
. |
. |
|
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.It Em Macro Ta Em Callable Ta Em Parsable |
.It Em Macro Ta Em Callable Ta Em Parsable |
.It \&Aq Ta Yes Ta Yes |
.It Sx \&Aq Ta Yes Ta Yes |
.It \&Bq Ta Yes Ta Yes |
.It Sx \&Bq Ta Yes Ta Yes |
.It \&Brq Ta Yes Ta Yes |
.It Sx \&Brq Ta Yes Ta Yes |
.It \&D1 Ta \&No Ta \&Yes |
.It Sx \&D1 Ta \&No Ta \&Yes |
.It \&Dl Ta \&No Ta Yes |
.It Sx \&Dl Ta \&No Ta Yes |
.It \&Dq Ta Yes Ta Yes |
.It Sx \&Dq Ta Yes Ta Yes |
.It \&Op Ta Yes Ta Yes |
.It Sx \&Op Ta Yes Ta Yes |
.It \&Pq Ta Yes Ta Yes |
.It Sx \&Pq Ta Yes Ta Yes |
.It \&Ql Ta Yes Ta Yes |
.It Sx \&Ql Ta Yes Ta Yes |
.It \&Qq Ta Yes Ta Yes |
.It Sx \&Qq Ta Yes Ta Yes |
.It \&Sq Ta Yes Ta Yes |
.It Sx \&Sq Ta Yes Ta Yes |
.El |
.El |
. |
. |
. |
. |
Line 522 then the macro accepts an arbitrary number of argument |
|
Line 801 then the macro accepts an arbitrary number of argument |
|
.It Sx \&%N Ta \&No Ta \&No Ta >0 |
.It Sx \&%N Ta \&No Ta \&No Ta >0 |
.It Sx \&%O Ta \&No Ta \&No Ta >0 |
.It Sx \&%O Ta \&No Ta \&No Ta >0 |
.It Sx \&%P Ta \&No Ta \&No Ta >0 |
.It Sx \&%P Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%Q Ta \&No Ta \&No Ta >0 |
.It Sx \&%R Ta \&No Ta \&No Ta >0 |
.It Sx \&%R Ta \&No Ta \&No Ta >0 |
.It Sx \&%T Ta \&No Ta \&No Ta >0 |
.It Sx \&%T Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%U Ta \&No Ta \&No Ta >0 |
.It Sx \&%V Ta \&No Ta \&No Ta >0 |
.It Sx \&%V Ta \&No Ta \&No Ta >0 |
.It \&Ad Ta Yes Ta Yes Ta n |
.It Sx \&Ad Ta Yes Ta Yes Ta n |
.It \&An Ta Yes Ta Yes Ta n |
.It Sx \&An Ta Yes Ta Yes Ta n |
.It \&Ap Ta Yes Ta Yes Ta 0 |
.It Sx \&Ap Ta Yes Ta Yes Ta 0 |
.It \&Ar Ta Yes Ta Yes Ta n |
.It Sx \&Ar Ta Yes Ta Yes Ta n |
.It \&At Ta Yes Ta Yes Ta 1 |
.It Sx \&At Ta Yes Ta Yes Ta 1 |
.It \&Bsx Ta Yes Ta Yes Ta n |
.It Sx \&Bsx Ta Yes Ta Yes Ta n |
.It \&Bt Ta \&No Ta \&No Ta 0 |
.It Sx \&Bt Ta \&No Ta \&No Ta 0 |
.It \&Bx Ta Yes Ta Yes Ta n |
.It Sx \&Bx Ta Yes Ta Yes Ta n |
.It \&Cd Ta Yes Ta Yes Ta >0 |
.It Sx \&Cd Ta Yes Ta Yes Ta >0 |
.It \&Cm Ta Yes Ta Yes Ta n |
.It Sx \&Cm Ta Yes Ta Yes Ta n |
.It \&Db Ta \&No Ta \&No Ta 1 |
.It Sx \&Db Ta \&No Ta \&No Ta 1 |
.It \&Dd Ta \&No Ta \&No Ta >0 |
.It Sx \&Dd Ta \&No Ta \&No Ta >0 |
.It \&Dt Ta \&No Ta \&No Ta n |
.It Sx \&Dt Ta \&No Ta \&No Ta n |
.It \&Dv Ta Yes Ta Yes Ta n |
.It Sx \&Dv Ta Yes Ta Yes Ta n |
.It \&Dx Ta Yes Ta Yes Ta n |
.It Sx \&Dx Ta Yes Ta Yes Ta n |
.It \&Em Ta Yes Ta Yes Ta >0 |
.It Sx \&Em Ta Yes Ta Yes Ta >0 |
.It \&En Ta \&No Ta \&No Ta 0 |
.It Sx \&En Ta \&No Ta \&No Ta 0 |
.It \&Er Ta Yes Ta Yes Ta >0 |
.It Sx \&Er Ta Yes Ta Yes Ta >0 |
.It \&Es Ta \&No Ta \&No Ta 0 |
.It Sx \&Es Ta \&No Ta \&No Ta 0 |
.It \&Ev Ta Yes Ta Yes Ta n |
.It Sx \&Ev Ta Yes Ta Yes Ta n |
.It \&Ex Ta \&No Ta \&No Ta n |
.It Sx \&Ex Ta \&No Ta \&No Ta n |
.It \&Fa Ta Yes Ta Yes Ta n |
.It Sx \&Fa Ta Yes Ta Yes Ta n |
.It \&Fd Ta \&No Ta \&No Ta >0 |
.It Sx \&Fd Ta \&No Ta \&No Ta >0 |
.It \&Fl Ta Yes Ta Yes Ta n |
.It Sx \&Fl Ta Yes Ta Yes Ta n |
.It \&Fn Ta Yes Ta Yes Ta >0 |
.It Sx \&Fn Ta Yes Ta Yes Ta >0 |
.It \&Fr Ta \&No Ta \&No Ta n |
.It Sx \&Fr Ta \&No Ta \&No Ta n |
.It \&Ft Ta Yes Ta Yes Ta n |
.It Sx \&Ft Ta Yes Ta Yes Ta n |
.It \&Fx Ta Yes Ta Yes Ta n |
.It Sx \&Fx Ta Yes Ta Yes Ta n |
.It \&Hf Ta \&No Ta \&No Ta n |
.It Sx \&Hf Ta \&No Ta \&No Ta n |
.It \&Ic Ta Yes Ta Yes Ta >0 |
.It Sx \&Ic Ta Yes Ta Yes Ta >0 |
.It \&In Ta \&No Ta \&No Ta n |
.It Sx \&In Ta \&No Ta \&No Ta n |
.It \&Lb Ta \&No Ta \&No Ta 1 |
.It Sx \&Lb Ta \&No Ta \&No Ta 1 |
.It \&Li Ta Yes Ta Yes Ta n |
.It Sx \&Li Ta Yes Ta Yes Ta n |
.It \&Lk Ta Yes Ta Yes Ta n |
.It Sx \&Lk Ta Yes Ta Yes Ta n |
.It \&Lp Ta \&No Ta \&No Ta 0 |
.It Sx \&Lp Ta \&No Ta \&No Ta 0 |
.It \&Ms Ta Yes Ta Yes Ta >0 |
.It Sx \&Ms Ta Yes Ta Yes Ta >0 |
.It \&Mt Ta Yes Ta Yes Ta >0 |
.It Sx \&Mt Ta Yes Ta Yes Ta >0 |
.It \&Nm Ta Yes Ta Yes Ta n |
.It Sx \&Nm Ta Yes Ta Yes Ta n |
.It \&No Ta Yes Ta Yes Ta 0 |
.It Sx \&No Ta Yes Ta Yes Ta 0 |
.It \&Ns Ta Yes Ta Yes Ta 0 |
.It Sx \&Ns Ta Yes Ta Yes Ta 0 |
.It \&Nx Ta Yes Ta Yes Ta n |
.It Sx \&Nx Ta Yes Ta Yes Ta n |
.It \&Os Ta \&No Ta \&No Ta n |
.It Sx \&Os Ta \&No Ta \&No Ta n |
.It \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It \&Ox Ta Yes Ta Yes Ta n |
.It Sx \&Ox Ta Yes Ta Yes Ta n |
.It \&Pa Ta Yes Ta Yes Ta n |
.It Sx \&Pa Ta Yes Ta Yes Ta n |
.It \&Pf Ta \&No Ta Yes Ta 1 |
.It Sx \&Pf Ta \&No Ta Yes Ta 1 |
.It \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It \&Sm Ta \&No Ta \&No Ta 1 |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
.It \&St Ta \&No Ta Yes Ta 1 |
.It Sx \&St Ta \&No Ta Yes Ta 1 |
.It \&Sx Ta Yes Ta Yes Ta >0 |
.It Sx \&Sx Ta Yes Ta Yes Ta >0 |
.It \&Sy Ta Yes Ta Yes Ta >0 |
.It Sx \&Sy Ta Yes Ta Yes Ta >0 |
.It \&Tn Ta Yes Ta Yes Ta >0 |
.It Sx \&Tn Ta Yes Ta Yes Ta >0 |
.It \&Ud Ta \&No Ta \&No Ta 0 |
.It Sx \&Ud Ta \&No Ta \&No Ta 0 |
.It \&Ux Ta Yes Ta Yes Ta n |
.It Sx \&Ux Ta Yes Ta Yes Ta n |
.It \&Va Ta Yes Ta Yes Ta n |
.It Sx \&Va Ta Yes Ta Yes Ta n |
.It \&Vt Ta Yes Ta Yes Ta >0 |
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
.It \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
. |
. |
. |
. |
Line 597 alphabetically. For the scoping of individual macros, |
|
Line 878 alphabetically. For the scoping of individual macros, |
|
Author name of an |
Author name of an |
.Sx \&Rs |
.Sx \&Rs |
block. Multiple authors should each be accorded their own |
block. Multiple authors should each be accorded their own |
.Sq \%%A |
.Sx \%%A |
line. |
line. Author names should be ordered with full or abbreviated |
.Pp |
forename(s) first, then full surname. |
Author names should be ordered with full or abbreviated forename(s) |
. |
first, then full surname. |
|
.Ss \&%B |
.Ss \&%B |
Book title of an |
Book title of an |
.Sx \&Rs |
.Sx \&Rs |
block. This macro may also be used in a non-bibliographic context when |
block. This macro may also be used in a non-bibliographic context when |
referring to book titles. |
referring to book titles. |
|
. |
.Ss \&%C |
.Ss \&%C |
Publication city or location of an |
Publication city or location of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
.Pp |
.Pp |
.Em Compatibility remark : |
.Em Remarks : |
this macro is not implemented in |
this macro is not implemented in |
.Xr groff 1 . |
.Xr groff 1 . |
|
. |
.Ss \&%D |
.Ss \&%D |
Publication date of an |
Publication date of an |
.Sx \&Rs |
.Sx \&Rs |
block. This should follow the canonical syntax for |
block. This should follow the reduced or canonical form syntax |
|
described in |
.Sx Dates . |
.Sx Dates . |
|
. |
.Ss \&%I |
.Ss \&%I |
Publisher or issuer name of an |
Publisher or issuer name of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%J |
.Ss \&%J |
Journal name of an |
Journal name of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%N |
.Ss \&%N |
Issue number (usually for journals) of an |
Issue number (usually for journals) of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%O |
.Ss \&%O |
Optional information of an |
Optional information of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%P |
.Ss \&%P |
Book or journal page number of an |
Book or journal page number of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%Q |
.Ss \&%Q |
Institutional author (school, government, etc.) of an |
Institutional author (school, government, etc.) of an |
.Sx \&Rs |
.Sx \&Rs |
block. Multiple institutional authors should each be accorded their own |
block. Multiple institutional authors should each be accorded their own |
.Sq \&%Q |
.Sx \&%Q |
line. |
line. |
|
. |
.Ss \&%R |
.Ss \&%R |
Technical report name of an |
Technical report name of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&%T |
.Ss \&%T |
Article title of an |
Article title of an |
.Sx \&Rs |
.Sx \&Rs |
block. This macro may also be used in a non-bibliographical context |
block. This macro may also be used in a non-bibliographical context |
when referring to article titles. |
when referring to article titles. |
|
. |
|
.Ss \&%U |
|
URI of reference document. |
|
. |
.Ss \&%V |
.Ss \&%V |
Volume number of an |
Volume number of an |
.Sx \&Rs |
.Sx \&Rs |
block. |
block. |
|
. |
.Ss \&Ac |
.Ss \&Ac |
Closes an |
Closes an |
.Sx \&Ao |
.Sx \&Ao |
block. Does not have any tail arguments. |
block. Does not have any tail arguments. |
|
. |
.Ss \&Ad |
.Ss \&Ad |
Address construct: usually in the context of an computational address in |
Address construct: usually in the context of an computational address in |
memory, not a physical (post) address. |
memory, not a physical (post) address. |
.Pp |
.Pp |
Example: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Ad [0,$] |
\&.Ad [0,$] |
\&.Ad 0x00000000 |
\&.Ad 0x00000000 |
.Ed |
.Ed |
|
. |
.Ss \&An |
.Ss \&An |
|
Author name. This macro may alternatively accepts the following |
|
arguments, although these may not be specified along with a parameter: |
|
.Bl -tag -width 12n -offset indent |
|
.It Fl split |
|
Renders a line break before each author listing. |
|
.It Fl nosplit |
|
The opposite of |
|
.Fl split . |
|
.El |
|
.Pp |
|
In the AUTHORS section, the default is not to split the first author |
|
listing, but all subsequent author listings, whether or not they're |
|
interspersed by other macros or text, are split. Thus, specifying |
|
.Fl split |
|
will cause the first listing also to be split. If not in the AUTHORS |
|
section, the default is not to split. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.An -nosplit |
|
\&.An J. E. Hopcraft , |
|
\&.An J. D. Ullman . |
|
.Ed |
|
.Pp |
|
.Em Remarks : |
|
the effects of |
|
.Fl split |
|
or |
|
.Fl nosplit |
|
are re-set when entering the AUTHORS section, so if one specifies |
|
.Sx \&An Fl nosplit |
|
in the general document body, it must be re-specified in the AUTHORS |
|
section. |
|
. |
.Ss \&Ao |
.Ss \&Ao |
Begins a block enclosed by angled brackets. Does not have any head |
Begins a block enclosed by angled brackets. Does not have any head |
arguments. |
arguments. |
.Pp |
.Pp |
Example: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Fl -key= Ns Ao Ar val Ac |
\&.Fl -key= Ns Ao Ar val Ac |
.Ed |
.Ed |
.Pp |
.Pp |
Note that, although this is overwhelmingly used to note URIs, the |
See also |
.Sx \&Lk |
.Sx \&Aq . |
and |
. |
.Sx \&Mt |
|
macros are better suited for this purpose. |
|
.Ss \&Ap |
.Ss \&Ap |
|
Inserts an apostrophe without any surrounding white-space. This is |
|
generally used as a grammatic device when referring to the verb form of |
|
a function: |
|
.Bd -literal -offset indent |
|
\&.Fn execve Ap d |
|
.Ed |
|
. |
.Ss \&Aq |
.Ss \&Aq |
|
Encloses its arguments in angled brackets. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Fl -key= Ns Aq Ar val |
|
.Ed |
|
.Pp |
|
.Em Remarks : |
|
this macro is often abused for rendering URIs, which should instead use |
|
.Sx \&Lk |
|
or |
|
.Sx \&Mt , |
|
or to note pre-processor |
|
.Dq Li #include |
|
statements, which should use |
|
.Sx \&In . |
|
.Pp |
|
See also |
|
.Sx \&Ao . |
|
. |
.Ss \&Ar |
.Ss \&Ar |
|
Command arguments. If an argument is not provided, the string |
|
.Dq file ... |
|
is used as a default. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Fl o Ns Ar file1 |
|
\&.Ar |
|
\&.Ar arg1 , arg2 . |
|
.Ed |
|
. |
.Ss \&At |
.Ss \&At |
|
Formats an AT&T version. Accepts at most one parameter: |
|
.Bl -tag -width 12n -offset indent |
|
.It Cm v[1-7] | 32v |
|
A version of |
|
.At . |
|
.It Cm V[.[1-4]]? |
|
A system version of |
|
.At . |
|
.El |
|
.Pp |
|
Note that these parameters do not begin with a hyphen. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.At |
|
\&.At V.1 |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Bc |
.Ss \&Bc |
|
Closes a |
|
.Sx \&Bo |
|
block. Does not have any tail arguments. |
|
. |
.Ss \&Bd |
.Ss \&Bd |
|
Begins a display block. A display is collection of macros or text which |
|
may be collectively offset or justified in a manner different from that |
|
of the enclosing context. By default, the block is preceded by a |
|
vertical space. |
|
.Pp |
|
Each display is associated with a type, which must be one of the |
|
following arguments: |
|
.Bl -tag -width 12n -offset indent |
|
.It Fl ragged |
|
Only left-justify the block. |
|
.It Fl unfilled |
|
Do not justify the block at all. |
|
.It Fl filled |
|
Left- and right-justify the block. |
|
.It Fl literal |
|
Alias for |
|
.Fl unfilled . |
|
.It Fl centered |
|
Centre-justify each line. |
|
.El |
|
.Pp |
|
The type must be provided first. Secondary arguments are as follows: |
|
.Bl -tag -width 12n -offset indent |
|
.It Fl offset Ar width |
|
Offset by the value of |
|
.Ar width , |
|
which is interpreted as one of the following, specified in order: |
|
.Bl -item |
|
.It |
|
As one of the pre-defined strings |
|
.Ar indent , |
|
the width of standard indentation; |
|
.Ar indent-two , |
|
twice |
|
.Ar indent ; |
|
.Ar left , |
|
which has no effect ; |
|
.Ar right , |
|
which justifies to the right margin; and |
|
.Ar center , |
|
which aligns around an imagined centre axis. |
|
.It |
|
As a precalculated width for a named macro. The most popular is the |
|
imaginary macro |
|
.Ar \&Ds , |
|
which resolves to |
|
.Ar 6n . |
|
.It |
|
As a scaling unit following the syntax described in |
|
.Sx Scaling Widths . |
|
.It |
|
As the calculated string length of the opaque string. |
|
.El |
|
.Pp |
|
If unset, it will revert to the value of |
|
.Ar 8n |
|
as described in |
|
.Sx Scaling Widths . |
|
.It Fl compact |
|
Do not assert a vertical space before the block. |
|
.It Fl file Ar file |
|
Prepend the file |
|
.Ar file |
|
before any text or macros within the block. |
|
.El |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bd \-unfilled \-offset two-indent \-compact |
|
Hello world. |
|
\&.Ed |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&D1 |
|
and |
|
.Sx \&Dl . |
|
. |
.Ss \&Bf |
.Ss \&Bf |
.Ss \&Bk |
.Ss \&Bk |
.Ss \&Bl |
.Ss \&Bl |
|
.\" Begins a list composed of one or more list entries. A list entry is |
|
.\" specified by the |
|
.\" .Sx \&It |
|
.\" macro, which consists of a head and optional body. By default, a list |
|
.\" is preceded by a blank line. A list must specify one of the following |
|
.\" list types: |
|
.\" .Bl -tag -width 12n |
|
.\" .It Fl bullet |
|
.\" A list offset by a bullet. The head of list entries must be empty. |
|
.\" List entry bodies are justified after the bullet. |
|
.\" .It Fl column |
|
.\" A columnated list. The number of columns is specified as arguments to |
|
.\" the |
|
.\" .Sx \&Bl |
|
.\" macro (the deprecated form of following the invocation of |
|
.\" .Fl column |
|
.\" is also accepted). Arguments dictate the width of columns specified in |
|
.\" list entries. List entry bodies must be left empty. Columns specified |
|
.\" in the list entry head are justified to their position in the sequence |
|
.\" of columns. |
|
.\" .It Fl dash |
|
.\" A list offset by a dash (hyphen). The head of list entries must be |
|
.\" empty. List entry bodies are justified past the dash. |
|
.\" .It Fl diag |
|
.\" Like |
|
.\" .Fl inset |
|
.\" lists, but with additional formatting to the head. |
|
.\" .It Fl enum |
|
.\" A list offset by a number indicating list entry position. The head of |
|
.\" list entries must be empty. List entry bodies are justified past the |
|
.\" enumeration. |
|
.\" .It Fl hang |
|
.\" Like |
|
.\" .Fl tag , |
|
.\" but instead of list bodies justifying to the head on the first line, |
|
.\" they trail the head text. |
|
.\" .It Fl hyphen |
|
.\" Synonym for |
|
.\" .Fl dash . |
|
.\" .It Fl inset |
|
.\" Like |
|
.\" .Fl tag , |
|
.\" but list entry bodies aren't justified. |
|
.\" .It Fl item |
|
.\" An un-justified list. This produces blocks of text. |
|
.\" .It Fl ohang |
|
.\" List bodies are placed on the line following the head. |
|
.\" .It Fl tag |
|
.\" A list offset by list entry heads. List entry bodies are justified |
|
.\" after the head. |
|
.\" .El |
|
.\" .Pp |
|
.\" More... |
|
.\" . |
.Ss \&Bo |
.Ss \&Bo |
|
Begins a block enclosed by square brackets. Does not have any head |
|
arguments. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bo 1 , |
|
\&.Dv BUFSIZ Bc |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Bq . |
|
. |
.Ss \&Bq |
.Ss \&Bq |
|
Encloses its arguments in square brackets. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bq 1 , Dv BUFSIZ |
|
.Ed |
|
.Pp |
|
.Em Remarks : |
|
this macro is sometimes abused to emulate optional arguments for |
|
commands; the correct macros to use for this purpose are |
|
.Sx \&Op , |
|
.Sx \&Oo , |
|
and |
|
.Sx \&Oc . |
|
.Pp |
|
See also |
|
.Sx \&Bo . |
|
. |
.Ss \&Brc |
.Ss \&Brc |
|
Closes a |
|
.Sx \&Bro |
|
block. Does not have any tail arguments. |
|
. |
.Ss \&Bro |
.Ss \&Bro |
|
Begins a block enclosed by curly braces. Does not have any head |
|
arguments. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bro 1 , ... , |
|
\&.Va n Brc |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Brq . |
|
. |
.Ss \&Brq |
.Ss \&Brq |
|
Encloses its arguments in curly braces. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Brq 1 , ... , Va n |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Bro . |
|
. |
.Ss \&Bsx |
.Ss \&Bsx |
|
Format the BSD/OS version provided as an argument, or a default value if |
|
no argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bsx 1.0 |
|
\&.Bsx |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Bt |
.Ss \&Bt |
|
Prints |
|
.Dq is currently in beta test. |
|
. |
.Ss \&Bx |
.Ss \&Bx |
|
Format the BSD version provided as an argument, or a default value if no |
|
argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bx 4.4 |
|
\&.Bx |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Cd |
.Ss \&Cd |
|
Configuration declaration (suggested for use only in section four |
|
manuals). This denotes strings accepted by |
|
.Xr config 8 . |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Cd device le0 at scode? |
|
.Ed |
|
.Pp |
|
.Em Remarks : |
|
this macro is commonly abused by using quoted literals to retain |
|
white-space and align consecutive |
|
.Sx \&Cd |
|
declarations. This practise is discouraged. |
|
. |
.Ss \&Cm |
.Ss \&Cm |
|
Command modifiers. Useful when specifying configuration options or |
|
keys. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Cm ControlPath |
|
\&.Cm ControlMaster |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Fl . |
|
. |
.Ss \&D1 |
.Ss \&D1 |
|
One-line indented display. This is formatted by the default rules and |
|
is useful for simple indented statements. It is followed by a newline. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.D1 Fl abcdefgh |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Bd |
|
and |
|
.Sx \&Dl . |
|
. |
.Ss \&Db |
.Ss \&Db |
.Ss \&Dc |
.Ss \&Dc |
|
Closes a |
|
.Sx \&Do |
|
block. Does not have any tail arguments. |
|
. |
.Ss \&Dd |
.Ss \&Dd |
|
Document date. This is the mandatory first macro of any |
|
.Nm |
|
manual. Its calling syntax is as follows: |
|
.Pp |
|
.D1 \. Ns Sx \&Dd Cm date |
|
.Pp |
|
The |
|
.Cm date |
|
field may be either |
|
.Ar $\&Mdocdate$ , |
|
which signifies the current manual revision date dictated by |
|
.Xr cvs 1 , |
|
or instead a valid canonical date as specified by |
|
.Sx Dates . |
|
If a date does not conform, the current date is used instead. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dd $\&Mdocdate$ |
|
\&.Dd $\&Mdocdate: July 21 2007$ |
|
\&.Dd July 21, 2007 |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Dt |
|
and |
|
.Sx \&Os . |
|
. |
.Ss \&Dl |
.Ss \&Dl |
|
One-line intended display. This is formatted as literal text and is |
|
useful for commands and invocations. It is followed by a newline. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dl % mandoc mdoc.7 | less |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Bd |
|
and |
|
.Sx \&D1 . |
|
. |
.Ss \&Do |
.Ss \&Do |
|
Begins a block enclosed by double quotes. Does not have any head |
|
arguments. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Dq . |
|
. |
.Ss \&Dq |
.Ss \&Dq |
|
Encloses its arguments in double quotes. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dq April is the cruellest month |
|
\e(em T.S. Eliot |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Do . |
|
. |
.Ss \&Dt |
.Ss \&Dt |
|
Document title. This is the mandatory second macro of any |
|
.Nm |
|
file. Its calling syntax is as follows: |
|
.Pp |
|
.D1 \. Ns Sx \&Dt Cm title section Op Cm volume | arch |
|
.Pp |
|
Its arguments are as follows: |
|
.Bl -tag -width Ds -offset Ds |
|
.It Cm title |
|
The document's title (name). This should be capitalised and is |
|
required. |
|
.It Cm section |
|
The manual section. This may be one of |
|
.Ar 1 |
|
.Pq utilities , |
|
.Ar 2 |
|
.Pq system calls , |
|
.Ar 3 |
|
.Pq libraries , |
|
.Ar 3p |
|
.Pq Perl libraries , |
|
.Ar 4 |
|
.Pq devices , |
|
.Ar 5 |
|
.Pq file formats , |
|
.Ar 6 |
|
.Pq games , |
|
.Ar 7 |
|
.Pq miscellaneous , |
|
.Ar 8 |
|
.Pq system utilities , |
|
.Ar 9 |
|
.Pq kernel functions , |
|
.Ar X11 |
|
.Pq X Window System , |
|
.Ar X11R6 |
|
.Pq X Window System , |
|
.Ar unass |
|
.Pq unassociated , |
|
.Ar local |
|
.Pq local system , |
|
.Ar draft |
|
.Pq draft manual , |
|
or |
|
.Ar paper |
|
.Pq paper . |
|
It is also required and should correspond to the manual's filename |
|
suffix. |
|
.It Cm volume |
|
This overrides the volume inferred from |
|
.Ar section . |
|
This field is optional, and if specified, must be one of |
|
.Ar USD |
|
.Pq users' supplementary documents , |
|
.Ar PS1 |
|
.Pq programmers' supplementary documents , |
|
.Ar AMD |
|
.Pq administrators' supplementary documents , |
|
.Ar SMM |
|
.Pq system managers' manuals , |
|
.Ar URM |
|
.Pq users' reference manuals , |
|
.Ar PRM |
|
.Pq programmers' reference manuals , |
|
.Ar KM |
|
.Pq kernel manuals , |
|
.Ar IND |
|
.Pq master index , |
|
.Ar MMI |
|
.Pq master index , |
|
.Ar LOCAL |
|
.Pq local manuals , |
|
.Ar LOC |
|
.Pq local manuals , |
|
or |
|
.Ar CON |
|
.Pq contributed manuals . |
|
.It Cm arch |
|
This specifies a specific relevant architecture. If |
|
.Cm volume |
|
is not provided, it may be used in its place, else it may be used |
|
subsequent that. It, too, is optional. It must be one of |
|
.Ar alpha , |
|
.Ar amd64 , |
|
.Ar amiga , |
|
.Ar arc , |
|
.Ar arm , |
|
.Ar armish , |
|
.Ar aviion , |
|
.Ar hp300 , |
|
.Ar hppa , |
|
.Ar hppa64 , |
|
.Ar i386 , |
|
.Ar landisk , |
|
.Ar luna88k , |
|
.Ar mac68k , |
|
.Ar macppc , |
|
.Ar mvme68k , |
|
.Ar mvme88k , |
|
.Ar mvmeppc , |
|
.Ar pmax , |
|
.Ar sgi , |
|
.Ar socppc , |
|
.Ar sparc , |
|
.Ar sparc64 , |
|
.Ar sun3 , |
|
.Ar vax , |
|
or |
|
.Ar zaurus . |
|
.El |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dt FOO 1 |
|
\&.Dt FOO 4 KM |
|
\&.Dt FOO 9 i386 |
|
\&.Dt FOO 9 KM i386 |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Dd |
|
and |
|
.Sx \&Os . |
|
. |
.Ss \&Dv |
.Ss \&Dv |
|
Defined variables such as preprocessor constants. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dv BUFSIZ |
|
\&.Dv STDOUT_FILENO |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Er . |
|
. |
.Ss \&Dx |
.Ss \&Dx |
|
Format the DragonFly BSD version provided as an argument, or a default |
|
value if no argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Dx 2.4.1 |
|
\&.Dx |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Ec |
.Ss \&Ec |
.Ss \&Ed |
.Ss \&Ed |
.Ss \&Ef |
.Ss \&Ef |
.Ss \&Ek |
.Ss \&Ek |
.Ss \&El |
.Ss \&El |
.Ss \&Em |
.Ss \&Em |
|
Denotes text that should be emphasised. Note that this is a |
|
presentation term and should not be used for stylistically decorating |
|
technical terms. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Ed Warnings! |
|
\&.Ed Remarks : |
|
.Ed |
|
. |
.Ss \&En |
.Ss \&En |
.Ss \&Eo |
.Ss \&Eo |
.Ss \&Er |
.Ss \&Er |
|
Error constants (suggested for use only in section two manuals). |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Er EPERM |
|
\&.Er ENOENT |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Dv . |
|
. |
.Ss \&Es |
.Ss \&Es |
|
. |
.Ss \&Ev |
.Ss \&Ev |
|
Environmental variables such as those specified in |
|
.Xr environ 7 . |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Ev DISPLAY |
|
\&.Ev PATH |
|
.Ed |
|
. |
.Ss \&Ex |
.Ss \&Ex |
|
Inserts text regarding a utility's exit values. This macro must have |
|
first the |
|
.Fl std |
|
argument specified, then an optional |
|
.Ar utility . |
|
If |
|
.Ar utility |
|
is not provided, the document's name as stipulated in |
|
.Sx \&Nm |
|
is provided. |
.Ss \&Fa |
.Ss \&Fa |
.Ss \&Fc |
.Ss \&Fc |
.Ss \&Fd |
.Ss \&Fd |
.Ss \&Fl |
.Ss \&Fl |
|
Command-line flag. Used when listing arguments to command-line |
|
utilities. Prints a fixed-width hyphen |
|
.Sq \- |
|
before each delimited argument. If no arguments are provided, a hyphen |
|
is still printed. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Fl a b c |
|
\&.Fl |
|
\&.Op Fl o Ns Ar file |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Cm . |
|
. |
.Ss \&Fn |
.Ss \&Fn |
.Ss \&Fo |
.Ss \&Fo |
.Ss \&Fr |
.Ss \&Fr |
.Ss \&Ft |
.Ss \&Ft |
.Ss \&Fx |
.Ss \&Fx |
|
Format the FreeBSD version provided as an argument, or a default value |
|
if no argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Fx 7.1 |
|
\&.Fx |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Hf |
.Ss \&Hf |
.Ss \&Ic |
.Ss \&Ic |
.Ss \&In |
.Ss \&In |
Line 744 macros are better suited for this purpose. |
|
Line 1710 macros are better suited for this purpose. |
|
.Ss \&Lb |
.Ss \&Lb |
.Ss \&Li |
.Ss \&Li |
.Ss \&Lk |
.Ss \&Lk |
|
Format a hyperlink. The calling syntax is as follows: |
|
.Pp |
|
.D1 \. Ns Sx \&Lk Cm uri Op Cm name |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Lk http://bsd.lv "The BSD.lv Project" |
|
\&.Lk http://bsd.lv |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Mt . |
|
. |
.Ss \&Lp |
.Ss \&Lp |
.Ss \&Ms |
.Ss \&Ms |
.Ss \&Mt |
.Ss \&Mt |
Line 752 macros are better suited for this purpose. |
|
Line 1731 macros are better suited for this purpose. |
|
.Ss \&No |
.Ss \&No |
.Ss \&Ns |
.Ss \&Ns |
.Ss \&Nx |
.Ss \&Nx |
|
Format the NetBSD version provided as an argument, or a default value if |
|
no argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Nx 5.01 |
|
\&.Nx |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Oc |
.Ss \&Oc |
.Ss \&Oo |
.Ss \&Oo |
.Ss \&Op |
.Ss \&Op |
.Ss \&Os |
.Ss \&Os |
|
Document operating system version. This is the mandatory third macro of |
|
any |
|
.Nm |
|
file. Its calling syntax is as follows: |
|
.Pp |
|
.D1 \. Ns Sx \&Os Op Cm system |
|
.Pp |
|
The optional |
|
.Cm system |
|
parameter specifies the relevant operating system or environment. Left |
|
unspecified, it defaults to the local operating system version. This is |
|
the suggested form. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Os |
|
\&.Os KTH/CSC/TCS |
|
\&.Os BSD 4.3 |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Dd |
|
and |
|
.Sx \&Dt . |
|
. |
.Ss \&Ot |
.Ss \&Ot |
|
Unknown usage. |
|
.Pp |
|
.Em Remarks : |
|
this macro has been deprecated. |
|
. |
.Ss \&Ox |
.Ss \&Ox |
|
Format the OpenBSD version provided as an argument, or a default value |
|
if no argument is provided. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Ox 4.5 |
|
\&.Ox |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
and |
|
.Sx \&Ux . |
|
. |
.Ss \&Pa |
.Ss \&Pa |
.Ss \&Pc |
.Ss \&Pc |
.Ss \&Pf |
.Ss \&Pf |
Line 768 macros are better suited for this purpose. |
|
Line 1815 macros are better suited for this purpose. |
|
.Ss \&Ql |
.Ss \&Ql |
.Ss \&Qo |
.Ss \&Qo |
.Ss \&Qq |
.Ss \&Qq |
|
. |
.Ss \&Re |
.Ss \&Re |
Closes a |
Closes a |
.Sx \&Rs |
.Sx \&Rs |
block. Does not have any tail arguments. |
block. Does not have any tail arguments. |
|
. |
.Ss \&Rs |
.Ss \&Rs |
Begins a bibliographic |
Begins a bibliographic |
.Pq Dq reference |
.Pq Dq reference |
block. Does not have any head arguments. The block macro and may only |
block. Does not have any head arguments. The block macro may only |
contain |
contain |
.Sx \&%A , |
.Sx \&%A , |
.Sx \&%B , |
.Sx \&%B , |
|
|
.Sx \&%V |
.Sx \&%V |
child macros (at least one must be specified). |
child macros (at least one must be specified). |
.Pp |
.Pp |
Example: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Rs |
\&.Rs |
\&.%A J. E. Hopcroft |
\&.%A J. E. Hopcroft |
|
|
block is used within a SEE ALSO section, a vertical space is asserted |
block is used within a SEE ALSO section, a vertical space is asserted |
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 |
.Ss \&Sc |
.Ss \&Sc |
.Ss \&Sh |
.Ss \&Sh |
|
|
.Ss \&Tn |
.Ss \&Tn |
.Ss \&Ud |
.Ss \&Ud |
.Ss \&Ux |
.Ss \&Ux |
|
Format the UNIX name. Accepts no argument. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Ux |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
and |
|
.Sx \&Ox . |
|
. |
.Ss \&Va |
.Ss \&Va |
.Ss \&Vt |
.Ss \&Vt |
.Ss \&Xc |
.Ss \&Xc |
|
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
In |
|
.Xr groff 1 , |
|
the |
|
.Sx \&Pa |
|
macro does not format its arguments when used in the FILES section under |
|
certain list types. This irregular behaviour has been discontinued. |
|
.It |
|
Historic |
|
.Xr groff 1 |
|
does not print a dash for empty |
|
.Sx \&Fl |
|
arguments. This behaviour has been discontinued. |
|
.It |
|
.Xr groff 1 |
|
behaves strangely (even between versions) when specifying |
|
.Sq \ef |
|
escapes within line-macro scopes. These aberrations have been |
|
normalised. |
|
.It |
Negative scaling units are now truncated to zero instead of creating |
Negative scaling units are now truncated to zero instead of creating |
interesting conditions, such as with |
interesting conditions, such as with |
.Sq \&sp -1i . |
.Sx \&sp |
|
.Fl 1i . |
Furthermore, the |
Furthermore, the |
.Sq f |
.Sq f |
scaling unit, while accepted, is rendered as the default unit. |
scaling unit, while accepted, is rendered as the default unit. |
.It |
.It |
The |
|
.Sq \-split |
|
or |
|
.Sq \-nosplit |
|
argument to |
|
.Sq \&An |
|
applies to the whole document, not just to the current section as it |
|
does in groff. |
|
.It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
standalone double-quote in formatted output. This idiosyncratic |
standalone double-quote in formatted output. This idiosyncratic |
behaviour is no longer applicable. |
behaviour is no longer applicable. |
.It |
.It |
|
Display types |
|
.Sx \&Bd |
|
.Fl center |
|
and |
|
.Fl right |
|
are aliases for |
|
.Fl left . |
The |
The |
.Sq \&sp |
.Fl file Ar file |
macro does not accept negative numbers. |
argument is ignored. Since text is not right-justified, |
|
.Fl ragged |
|
and |
|
.Fl filled |
|
are aliases, as are |
|
.Fl literal |
|
and |
|
.Fl unfilled . |
.It |
.It |
Blocks of whitespace are stripped from both macro and free-form text |
Blocks of whitespace are stripped from both macro and free-form text |
lines (except when in literal mode), while groff would retain whitespace |
lines (except when in literal mode), while groff would retain whitespace |
Line 884 made historic groff |
|
Line 1976 made historic groff |
|
.Qq go orbital |
.Qq go orbital |
but is a proper delimiter in this implementation. |
but is a proper delimiter in this implementation. |
.It |
.It |
.Sq \&It \-nested |
.Sx \&It |
|
.Fl nested |
is assumed for all lists (it wasn't in historic groff): any list may be |
is assumed for all lists (it wasn't in historic groff): any list may be |
nested and |
nested and |
.Sq \-enum |
.Fl enum |
lists will restart the sequence only for the sub-list. |
lists will restart the sequence only for the sub-list. |
.It |
.It |
.Sq \&It \-column |
|
syntax where column widths may be preceded by other arguments (instead |
|
of proceeded) is not supported. |
|
.It |
|
The |
|
.Sq \&At |
|
macro only accepts a single parameter. |
|
.It |
|
Some manuals use |
Some manuals use |
.Sq \&Li |
.Sx \&Li |
incorrectly by following it with a reserved character and expecting the |
incorrectly by following it with a reserved character and expecting the |
delimiter to render. This is not supported. |
delimiter to render. This is not supported. |
.It |
.It |
In groff, the |
In groff, the |
.Sq \&Fo |
.Sx \&Fo |
macro only produces the first parameter. This is no longer the case. |
macro only produces the first parameter. This is no longer the case. |
.El |
.El |
. |
. |
|
|
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
. |
.\" |
. |
.\" XXX: this really isn't the place for these caveats. |
.Sh CAVEATS |
.\" . |
There are many ambiguous parts of mdoc. |
.\" . |
. |
.\" .Sh CAVEATS |
.Pp |
.\" There are many ambiguous parts of mdoc. |
.Bl -dash -compact |
.\" . |
.It |
.\" .Pp |
.Sq \&Fa |
.\" .Bl -dash -compact |
should be |
.\" .It |
.Sq \&Va |
.\" .Sq \&Fa |
as function arguments are variables. |
.\" should be |
.It |
.\" .Sq \&Va |
.Sq \&Ft |
.\" as function arguments are variables. |
should be |
.\" .It |
.Sq \&Vt |
.\" .Sq \&Ft |
as function return types are still types. Furthermore, the |
.\" should be |
.Sq \&Ft |
.\" .Sq \&Vt |
should be removed and |
.\" as function return types are still types. Furthermore, the |
.Sq \&Fo , |
.\" .Sq \&Ft |
which ostensibly follows it, should follow the same convention as |
.\" should be removed and |
.Sq \&Va . |
.\" .Sq \&Fo , |
.It |
.\" which ostensibly follows it, should follow the same convention as |
.Sq \&Va |
.\" .Sq \&Va . |
should formalise that only one or two arguments are acceptable: a |
.\" .It |
variable name and optional, preceding type. |
.\" .Sq \&Va |
.It |
.\" should formalise that only one or two arguments are acceptable: a |
.Sq \&Fd |
.\" variable name and optional, preceding type. |
is ambiguous. It's commonly used to indicate an include file in the |
.\" .It |
synopsis section. |
.\" .Sq \&Fd |
.Sq \&In |
.\" is ambiguous. It's commonly used to indicate an include file in the |
should be used, instead. |
.\" synopsis section. |
.It |
.\" .Sq \&In |
Only the |
.\" should be used, instead. |
.Sq \-literal |
.\" .It |
argument to |
.\" Only the |
.Sq \&Bd |
.\" .Sq \-literal |
makes sense. The remaining ones should be removed. |
.\" argument to |
.It |
.\" .Sq \&Bd |
The |
.\" makes sense. The remaining ones should be removed. |
.Sq \&Xo |
.\" .It |
and |
.\" The |
.Sq \&Xc |
.\" .Sq \&Xo |
macros should be deprecated. |
.\" and |
.It |
.\" .Sq \&Xc |
The |
.\" macros should be deprecated. |
.Sq \&Dt |
.\" .It |
macro lacks clarity. It should be absolutely clear which title will |
.\" The |
render when formatting the manual page. |
.\" .Sq \&Dt |
.It |
.\" macro lacks clarity. It should be absolutely clear which title will |
A |
.\" render when formatting the manual page. |
.Sq \&Lx |
.\" .It |
should be provided for Linux (\(`a la |
.\" A |
.Sq \&Ox , |
.\" .Sq \&Lx |
.Sq \&Nx |
.\" should be provided for Linux (\(`a la |
etc.). |
.\" .Sq \&Ox , |
.It |
.\" .Sq \&Nx |
There's no way to refer to references in |
.\" etc.). |
.Sq \&Rs/Re |
.\" .It |
blocks. |
.\" There's no way to refer to references in |
.It |
.\" .Sq \&Rs/Re |
The \-split and \-nosplit dictates via |
.\" blocks. |
.Sq \&An |
.\" .It |
are re-set when entering and leaving the AUTHORS section. |
.\" The \-split and \-nosplit dictates via |
.El |
.\" .Sq \&An |
. |
.\" are re-set when entering and leaving the AUTHORS section. |
|
.\" .El |
|
.\" . |