| version 1.15, 2009/03/23 16:02:56 |
version 1.48, 2009/07/18 23:31:04 |
|
|
| .\" $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 |
.\" SECTION--------------------------------------------- |
| .Sh NAME |
.Sh NAME |
| .Nm mdoc |
.Nm mdoc |
| .Nd mdoc language reference |
.Nd mdoc language reference |
| .\" SECTION |
.\" 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 |
| .Nm |
.Xr mandoc 1 . |
| language. |
The |
| .\" PARAGRAPH |
.Sx COMPATIBILITY |
| |
section describes compatibility with |
| |
.Xr groff 1 . |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| An |
An |
| .Nm |
.Nm |
|
|
| .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 |
.\" SECTION--------------------------------------------- |
| .Pp |
.Sh LANGUAGE SYNTAX |
| 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 |
.\" SUB-SECTION---------------------- |
| .Sq \en |
.Ss Comments |
| line termination. |
Text following a |
| .Pp |
.Sq \e" , |
| The only time a blank line is acceptable is within |
whether in a macro or free-form text line, is ignored to the end of |
| the context of |
line. A macro line with only a control character and comment escape, |
| .Sq \&Bd \-literal |
.Sq \&.\e" , |
| or |
is also ignored. |
| .Sq \&Bd \-unfilled . |
.\" SUB-SECTION---------------------- |
| .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 |
.Bl -tag -width Ds -offset indent -compact |
| .It \&. |
.It \&. |
| .Pq period |
.Pq period |
| .It \&, |
.It \&, |
| Line 103 Within a macro line, the following characters are rese |
|
| Line 88 Within a macro line, the following characters are rese |
|
| .Pq question |
.Pq question |
| .It \&! |
.It \&! |
| .Pq exclamation |
.Pq exclamation |
| |
.It \&| |
| |
.Pq vertical bar |
| .El |
.El |
| .\" PARAGRAPH |
.\" 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 |
.\" 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 |
| |
.Sq \e |
| followed by either an open-parenthesis |
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 1 |
| |
for a complete list. Examples include |
| |
.Sq \e(em |
| |
.Pq em-dash |
| |
and |
| |
.Sq \ee |
| |
.Pq back-slash . |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| Characters may alternatively be escaped by a slash-asterisk, |
An alternative escape sequence is |
| .Sq \\* , |
the slash-asterisk, |
| with the same combinations as described above. This form is deprecated. |
.Sq \e* , |
| |
but this method is discouraged for compatibility reasons. |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| The following is a table of all available escapes. |
Terms may |
| |
also be text-decorated using the |
| |
.Sq \ef |
| |
escape followed by an indicator: B (bold), I, (italic), or P and R |
| |
(Roman, or reset). This form is not recommended. |
| |
.\" SUB-SECTION---------------------- |
| |
.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 |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| Grammatic: |
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 \\(em |
.\" PARAGRAPH------------ |
| .Pq em-dash |
|
| .It \\(en |
|
| .Pq en-dash |
|
| .It \e- |
|
| .Pq hyphen |
|
| .It \\\\ |
|
| .Pq back-slash |
|
| .It \e' |
|
| .Pq apostrophe |
|
| .It \e` |
|
| .Pq back-tick |
|
| .It \\ |
|
| .Pq space |
|
| .It \\. |
|
| .Pq period |
|
| .It \\(r! |
|
| .Pq upside-down exclamation |
|
| .It \\(r? |
|
| .Pq upside-down question |
|
| .El |
|
| .\" PARAGRAPH |
|
| .Pp |
.Pp |
| Enclosures: |
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 \\(lh |
delimiting |
| .Pq left hand |
.Sq \&Bl \-column |
| .It \\(rh |
or when in a literal context. |
| .Pq right hand |
.\" SUB-SECTION---------------------- |
| .It \\(Fo |
.Ss Quotation |
| .Pq left guillemet |
Macro arguments may be quoted with a double-quote to group |
| .It \\(Fc |
space-delimited terms or to retain blocks of whitespace. A quoted |
| .Pq right guillemet |
argument begins with a double-quote preceded by whitespace. The next |
| .It \\(fo |
double-quote not pair-wise adjacent to another double-quote terminates |
| .Pq left guilsing |
the literal, regardless of surrounding whitespace. |
| .It \\(fc |
.\" PARAGRAPH------------ |
| .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: |
This produces tokens |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.Sq a" , |
| .It \\(<- |
.Sq b c , |
| .Pq left arrow |
.Sq de , |
| .It \\(-> |
and |
| .Pq right arrow |
.Sq fg" . |
| .It \\(ua |
Note that any quoted term, be it argument or macro, is indiscriminately |
| .Pq up arrow |
considered literal text. Thus, the following produces |
| .It \\(da |
.Sq \&Em a : |
| .Pq down arrow |
.Bd -literal -offset indent |
| .It \\(<> |
\&.Em "Em a" |
| .Pq left-right arrow |
.Ed |
| .It \\(lA |
.\" PARAGRAPH------------ |
| .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: |
In free-form mode, quotes are regarded as opaque text. |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.\" SECTION--------------------------------------------- |
| .It \\(es |
.Sh MANUAL STRUCTURE |
| .Pq empty set |
Each |
| .It \\(ca |
.Nm |
| .Pq intersection |
document must begin with a document prologue, containing, in order, |
| .It \\(cu |
.Sq \&Dd , |
| .Pq union |
.Sq \&Dt , |
| .It \\(gr |
and |
| .Pq gradient |
.Sq \&Os , |
| .It \\(pd |
then the NAME section containing at least one |
| .Pq partial differential |
.Sq \&Nm |
| .It \\(ap |
followed by |
| .Pq similarity |
.Sq \&Nd : |
| .It \\(=) |
.Bd -literal -offset indent |
| .Pq proper superset |
\&.Dd $\&Mdocdate$ |
| .It \\((= |
\&.Dt mdoc 7 |
| .Pq proper subset |
\&.Os |
| .It \\(eq |
\&.Sh NAME |
| .Pq equals |
\&.Nm mdoc |
| .It \\(di |
\&.Nd mdoc language reference |
| .Pq division |
.Ed |
| .It \\(mu |
.\" PARAGRAPH------------ |
| .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: |
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, |
| .Bl -tag -width 12n -offset "XXXX" -compact |
but non-compulsory. |
| .It \\(ss |
.\" SECTION--------------------------------------------- |
| .Pq German eszett |
.Sh MACRO SYNTAX |
| .It \\(AE |
Every line beginning with the control character |
| .Pq upper-case AE |
.Sq \. |
| .It \\(ae |
is processed for macros, two- or three-character sequences. |
| .Pq lower-case AE |
.\" PARAGRAPH------------ |
| .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 of a macro depends on its classification. In this section, |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \-arg |
| .It \\(ga |
refers to macro arguments, which may be followed by zero or more |
| .Pq grave accent |
.Sq parm |
| .It \\(aa |
parameters; |
| .Pq accute accent |
.Sq \&Yo |
| .It \\(a" |
opens the scope of a macro; and if specified, |
| .Pq umlaut accent |
.Sq \&Yc |
| .It \\(ad |
closes it out. |
| .Pq dieresis accent |
.\" PARAGRAPH------------ |
| .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: |
The |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.Em Callable |
| .It \\(Cs |
column indicates that the macro may be called subsequent to the initial |
| .Pq Scandinavian |
line-macro. The |
| .It \\(Do |
.Em Parsable |
| .Pq dollar |
column indicates whether the macro may be followed by further |
| .It \\(Po |
(ostensibly callable) macros. The |
| .Pq pound |
.Em Scope |
| .It \\(Ye |
column, if applicable, describes closure rules. |
| .Pq yen |
.\" SUB-SECTION---------------------- |
| .It \\(Fn |
.Ss Block full-explicit |
| .Pq florin |
Multi-line scope closed by an explicit closing macro. All macros |
| .It \\(ct |
contains bodies; only |
| .Pq cent |
.Pq Sq \&Bf |
| .El |
contains a head. |
| .\" PARAGRAPH |
.Bd -literal -offset indent |
| .Pp |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
| Special symbols: |
|
| .Bl -tag -width 12n -offset "XXXX" -compact |
|
| .It \\(de |
|
| .Pq degree |
|
| .It \\(ps |
|
| .Pq paragraph |
|
| .It \\(sc |
|
| .Pq section |
|
| .It \\(dg |
|
| .Pq dagger |
|
| .It \\(dd |
|
| .Pq double dagger |
|
| .It \\(ci |
|
| .Pq circle |
|
| .It \\(ba |
|
| .Pq bar |
|
| .It \\(bb |
|
| .Pq broken bar |
|
| .It \\(Ba |
|
| .Pq bar, deprecated |
|
| .It \\(co |
|
| .Pq copyright |
|
| .It \\(rg |
|
| .Pq registered |
|
| .It \\(tm |
|
| .Pq trademarked |
|
| .It \\& |
|
| .Pq non-breaking space |
|
| .It \\e |
|
| .Pq escape |
|
| .It \\(Am |
|
| .Pq ampersand, deprecated |
|
| .El |
|
| .\" SECTION |
|
| .Sh ONTOLOGY |
|
| Macros are classified in an ontology described by their scope rules. |
|
| Some macros are allowed to deviate from their classifications to |
|
| preserve backward-compatibility with old macro combinations still found |
|
| in the manual corpus. These are specifically noted on a per-macro |
|
| basis. |
|
| .\" SUB-SECTION |
|
| .Ss Scope |
|
| .Bl -inset |
|
| .\" LIST-ITEM |
|
| .It Em Block |
|
| macros enclose other block macros, in-line macros or text, and |
|
| may span multiple lines. |
|
| .Bl -inset -offset XXXX |
|
| .\" LIST-ITEM |
|
| .It Em Full-block |
|
| macros always span multiple lines. They consist of zero or |
|
| more |
|
| .Qq heads , |
|
| subsequent macros or text on the same line following invocation; an |
|
| optional |
|
| .Qq body , |
|
| which spans subsequent lines of text or macros; and an optional |
|
| .Qq tail , |
|
| macros or text on the same line following closure. |
|
| .\" LIST-ITEM |
|
| .It Em Partial-block |
|
| macros may span multiple lines. They consists of a optional |
|
| .Qq head , |
|
| text immediately following invocation; always a |
|
| .Qq body , |
|
| text or macros following the head on the same and subsequent lines; and |
|
| optionally a |
|
| .Qq tail , |
|
| 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 |
|
| .Bl -tag -width 12n -offset XXXX -compact |
|
| .It BPE , BFE |
|
| corresponding explicit closure macro |
|
| .It BFI |
|
| end-of-file or a corresponding implicit closure macro |
|
| .It BPI |
|
| end-of-line (body may be closed by >0 space-separated |
|
| .Sx Reserved Characters , |
|
| although block scope will still be open) |
|
| .It INL |
|
| end-of-line |
|
| .El |
|
| .\" PARAGRAPH |
|
| .Pp |
|
| If a macro (block or in-line) is parsable, it may also be closed out by |
|
| one of the following scenarios (unless specifically noted otherwise): |
|
| .\" PARAGRAPH |
|
| .Pp |
|
| .Bl -dash -offset XXXX -compact |
|
| .It |
|
| a sequence of >0 space-separated |
|
| .Sx Reserved Characters , |
|
| .It |
|
| another macro, |
|
| .It |
|
| end-of-line, or |
|
| .It |
|
| completion of a set number of arguments. |
|
| .El |
|
| .\" PARAGRAPH |
|
| .Pp |
|
| If >0 space-separated |
|
| .Sx Reserved Characters |
|
| are followed by non-reserved characters, the behaviour differs per |
|
| macro. In general, scope of the macro is closed and re-opened: |
|
| subsequent tokens are interpreted as if the scope had just been opened. |
|
| 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 |
|
| Block full-explicit (may contain head, body, tail). |
|
| .Bd -literal -offset XXXX |
|
| \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB |
|
| \(lBbody...\(rB |
\(lBbody...\(rB |
| \&.Yc \(lBtail...\(rB |
|
| .Ed |
|
| .\" PARAGRAPH |
|
| .Pp |
|
| Block full-implicit (may contain zero or more heads, body, no tail). |
|
| .Bd -literal -offset XXXX |
|
| \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
| \(lBbody...\(rB |
|
| \&.Yc |
\&.Yc |
| .Ed |
.Ed |
| .\" PARAGRAPH |
.\" 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 |
.\" SUB-SECTION---------------------- |
| 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 \-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 |
| |
.\" PARAGRAPH------------ |
| .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 |
.\" 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 |
|
| .\" PARAGRAPH |
|
| .Pp |
|
| The |
|
| .Sq \&Op |
|
| may be broken by \&Oc as in the following example: |
|
| .Bd -literal -offset XXXX |
|
| \&.Oo |
|
| \&.Op Fl a Oc |
|
| .Ed |
|
| .Pp |
|
| In the above example, the scope of |
|
| .Sq \&Op |
|
| is technically broken by |
|
| .Sq \&Oc , |
|
| however, due to the overwhelming existence of this sequence, it's |
|
| allowed. |
|
| .\" 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 |
| |
.\" PARAGRAPH------------ |
| .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 |
.\" SUB-SECTION---------------------- |
| .Ss In-line |
.Ss Block partial-implicit |
| In-line macros have only text children. If a number (or inequality) of |
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 |
| |
.\" PARAGRAPH------------ |
| |
.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 |
| |
.\" SUB-SECTION---------------------- |
| |
.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 |
| |
.\" PARAGRAPH------------ |
| .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 \&No 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 0 |
| .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 0 |
| .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 |
| |
.It \&sp Ta \&No Ta \&No Ta 1 |
| .El |
.El |
| .Pp |
.\" SECTION--------------------------------------------- |
| 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 . |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| .Bl -dash -compact |
.Bl -dash -compact |
| .\" LIST-ITEM |
.\" LIST-ITEM |
| .It |
.It |
| .Sq \&Fo |
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. |
| |
.\" LIST-ITEM |
| |
.It |
| |
The |
| |
.Sq \&sp |
| |
macro does not accept negative numbers. |
| |
.\" LIST-ITEM |
| |
.It |
| |
Some character sequences in groff are not handled depending on escape |
| |
style, e.g., |
| |
.Sq \e(ba |
| and |
and |
| .Sq \&St |
.Sq \e*(Ba |
| historically weren't always callable. Both are now correctly callable. |
may not be interchanged. This is no longer the case: all character |
| |
sequences resolve to the same symbol, regardless the escape style. |
| .\" LIST-ITEM |
.\" LIST-ITEM |
| .It |
.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. |
| |
.\" LIST-ITEM |
| |
.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. |
| |
.\" LIST-ITEM |
| |
.It |
| |
The vertical bar |
| |
.Sq \(ba |
| |
made historic groff |
| |
.Qq go orbital |
| |
but is a proper delimiter in this implementation. |
| |
.\" LIST-ITEM |
| |
.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 |
.\" 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 |
.\" LIST-ITEM |
| .It |
.It |
|
|
| macro only accepts a single parameter. |
macro only accepts a single parameter. |
| .\" LIST-ITEM |
.\" 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 |
.\" LIST-ITEM |
| .It |
.It |
| .Sq \&Cd |
If an special-character control character is escaped |
| is callable. |
.Sq \e\e , |
| |
it will obviously not render the subsequent sequence. Even newer |
| |
versions of groff seem to dither on this. |
| |
.\" LIST-ITEM |
| |
.It |
| |
In groff, the |
| |
.Sq \&Fo |
| |
macro only produces the first parameter. This is no longer the case. |
| .El |
.El |
| .\" SECTION |
.\" SECTION--------------------------------------------- |
| .Sh SEE ALSO |
.Sh SEE ALSO |
| .Xr mandoc 1 |
.Xr mandoc 1 , |
| .\" SECTION |
.Xr mandoc_char 7 |
| |
.\" 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 |
.\" SECTION--------------------------------------------- |
| .Sh CAVEATS |
.Sh CAVEATS |
| There are several ambiguous parts of mdoc. |
There are many ambiguous parts of mdoc. |
| |
.\" PARAGRAPH------------ |
| .Pp |
.Pp |
| .Bl -dash -compact |
.Bl -dash -compact |
| .\" LIST-ITEM |
.\" LIST-ITEM |
| Line 977 which ostensibly follows it, should follow the same co |
|
| Line 562 which ostensibly follows it, should follow the same co |
|
| .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 |
.\" LIST-ITEM |
| .It |
.It |
| .Sq \&Fd |
.Sq \&Fd |
|
|
| There's no way to refer to references in |
There's no way to refer to references in |
| .Sq \&Rs/Re |
.Sq \&Rs/Re |
| blocks. |
blocks. |
| |
.\" LIST-ITEM |
| |
.It |
| |
The \-split and \-nosplit arguments to |
| |
.Sq \&An |
| |
are inane. |
| .El |
.El |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc.7 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc