version 1.13, 2009/03/22 08:52:27 |
version 1.125, 2010/06/12 10:09:19 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdoc 7 |
.Dt MDOC 7 |
.Os |
.Os |
.\" SECTION |
|
.Sh NAME |
.Sh NAME |
.Nm mdoc |
.Nm mdoc |
.Nd mdoc macro reference |
.Nd mdoc language reference |
.\" SECTION |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm mdoc |
.Nm mdoc |
language is used to format |
language is used to format |
.Bx |
.Bx |
.Ux |
.Ux |
manuals. In this reference document, we describe the syntax, ontology |
manuals. In this reference document, we describe its syntax, structure, |
and structure of the |
and usage. Our reference implementation is mandoc; the |
.Nm |
.Sx COMPATIBILITY |
language. |
section describes compatibility with other troff \-mdoc implementations. |
.\" PARAGRAPH |
|
.Pp |
.Pp |
An |
An |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
.Sq \. |
.Sq \. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. Other lines are interpreted within the scope of |
prior macros: |
prior macros: |
.Bd -literal -offset XXX |
.Bd -literal -offset indent |
\&.Sh Macro lines change control state. |
\&.Sh Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
.Ed |
.\" PARAGRAPH |
.Sh LANGUAGE SYNTAX |
.Pp |
|
Macros are two- or three-character sequences whose scope rules, rules |
|
that dictate handling of subsequent-line or same-line arguments, are |
|
governed by one of five classifications described in this document. |
|
.\" SECTION |
|
.Sh INPUT ENCODING |
|
.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 |
character, and, in certain circumstances, the tab character. All |
.Sq \ , |
manuals must have |
and, in certain circumstances, the tab character |
.Ux |
.Sq \et . |
line terminators. |
All manuals must have |
.Ss Comments |
.Sq \en |
Text following a |
line termination. |
.Sq \e" , |
.Pp |
whether in a macro or free-form text line, is ignored to the end of |
The only time a blank line is acceptable is within |
line. A macro line with only a control character and comment escape, |
the context of |
.Sq \&.\e" , |
.Sq \&Bd \-literal |
is also ignored. Macro lines with only a control character and optionally |
or |
whitespace are stripped from input. |
.Sq \&Bd \-unfilled . |
|
.Pp |
|
Tab characters |
|
.Pq \et |
|
are only acceptable when delimiting |
|
.Sq \&Bl \-column |
|
and in |
|
.Sq \&Bd \-literal |
|
or |
|
.Sq \&Bd \-unfilled |
|
contexts. |
|
.\" SUB-SECTION |
|
.Ss Reserved Characters |
.Ss Reserved Characters |
Within a macro line, the following characters are reserved: |
Within a macro line, the following characters are reserved: |
.Bl -tag -width 12n -offset XXXX -compact |
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
.It \&. |
.It \&. |
.Pq period |
.Pq period |
.It \&, |
.It \&, |
Line 102 Within a macro line, the following characters are rese |
|
Line 80 Within a macro line, the following characters are rese |
|
.It \&? |
.It \&? |
.Pq question |
.Pq question |
.It \&! |
.It \&! |
.Pq exclamation |
.Pq exclamation |
|
.It \&| |
|
.Pq vertical bar |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Use of reserved characters is described in |
Use of reserved characters is described in |
.Sx Closure . |
.Sx MACRO SYNTAX . |
For general non-reserved use, characters must either be escaped with a |
For general use in macro lines, these characters must either be escaped |
non-breaking space |
with a non-breaking space |
.Pq Sq \e& |
.Pq Sq \e& |
or, if applicable, an appropriate escape-sequence used. |
or, if applicable, an appropriate escape sequence used. |
.\" SUB-SECTION |
|
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special characters may occur in both macro and free-form lines. |
.Sq \\ |
Sequences begin with the escape character |
followed by either an open-parenthesis |
.Sq \e |
|
followed by either an open-parenthesis |
.Sq \&( |
.Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
.Sq \&[ |
.Sq \&[ |
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. |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. |
|
Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
.Ss Text Decoration |
|
Terms may be text-decorated using the |
|
.Sq \ef |
|
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
|
(revert to previous mode): |
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
.D1 \efBbold\efR \efIitalic\efP |
.Sq \\* , |
|
with the same combinations as described above. This form is deprecated. |
|
.Pp |
.Pp |
The following is a table of all available escapes. |
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 |
.Pp |
Grammatic: |
Text may also be sized with the |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \es |
.It \\(em |
escape, whose syntax is one of |
.Pq em-dash |
.Sq \es+-n |
.It \\(en |
for one-digit numerals; |
.Pq en-dash |
.Sq \es(+-nn |
.It \e- |
or |
.Pq hyphen |
.Sq \es+-(nn |
.It \\\\ |
for two-digit numerals; and |
.Pq back-slash |
.Sq \es[+-N] , |
.It \e' |
.Sq \es+-[N] , |
.Pq apostrophe |
.Sq \es'+-N' , |
.It \e` |
or |
.Pq back-tick |
.Sq \es+-'N' |
.It \\ |
for arbitrary-digit numerals: |
.Pq space |
.Pp |
.It \\. |
.D1 \es+1bigger\es-1 |
.Pq period |
.D1 \es[+10]much bigger\es[-10] |
.It \\(r! |
.D1 \es+(10much bigger\es-(10 |
.Pq upside-down exclamation |
.D1 \es+'100'much much bigger\es-'100' |
.It \\(r? |
.Pp |
.Pq upside-down question |
Note these forms are |
|
.Em not |
|
recommended for |
|
.Nm , |
|
which encourages semantic annotation. |
|
.Ss Predefined Strings |
|
Historically, |
|
.Xr groff 1 |
|
also defined a set of package-specific |
|
.Dq predefined strings , |
|
which, like |
|
.Sx Special Characters , |
|
mark special output characters and strings by way of input codes. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e*[N] . |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. |
|
Examples include |
|
.Sq \e*(Am |
|
.Pq ampersand |
|
and |
|
.Sq \e*(Ba |
|
.Pq vertical bar . |
|
.Ss Whitespace |
|
Whitespace consists of the space character. |
|
In free-form lines, whitespace is preserved within a line; un-escaped |
|
trailing spaces are stripped from input (unless in a literal context). |
|
Blank free-form lines, which may include whitespace, are only permitted |
|
within literal contexts. |
|
.Pp |
|
In macro lines, whitespace delimits arguments and is discarded. |
|
If arguments are quoted, whitespace within the quotes is retained. |
|
.Ss Quotation |
|
Macro arguments may be quoted with a double-quote to group |
|
space-delimited terms or to retain blocks of whitespace. |
|
A quoted argument begins with a double-quote preceded by whitespace. |
|
The next double-quote not pair-wise adjacent to another double-quote |
|
terminates the literal, regardless of surrounding whitespace. |
|
.Pp |
|
This produces tokens |
|
.Sq a" , |
|
.Sq b c , |
|
.Sq de , |
|
and |
|
.Sq fg" . |
|
Note that any quoted term, be it argument or macro, is indiscriminately |
|
considered literal text. |
|
Thus, the following produces |
|
.Sq \&Em a : |
|
.Bd -literal -offset indent |
|
\&.Em "Em a" |
|
.Ed |
|
.Pp |
|
In free-form mode, quotes are regarded as opaque text. |
|
.Ss Dates |
|
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 |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch list indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.Bl -tag -width 2i |
|
.Ed |
|
.Pp |
|
The syntax for scaled widths is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , |
|
where a decimal must be preceded or proceeded by at least one digit. |
|
Negative numbers, while accepted, are truncated to zero. |
|
The following scaling units are accepted: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It c |
|
centimetre |
|
.It i |
|
inch |
|
.It P |
|
pica (~1/6 inch) |
|
.It p |
|
point (~1/72 inch) |
|
.It f |
|
synonym for |
|
.Sq u |
|
.It v |
|
default vertical span |
|
.It m |
|
width of rendered |
|
.Sq m |
|
.Pq em |
|
character |
|
.It n |
|
width of rendered |
|
.Sq n |
|
.Pq en |
|
character |
|
.It u |
|
default horizontal span |
|
.It M |
|
mini-em (~1/100 em) |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Enclosures: |
Using anything other than |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq m , |
.It \\(lh |
.Sq n , |
.Pq left hand |
.Sq u , |
.It \\(rh |
or |
.Pq right hand |
.Sq v |
.It \\(Fo |
is necessarily non-portable across output media. |
.Pq left guillemet |
See |
.It \\(Fc |
.Sx COMPATIBILITY . |
.Pq right guillemet |
.Ss Sentence Spacing |
.It \\(fo |
When composing a manual, make sure that your sentences end at the end of |
.Pq left guilsing |
a line. |
.It \\(fc |
By doing so, front-ends will be able to apply the proper amount of |
.Pq right guilsing |
spacing after the end of sentence (unescaped) period, exclamation mark, |
.It \\(rC |
or question mark followed by zero or more non-sentence closing |
.Pq right brace |
delimiters ( |
.It \\(lC |
.Ns Sq \&) , |
.Pq left brace |
.Sq \&] , |
.It \\(ra |
.Sq \&' , |
.Pq right angle |
.Sq \&" ) . |
.It \\(la |
.Pp |
.Pq left angle |
The proper spacing is also intelligently preserved if a sentence ends at |
.It \\(rB |
the boundary of a macro line, e.g., |
.Pq right bracket |
.Pp |
.It \\(lB |
.D1 \&Xr mandoc 1 \. |
.Pq left bracket |
.D1 \&Fl T \&Ns \&Cm ascii \. |
.It \\q |
.Sh MANUAL STRUCTURE |
.Pq double-quote |
A well-formed |
.It \\(lq |
.Nm |
.Pq left double-quote |
document consists of a document prologue followed by one or more |
.It \\(Lq |
sections. |
.Pq left double-quote, deprecated |
.Pp |
.It \\(rq |
The prologue, which consists of (in order) the |
.Pq right double-quote |
.Sx \&Dd , |
.It \\(Rq |
.Sx \&Dt , |
.Pq right double-quote, deprecated |
and |
.It \\(oq |
.Sx \&Os |
.Pq left single-quote |
macros, is required for every document. |
.It \\(aq |
.Pp |
.Pq right single-quote |
The first section (sections are denoted by |
.It \\(Bq |
.Sx \&Sh ) |
.Pq right low double-quote |
must be the NAME section, consisting of at least one |
.It \\(bq |
.Sx \&Nm |
.Pq right low single-quote |
followed by |
|
.Sx \&Nd . |
|
.Pp |
|
Following that, convention dictates specifying at least the |
|
.Em SYNOPSIS |
|
and |
|
.Em DESCRIPTION |
|
sections, although this varies between manual sections. |
|
.Pp |
|
The following is a well-formed skeleton |
|
.Nm |
|
file: |
|
.Bd -literal -offset indent |
|
\&.Dd $\&Mdocdate$ |
|
\&.Dt mdoc 7 |
|
\&.Os |
|
\&.Sh NAME |
|
\&.Nm foo |
|
\&.Nd a description goes here |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh LIBRARY |
|
\&.Sh SYNOPSIS |
|
\&.Nm foo |
|
\&.Op Fl options |
|
\&.Ar |
|
\&.Sh DESCRIPTION |
|
The |
|
\&.Nm |
|
utility processes files ... |
|
\&.\e\*q .Sh IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
|
\&.\e\*q .Sh ENVIRONMENT |
|
\&.\e\*q .Sh FILES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .Sh EXIT STATUS |
|
\&.\e\*q .Sh EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .Sh DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh ERRORS |
|
\&.\e\*q .Sh SEE ALSO |
|
\&.\e\*q .Xr foobar 1 |
|
\&.\e\*q .Sh STANDARDS |
|
\&.\e\*q .Sh HISTORY |
|
\&.\e\*q .Sh AUTHORS |
|
\&.\e\*q .Sh CAVEATS |
|
\&.\e\*q .Sh BUGS |
|
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
|
.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, 3, or 9 manual. |
|
The syntax for this is as follows: |
|
.Bd -literal -offset indent |
|
\&.Lb libarm |
|
.Ed |
|
.Pp |
|
See |
|
.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 |
|
Some macros are displayed differently in the |
|
.Em SYNOPSIS |
|
section, particularly |
|
.Sx \&Nm , |
|
.Sx \&Cd , |
|
.Sx \&Fd , |
|
.Sx \&Fn , |
|
.Sx \&Fo , |
|
.Sx \&In , |
|
.Sx \&Vt , |
|
and |
|
.Sx \&Ft . |
|
All of these macros are output on their own line. If two such |
|
dissimilar macros are pair-wise invoked (except for |
|
.Sx \&Ft |
|
before |
|
.Sx \&Fo |
|
or |
|
.Sx \&Fn ) , |
|
they are separated by a vertical space, unless in the case of |
|
.Sx \&Fo , |
|
.Sx \&Fn , |
|
and |
|
.Sx \&Ft , |
|
which are always separated by vertical space. |
|
.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 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 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 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 |
.El |
.\" PARAGRAPH |
.Sh MACRO SYNTAX |
|
Macros are one to three three characters in length and begin with a |
|
control character , |
|
.Sq \&. , |
|
at the beginning of the line. |
|
An arbitrary amount of whitespace may sit between the control character |
|
and the macro name. |
|
Thus, the following are equivalent: |
|
.Bd -literal -offset indent |
|
\&.Pp |
|
\&.\ \ \ \&Pp |
|
.Ed |
.Pp |
.Pp |
Indicatives: |
The syntax of a macro depends on its classification. |
.Bl -tag -width 12n -offset "XXXX" -compact |
In this section, |
.It \\(<- |
.Sq \-arg |
.Pq left arrow |
refers to macro arguments, which may be followed by zero or more |
.It \\(-> |
.Sq parm |
.Pq right arrow |
parameters; |
.It \\(ua |
.Sq \&Yo |
.Pq up arrow |
opens the scope of a macro; and if specified, |
.It \\(da |
.Sq \&Yc |
.Pq down arrow |
closes it out. |
.It \\(<> |
.Pp |
.Pq left-right arrow |
The |
.It \\(lA |
.Em Callable |
.Pq left double-arrow |
column indicates that the macro may be called subsequent to the initial |
.It \\(rA |
line-macro. |
.Pq right double-arrow |
If a macro is not callable, then its invocation after the initial line |
.It \\(uA |
macro is interpreted as opaque text, such that |
.Pq up double-arrow |
.Sq \&.Fl \&Sh |
.It \\(dA |
produces |
.Pq down double-arrow |
.Sq Fl \&Sh . |
.It \\(hA |
.Pp |
.Pq left-right double-arrow |
The |
|
.Em Parsable |
|
column indicates whether the macro may be followed by further |
|
(ostensibly callable) macros. |
|
If a macro is not parsable, subsequent macro invocations on the line |
|
will be interpreted as opaque text. |
|
.Pp |
|
The |
|
.Em Scope |
|
column, if applicable, describes closure rules. |
|
.Ss Block full-explicit |
|
Multi-line scope closed by an explicit closing macro. |
|
All macros contains bodies; only |
|
.Sx \&Bf |
|
contains a head. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc |
|
.Ed |
|
.Pp |
|
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
|
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
|
.It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed |
|
.It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef |
|
.It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek |
|
.It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El |
|
.It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd |
|
.It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf |
|
.It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk |
|
.It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl |
.El |
.El |
.\" PARAGRAPH |
.Ss Block full-implicit |
|
Multi-line scope closed by end-of-file or implicitly by another macro. |
|
All macros have bodies; some |
|
.Po |
|
.Sx \&It Fl bullet , |
|
.Fl hyphen , |
|
.Fl dash , |
|
.Fl enum , |
|
.Fl item |
|
.Pc |
|
don't have heads; only one |
|
.Po |
|
.Sx \&It Fl column |
|
.Pc |
|
has multiple heads. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
.Ed |
.Pp |
.Pp |
Mathematical: |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \\(es |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.Pq empty set |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It \\(ca |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.Pq intersection |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.It \\(cu |
|
.Pq union |
|
.It \\(gr |
|
.Pq gradient |
|
.It \\(pd |
|
.Pq partial differential |
|
.It \\(ap |
|
.Pq similarity |
|
.It \\(=) |
|
.Pq proper superset |
|
.It \\((= |
|
.Pq proper subset |
|
.It \\(eq |
|
.Pq equals |
|
.It \\(di |
|
.Pq division |
|
.It \\(mu |
|
.Pq multiplication |
|
.It \\(pl |
|
.Pq addition |
|
.It \\(nm |
|
.Pq not element |
|
.It \\(mo |
|
.Pq element |
|
.It \\(Im |
|
.Pq imaginary |
|
.It \\(Re |
|
.Pq real |
|
.It \\(Ah |
|
.Pq aleph |
|
.It \\(te |
|
.Pq existential quantifier |
|
.It \\(fa |
|
.Pq universal quantifier |
|
.It \\(AN |
|
.Pq logical AND |
|
.It \\(OR |
|
.Pq logical OR |
|
.It \\(no |
|
.Pq logical NOT |
|
.It \\(st |
|
.Pq such that |
|
.It \\(tf |
|
.Pq therefore |
|
.It \\(~~ |
|
.Pq approximate |
|
.It \\(~= |
|
.Pq approximately equals |
|
.It \\(=~ |
|
.Pq congruent |
|
.It \\(Gt |
|
.Pq greater-than, deprecated |
|
.It \\(Lt |
|
.Pq less-than, deprecated |
|
.It \\(<= |
|
.Pq less-than-equal |
|
.It \\(Le |
|
.Pq less-than-equal, deprecated |
|
.It \\(>= |
|
.Pq greater-than-equal |
|
.It \\(Ge |
|
.Pq greater-than-equal |
|
.It \\(== |
|
.Pq equal |
|
.It \\(!= |
|
.Pq not equal |
|
.It \\(Ne |
|
.Pq not equal, deprecated |
|
.It \\(if |
|
.Pq infinity |
|
.It \\(If |
|
.Pq infinity, deprecated |
|
.It \\(na |
|
.Pq NaN , an extension |
|
.It \\(Na |
|
.Pq NaN, deprecated |
|
.It \\(+- |
|
.Pq plus-minus |
|
.It \\(Pm |
|
.Pq plus-minus, deprecated |
|
.It \\(** |
|
.Pq asterisk |
|
.El |
.El |
.\" PARAGRAPH |
.Ss Block partial-explicit |
|
Like block full-explicit, but also with single-line scope. |
|
Each has at least a body and, in limited circumstances, a head |
|
.Po |
|
.Sx \&Fo , |
|
.Sx \&Eo |
|
.Pc |
|
and/or tail |
|
.Pq Sx \&Ec . |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
|
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
|
.Ed |
.Pp |
.Pp |
Ligatures: |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It \\(ss |
.It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao |
.Pq German eszett |
.It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac |
.It \\(AE |
.It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo |
.Pq upper-case AE |
.It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc |
.It \\(ae |
.It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro |
.Pq lower-case AE |
.It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc |
.It \\(OE |
.It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do |
.Pq upper-case OE |
.It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc |
.It \\(oe |
.It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo |
.Pq lower-case OE |
.It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec |
.It \\(ff |
.It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo |
.Pq ff ligature |
.It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc |
.It \\(fi |
.It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo |
.Pq fi ligature |
.It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc |
.It \\(fl |
.It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po |
.Pq fl ligature |
.It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc |
.It \\(Fi |
.It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo |
.Pq ffi ligature |
.It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc |
.It \\(Fl |
.It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs |
.Pq ffl ligature |
.It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re |
|
.It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So |
|
.It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc |
|
.It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo |
|
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
.El |
.El |
.\" PARAGRAPH |
.Ss Block partial-implicit |
|
Like block full-implicit, but with single-line scope closed by |
|
.Sx Reserved Characters |
|
or end of line. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
|
.Ed |
.Pp |
.Pp |
Diacritics and letters: |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It Em Macro Ta Em Callable Ta Em Parsable |
.It \\(ga |
.It Sx \&Aq Ta Yes Ta Yes |
.Pq grave accent |
.It Sx \&Bq Ta Yes Ta Yes |
.It \\(aa |
.It Sx \&Brq Ta Yes Ta Yes |
.Pq accute accent |
.It Sx \&D1 Ta \&No Ta \&Yes |
.It \\(a" |
.It Sx \&Dl Ta \&No Ta Yes |
.Pq umlaut accent |
.It Sx \&Dq Ta Yes Ta Yes |
.It \\(ad |
.It Sx \&Op Ta Yes Ta Yes |
.Pq dieresis accent |
.It Sx \&Pq Ta Yes Ta Yes |
.It \\(a~ |
.It Sx \&Ql Ta Yes Ta Yes |
.Pq tilde accent |
.It Sx \&Qq Ta Yes Ta Yes |
.It \\(a^ |
.It Sx \&Sq Ta Yes Ta Yes |
.Pq circumflex accent |
.It Sx \&Vt Ta Yes Ta Yes |
.It \\(ac |
|
.Pq cedilla accent |
|
.It \\(ad |
|
.Pq dieresis accent |
|
.It \\(ah |
|
.Pq caron accent |
|
.It \\(ao |
|
.Pq ring accent |
|
.It \\(ho |
|
.Pq hook accent |
|
.It \\(ab |
|
.Pq breve accent |
|
.It \\(a- |
|
.Pq macron accent |
|
.It \\(-D |
|
.Pq upper-case eth |
|
.It \\(Sd |
|
.Pq lower-case eth |
|
.It \\(TP |
|
.Pq upper-case thorn |
|
.It \\(Tp |
|
.Pq lower-case thorn |
|
.It \\('A |
|
.Pq upper-case acute A |
|
.It \\('E |
|
.Pq upper-case acute E |
|
.It \\('I |
|
.Pq upper-case acute I |
|
.It \\('O |
|
.Pq upper-case acute O |
|
.It \\('U |
|
.Pq upper-case acute U |
|
.It \\('a |
|
.Pq lower-case acute a |
|
.It \\('e |
|
.Pq lower-case acute e |
|
.It \\('i |
|
.Pq lower-case acute i |
|
.It \\('o |
|
.Pq lower-case acute o |
|
.It \\('u |
|
.Pq lower-case acute u |
|
.It \\(`A |
|
.Pq upper-case grave A |
|
.It \\(`E |
|
.Pq upper-case grave E |
|
.It \\(`I |
|
.Pq upper-case grave I |
|
.It \\(`O |
|
.Pq upper-case grave O |
|
.It \\(`U |
|
.Pq upper-case grave U |
|
.It \\(`a |
|
.Pq lower-case grave a |
|
.It \\(`e |
|
.Pq lower-case grave e |
|
.It \\(`i |
|
.Pq lower-case grave i |
|
.It \\(`o |
|
.Pq lower-case grave o |
|
.It \\(`u |
|
.Pq lower-case grave u |
|
.It \\(~A |
|
.Pq upper-case tilde A |
|
.It \\(~N |
|
.Pq upper-case tilde N |
|
.It \\(~O |
|
.Pq upper-case tilde O |
|
.It \\(~a |
|
.Pq lower-case tilde a |
|
.It \\(~n |
|
.Pq lower-case tilde n |
|
.It \\(~o |
|
.Pq lower-case tilde o |
|
.It \\(:A |
|
.Pq upper-case dieresis A |
|
.It \\(:E |
|
.Pq upper-case dieresis E |
|
.It \\(:I |
|
.Pq upper-case dieresis I |
|
.It \\(:O |
|
.Pq upper-case dieresis O |
|
.It \\(:U |
|
.Pq upper-case dieresis U |
|
.It \\(:a |
|
.Pq lower-case dieresis a |
|
.It \\(:e |
|
.Pq lower-case dieresis e |
|
.It \\(:i |
|
.Pq lower-case dieresis i |
|
.It \\(:o |
|
.Pq lower-case dieresis o |
|
.It \\(:u |
|
.Pq lower-case dieresis u |
|
.It \\(:y |
|
.Pq lower-case dieresis y |
|
.It \\(^A |
|
.Pq upper-case circumflex A |
|
.It \\(^E |
|
.Pq upper-case circumflex E |
|
.It \\(^I |
|
.Pq upper-case circumflex I |
|
.It \\(^O |
|
.Pq upper-case circumflex O |
|
.It \\(^U |
|
.Pq upper-case circumflex U |
|
.It \\(^a |
|
.Pq lower-case circumflex a |
|
.It \\(^e |
|
.Pq lower-case circumflex e |
|
.It \\(^i |
|
.Pq lower-case circumflex i |
|
.It \\(^o |
|
.Pq lower-case circumflex o |
|
.It \\(^u |
|
.Pq lower-case circumflex u |
|
.It \\(,C |
|
.Pq upper-case cedilla C |
|
.It \\(,c |
|
.Pq lower-case cedilla c |
|
.It \\(/L |
|
.Pq upper-case stroke L |
|
.It \\(/l |
|
.Pq lower-case stroke l |
|
.It \\(/O |
|
.Pq upper-case stroke O |
|
.It \\(/o |
|
.Pq lower-case stroke o |
|
.It \\(oA |
|
.Pq upper-case ring A |
|
.It \\(oa |
|
.Pq lower-case ring a |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Monetary: |
Note that the |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sx \&Vt |
.It \\(Cs |
macro is a |
.Pq Scandinavian |
.Sx Block partial-implicit |
.It \\(Do |
only when invoked as the first macro |
.Pq dollar |
in a |
.It \\(Po |
.Em SYNOPSIS |
.Pq pound |
section line, else it is |
.It \\(Ye |
.Sx In-line . |
.Pq yen |
.Ss In-line |
.It \\(Fn |
Closed by |
.Pq florin |
.Sx Reserved Characters , |
.It \\(ct |
end of line, fixed argument lengths, and/or subsequent macros. |
.Pq cent |
In-line macros have only text children. |
|
If a number (or inequality) of arguments is |
|
.Pq n , |
|
then the macro accepts an arbitrary number of arguments. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
|
.Ed |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
|
.It Sx \&%A Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%B Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%C Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%D Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%I Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%J 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 \&%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 \&%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 \&Ad Ta Yes Ta Yes Ta n |
|
.It Sx \&An Ta Yes Ta Yes Ta n |
|
.It Sx \&Ap Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Ar Ta Yes Ta Yes Ta n |
|
.It Sx \&At Ta Yes Ta Yes Ta 1 |
|
.It Sx \&Bsx Ta Yes Ta Yes Ta n |
|
.It Sx \&Bt Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Bx Ta Yes Ta Yes Ta n |
|
.It Sx \&Cd Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Cm Ta Yes Ta Yes Ta n |
|
.It Sx \&Db Ta \&No Ta \&No Ta 1 |
|
.It Sx \&Dd Ta \&No Ta \&No Ta >0 |
|
.It Sx \&Dt Ta \&No Ta \&No Ta n |
|
.It Sx \&Dv Ta Yes Ta Yes Ta n |
|
.It Sx \&Dx Ta Yes Ta Yes Ta n |
|
.It Sx \&Em Ta Yes Ta Yes Ta >0 |
|
.It Sx \&En Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Er Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Es Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Ev Ta Yes Ta Yes Ta n |
|
.It Sx \&Ex Ta \&No Ta \&No Ta n |
|
.It Sx \&Fa Ta Yes Ta Yes Ta n |
|
.It Sx \&Fd Ta \&No Ta \&No Ta >0 |
|
.It Sx \&Fl Ta Yes Ta Yes Ta n |
|
.It Sx \&Fn Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Fr Ta \&No Ta \&No Ta n |
|
.It Sx \&Ft Ta Yes Ta Yes Ta n |
|
.It Sx \&Fx Ta Yes Ta Yes Ta n |
|
.It Sx \&Hf Ta \&No Ta \&No Ta n |
|
.It Sx \&Ic Ta Yes Ta Yes Ta >0 |
|
.It Sx \&In Ta \&No Ta \&No Ta n |
|
.It Sx \&Lb Ta \&No Ta \&No Ta 1 |
|
.It Sx \&Li Ta Yes Ta Yes Ta n |
|
.It Sx \&Lk Ta Yes Ta Yes Ta n |
|
.It Sx \&Lp Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Ms Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Mt Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Nm Ta Yes Ta Yes Ta n |
|
.It Sx \&No Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Ns Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Nx Ta Yes Ta Yes Ta n |
|
.It Sx \&Os Ta \&No Ta \&No Ta n |
|
.It Sx \&Ot Ta \&No Ta \&No Ta n |
|
.It Sx \&Ox Ta Yes Ta Yes Ta n |
|
.It Sx \&Pa Ta Yes Ta Yes Ta n |
|
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
|
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Rv Ta \&No Ta \&No Ta n |
|
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
|
.It Sx \&St Ta \&No Ta Yes Ta 1 |
|
.It Sx \&Sx Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Sy Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Tn Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Ud Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Ux Ta Yes Ta Yes Ta n |
|
.It Sx \&Va Ta Yes Ta Yes Ta n |
|
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Xr Ta Yes Ta Yes Ta >0 |
|
.It Sx \&br Ta \&No Ta \&No Ta 0 |
|
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
.\" PARAGRAPH |
.Sh REFERENCE |
|
This section is a canonical reference of all macros, arranged |
|
alphabetically. |
|
For the scoping of individual macros, see |
|
.Sx MACRO SYNTAX . |
|
.Ss \&%A |
|
Author name of an |
|
.Sx \&Rs |
|
block. Multiple authors should each be accorded their own |
|
.Sx \%%A |
|
line. Author names should be ordered with full or abbreviated |
|
forename(s) first, then full surname. |
|
.Ss \&%B |
|
Book title of an |
|
.Sx \&Rs |
|
block. This macro may also be used in a non-bibliographic context when |
|
referring to book titles. |
|
.Ss \&%C |
|
Publication city or location of an |
|
.Sx \&Rs |
|
block. |
.Pp |
.Pp |
Special symbols: |
.Em Remarks : |
.Bl -tag -width 12n -offset "XXXX" -compact |
this macro is not implemented in |
.It \\(de |
.Xr groff 1 . |
.Pq degree |
.Ss \&%D |
.It \\(ps |
Publication date of an |
.Pq paragraph |
.Sx \&Rs |
.It \\(sc |
block. This should follow the reduced or canonical form syntax |
.Pq section |
described in |
.It \\(dg |
.Sx Dates . |
.Pq dagger |
.Ss \&%I |
.It \\(dd |
Publisher or issuer name of an |
.Pq double dagger |
.Sx \&Rs |
.It \\(ci |
block. |
.Pq circle |
.Ss \&%J |
.It \\(ba |
Journal name of an |
.Pq bar |
.Sx \&Rs |
.It \\(bb |
block. |
.Pq broken bar |
.Ss \&%N |
.It \\(Ba |
Issue number (usually for journals) of an |
.Pq bar, deprecated |
.Sx \&Rs |
.It \\(co |
block. |
.Pq copyright |
.Ss \&%O |
.It \\(rg |
Optional information of an |
.Pq registered |
.Sx \&Rs |
.It \\(tm |
block. |
.Pq trademarked |
.Ss \&%P |
.It \\& |
Book or journal page number of an |
.Pq non-breaking space |
.Sx \&Rs |
.It \\e |
block. |
.Pq escape |
.Ss \&%Q |
.It \\(Am |
Institutional author (school, government, etc.) of an |
.Pq ampersand, deprecated |
.Sx \&Rs |
.El |
block. Multiple institutional authors should each be accorded their own |
.\" SECTION |
.Sx \&%Q |
.Sh ONTOLOGY |
line. |
Macros are classified in an ontology described by their scope rules. |
.Ss \&%R |
Some macros are allowed to deviate from their classifications to |
Technical report name of an |
preserve backward-compatibility with old macro combinations still found |
.Sx \&Rs |
in the manual corpus. These are specifically noted on a per-macro |
block. |
basis. |
.Ss \&%T |
.\" SUB-SECTION |
Article title of an |
.Ss Scope |
.Sx \&Rs |
.Bl -inset |
block. This macro may also be used in a non-bibliographical context |
.\" LIST-ITEM |
when referring to article titles. |
.It Em Block |
.Ss \&%U |
macros enclose other block macros, in-line macros or text, and |
URI of reference document. |
may span multiple lines. |
.Ss \&%V |
.Bl -inset -offset XXXX |
Volume number of an |
.\" LIST-ITEM |
.Sx \&Rs |
.It Em Full-block |
block. |
macros always span multiple lines. They consist of zero or |
.Ss \&Ac |
more |
Closes an |
.Qq heads , |
.Sx \&Ao |
subsequent macros or text on the same line following invocation; an |
block. Does not have any tail arguments. |
optional |
.Ss \&Ad |
.Qq body , |
Address construct: usually in the context of an computational address in |
which spans subsequent lines of text or macros; and an optional |
memory, not a physical (post) address. |
.Qq tail , |
.Pp |
macros or text on the same line following closure. |
Examples: |
.\" LIST-ITEM |
.D1 \&.Ad [0,$] |
.It Em Partial-block |
.D1 \&.Ad 0x00000000 |
macros may span multiple lines. They consists of a optional |
.Ss \&An |
.Qq head , |
Author name. |
text immediately following invocation; always a |
This macro may alternatively accepts the following arguments, although |
.Qq body , |
these may not be specified along with a parameter: |
text or macros following the head on the same and subsequent lines; and |
.Bl -tag -width 12n -offset indent |
optionally a |
.It Fl split |
.Qq tail , |
Renders a line break before each author listing. |
text immediately following closure. |
.It Fl nosplit |
.\" LIST-ITEM |
The opposite of |
.It Em In-line |
.Fl split . |
macros may only enclose text and span at most a single line. |
|
.El |
.El |
.El |
|
.\" SUB-SECTION |
|
.Ss Closure |
|
Closure of a macro's scope depends first on its classification, then |
|
on whether it's parsable. In this table, |
|
.Sq BFE |
|
refers to block full-explicit and so on. |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
.Bl -tag -width 12n -offset XXXX -compact |
In the AUTHORS section, the default is not to split the first author |
.It BPE , BFE |
listing, but all subsequent author listings, whether or not they're |
corresponding explicit closure macro |
interspersed by other macros or text, are split. |
.It BFI |
Thus, specifying |
end-of-file or a corresponding implicit closure macro |
.Fl split |
.It BPI |
will cause the first listing also to be split. |
end-of-line (body may be closed by >0 space-separated |
If not in the AUTHORS section, the default is not to split. |
.Sx Reserved Characters , |
.Pp |
although block scope will still be open) |
Examples: |
.It INL |
.D1 \&.An -nosplit |
end-of-line |
.D1 \&.An J. D. Ullman . |
|
.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 |
|
Begins a block enclosed by angled brackets. |
|
Does not have any head arguments. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac |
|
.Pp |
|
See also |
|
.Sx \&Aq . |
|
.Ss \&Ap |
|
Inserts an apostrophe without any surrounding white-space. |
|
This is generally used as a grammatical device when referring to the verb |
|
form of a function: |
|
.Bd -literal -offset indent |
|
\&.Fn execve Ap d |
|
.Ed |
|
.Ss \&Aq |
|
Encloses its arguments in angled brackets. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fl -key= \&Ns \&Aq \&Ar val |
|
.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 |
|
Command arguments. |
|
If an argument is not provided, the string |
|
.Dq file ... |
|
is used as a default. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fl o \&Ns \&Ar file1 |
|
.D1 \&.Ar |
|
.D1 \&.Ar arg1 , arg2 . |
|
.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 |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
If a macro (block or in-line) is parsable, it may also be closed out by |
Note that these parameters do not begin with a hyphen. |
one of the following scenarios (unless specifically noted otherwise): |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
.Bl -dash -offset XXXX -compact |
Examples: |
.It |
.D1 \&.At |
a sequence of >0 space-separated |
.D1 \&.At V.1 |
.Sx Reserved Characters , |
.Pp |
|
See also |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Bc |
|
Closes a |
|
.Sx \&Bo |
|
block. Does not have any tail arguments. |
|
.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 |
.It |
another macro, |
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 |
.It |
end-of-line, or |
As a precalculated width for a named macro. |
|
The most popular is the imaginary macro |
|
.Ar \&Ds , |
|
which resolves to |
|
.Ar 6n . |
.It |
.It |
completion of a set number of arguments. |
As a scaling unit following the syntax described in |
|
.Sx Scaling Widths . |
|
.It |
|
As the calculated string length of the opaque string. |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
If >0 space-separated |
If unset, it will revert to the value of |
.Sx Reserved Characters |
.Ar 8n |
are followed by non-reserved characters, the behaviour differs per |
as described in |
macro. In general, scope of the macro is closed and re-opened: |
.Sx Scaling Widths . |
subsequent tokens are interpreted as if the scope had just been opened. |
.It Fl compact |
In other circumstances, scope is simply closed out. |
Do not assert a vertical space before the block. |
.\" SECTION |
.It Fl file Ar file |
.Sh SYNTAX |
Prepend the file |
Macros are generally two and at times three characters in length. The |
.Ar file |
syntax of macro invocation depends on its classification. |
before any text or macros within the block. |
.Qq \-arg |
.El |
refers to the macro arguments (which may contain zero or more values). |
|
In these illustrations, |
|
.Sq \&.Yo |
|
opens the scope of a macro, and if specified, |
|
.Sq \&.Yc |
|
closes it out (closure may be implicit at end-of-line or end-of-file). |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Block full-explicit (may contain head, body, tail). |
Examples: |
.Bd -literal -offset XXXX |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
\&.Bd \-unfilled \-offset two-indent \-compact |
\(lBbody...\(rB |
Hello world. |
\&.Yc \(lBtail...\(rB |
\&.Ed |
.Ed |
.Ed |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Block full-implicit (may contain zero or more heads, body, no tail). |
See also |
.Bd -literal -offset XXXX |
.Sx \&D1 |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
and |
\(lBbody...\(rB |
.Sx \&Dl . |
\&.Yc |
.Ss \&Bf |
.Ed |
.Ss \&Bk |
.\" PARAGRAPH |
.Ss \&Bl |
|
Begins a list composed of one or more list entries. |
|
A list is associated with a type, which is a required argument. |
|
Other arguments are |
|
.Fl width , |
|
defined per-type as accepting a literal or |
|
.Sx Scaling Widths |
|
value; |
|
.Fl offset , |
|
also accepting a literal or |
|
.Sx Scaling Widths |
|
value setting the list's global offset; and |
|
.Fl compact , |
|
suppressing the default vertical space printed before each list entry. |
|
A list entry is specified by the |
|
.Sx \&It |
|
macro, which consists of a head and optional body (depending on the list |
|
type). |
|
A list must specify one of the following list types: |
|
.Bl -tag -width 12n -offset indent |
|
.It Fl bullet |
|
A list offset by a bullet. |
|
The head of list entries must be empty. |
|
List entry bodies are positioned after the bullet. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
|
.It Fl column |
|
A columnated list. |
|
The |
|
.Fl width |
|
argument has no effect. |
|
The number of columns is specified as parameters to the |
|
.Sx \&Bl |
|
macro. |
|
These dictate the width of columns either as |
|
.Sx Scaling Widths |
|
or literal text. |
|
If the initial macro of a |
|
.Fl column |
|
list is not an |
|
.Sx \&It , |
|
an |
|
.Sx \&It |
|
context spanning each line is implied until an |
|
.Sx \&It |
|
line macro is encountered, at which point list bodies are interpreted as |
|
described in the |
|
.Sx \&It |
|
documentation. |
|
.It Fl dash |
|
A list offset by a dash (hyphen). |
|
The head of list entries must be empty. |
|
List entry bodies are positioned past the dash. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
|
.It Fl diag |
|
Like |
|
.Fl inset , |
|
but with additional formatting to the head. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
|
.It Fl enum |
|
An enumerated list offset by the enumeration from 1. |
|
The head of list entries must be empty. |
|
List entry bodies are positioned after the enumeration. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
|
.It Fl hang |
|
Like |
|
.Fl tag , |
|
but instead of list bodies positioned after the head, they trail the |
|
head text. |
|
The |
|
.Fl width |
|
argument varies the width of list bodies' left-margins. |
|
.It Fl hyphen |
|
Synonym for |
|
.Fl dash . |
|
.It Fl inset |
|
List bodies follow the list head. |
|
The |
|
.Fl width |
|
argument is ignored. |
|
.It Fl item |
|
This produces blocks of text. |
|
The head of list entries must be empty. |
|
The |
|
.Fl width |
|
argument is ignored. |
|
.It Fl ohang |
|
List bodies are positioned on the line following the head. |
|
The |
|
.Fl width |
|
argument is ignored. |
|
.It Fl tag |
|
A list offset by list entry heads. List entry bodies are positioned |
|
after the head as specified by the |
|
.Fl width |
|
argument. |
|
.El |
.Pp |
.Pp |
Block partial-explicit (may contain head, multi-line body, tail). |
See also |
.Bd -literal -offset XXXX |
.Sx \&It . |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
.Ss \&Bo |
\(lBbody...\(rB |
Begins a block enclosed by square brackets. |
\&.Yc \(lBtail...\(rB |
Does not have any head arguments. |
|
.Pp |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
Examples: |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
.Bd -literal -offset indent |
|
\&.Bo 1 , |
|
\&.Dv BUFSIZ \&Bc |
.Ed |
.Ed |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Block partial-implicit (no head, body, no tail). Note that the body |
See also |
section may be followed by zero or more |
.Sx \&Bq . |
.Sx Reserved Words . |
.Ss \&Bq |
These are in the block scope, but not in the body scope. |
Encloses its arguments in square brackets. |
.Bd -literal -offset XXXX |
.Pp |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB |
Examples: |
|
.D1 \&.Bq 1 , \&Dv BUFSIZ |
|
.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 |
|
Closes a |
|
.Sx \&Bro |
|
block. Does not have any tail arguments. |
|
.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 |
.Ed |
.\" PARAGRAPH |
|
.Pp |
.Pp |
In-lines have \(>=0 scoped arguments. |
See also |
.Bd -literal -offset XXX |
.Sx \&Brq . |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB |
.Ss \&Brq |
|
Encloses its arguments in curly braces. |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.Pp |
|
Examples: |
|
.D1 \&.Brq 1 , ... , \&Va n |
|
.Pp |
|
See also |
|
.Sx \&Bro . |
|
.Ss \&Bsx |
|
Format the BSD/OS version provided as an argument, or a default value if |
|
no argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Bsx 1.0 |
|
.D1 \&.Bsx |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Bt |
|
Prints |
|
.Dq is currently in beta test. |
|
.Ss \&Bx |
|
Format the BSD version provided as an argument, or a default value if no |
|
argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Bx 4.4 |
|
.D1 \&.Bx |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Cd |
|
Configuration declaration. |
|
This denotes strings accepted by |
|
.Xr config 8 . |
|
.Pp |
|
Examples: |
|
.D1 \&.Cd device le0 at scode? |
|
.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 |
|
Command modifiers. |
|
Useful when specifying configuration options or keys. |
|
.Pp |
|
Examples: |
|
.D1 \&.Cm ControlPath |
|
.D1 \&.Cm ControlMaster |
|
.Pp |
|
See also |
|
.Sx \&Fl . |
|
.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: |
|
.D1 \&.D1 \&Fl abcdefgh |
|
.Pp |
|
See also |
|
.Sx \&Bd |
|
and |
|
.Sx \&Dl . |
|
.Ss \&Db |
|
Start a debugging context. |
|
This macro is parsed, but generally ignored. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Db Cm on | off |
|
.Ss \&Dc |
|
Closes a |
|
.Sx \&Do |
|
block. Does not have any tail arguments. |
|
.Ss \&Dd |
|
Document date. |
|
This is the mandatory first macro of any |
|
.Nm |
|
manual. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. 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: |
|
.D1 \&.Dd $\&Mdocdate$ |
|
.D1 \&.Dd $\&Mdocdate: July 21 2007$ |
|
.D1 \&.Dd July 21, 2007 |
|
.Pp |
|
See also |
|
.Sx \&Dt |
|
and |
|
.Sx \&Os . |
|
.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: |
|
.D1 \&.Dl % mandoc mdoc.7 | less |
|
.Pp |
|
See also |
|
.Sx \&Bd |
|
and |
|
.Sx \&D1 . |
|
.Ss \&Do |
|
Begins a block enclosed by double quotes. Does not have any head |
|
arguments. |
|
.Pp |
|
Examples: |
|
.D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot |
|
.Pp |
|
See also |
|
.Sx \&Dq . |
|
.Ss \&Dq |
|
Encloses its arguments in double quotes. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent -compact |
|
\&.Dq April is the cruellest month |
|
\e(em T.S. Eliot |
.Ed |
.Ed |
.\" |
.Pp |
.Sh MACROS |
See also |
This section contains a complete list of all |
.Sx \&Do . |
|
.Ss \&Dt |
|
Document title. |
|
This is the mandatory second macro of any |
.Nm |
.Nm |
macros, arranged ontologically. A |
file. |
.Qq callable |
Its syntax is as follows: |
macro is may be invoked subsequent to the initial macro-line macro. A |
.Bd -ragged -offset indent |
.Qq parsable |
.Pf \. Sx \&Dt |
macro may be followed by further (ostensibly callable) macros. |
.Oo |
.\" SUB-SECTION |
.Cm title |
.Ss Block full-implicit |
.Oo |
The head of these macros follows invocation; the body is the content of |
.Cm section |
subsequent lines prior to closure. None of these macros have tails; |
.Op Cm volume | arch |
some |
.Oc |
.Po |
.Oc |
.Sq \&It \-bullet , |
.Ed |
.Sq \-hyphen , |
|
.Sq \-dash , |
|
.Sq \-enum , |
|
.Sq \-item |
|
.Pc |
|
don't have heads. |
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX |
Its arguments are as follows: |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing |
.Bl -tag -width Ds -offset Ds |
.It \&.Sh Ta \&No Ta \&No Ta \&.Sh |
.It Cm title |
.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss |
The document's title (name), defaulting to |
.It \&.It Ta \&No Ta Yes Ta \&.It, \&.El |
.Qq UNKNOWN |
|
if unspecified. |
|
It should be capitalised. |
|
.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 should correspond to the manual's filename suffix and defaults to |
|
.Qq 1 |
|
if unspecified. |
|
.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 loongson , |
|
.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 |
.El |
.\" SUB-SECTION |
|
.Ss Block full-explicit |
|
None of these macros are callable or parsed. The last column indicates |
|
the explicit scope rules. All contains bodies, some may contain heads |
|
.Pq So \&Bf Sc . |
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX |
Examples: |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.D1 \&.Dt FOO 1 |
.It \&.Bd Ta \&No Ta \&No Ta closed by \&.Ed |
.D1 \&.Dt FOO 4 KM |
.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd |
.D1 \&.Dt FOO 9 i386 |
.It \&.Bl Ta \&No Ta \&No Ta closed by \&.El |
|
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
|
.It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef |
|
.It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf |
|
.It \&.Bk Ta \&No Ta \&No Ta closed by \&.Ek |
|
.It \&.Ek Ta \&No Ta \&No Ta opened by \&.Bk |
|
.El |
|
.\" SUB-SECTION |
|
.Ss Block partial-implicit |
|
All of these are callable and parsed for further macros. Their scopes |
|
close at the invocation's end-of-line. |
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
See also |
.It Em Macro Ta Em Callable Ta Em Parsable |
.Sx \&Dd |
.It \&.Aq Ta Yes Ta Yes |
and |
.It \&.Op Ta Yes Ta Yes |
.Sx \&Os . |
.It \&.Bq Ta Yes Ta Yes |
.Ss \&Dv |
.It \&.Dq Ta Yes Ta Yes |
Defined variables such as preprocessor constants. |
.It \&.Pq Ta Yes Ta Yes |
|
.It \&.Qq Ta Yes Ta Yes |
|
.It \&.Sq Ta Yes Ta Yes |
|
.It \&.Brq Ta Yes Ta Yes |
|
.It \&.D1 Ta \&No Ta \&Yes |
|
.It \&.Dl Ta \&No Ta Yes |
|
.It \&.Ql Ta Yes Ta Yes |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
|
Examples: |
|
.D1 \&.Dv BUFSIZ |
|
.D1 \&.Dv STDOUT_FILENO |
|
.Pp |
|
See also |
|
.Sx \&Er . |
|
.Ss \&Dx |
|
Format the DragonFly BSD version provided as an argument, or a default |
|
value if no argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Dx 2.4.1 |
|
.D1 \&.Dx |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Ec |
|
.Ss \&Ed |
|
.Ss \&Ef |
|
.Ss \&Ek |
|
.Ss \&El |
|
Ends a list context started by |
|
.Sx \&Bl . |
|
.Pp |
|
See also |
|
.Sx \&Bl |
|
and |
|
.Sx \&It . |
|
.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: |
|
.D1 \&.Em Warnings! |
|
.D1 \&.Em Remarks : |
|
.Ss \&En |
|
.Ss \&Eo |
|
.Ss \&Er |
|
Display error constants. |
|
.Pp |
|
Examples: |
|
.D1 \&.Er EPERM |
|
.D1 \&.Er ENOENT |
|
.Pp |
|
See also |
|
.Sx \&Dv . |
|
.Ss \&Es |
|
.Ss \&Ev |
|
Environmental variables such as those specified in |
|
.Xr environ 7 . |
|
.Pp |
|
Examples: |
|
.D1 \&.Ev DISPLAY |
|
.D1 \&.Ev PATH |
|
.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 |
|
Function argument. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Fa |
|
.Op Cm argtype |
|
.Cm argname |
|
.Ed |
|
.Pp |
|
This may be invoked for names with or without the corresponding type. |
|
It is also used to specify the field name of a structure. |
|
Most often, the |
|
.Sx \&Fa |
|
macro is used in the |
|
.Em SYNOPSIS |
|
within |
|
.Sx \&Fo |
|
section when documenting multi-line function prototypes. |
|
If invoked with multiple arguments, the arguments are separated by a |
|
comma. |
|
Furthermore, if the following macro is another |
|
.Sx \&Fa , |
|
the last argument will also have a trailing comma. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fa \(dqconst char *p\(dq |
|
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
|
.D1 \&.Fa foo |
|
.Pp |
|
See also |
|
.Sx \&Fo . |
|
.Ss \&Fc |
|
.Ss \&Fd |
|
Historically used to document include files. |
|
This usage has been deprecated in favour of |
|
.Sx \&In . |
|
Do not use this macro. |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE |
|
and |
|
.Sx \&In . |
|
.Ss \&Fl |
|
Command-line flag. |
|
Used when listing arguments to command-line utilities. |
|
Prints a fixed-width hyphen |
|
.Sq \- |
|
directly followed by each argument. |
|
If no arguments are provided, a hyphen is printed followed by a space. |
|
If the argument is a macro, a hyphen is prefixed to the subsequent macro |
|
output. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fl a b c |
|
.D1 \&.Fl \&Pf a b |
|
.D1 \&.Fl |
|
.D1 \&.Op \&Fl o \&Ns \&Ar file |
|
.Pp |
|
See also |
|
.Sx \&Cm . |
|
.Ss \&Fn |
|
A function name. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Ns Sx \&Fn |
|
.Op Cm functype |
|
.Cm funcname |
|
.Op Oo Cm argtype Oc Cm argname |
|
.Ed |
|
.Pp |
|
Function arguments are surrounded in parenthesis and |
|
are delimited by commas. |
|
If no arguments are specified, blank parenthesis are output. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fn "int funcname" "int arg0" "int arg1" |
|
.D1 \&.Fn funcname "int arg0" |
|
.D1 \&.Fn funcname arg0 |
|
.Bd -literal -offset indent -compact |
|
\&.Ft functype |
|
\&.Fn funcname |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE |
|
and |
|
.Sx \&Ft . |
|
.Ss \&Fo |
|
Begin a function block. |
|
This is a multi-line version of |
|
.Sx \&Fn . |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Fo Cm funcname |
|
.Pp |
|
Invocations usually occur in the following context: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Ft Cm functype |
|
.br |
|
.Pf \. Sx \&Fo Cm funcname |
|
.br |
|
.Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname |
|
.br |
|
\.\.\. |
|
.br |
|
.Pf \. Sx \&Fc |
|
.Ed |
|
.Pp |
|
A |
|
.Sx \&Fo |
|
scope is closed by |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE , |
|
.Sx \&Fa , |
|
.Sx \&Fc , |
|
and |
|
.Ss \&Ft |
|
A function type. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Ft Cm functype |
|
.Pp |
|
Examples: |
|
.D1 \&.Ft int |
|
.Bd -literal -offset indent -compact |
|
\&.Ft functype |
|
\&.Fn funcname |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE , |
|
.Sx \&Fn , |
|
and |
|
.Sx \&Fo . |
|
.Ss \&Fx |
|
Format the FreeBSD version provided as an argument, or a default value |
|
if no argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fx 7.1 |
|
.D1 \&.Fx |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Nx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Hf |
|
.Ss \&Ic |
|
.Ss \&In |
|
An |
|
.Qq include |
|
file. |
|
In the |
|
.Em SYNOPSIS |
|
section (only if invoked as the line macro), the first argument is |
|
preceded by |
|
.Qq #include , |
|
the arguments is enclosed in angled braces. |
|
.Pp |
|
Examples: |
|
.D1 \&.In sys/types |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE . |
|
.Ss \&It |
|
A list item. |
|
The syntax of this macro depends on the list type. |
|
.Pp |
|
Lists |
|
of type |
|
.Fl hang , |
|
.Fl ohang , |
|
.Fl inset , |
|
and |
|
.Fl diag |
|
have the following syntax: |
|
.Pp |
|
.D1 Pf \. Sx \&It Cm args |
|
.Pp |
|
Lists of type |
|
.Fl bullet , |
|
.Fl dash , |
|
.Fl enum , |
|
.Fl hyphen |
|
and |
|
.Fl item |
|
have the following syntax: |
|
.Pp |
|
.D1 Pf \. Sx \&It |
|
.Pp |
|
with subsequent lines interpreted within the scope of the |
|
.Sx \&It |
|
until either a closing |
|
.Sx \&El |
|
or another |
|
.Sx \&It . |
|
.Pp |
The |
The |
.Sq \&Op |
.Fl tag |
may be broken by \&Oc as in the following example: |
list has the following syntax: |
.Bd -literal -offset XXXX |
.Pp |
\&.Oo |
.D1 Pf \. Sx \&It Op Cm args |
\&.Op Fl a Oc |
.Pp |
|
Subsequent lines are interpreted as with |
|
.Fl bullet |
|
and family. |
|
The line arguments correspond to the list's left-hand side; body |
|
arguments correspond to the list's contents. |
|
.Pp |
|
The |
|
.Fl column |
|
list is the most complicated. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&It Op Cm args |
|
.Pp |
|
The |
|
.Cm args |
|
are phrases, a mix of macros and text corresponding to a line column, |
|
delimited by tabs or the special |
|
.Sq \&Ta |
|
pseudo-macro. |
|
Lines subsequent the |
|
.Sx \&It |
|
are interpreted within the scope of the last phrase. |
|
Calling the pseudo-macro |
|
.Sq \&Ta |
|
will open a new phrase scope (this must occur on a macro line to be |
|
interpreted as a macro). Note that the tab phrase delimiter may only be |
|
used within the |
|
.Sx \&It |
|
line itself. |
|
Subsequent this, only the |
|
.Sq \&Ta |
|
pseudo-macro may be used to delimit phrases. |
|
Furthermore, note that quoted sections propagate over tab-delimited |
|
phrases on an |
|
.Sx \&It , |
|
for example, |
|
.Pp |
|
.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
|
.Pp |
|
will preserve the semicolon whitespace except for the last. |
|
.Pp |
|
See also |
|
.Sx \&Bl . |
|
.Ss \&Lb |
|
Specify a library. |
|
The syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Lb Cm library |
|
.Pp |
|
The |
|
.Cm library |
|
parameter may be a system library, such as |
|
.Cm libz |
|
or |
|
.Cm libpam , |
|
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 |
|
printed in quotes. |
|
This is most commonly used in the |
|
.Em SYNOPSIS |
|
section as described in |
|
.Sx MANUAL STRUCTURE . |
|
.Pp |
|
Examples: |
|
.D1 \&.Lb libz |
|
.D1 \&.Lb mdoc |
|
.Ss \&Li |
|
.Ss \&Lk |
|
Format a hyperlink. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Lk Cm uri Op Cm name |
|
.Pp |
|
Examples: |
|
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
|
.D1 \&.Lk http://bsd.lv |
|
.Pp |
|
See also |
|
.Sx \&Mt . |
|
.Ss \&Lp |
|
.Ss \&Ms |
|
.Ss \&Mt |
|
Format a |
|
.Qq mailto: |
|
hyperlink. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Mt Cm address |
|
.Pp |
|
Examples: |
|
.D1 \&.Mt discuss@manpages.bsd.lv |
|
.Ss \&Nd |
|
.Ss \&Nm |
|
.Ss \&No |
|
.Ss \&Ns |
|
.Ss \&Nx |
|
Format the NetBSD version provided as an argument, or a default value if |
|
no argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Nx 5.01 |
|
.D1 \&.Nx |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Ox , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Oc |
|
.Ss \&Oo |
|
.Ss \&Op |
|
.Ss \&Os |
|
Document operating system version. |
|
This is the mandatory third macro of |
|
any |
|
.Nm |
|
file. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. 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: |
|
.D1 \&.Os |
|
.D1 \&.Os KTH/CSC/TCS |
|
.D1 \&.Os BSD 4.3 |
|
.Pp |
|
See also |
|
.Sx \&Dd |
|
and |
|
.Sx \&Dt . |
|
.Ss \&Ot |
|
Unknown usage. |
|
.Pp |
|
.Em Remarks : |
|
this macro has been deprecated. |
|
.Ss \&Ox |
|
Format the OpenBSD version provided as an argument, or a default value |
|
if no argument is provided. |
|
.Pp |
|
Examples: |
|
.D1 \&.Ox 4.5 |
|
.D1 \&.Ox |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
and |
|
.Sx \&Ux . |
|
.Ss \&Pa |
|
.Ss \&Pc |
|
.Ss \&Pf |
|
.Ss \&Po |
|
.Ss \&Pp |
|
.Ss \&Pq |
|
.Ss \&Qc |
|
.Ss \&Ql |
|
.Ss \&Qo |
|
.Ss \&Qq |
|
.Ss \&Re |
|
Closes a |
|
.Sx \&Rs |
|
block. |
|
Does not have any tail arguments. |
|
.Ss \&Rs |
|
Begins a bibliographic |
|
.Pq Dq reference |
|
block. |
|
Does not have any head arguments. |
|
The block macro may only contain |
|
.Sx \&%A , |
|
.Sx \&%B , |
|
.Sx \&%C , |
|
.Sx \&%D , |
|
.Sx \&%I , |
|
.Sx \&%J , |
|
.Sx \&%N , |
|
.Sx \&%O , |
|
.Sx \&%P , |
|
.Sx \&%Q , |
|
.Sx \&%R , |
|
.Sx \&%T , |
|
.Sx \&%U , |
|
and |
|
.Sx \&%V |
|
child macros (at least one must be specified). |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent -compact |
|
\&.Rs |
|
\&.%A J. E. Hopcroft |
|
\&.%A J. D. Ullman |
|
\&.%B Introduction to Automata Theory, Languages, and Computation |
|
\&.%I Addison-Wesley |
|
\&.%C Reading, Massachusettes |
|
\&.%D 1979 |
|
\&.Re |
.Ed |
.Ed |
.Pp |
.Pp |
In the above example, the scope of |
If an |
.Sq \&Op |
.Sx \&Rs |
is technically broken by |
block is used within a SEE ALSO section, a vertical space is asserted |
.Sq \&Oc , |
before the rendered output, else the block continues on the current |
however, due to the overwhelming existence of this sequence, it's |
line. |
allowed. |
.Ss \&Rv |
.\" SUB-SECTION |
.Ss \&Sc |
.Ss Block partial-explicit |
.Ss \&Sh |
Each of these contains at least a body and, in limited circumstances, a |
.Ss \&Sm |
head |
.Ss \&So |
.Pq So \&Fo Sc , So \&Eo Sc |
.Ss \&Sq |
and/or tail |
.Ss \&Ss |
.Pq So \&Ec Sc . |
.Ss \&St |
|
.Ss \&Sx |
|
.Ss \&Sy |
|
.Ss \&Tn |
|
.Ss \&Ud |
|
Prints out |
|
.Dq currently under development. |
|
.Ss \&Ux |
|
Format the UNIX name. |
|
Accepts no argument. |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
Examples: |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.D1 \&.Ux |
.It \&.Ao Ta Yes Ta Yes Ta closed by \&.Ac |
|
.It \&.Ac Ta Yes Ta Yes Ta opened by \&.Ao |
|
.It \&.Bc Ta Yes Ta Yes Ta closed by \&.Bo |
|
.It \&.Bo Ta Yes Ta Yes Ta opened by \&.Bc |
|
.It \&.Pc Ta Yes Ta Yes Ta closed by \&.Po |
|
.It \&.Po Ta Yes Ta Yes Ta opened by \&.Pc |
|
.It \&.Do Ta Yes Ta Yes Ta closed by \&.Dc |
|
.It \&.Dc Ta Yes Ta Yes Ta opened by \&.Do |
|
.It \&.Xo Ta Yes Ta Yes Ta closed by \&.Xc |
|
.It \&.Xc Ta Yes Ta Yes Ta opened by \&.Xo |
|
.It \&.Bro Ta Yes Ta Yes Ta closed by \&.Brc |
|
.It \&.Brc Ta Yes Ta Yes Ta opened by \&.Bro |
|
.It \&.Oc Ta Yes Ta Yes Ta closed by \&.Oo |
|
.It \&.Oo Ta Yes Ta Yes Ta opened by \&.Oc |
|
.It \&.So Ta Yes Ta Yes Ta closed by \&.Sc |
|
.It \&.Sc Ta Yes Ta Yes Ta opened by \&.So |
|
.It \&.Fc Ta Yes Ta Yes Ta opened by \&.Fo |
|
.It \&.Fo Ta \&No Ta \&No Ta closed by \&.Fc |
|
.It \&.Ec Ta Yes Ta Yes Ta opened by \&.Eo |
|
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
|
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
|
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
|
.It \&.Re Ta \&No Ta \&No Ta opened by \&.Rs |
|
.It \&.Rs Ta \&No Ta \&No Ta closed by \&.Re |
|
.El |
|
.\" SUB-SECTION |
|
.Ss In-line |
|
In-line macros have only text children. If a number (or inequality) of |
|
arguments is |
|
.Pq n , |
|
then the macro accepts an arbitrary number of arguments. |
|
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
See also |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.Sx \&At , |
.It \&.Dd Ta \&No Ta \&No Ta >0 |
.Sx \&Bsx , |
.It \&.Dt Ta \&No Ta \&No Ta n |
.Sx \&Bx , |
.It \&.Os Ta \&No Ta \&No Ta n |
.Sx \&Dx , |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
.Sx \&Fx , |
.It \&.Ad Ta Yes Ta Yes Ta n |
.Sx \&Nx , |
.It \&.An Ta \&No Ta Yes Ta n |
and |
.It \&.Ar Ta Yes Ta Yes Ta n |
.Sx \&Ox . |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
.Ss \&Va |
.It \&.Cm Ta Yes Ta Yes Ta n |
.Ss \&Vt |
.It \&.Dv Ta Yes Ta Yes Ta n |
A variable type. |
.It \&.Er Ta Yes Ta Yes Ta >0 |
This is also used for indicating global variables in the |
.It \&.Ev Ta Yes Ta Yes Ta n |
.Em SYNOPSIS |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
section, in which case a variable name is also specified. |
.It \&.Fa Ta Yes Ta Yes Ta n |
Note that it accepts |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
.Sx Block partial-implicit |
.It \&.Fl Ta Yes Ta Yes Ta n |
syntax when invoked as the first macro in the |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
.Em SYNOPSIS |
.It \&.Ft Ta \&No Ta Yes Ta n |
section, else it accepts ordinary |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
.Sx In-line |
.It \&.In Ta \&No Ta \&No Ta n |
syntax. |
.It \&.Li Ta Yes Ta Yes Ta n |
|
.It \&.Nd Ta \&No Ta \&No Ta n |
|
.It \&.Nm Ta Yes Ta Yes Ta n |
|
.It \&.Ot Ta \&No Ta \&No Ta n |
|
.It \&.Pa Ta Yes Ta Yes Ta n |
|
.It \&.Rv Ta \&No Ta \&No Ta 0 |
|
.It \&.St Ta \&No Ta Yes Ta 1 |
|
.It \&.Va Ta Yes Ta Yes Ta n |
|
.It \&.Vt Ta Yes Ta Yes Ta >0 |
|
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
|
.It \&.%A Ta \&No Ta \&No Ta >0 |
|
.It \&.%B Ta \&No Ta \&No Ta >0 |
|
.It \&.%C Ta \&No Ta \&No Ta >0 |
|
.It \&.%D Ta \&No Ta \&No Ta >0 |
|
.It \&.%I Ta \&No Ta \&No Ta >0 |
|
.It \&.%J Ta \&No Ta \&No Ta >0 |
|
.It \&.%N Ta \&No Ta \&No Ta >0 |
|
.It \&.%O Ta \&No Ta \&No Ta >0 |
|
.It \&.%P Ta \&No Ta \&No Ta >0 |
|
.It \&.%R Ta \&No Ta \&No Ta >0 |
|
.It \&.%T Ta \&No Ta \&No Ta >0 |
|
.It \&.%V Ta \&No Ta \&No Ta >0 |
|
.It \&.At Ta Yes Ta Yes Ta 1 |
|
.It \&.Bsx Ta Yes Ta Yes Ta n |
|
.It \&.Bx Ta Yes Ta Yes Ta n |
|
.It \&.Db Ta \&No Ta \&No Ta 1 |
|
.It \&.Em Ta Yes Ta Yes Ta n |
|
.It \&.Fx Ta Yes Ta Yes Ta n |
|
.It \&.Ms Ta \&No Ta Yes Ta >0 |
|
.It \&.No Ta Yes Ta Yes Ta 0 |
|
.It \&.Ns Ta Yes Ta Yes Ta 0 |
|
.It \&.Nx Ta Yes Ta Yes Ta n |
|
.It \&.Ox Ta Yes Ta Yes Ta n |
|
.It \&.Pf Ta \&No Ta Yes Ta 1 |
|
.It \&.Sm Ta \&No Ta \&No Ta 1 |
|
.It \&.Sx Ta Yes Ta Yes Ta >0 |
|
.It \&.Sy Ta Yes Ta Yes Ta >0 |
|
.It \&.Tn Ta Yes Ta Yes Ta >0 |
|
.It \&.Ux Ta Yes Ta Yes Ta n |
|
.It \&.Dx Ta Yes Ta Yes Ta n |
|
.It \&.Bt Ta \&No Ta \&No Ta 0 |
|
.It \&.Hf Ta \&No Ta \&No Ta n |
|
.It \&.Fr Ta \&No Ta \&No Ta n |
|
.It \&.Ud Ta \&No Ta \&No Ta 0 |
|
.It \&.Lb Ta \&No Ta \&No Ta 1 |
|
.It \&.Ap Ta Yes Ta Yes Ta 0 |
|
.It \&.Lp Ta \&No Ta \&No Ta 0 |
|
.It \&.Lk Ta \&No Ta Yes Ta >0 |
|
.It \&.Mt Ta \&No Ta Yes Ta >0 |
|
.It \&.Es Ta \&No Ta \&No Ta 0 |
|
.It \&.En Ta \&No Ta \&No Ta 0 |
|
.El |
|
.Pp |
.Pp |
|
Note that this should not be confused with |
|
.Sx \&Ft , |
|
which is used for function return types. |
|
.Pp |
|
Examples: |
|
.D1 \&.Vt unsigned char |
|
.D1 \&.Vt extern const char * const sys_signame[] \&; |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE |
|
and |
|
.Sx \&Va . |
|
.Ss \&Xc |
|
Close a scope opened by |
|
.Sx \&Xo . |
|
.Ss \&Xo |
|
Open an extension scope. |
|
This macro originally existed to extend the 9-argument limit of troff; |
|
since this limit has been lifted, the macro has been deprecated. |
|
.Ss \&Xr |
|
Link to another manual |
|
.Pq Qq cross-reference . |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Xr Cm name section |
|
.Pp |
The |
The |
.Sq \&Ot , |
.Cm name |
.Sq \&Fr , |
|
.Sq \&Es |
|
and |
and |
.Sq \&En , |
.Cm section |
macros are obsolete. |
are the name and section of the linked manual. |
.\" SECTION |
If |
|
.Cm section |
|
is followed by non-punctuation, an |
|
.Sx \&Ns |
|
is inserted into the token stream. |
|
This behaviour is for compatibility with |
|
.Xr groff 1 . |
|
.Pp |
|
Examples: |
|
.D1 \&.Xr mandoc 1 |
|
.D1 \&.Xr mandoc 1 \&; |
|
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
|
.Ss \&br |
|
.Ss \&sp |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
The mdoc language was traditionally a |
This section documents compatibility between mandoc and other other |
.Qq roff |
troff implementations, at this time limited to GNU troff |
macro package; most existing manuals were written with mdoc syntax |
.Pq Qq groff . |
dictated by system-dependent roff installations. This section documents |
The term |
compatibility with these systems. |
.Qq historic groff |
|
refers to groff versions before the |
|
.Pa doc.tmac |
|
file re-write |
|
.Pq somewhere between 1.15 and 1.19 . |
.Pp |
.Pp |
|
Heirloom troff, the other significant troff implementation accepting |
|
\-mdoc, is similar to historic groff. |
|
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Fo |
groff supports a |
and |
.Fl file Ar filename |
.Sq \&St |
argument to |
historically weren't always callable. Both are now correctly callable. |
.Sx \&Bd . |
.\" LIST-ITEM |
mandoc does not. |
.It |
.It |
.Sq \&It \-nested |
groff behaves inconsistently when encountering |
is assumed for all lists: any list may be nested and |
.Pf non- Sx \&Fa |
.Sq \-enum |
children of |
lists will restart the sequence only for the sub-list. |
.Sx \&Fo |
.\" LIST-ITEM |
regarding spacing between arguments. |
|
In mandoc, this is not the case: each argument is consistently followed |
|
by a single space and the trailing |
|
.Sq \&) |
|
suppresses prior spacing. |
.It |
.It |
.Sq \&It \-column |
groff behaves inconsistently when encountering |
syntax where column widths may be preceeded by other arguments (instead |
.Sx \&Ft |
of proceeded) is not supported. |
and |
.\" LIST-ITEM |
.Sx \&Fn |
|
in the |
|
.Em SYNOPSIS : |
|
at times newline(s) are suppressed depending on whether a prior |
|
.Sx \&Fn |
|
has been invoked. |
|
In mandoc, this is not the case. |
|
See |
|
.Sx \&Ft |
|
and |
|
.Sx \&Fn |
|
for the normalised behaviour. |
.It |
.It |
The |
Historic groff does not break before an |
.Sq \&At |
.Sx \&Fn |
macro only accepts a single parameter. |
when not invoked as the line macro in the |
.\" LIST-ITEM |
.Em SYNOPSIS |
|
section. |
.It |
.It |
The system-name macros ( |
Historic groff formats the |
.Ns Sq \&At , |
.Sx \&In |
.Sq \&Bsx , |
badly: trailing arguments are trashed and |
.Sq \&Bx , |
.Em SYNOPSIS |
.Sq \&Fx , |
is not specially treated. |
.Sq \&Nx , |
|
.Sq \&Ox , |
|
and |
|
.Sq \&Ux ) |
|
are callable. |
|
.\" LIST-ITEM |
|
.It |
.It |
Some manuals use |
groff does not accept the |
.Sq \&Li |
.Sq \&Ta |
incorrectly by following it with a reserved character and expecting the |
pseudo-macro as a line macro. |
delimiter to render. This is not supported. |
mandoc does. |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Cd |
The comment syntax |
is callable. |
.Sq \e." |
.El |
is no longer accepted. |
.\" SECTION |
|
.Sh SEE ALSO |
|
.Xr mdoctree 1 , |
|
.Xr mdoclint 1 , |
|
.Xr mdocterm 1 , |
|
.Xr mdoc 3 |
|
.\" SECTION |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
utility was written by |
|
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
|
.\" SECTION |
|
.Sh CAVEATS |
|
There are several ambiguous parts of mdoc. |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Fa |
In groff, the |
should be |
.Sx \&Pa |
.Sq \&Va |
macro does not format its arguments when used in the FILES section under |
as function arguments are variables. |
certain list types. |
.\" LIST-ITEM |
mandoc does. |
.It |
.It |
.Sq \&Ft |
Historic groff does not print a dash for empty |
should be |
.Sx \&Fl |
.Sq \&Vt |
arguments. |
as function return types are still types. Furthermore, the |
mandoc and newer groff implementations do. |
.Sq \&Ft |
|
should be removed and |
|
.Sq \&Fo , |
|
which ostensibly follows it, should follow the same convention as |
|
.Sq \&Va . |
|
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Va |
groff behaves irregularly when specifying |
should formalise that only one or two arguments are acceptable: a |
.Sq \ef |
variable name and optional, preceeding type. |
.Sx Text Decoration |
.\" LIST-ITEM |
within line-macro scopes. |
|
mandoc follows a consistent system. |
.It |
.It |
.Sq \&Fd |
In mandoc, negative scaling units are truncated to zero; groff would |
is ambiguous. It's commonly used to indicate an include file in the |
move to prior lines. |
synopsis section. |
Furthermore, the |
.Sq \&In |
.Sq f |
should be used, instead. |
scaling unit, while accepted, is rendered as the default unit. |
.\" LIST-ITEM |
|
.It |
.It |
Only the |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
.Sq \-literal |
standalone double-quote in formatted output. |
argument to |
This idiosyncratic behaviour is not applicable in mandoc. |
.Sq \&Bd |
|
makes sense. The remaining ones should be removed. |
|
.\" LIST-ITEM |
|
.It |
.It |
The |
Display types |
.Sq \&Xo |
.Sx \&Bd |
|
.Fl center |
and |
and |
.Sq \&Xc |
.Fl right |
macros should be deprecated. |
are aliases for |
.\" LIST-ITEM |
.Fl left |
|
in mandoc. Furthermore, the |
|
.Fl file Ar file |
|
argument is ignored. |
|
Lastly, since text is not right-justified in mandoc (or even groff), |
|
.Fl ragged |
|
and |
|
.Fl filled |
|
are aliases, as are |
|
.Fl literal |
|
and |
|
.Fl unfilled . |
.It |
.It |
The |
Historic groff has many un-callable macros. |
.Sq \&Dt |
Most of these (excluding some block-level macros) are now callable. |
macro lacks clarity. It should be absolutely clear which title will |
|
render when formatting the manual page. |
|
.\" LIST-ITEM |
|
.It |
.It |
A |
The vertical bar |
.Sq \&Lx |
.Sq \(ba |
should be provided for Linux (\(`a la |
made historic groff |
.Sq \&Ox , |
.Qq go orbital |
.Sq \&Nx |
but has been a proper delimiter since then. |
etc.). |
.It |
|
.Sx \&It Fl nested |
|
is assumed for all lists (it wasn't in historic groff): any list may be |
|
nested and |
|
.Fl enum |
|
lists will restart the sequence only for the sub-list. |
|
.It |
|
Some manuals use |
|
.Sx \&Li |
|
incorrectly by following it with a reserved character and expecting the |
|
delimiter to render. |
|
This is not supported in mandoc. |
|
.It |
|
In groff, the |
|
.Sx \&Cd , |
|
.Sx \&Er , |
|
.Sx \&Ex , |
|
and |
|
.Sx \&Rv |
|
macros were stipulated only to occur in certain manual sections. |
|
mandoc does not have these restrictions. |
|
.It |
|
Newer groff and mandoc print |
|
.Qq AT&T UNIX |
|
prior to unknown arguments of |
|
.Sx \&At ; |
|
older groff did nothing. |
.El |
.El |
|
.Sh SEE ALSO |
|
.Xr mandoc 1 , |
|
.Xr mandoc_char 7 |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
reference was written by |
|
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
|
.\" |
|
.\" XXX: this really isn't the place for these caveats. |
|
.\" . |
|
.\" . |
|
.\" .Sh CAVEATS |
|
.\" There are many ambiguous parts of mdoc. |
|
.\" . |
|
.\" .Pp |
|
.\" .Bl -dash -compact |
|
.\" .It |
|
.\" .Sq \&Fa |
|
.\" should be |
|
.\" .Sq \&Va |
|
.\" as function arguments are variables. |
|
.\" .It |
|
.\" .Sq \&Ft |
|
.\" should be |
|
.\" .Sq \&Vt |
|
.\" as function return types are still types. Furthermore, the |
|
.\" .Sq \&Ft |
|
.\" should be removed and |
|
.\" .Sq \&Fo , |
|
.\" which ostensibly follows it, should follow the same convention as |
|
.\" .Sq \&Va . |
|
.\" .It |
|
.\" .Sq \&Va |
|
.\" should formalise that only one or two arguments are acceptable: a |
|
.\" variable name and optional, preceding type. |
|
.\" .It |
|
.\" .Sq \&Fd |
|
.\" is ambiguous. It's commonly used to indicate an include file in the |
|
.\" synopsis section. |
|
.\" .Sq \&In |
|
.\" should be used, instead. |
|
.\" .It |
|
.\" Only the |
|
.\" .Sq \-literal |
|
.\" argument to |
|
.\" .Sq \&Bd |
|
.\" makes sense. The remaining ones should be removed. |
|
.\" .It |
|
.\" The |
|
.\" .Sq \&Xo |
|
.\" and |
|
.\" .Sq \&Xc |
|
.\" macros should be deprecated. |
|
.\" .It |
|
.\" The |
|
.\" .Sq \&Dt |
|
.\" macro lacks clarity. It should be absolutely clear which title will |
|
.\" render when formatting the manual page. |
|
.\" .It |
|
.\" A |
|
.\" .Sq \&Lx |
|
.\" should be provided for Linux (\(`a la |
|
.\" .Sq \&Ox , |
|
.\" .Sq \&Nx |
|
.\" etc.). |
|
.\" .It |
|
.\" There's no way to refer to references in |
|
.\" .Sq \&Rs/Re |
|
.\" blocks. |
|
.\" .It |
|
.\" The \-split and \-nosplit dictates via |
|
.\" .Sq \&An |
|
.\" are re-set when entering and leaving the AUTHORS section. |
|
.\" .El |
|
.\" . |