version 1.12, 2009/03/21 13:47:02 |
version 1.61, 2009/10/18 13:58:48 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" 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. An |
manuals. In this reference document, we describe its syntax, structure, |
|
and usage. Our reference implementation is |
|
.Xr mandoc 1 . |
|
The |
|
.Sx COMPATIBILITY |
|
section describes compatibility with |
|
.Xr groff 1 . |
|
. |
|
.Pp |
|
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. This document describes the encoding, ontology and syntax |
prior macros: |
of these macros. |
.Bd -literal -offset indent |
.\" SECTION |
\&.Sh Macro lines change control state. |
.Sh CHARACTER ENCODING |
Other lines are interpreted within the current state. |
|
.Ed |
|
. |
|
. |
|
.Sh LANGUAGE SYNTAX |
.Nm |
.Nm |
documents may contain only printable characters, the space character |
documents may contain only graphable 7-bit ASCII characters, the space |
.Sq \ , |
character, and, in certain circumstances, the tab character. All |
and, in certain circumstances, the tab character |
manuals must have |
.Sq \et . |
.Ux |
All manuals must have |
line terminators. |
.Sq \en |
. |
line termination. |
. |
.Pp |
.Ss Comments |
The only time a blank line is acceptable is within |
Text following a |
the context of |
.Sq \e" , |
.Sq \&Bd \-literal |
whether in a macro or free-form text line, is ignored to the end of |
or |
line. A macro line with only a control character and comment escape, |
.Sq \&Bd \-unfilled . |
.Sq \&.\e" , |
.Pp |
is also ignored. Macro lines with only a control charater and optionally |
Tab characters |
whitespace are stripped from input. |
.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 87 Within a macro line, the following characters are rese |
|
Line 94 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 |
.Pp |
.Xr mandoc_char 7 |
Characters may alternatively be escaped by a slash-asterisk, |
for a complete list. Examples include |
.Sq \\* , |
.Sq \e(em |
with the same combinations as described above. This form is deprecated. |
|
.Pp |
|
The following is a table of all available escapes. |
|
.Pp |
|
Grammatic: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(em |
|
.Pq em-dash |
.Pq em-dash |
.It \\(en |
and |
.Pq en-dash |
.Sq \ee |
.It \e- |
.Pq back-slash . |
.Pq hyphen |
. |
.It \\\\ |
. |
.Pq back-slash |
.Ss Text Decoration |
.It \e' |
Terms may be text-decorated using the |
.Pq apostrophe |
.Sq \ef |
.It \e` |
escape followed by an indicator: B (bold), I, (italic), or P and R |
.Pq back-tick |
(Roman, or reset). This form is not recommended for |
.It \\ |
.Nm , |
.Pq space |
which encourages semantic, not presentation, annotation. |
.It \\. |
. |
.Pq period |
. |
.It \\(r! |
.Ss Predefined Strings |
.Pq upside-down exclamation |
Historically, |
.It \\(r? |
.Xr groff 1 |
.Pq upside-down question |
also defined a set of package-specific |
.El |
.Dq predefined strings , |
.\" PARAGRAPH |
which, like |
|
.Sx Special Characters , |
|
demark 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 |
|
In non-literal free-form lines, consecutive blocks of whitespace are |
|
pruned from input and added later in the output filter, if applicable: |
|
.Bd -literal -offset indent |
|
These spaces are pruned from input. |
|
\&.Bd \-literal |
|
These are not. |
|
\&.Ed |
|
.Ed |
|
. |
.Pp |
.Pp |
Enclosures: |
In macro lines, whitespace delimits arguments and is discarded. If |
.Bl -tag -width 12n -offset "XXXX" -compact |
arguments are quoted, whitespace within the quotes is retained. |
.It \\(lh |
. |
.Pq left hand |
|
.It \\(rh |
|
.Pq right hand |
|
.It \\(Fo |
|
.Pq left guillemet |
|
.It \\(Fc |
|
.Pq right guillemet |
|
.It \\(fo |
|
.Pq left guilsing |
|
.It \\(fc |
|
.Pq right guilsing |
|
.It \\(rC |
|
.Pq right brace |
|
.It \\(lC |
|
.Pq left brace |
|
.It \\(ra |
|
.Pq right angle |
|
.It \\(la |
|
.Pq left angle |
|
.It \\(rB |
|
.Pq right bracket |
|
.It \\(lB |
|
.Pq left bracket |
|
.It \\q |
|
.Pq double-quote |
|
.It \\(lq |
|
.Pq left double-quote |
|
.It \\(Lq |
|
.Pq left double-quote, deprecated |
|
.It \\(rq |
|
.Pq right double-quote |
|
.It \\(Rq |
|
.Pq right double-quote, deprecated |
|
.It \\(oq |
|
.Pq left single-quote |
|
.It \\(aq |
|
.Pq right single-quote |
|
.It \\(Bq |
|
.Pq right low double-quote |
|
.It \\(bq |
|
.Pq right low single-quote |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Indicatives: |
Blank lines are only permitted within literal contexts, as are lines |
.Bl -tag -width 12n -offset "XXXX" -compact |
containing only whitespace. Tab characters are only acceptable when |
.It \\(<- |
delimiting |
.Pq left arrow |
.Sq \&Bl \-column |
.It \\(-> |
or when in a literal context. |
.Pq right arrow |
. |
.It \\(ua |
. |
.Pq up arrow |
.Ss Quotation |
.It \\(da |
Macro arguments may be quoted with a double-quote to group |
.Pq down arrow |
space-delimited terms or to retain blocks of whitespace. A quoted |
.It \\(<> |
argument begins with a double-quote preceded by whitespace. The next |
.Pq left-right arrow |
double-quote not pair-wise adjacent to another double-quote terminates |
.It \\(lA |
the literal, regardless of surrounding whitespace. |
.Pq left double-arrow |
. |
.It \\(rA |
|
.Pq right double-arrow |
|
.It \\(uA |
|
.Pq up double-arrow |
|
.It \\(dA |
|
.Pq down double-arrow |
|
.It \\(hA |
|
.Pq left-right double-arrow |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Mathematical: |
This produces tokens |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq a" , |
.It \\(es |
.Sq b c , |
.Pq empty set |
.Sq de , |
.It \\(ca |
and |
.Pq intersection |
.Sq fg" . |
.It \\(cu |
Note that any quoted term, be it argument or macro, is indiscriminately |
.Pq union |
considered literal text. Thus, the following produces |
.It \\(gr |
.Sq \&Em a : |
.Pq gradient |
.Bd -literal -offset indent |
.It \\(pd |
\&.Em "Em a" |
.Pq partial differential |
.Ed |
.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 |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Ligatures: |
In free-form mode, quotes are regarded as opaque text. |
.Bl -tag -width 12n -offset "XXXX" -compact |
. |
.It \\(ss |
.Ss Scaling Widths |
.Pq German eszett |
Many macros support scaled widths for their arguments, such as |
.It \\(AE |
stipulating a two-inch list indentation with the following: |
.Pq upper-case AE |
.Bd -literal -offset indent |
.It \\(ae |
\&.Bl -tag -width 2i |
.Pq lower-case AE |
.Ed |
.It \\(OE |
. |
.Pq upper-case OE |
|
.It \\(oe |
|
.Pq lower-case OE |
|
.It \\(ff |
|
.Pq ff ligature |
|
.It \\(fi |
|
.Pq fi ligature |
|
.It \\(fl |
|
.Pq fl ligature |
|
.It \\(Fi |
|
.Pq ffi ligature |
|
.It \\(Fl |
|
.Pq ffl ligature |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Diacritics and letters: |
The syntax for scaled widths is |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq Li [+-]?[0-9]*.[0-9]*[unit] , |
.It \\(ga |
where a decimal must be preceded or proceeded by at least one digit. |
.Pq grave accent |
Negative numbers, while accepted, are truncated to zero. The following |
.It \\(aa |
scaling units are accepted: |
.Pq accute accent |
|
.It \\(a" |
|
.Pq umlaut accent |
|
.It \\(ad |
|
.Pq dieresis accent |
|
.It \\(a~ |
|
.Pq tilde accent |
|
.It \\(a^ |
|
.Pq circumflex accent |
|
.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 |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Monetary: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It c |
.It \\(Cs |
centimetre |
.Pq Scandinavian |
.It i |
.It \\(Do |
inch |
.Pq dollar |
.It P |
.It \\(Po |
pica (~1/6 inch) |
.Pq pound |
.It p |
.It \\(Ye |
point (~1/72 inch) |
.Pq yen |
.It f |
.It \\(Fn |
synonym for |
.Pq florin |
.Sq u |
.It \\(ct |
.It v |
.Pq cent |
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 |
Special symbols: |
Using anything other than |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq m , |
.It \\(de |
.Sq n , |
.Pq degree |
.Sq u , |
.It \\(ps |
or |
.Pq paragraph |
.Sq v |
.It \\(sc |
is necessarily non-portable across output media. See |
.Pq section |
.Sx COMPATIBILITY . |
.It \\(dg |
. |
.Pq dagger |
. |
.It \\(dd |
.Sh MANUAL STRUCTURE |
.Pq double dagger |
Each |
.It \\(ci |
.Nm |
.Pq circle |
document must begin with a document prologue, containing, in order, |
.It \\(ba |
.Sq \&Dd , |
.Pq bar |
.Sq \&Dt , |
.It \\(bb |
and |
.Pq broken bar |
.Sq \&Os , |
.It \\(Ba |
then the NAME section containing at least one |
.Pq bar, deprecated |
.Sq \&Nm |
.It \\(co |
followed by |
.Pq copyright |
.Sq \&Nd : |
.It \\(rg |
.Bd -literal -offset indent |
.Pq registered |
\&.Dd $\&Mdocdate$ |
.It \\(tm |
\&.Dt mdoc 7 |
.Pq trademarked |
\&.Os |
.It \\& |
\&. |
.Pq non-breaking space |
\&.Sh NAME |
.It \\e |
\&.Nm foo |
.Pq escape |
\&.Nd a description goes here |
.It \\(Am |
\&.\e\*q The next is for sections 2 & 3 only. |
.Pq ampersand, deprecated |
\&.\e\*q .Sh LIBRARY |
.El |
\&. |
.\" SECTION |
\&.Sh SYNOPSIS |
.Sh ONTOLOGY |
\&.Nm foo |
Macros are classified in an ontology described by scope rules. |
\&.Op Fl options |
.\" SUB-SECTION |
\&.Ar |
.Ss Scope |
\&. |
.Bl -inset |
\&.Sh DESCRIPTION |
.\" LIST-ITEM |
The |
.It Em Block |
\&.Nm |
macros enclose other block macros, in-line macros or text, and |
utility processes files ... |
may span multiple lines. |
\&.\e\*q .Sh IMPLEMENTATION NOTES |
.Bl -inset -offset XXXX |
\&.\e\*q The next is for sections 1 & 8 only. |
.\" LIST-ITEM |
\&.\e\*q .Sh EXIT STATUS |
.It Em Full-block |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
macros always span multiple lines. They consist of zero or |
\&.\e\*q .Sh RETURN VALUES |
more |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
.Qq heads , |
\&.\e\*q .Sh ENVIRONMENT |
subsequent macros or text on the same line following invocation; an |
\&.\e\*q .Sh FILES |
optional |
\&.\e\*q .Sh EXAMPLES |
.Qq body , |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
which spans subsequent lines of text or macros; and an optional |
\&.\e\*q .Sh DIAGNOSTICS |
.Qq tail , |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
macros or text on the same line following closure. |
\&.\e\*q .Sh ERRORS |
.\" LIST-ITEM |
\&.\e\*q .Sh SEE ALSO |
.It Em Partial-block |
\&.\e\*q .Xr foobar 1 |
macros may span multiple lines. They consists of a optional |
\&.\e\*q .Sh STANDARDS |
.Qq head , |
\&.\e\*q .Sh HISTORY |
text immediately following invocation; always a |
\&.\e\*q .Sh AUTHORS |
.Qq body , |
\&.\e\*q .Sh CAVEATS |
text or macros following the head on the same and subsequent lines; and |
\&.\e\*q .Sh BUGS |
optionally a |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
.Qq tail , |
.Ed |
text immediately following closure. |
. |
.\" LIST-ITEM |
|
.It Em In-line |
|
macros may only enclose text and span at most a single line. |
|
.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 |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
.It BPE , BFE |
but non-compulsory. |
corresponding explicit closure macro |
. |
.It BFI |
. |
end-of-file or a corresponding implicit closure macro |
.Sh MACRO SYNTAX |
.It BPI |
Macros are one to three three characters in length and begin with a |
end-of-line (body may be closed by >0 space-separated |
control character , |
.Sx Reserved Characters , |
.Sq \&. , |
although block scope will still be open) |
at the beginning of the line. An arbitrary amount of whitespace may |
.It INL |
sit between the control character and the macro name. Thus, |
end-of-line |
.Sq \&.Pp |
.El |
and |
.\" PARAGRAPH |
.Sq \&.\ \ \ \&Pp |
|
are equivalent. Macro names are two or three characters in length. |
|
. |
.Pp |
.Pp |
If a macro (block or in-line) is parsable, it may also be closed out by |
The syntax of a macro depends on its classification. In this section, |
one of the following scenarios (unless specifically noted otherwise): |
.Sq \-arg |
.\" PARAGRAPH |
refers to macro arguments, which may be followed by zero or more |
|
.Sq parm |
|
parameters; |
|
.Sq \&Yo |
|
opens the scope of a macro; and if specified, |
|
.Sq \&Yc |
|
closes it out. |
|
. |
.Pp |
.Pp |
.Bl -dash -offset XXXX -compact |
The |
.It |
.Em Callable |
a sequence of >0 space-separated |
column indicates that the macro may be called subsequent to the initial |
.Sx Reserved Characters , |
line-macro. If a macro is not callable, then its invocation after the |
.It |
initial line macro is interpreted as opaque text, such that |
another macro, |
.Sq \&.Fl \&Sh |
.It |
produces |
end-of-line, or |
.Sq Fl \&Sh . |
.It |
. |
completion of a set number of arguments. |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
If >0 space-separated |
The |
.Sx Reserved Characters |
.Em Parsable |
are followed by non-reserved characters, the behaviour differs per |
column indicates whether the macro may be followed by further |
macro. In general, scope of the macro is closed and re-opened: |
(ostensibly callable) macros. If a macro is not parsable, subsequent |
subsequent tokens are interpreted as if the scope had just been opened. |
macro invocations on the line will be interpreted as opaque text. |
In other circumstances, scope is simply closed out. |
. |
.\" SECTION |
|
.Sh SYNTAX |
|
Macros are generally two and at times three characters in length. The |
|
syntax of macro invocation depends on its classification. |
|
.Qq \-arg |
|
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). |
The |
.Bd -literal -offset XXXX |
.Em Scope |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
column, if applicable, describes closure rules. |
\(lBbody...\(rB |
. |
\&.Yc \(lBtail...\(rB |
. |
.Ed |
.Ss Block full-explicit |
.\" PARAGRAPH |
Multi-line scope closed by an explicit closing macro. All macros |
.Pp |
contains bodies; only |
Block full-implicit (may contain zero or more heads, body, no tail). |
.Pq Sq \&Bf |
.Bd -literal -offset XXXX |
contains a head. |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
.Bd -literal -offset indent |
\(lBbody...\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
\&.Yc |
\&.Yc |
.Ed |
.Ed |
.\" PARAGRAPH |
. |
.Pp |
.Pp |
Block partial-explicit (may contain head, multi-line body, tail). |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" |
.Bd -literal -offset XXXX |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
.It \&Bd Ta \&No Ta \&No Ta closed by \&Ed |
\(lBbody...\(rB |
.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef |
\&.Yc \(lBtail...\(rB |
.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek |
|
.It \&Bl Ta \&No Ta \&No Ta closed by \&El |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ |
.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd |
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf |
.Ed |
.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk |
.\" PARAGRAPH |
.It \&El Ta \&No Ta \&No Ta opened by \&Bl |
.Pp |
.El |
Block partial-implicit (no head, body, no tail). Note that the body |
. |
section may be followed by zero or more |
. |
.Sx Reserved Words . |
|
These are in the block scope, but not in the body scope. |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB |
|
.Ed |
|
.\" PARAGRAPH |
|
.Pp |
|
In-lines have \(>=0 scoped arguments. |
|
.Bd -literal -offset XXX |
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
|
.Ed |
|
.\" |
|
.Sh MACROS |
|
This section contains a complete list of all |
|
.Nm |
|
macros, arranged ontologically. A |
|
.Qq callable |
|
macro is may be invoked subsequent to the initial macro-line macro. A |
|
.Qq parsable |
|
macro may be followed by further (ostensibly callable) macros. |
|
.\" SUB-SECTION |
|
.Ss Block full-implicit |
.Ss Block full-implicit |
The head of these macros follows invocation; the body is the content of |
Multi-line scope closed by end-of-file or implicitly by another macro. |
subsequent lines prior to closure. None of these macros have tails; |
All macros have bodies; some |
some |
|
.Po |
.Po |
.Sq \&It \-bullet , |
.Sq \&It \-bullet , |
.Sq \-hyphen , |
.Sq \-hyphen , |
.Sq \-dash , |
.Sq \-dash , |
.Sq \-enum , |
.Sq \-enum , |
.Sq \-item |
.Sq \-item |
.Pc |
.Pc |
don't have heads. |
don't have heads, while |
|
.Sq \&It \-column |
|
may have multiple heads. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
. |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX |
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing |
|
.It \&.Sh Ta \&No Ta \&No Ta \&.Sh |
|
.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss |
|
.It \&.It Ta \&No Ta Yes Ta \&.It, \&.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 |
|
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX |
|
.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 \&It Ta \&No Ta Yes Ta closed by \&It, \&El |
.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd |
.It \&Nd Ta \&No Ta \&No Ta closed by \&Sh |
.It \&.Bl Ta \&No Ta \&No Ta closed by \&.El |
.It \&Sh Ta \&No Ta \&No Ta closed by \&Sh |
.It \&.El Ta \&No Ta \&No Ta opened by \&.Bl |
.It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss |
.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 |
.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 |
|
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX |
|
.It Em Macro Ta Em Callable Ta Em Parsable |
|
.It \&.Aq Ta Yes Ta Yes |
|
.It \&.Op Ta Yes Ta Yes |
|
.It \&.Bq Ta Yes Ta Yes |
|
.It \&.Dq Ta Yes Ta Yes |
|
.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 |
|
.\" SUB-SECTION |
|
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Each of these contains at least a body and, in limited circumstances, a |
Like block full-explicit, but also with single-line scope. Each |
head |
has at least a body and, in limited circumstances, a head |
.Pq So \&Fo Sc , So \&Eo Sc |
.Pq So \&Fo Sc , So \&Eo Sc |
and/or tail |
and/or tail |
.Pq So \&Ec Sc . |
.Pq So \&Ec Sc . |
|
.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 |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
.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 \&.Ao Ta Yes Ta Yes Ta closed by \&.Ac |
.It \&Ac Ta Yes Ta Yes Ta opened by \&Ao |
.It \&.Ac Ta Yes Ta Yes Ta opened by \&.Ao |
.It \&Ao Ta Yes Ta Yes Ta closed by \&Ac |
.It \&.Bc Ta Yes Ta Yes Ta closed by \&.Bo |
.It \&Bc Ta Yes Ta Yes Ta closed by \&Bo |
.It \&.Bo Ta Yes Ta Yes Ta opened by \&.Bc |
.It \&Bo Ta Yes Ta Yes Ta opened by \&Bc |
.It \&.Pc Ta Yes Ta Yes Ta closed by \&.Po |
.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro |
.It \&.Po Ta Yes Ta Yes Ta opened by \&.Pc |
.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc |
.It \&.Do Ta Yes Ta Yes Ta closed by \&.Dc |
.It \&Dc Ta Yes Ta Yes Ta opened by \&Do |
.It \&.Dc Ta Yes Ta Yes Ta opened by \&.Do |
.It \&Do Ta Yes Ta Yes Ta closed by \&Dc |
.It \&.Xo Ta Yes Ta Yes Ta closed by \&.Xc |
.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo |
.It \&.Xc Ta Yes Ta Yes Ta opened by \&.Xo |
.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec |
.It \&.Bro Ta Yes Ta Yes Ta closed by \&.Brc |
.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo |
.It \&.Brc Ta Yes Ta Yes Ta opened by \&.Bro |
.It \&Fo Ta \&No Ta \&No Ta closed by \&Fc |
.It \&.Oc Ta Yes Ta Yes Ta closed by \&.Oo |
.It \&Oc Ta Yes Ta Yes Ta closed by \&Oo |
.It \&.Oo Ta Yes Ta Yes Ta opened by \&.Oc |
.It \&Oo Ta Yes Ta Yes Ta opened by \&Oc |
.It \&.So Ta Yes Ta Yes Ta closed by \&.Sc |
.It \&Pc Ta Yes Ta Yes Ta closed by \&Po |
.It \&.Sc Ta Yes Ta Yes Ta opened by \&.So |
.It \&Po Ta Yes Ta Yes Ta opened by \&Pc |
.It \&.Fc Ta Yes Ta Yes Ta opened by \&.Fo |
.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo |
.It \&.Fo Ta \&No Ta \&No Ta closed by \&.Fc |
.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc |
.It \&.Ec Ta Yes Ta Yes Ta opened by \&.Eo |
.It \&Re Ta \&No Ta \&No Ta opened by \&Rs |
.It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec |
.It \&Rs Ta \&No Ta \&No Ta closed by \&Re |
.It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo |
.It \&Sc Ta Yes Ta Yes Ta opened by \&So |
.It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc |
.It \&So Ta Yes Ta Yes Ta closed by \&Sc |
.It \&.Re Ta \&No Ta \&No Ta opened by \&.Rs |
.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo |
.It \&.Rs Ta \&No Ta \&No Ta closed by \&.Re |
.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc |
.El |
.El |
.\" SUB-SECTION |
. |
.Ss In-line |
. |
In-line macros have only text children. If a number (or inequality) of |
.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 |
|
.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsable |
|
.It \&Aq Ta Yes Ta Yes |
|
.It \&Bq Ta Yes Ta Yes |
|
.It \&Brq Ta Yes Ta Yes |
|
.It \&D1 Ta \&No Ta \&Yes |
|
.It \&Dl Ta \&No Ta Yes |
|
.It \&Dq Ta Yes Ta Yes |
|
.It \&Op Ta Yes Ta Yes |
|
.It \&Pq Ta Yes Ta Yes |
|
.It \&Ql Ta Yes Ta Yes |
|
.It \&Qq Ta Yes Ta Yes |
|
.It \&Sq Ta Yes Ta Yes |
|
.El |
|
. |
|
. |
|
.Ss In-line |
|
Closed by |
|
.Sx Reserved Characters , |
|
end of line, fixed argument lengths, and/or subsequent macros. In-line |
|
macros have only text children. If a number (or inequality) of |
arguments is |
arguments is |
.Pq n , |
.Pq n , |
then the macro accepts an arbitrary number of arguments. |
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 |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX |
.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments |
.It \&.Dd Ta \&No Ta \&No Ta >0 |
.It \&%A Ta \&No Ta \&No Ta >0 |
.It \&.Dt Ta \&No Ta \&No Ta n |
.It \&%B Ta \&No Ta \&No Ta >0 |
.It \&.Os Ta \&No Ta \&No Ta n |
.It \&%C Ta \&No Ta \&No Ta >0 |
.It \&.Pp Ta \&No Ta \&No Ta 0 |
.It \&%D Ta \&No Ta \&No Ta >0 |
.It \&.Ad Ta Yes Ta Yes Ta n |
.It \&%I Ta \&No Ta \&No Ta >0 |
.It \&.An Ta \&No Ta Yes Ta n |
.It \&%J Ta \&No Ta \&No Ta >0 |
.It \&.Ar Ta Yes Ta Yes Ta n |
.It \&%N Ta \&No Ta \&No Ta >0 |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
.It \&%O Ta \&No Ta \&No Ta >0 |
.It \&.Cm Ta Yes Ta Yes Ta n |
.It \&%P Ta \&No Ta \&No Ta >0 |
.It \&.Dv Ta Yes Ta Yes Ta n |
.It \&%R Ta \&No Ta \&No Ta >0 |
.It \&.Er Ta Yes Ta Yes Ta >0 |
.It \&%T Ta \&No Ta \&No Ta >0 |
.It \&.Ev Ta Yes Ta Yes Ta n |
.It \&%V Ta \&No Ta \&No Ta >0 |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
.It \&Ad Ta Yes Ta Yes Ta n |
.It \&.Fa Ta Yes Ta Yes Ta n |
.It \&An Ta Yes Ta Yes Ta n |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
.It \&Ap Ta Yes Ta Yes Ta 0 |
.It \&.Fl Ta Yes Ta Yes Ta n |
.It \&Ar Ta Yes Ta Yes Ta n |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
.It \&At Ta Yes Ta Yes Ta 1 |
.It \&.Ft Ta \&No Ta Yes Ta n |
.It \&Bsx Ta Yes Ta Yes Ta n |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
.It \&Bt Ta \&No Ta \&No Ta 0 |
.It \&.In Ta \&No Ta \&No Ta n |
.It \&Bx Ta Yes Ta Yes Ta n |
.It \&.Li Ta Yes Ta Yes Ta n |
.It \&Cd Ta Yes Ta Yes Ta >0 |
.It \&.Nd Ta \&No Ta \&No Ta n |
.It \&Cm Ta Yes Ta Yes Ta n |
.It \&.Nm Ta Yes Ta Yes Ta n |
.It \&Db Ta \&No Ta \&No Ta 1 |
.It \&.Ot Ta \&No Ta \&No Ta n |
.It \&Dd Ta \&No Ta \&No Ta >0 |
.It \&.Pa Ta Yes Ta Yes Ta n |
.It \&Dt Ta \&No Ta \&No Ta n |
.It \&.Rv Ta \&No Ta \&No Ta 0 |
.It \&Dv Ta Yes Ta Yes Ta n |
.It \&.St Ta \&No Ta Yes Ta 1 |
.It \&Dx Ta Yes Ta Yes Ta n |
.It \&.Va Ta Yes Ta Yes Ta n |
.It \&Em Ta Yes Ta Yes Ta >0 |
.It \&.Vt Ta Yes Ta Yes Ta >0 |
.It \&En Ta \&No Ta \&No Ta 0 |
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&Er Ta Yes Ta Yes Ta >0 |
.It \&.%A Ta \&No Ta \&No Ta >0 |
.It \&Es Ta \&No Ta \&No Ta 0 |
.It \&.%B Ta \&No Ta \&No Ta >0 |
.It \&Ev Ta Yes Ta Yes Ta n |
.It \&.%C Ta \&No Ta \&No Ta >0 |
.It \&Ex Ta \&No Ta \&No Ta n |
.It \&.%D Ta \&No Ta \&No Ta >0 |
.It \&Fa Ta Yes Ta Yes Ta n |
.It \&.%I Ta \&No Ta \&No Ta >0 |
.It \&Fd Ta \&No Ta \&No Ta >0 |
.It \&.%J Ta \&No Ta \&No Ta >0 |
.It \&Fl Ta Yes Ta Yes Ta n |
.It \&.%N Ta \&No Ta \&No Ta >0 |
.It \&Fn Ta Yes Ta Yes Ta >0 |
.It \&.%O Ta \&No Ta \&No Ta >0 |
.It \&Fr Ta \&No Ta \&No Ta n |
.It \&.%P Ta \&No Ta \&No Ta >0 |
.It \&Ft Ta Yes Ta Yes Ta n |
.It \&.%R Ta \&No Ta \&No Ta >0 |
.It \&Fx Ta Yes Ta Yes Ta n |
.It \&.%T Ta \&No Ta \&No Ta >0 |
.It \&Hf Ta \&No Ta \&No Ta n |
.It \&.%V Ta \&No Ta \&No Ta >0 |
.It \&Ic Ta Yes Ta Yes Ta >0 |
.It \&.At Ta Yes Ta Yes Ta 1 |
.It \&In Ta \&No Ta \&No Ta n |
.It \&.Bsx Ta Yes Ta Yes Ta n |
.It \&Lb Ta \&No Ta \&No Ta 1 |
.It \&.Bx Ta Yes Ta Yes Ta n |
.It \&Li Ta Yes Ta Yes Ta n |
.It \&.Db Ta \&No Ta \&No Ta 1 |
.It \&Lk Ta Yes Ta Yes Ta n |
.It \&.Em Ta Yes Ta Yes Ta n |
.It \&Lp Ta \&No Ta \&No Ta 0 |
.It \&.Fx Ta Yes Ta Yes Ta n |
.It \&Ms Ta Yes Ta Yes Ta >0 |
.It \&.Ms Ta \&No Ta Yes Ta >0 |
.It \&Mt Ta Yes Ta Yes Ta >0 |
.It \&.No Ta Yes Ta Yes Ta 0 |
.It \&Nm Ta Yes Ta Yes Ta n |
.It \&.Ns Ta Yes Ta Yes Ta 0 |
.It \&No Ta Yes Ta Yes Ta 0 |
.It \&.Nx Ta Yes Ta Yes Ta n |
.It \&Ns Ta Yes Ta Yes Ta 0 |
.It \&.Ox Ta Yes Ta Yes Ta n |
.It \&Nx Ta Yes Ta Yes Ta n |
.It \&.Pf Ta \&No Ta Yes Ta 1 |
.It \&Os Ta \&No Ta \&No Ta n |
.It \&.Sm Ta \&No Ta \&No Ta 1 |
.It \&Ot Ta \&No Ta \&No Ta n |
.It \&.Sx Ta Yes Ta Yes Ta >0 |
.It \&Ox Ta Yes Ta Yes Ta n |
.It \&.Sy Ta Yes Ta Yes Ta >0 |
.It \&Pa Ta Yes Ta Yes Ta n |
.It \&.Tn Ta Yes Ta Yes Ta >0 |
.It \&Pf Ta \&No Ta Yes Ta 1 |
.It \&.Ux Ta Yes Ta Yes Ta n |
.It \&Pp Ta \&No Ta \&No Ta 0 |
.It \&.Dx Ta Yes Ta Yes Ta n |
.It \&Rv Ta \&No Ta \&No Ta n |
.It \&.Bt Ta \&No Ta \&No Ta 0 |
.It \&Sm Ta \&No Ta \&No Ta 1 |
.It \&.Hf Ta \&No Ta \&No Ta n |
.It \&St Ta \&No Ta Yes Ta 1 |
.It \&.Fr Ta \&No Ta \&No Ta n |
.It \&Sx Ta Yes Ta Yes Ta >0 |
.It \&.Ud Ta \&No Ta \&No Ta 0 |
.It \&Sy Ta Yes Ta Yes Ta >0 |
.It \&.Lb Ta \&No Ta \&No Ta 1 |
.It \&Tn Ta Yes Ta Yes Ta >0 |
.It \&.Ap Ta Yes Ta Yes Ta 0 |
.It \&Ud Ta \&No Ta \&No Ta 0 |
.It \&.Lp Ta \&No Ta \&No Ta 0 |
.It \&Ux Ta Yes Ta Yes Ta n |
.It \&.Lk Ta \&No Ta Yes Ta >0 |
.It \&Va Ta Yes Ta Yes Ta n |
.It \&.Mt Ta \&No Ta Yes Ta >0 |
.It \&Vt Ta Yes Ta Yes Ta >0 |
.It \&.Es Ta \&No Ta \&No Ta 0 |
.It \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&.En Ta \&No Ta \&No Ta 0 |
.It \&br Ta \&No Ta \&No Ta 0 |
.El |
.It \&sp Ta \&No Ta \&No Ta 1 |
.Pp |
.El |
The |
. |
.Sq \&Ot , |
. |
.Sq \&Fr , |
|
.Sq \&Es |
|
and |
|
.Sq \&En , |
|
macros are obsolete. |
|
.\" SECTION |
|
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
The mdoc language was traditionally a |
This section documents compatibility with other roff implementations, at |
.Qq roff |
this time limited to |
macro package; most existing manuals were written with mdoc syntax |
.Xr groff 1 . |
dictated by system-dependent roff installations. This section documents |
The term |
compatibility with these systems. |
.Qq historic groff |
|
refers to those versions before the |
|
.Pa doc.tmac |
|
file re-write |
|
.Pq somewhere between 1.15 and 1.19 . |
|
. |
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Fo |
Negative scaling units are now truncated to zero instead of creating |
and |
interesting conditions, such as with |
.Sq \&St |
.Sq \&sp -1i . |
historically weren't always callable. Both are now correctly callable. |
Furthermore, the |
.\" LIST-ITEM |
.Sq f |
|
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 |
|
standalone double-quote in formatted output. This idiosyncratic |
|
behaviour is no longer applicable. |
|
.It |
|
The |
|
.Sq \&sp |
|
macro does not accept negative numbers. |
|
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
|
lines (except when in literal mode), while groff would retain whitespace |
|
in free-form text lines. |
|
.It |
|
Historic groff has many un-callable macros. Most of these (excluding |
|
some block-level macros) are now callable, conforming to the |
|
non-historic groff version. |
|
.It |
|
The vertical bar |
|
.Sq \(ba |
|
made historic groff |
|
.Qq go orbital |
|
but is a proper delimiter in this implementation. |
|
.It |
.Sq \&It \-nested |
.Sq \&It \-nested |
is assumed for all lists: any list may be nested and |
is assumed for all lists (it wasn't in historic groff): any list may be |
|
nested and |
.Sq \-enum |
.Sq \-enum |
lists will restart the sequence only for the sub-list. |
lists will restart the sequence only for the sub-list. |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&It \-column |
.Sq \&It \-column |
syntax where column widths may be preceeded by other arguments (instead |
syntax where column widths may be preceded by other arguments (instead |
of proceeded) is not supported. |
of proceeded) is not supported. |
.\" LIST-ITEM |
|
.It |
.It |
The |
The |
.Sq \&At |
.Sq \&At |
macro only accepts a single parameter. |
macro only accepts a single parameter. |
.\" LIST-ITEM |
|
.It |
.It |
The system-name macros ( |
|
.Ns Sq \&At , |
|
.Sq \&Bsx , |
|
.Sq \&Bx , |
|
.Sq \&Fx , |
|
.Sq \&Nx , |
|
.Sq \&Ox , |
|
and |
|
.Sq \&Ux ) |
|
are callable. |
|
.\" LIST-ITEM |
|
.It |
|
Some manuals use |
Some manuals use |
.Sq \&Li |
.Sq \&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. |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Cd |
In groff, the |
is callable. |
.Sq \&Fo |
|
macro only produces the first parameter. This is no longer the case. |
.El |
.El |
.\" SECTION |
. |
|
. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mandoc 1 , |
.Xr mdoclint 1 , |
.Xr mandoc_char 7 |
.Xr mdocterm 1 , |
. |
.Xr mdoc 3 |
. |
.\" SECTION |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
. |
|
. |
.Sh CAVEATS |
.Sh CAVEATS |
There are several ambiguous parts of mdoc. |
There are many ambiguous parts of mdoc. |
|
. |
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Fa |
.Sq \&Fa |
should be |
should be |
.Sq \&Va |
.Sq \&Va |
as function arguments are variables. |
as function arguments are variables. |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Ft |
.Sq \&Ft |
should be |
should be |
Line 941 should be removed and |
|
Line 694 should be removed and |
|
.Sq \&Fo , |
.Sq \&Fo , |
which ostensibly follows it, should follow the same convention as |
which ostensibly follows it, should follow the same convention as |
.Sq \&Va . |
.Sq \&Va . |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Va |
.Sq \&Va |
should formalise that only one or two arguments are acceptable: a |
should formalise that only one or two arguments are acceptable: a |
variable name and optional, preceeding type. |
variable name and optional, preceding type. |
.\" LIST-ITEM |
|
.It |
.It |
.Sq \&Fd |
.Sq \&Fd |
is ambiguous. It's commonly used to indicate an include file in the |
is ambiguous. It's commonly used to indicate an include file in the |
synopsis section. |
synopsis section. |
.Sq \&In |
.Sq \&In |
should be used, instead. |
should be used, instead. |
.\" LIST-ITEM |
|
.It |
.It |
Only the |
Only the |
.Sq \-literal |
.Sq \-literal |
argument to |
argument to |
.Sq \&Bd |
.Sq \&Bd |
makes sense. The remaining ones should be removed. |
makes sense. The remaining ones should be removed. |
.\" LIST-ITEM |
|
.It |
.It |
The |
The |
.Sq \&Xo |
.Sq \&Xo |
and |
and |
.Sq \&Xc |
.Sq \&Xc |
macros should be deprecated. |
macros should be deprecated. |
.\" LIST-ITEM |
|
.It |
.It |
The |
The |
.Sq \&Dt |
.Sq \&Dt |
macro lacks clarity. It should be absolutely clear which title will |
macro lacks clarity. It should be absolutely clear which title will |
render when formatting the manual page. |
render when formatting the manual page. |
.\" LIST-ITEM |
|
.It |
.It |
A |
A |
.Sq \&Lx |
.Sq \&Lx |
should be provided for Linux (\(`a la |
should be provided for Linux (\(`a la |
.Sq \&Ox , |
.Sq \&Ox , |
.Sq \&Nx |
.Sq \&Nx |
etc.). |
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 |
.El |
|
. |