version 1.4, 2009/03/14 05:21:58 |
version 1.17, 2009/03/26 23:01:26 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" |
.\" |
.\" 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 |
|
|
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
.Nm mdoc |
.Nm mdoc |
.Nd mdoc macro reference |
.Nd mdoc language reference |
.\" SECTION |
.\" SECTION |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
|
|
language is used to format |
language is used to format |
.Bx |
.Bx |
.Ux |
.Ux |
manuals. An |
manuals. In this reference document, we describe the syntax, ontology |
|
and structure of the |
.Nm |
.Nm |
|
language. |
|
.\" PARAGRAPH |
|
.Pp |
|
An |
|
.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 XXX |
|
\&.Sh Macro lines change control state. |
|
Other lines are interpreted within the current state. |
|
.Ed |
.\" SECTION |
.\" SECTION |
.Sh CHARACTER ENCODING |
.Sh INPUT ENCODING |
.Nm |
.Nm |
documents may contain only printable alphanumeric characters, the space |
documents may contain only graphable 7-bit ASCII characters, the space |
character |
character |
.Sq \ , |
.Sq \ , |
and, in certain circumstances, the tab character |
and, in certain circumstances, the tab character |
.Sq \et . |
.Sq \et . |
All manuals must have |
All manuals must have |
.Sq \en |
.Sq \en |
line termination. |
line termination. |
|
.Pp |
|
The only time a blank line is acceptable is within |
|
the context of |
|
.Sq \&.Bd \-literal |
|
or |
|
.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 |
.\" 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: |
Line 72 Within a macro line, the following characters are rese |
|
Line 97 Within a macro line, the following characters are rese |
|
.It \&? |
.It \&? |
.Pq question |
.Pq question |
.It \&! |
.It \&! |
.Pq exclmamation |
.Pq exclamation |
.El |
.El |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Use of these characters must either be escaped with a non-breaking space |
Use of reserved characters is described in |
.Pq Sq \e& |
|
or, if applicable, an appropriate escape-sequence used. Use of reserved |
|
characters is described in |
|
.Sx Closure . |
.Sx Closure . |
|
For general non-reserved use, characters must either be escaped with a |
|
non-breaking space |
|
.Pq Sq \e& |
|
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 character sequences begin with the escape character |
.Sq \\ |
.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 |
Line 93 for n-character sequences (terminated at a close-brack |
|
Line 120 for n-character sequences (terminated at a close-brack |
|
or a single one-character sequence. |
or a single one-character sequence. |
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
Characters may alternatively be escaped by a slash-asterisk, |
.Sq \\* , |
.Sq \e* , |
with the same combinations as described above. This form is deprecated. |
with the same combinations as described above. This form is deprecated. |
.Pp |
.Pp |
The following is a table of all available escapes. |
The following is a table of all available escapes. |
.Pp |
.Pp |
Grammatic: |
Grammatic: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(em |
.It \e(em |
.Pq em-dash |
.Pq em-dash |
.It \\(en |
.It \e(en |
.Pq en-dash |
.Pq en-dash |
.It \e- |
.It \e- |
.Pq hyphen |
.Pq hyphen |
.It \\\\ |
.It \e\e |
.Pq back-slash |
.Pq back-slash |
.It \e' |
.It \e' |
.Pq apostrophe |
.Pq apostrophe |
.It \e` |
.It \e` |
.Pq back-tick |
.Pq back-tick |
.It \\ |
.It \e |
.Pq space |
.Pq space |
.It \\. |
.It \e. |
.Pq period |
.Pq period |
|
.It \e(r! |
|
.Pq upside-down exclamation |
|
.It \e(r? |
|
.Pq upside-down question |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Enclosures: |
Enclosures: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(rC |
.It \e(lh |
|
.Pq left hand |
|
.It \e(rh |
|
.Pq right hand |
|
.It \e(Fo |
|
.Pq left guillemet |
|
.It \e(Fc |
|
.Pq right guillemet |
|
.It \e(fo |
|
.Pq left guilsing |
|
.It \e(fc |
|
.Pq right guilsing |
|
.It \e(rC |
.Pq right brace |
.Pq right brace |
.It \\(lC |
.It \e(lC |
.Pq left brace |
.Pq left brace |
.It \\(ra |
.It \e(ra |
.Pq right angle |
.Pq right angle |
.It \\(la |
.It \e(la |
.Pq left angle |
.Pq left angle |
.It \\(rB |
.It \e(rB |
.Pq right bracket |
.Pq right bracket |
.It \\(lB |
.It \e(lB |
.Pq left bracket |
.Pq left bracket |
.It \\q |
.It \eq |
.Pq double-quote |
.Pq double-quote |
.It \\(lq |
.It \e(lq |
.Pq left double-quote |
.Pq left double-quote |
.It \\(Lq |
.It \e(Lq |
.Pq left double-quote, deprecated |
.Pq left double-quote, deprecated |
.It \\(rq |
.It \e(rq |
.Pq right double-quote |
.Pq right double-quote |
.It \\(Rq |
.It \e(Rq |
.Pq right double-quote, deprecated |
.Pq right double-quote, deprecated |
.It \\(oq |
.It \e(oq |
.Pq left single-quote |
.Pq left single-quote |
.It \\(aq |
.It \e(aq |
.Pq right single-quote |
.Pq right single-quote |
|
.It \e(Bq |
|
.Pq right low double-quote |
|
.It \e(bq |
|
.Pq right low single-quote |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Indicatives: |
Indicatives: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(<- |
.It \e(<- |
.Pq left arrow |
.Pq left arrow |
.It \\(-> |
.It \e(-> |
.Pq right arrow |
.Pq right arrow |
.It \\(ua |
.It \e(ua |
.Pq up arrow |
.Pq up arrow |
.It \\(da |
.It \e(da |
.Pq down arrow |
.Pq down arrow |
|
.It \e(<> |
|
.Pq left-right arrow |
|
.It \e(lA |
|
.Pq left double-arrow |
|
.It \e(rA |
|
.Pq right double-arrow |
|
.It \e(uA |
|
.Pq up double-arrow |
|
.It \e(dA |
|
.Pq down double-arrow |
|
.It \e(hA |
|
.Pq left-right double-arrow |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Mathematical: |
Mathematical: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(Gt |
.It \e(es |
|
.Pq empty set |
|
.It \e(ca |
|
.Pq intersection |
|
.It \e(cu |
|
.Pq union |
|
.It \e(gr |
|
.Pq gradient |
|
.It \e(pd |
|
.Pq partial differential |
|
.It \e(ap |
|
.Pq similarity |
|
.It \e(=) |
|
.Pq proper superset |
|
.It \e((= |
|
.Pq proper subset |
|
.It \e(eq |
|
.Pq equals |
|
.It \e(di |
|
.Pq division |
|
.It \e(mu |
|
.Pq multiplication |
|
.It \e(pl |
|
.Pq addition |
|
.It \e(nm |
|
.Pq not element |
|
.It \e(mo |
|
.Pq element |
|
.It \e(Im |
|
.Pq imaginary |
|
.It \e(Re |
|
.Pq real |
|
.It \e(Ah |
|
.Pq aleph |
|
.It \e(te |
|
.Pq existential quantifier |
|
.It \e(fa |
|
.Pq universal quantifier |
|
.It \e(AN |
|
.Pq logical AND |
|
.It \e(OR |
|
.Pq logical OR |
|
.It \e(no |
|
.Pq logical NOT |
|
.It \e(st |
|
.Pq such that |
|
.It \e(tf |
|
.Pq therefore |
|
.It \e(~~ |
|
.Pq approximate |
|
.It \e(~= |
|
.Pq approximately equals |
|
.It \e(=~ |
|
.Pq congruent |
|
.It \e(Gt |
.Pq greater-than, deprecated |
.Pq greater-than, deprecated |
.It \\(Lt |
.It \e(Lt |
.Pq less-than, deprecated |
.Pq less-than, deprecated |
.It \\(<= |
.It \e(<= |
.Pq less-than-equal |
.Pq less-than-equal |
.It \\(Le |
.It \e(Le |
.Pq less-than-equal, deprecated |
.Pq less-than-equal, deprecated |
.It \\(>= |
.It \e(>= |
.Pq greater-than-equal |
.Pq greater-than-equal |
.It \\(Ge |
.It \e(Ge |
.Pq greater-than-equal |
.Pq greater-than-equal |
.It \\(== |
.It \e(== |
.Pq equal |
.Pq equal |
.It \\(!= |
.It \e(!= |
.Pq not equal |
.Pq not equal |
.It \\(Ne |
.It \e(Ne |
.Pq not equal, deprecated |
.Pq not equal, deprecated |
.It \\(if |
.It \e(if |
.Pq infinity |
.Pq infinity |
.It \\(If |
.It \e(If |
.Pq infinity, deprecated |
.Pq infinity, deprecated |
.It \\(na |
.It \e(na |
.Pq NaN , an extension |
.Pq NaN , an extension |
.It \\(Na |
.It \e(Na |
.Pq NaN, deprecated |
.Pq NaN, deprecated |
.It \\(+- |
.It \e(+- |
.Pq plus-minus |
.Pq plus-minus |
.It \\(Pm |
.It \e(Pm |
.Pq plus-minus, deprecated |
.Pq plus-minus, deprecated |
.It \\(** |
.It \e(** |
.Pq asterisk |
.Pq asterisk |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Diacritics: |
Ligatures: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(ga |
.It \e(ss |
.Pq accent grave |
.Pq German eszett |
.It \\(aa |
.It \e(AE |
.Pq accent accute |
.Pq upper-case AE |
|
.It \e(ae |
|
.Pq lower-case AE |
|
.It \e(OE |
|
.Pq upper-case OE |
|
.It \e(oe |
|
.Pq lower-case OE |
|
.It \e(ff |
|
.Pq ff ligature |
|
.It \e(fi |
|
.Pq fi ligature |
|
.It \e(fl |
|
.Pq fl ligature |
|
.It \e(Fi |
|
.Pq ffi ligature |
|
.It \e(Fl |
|
.Pq ffl ligature |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
Diacritics and letters: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \e(ga |
|
.Pq grave accent |
|
.It \e(aa |
|
.Pq accute accent |
|
.It \e(a" |
|
.Pq umlaut accent |
|
.It \e(ad |
|
.Pq dieresis accent |
|
.It \e(a~ |
|
.Pq tilde accent |
|
.It \e(a^ |
|
.Pq circumflex accent |
|
.It \e(ac |
|
.Pq cedilla accent |
|
.It \e(ad |
|
.Pq dieresis accent |
|
.It \e(ah |
|
.Pq caron accent |
|
.It \e(ao |
|
.Pq ring accent |
|
.It \e(ho |
|
.Pq hook accent |
|
.It \e(ab |
|
.Pq breve accent |
|
.It \e(a- |
|
.Pq macron accent |
|
.It \e(-D |
|
.Pq upper-case eth |
|
.It \e(Sd |
|
.Pq lower-case eth |
|
.It \e(TP |
|
.Pq upper-case thorn |
|
.It \e(Tp |
|
.Pq lower-case thorn |
|
.It \e('A |
|
.Pq upper-case acute A |
|
.It \e('E |
|
.Pq upper-case acute E |
|
.It \e('I |
|
.Pq upper-case acute I |
|
.It \e('O |
|
.Pq upper-case acute O |
|
.It \e('U |
|
.Pq upper-case acute U |
|
.It \e('a |
|
.Pq lower-case acute a |
|
.It \e('e |
|
.Pq lower-case acute e |
|
.It \e('i |
|
.Pq lower-case acute i |
|
.It \e('o |
|
.Pq lower-case acute o |
|
.It \e('u |
|
.Pq lower-case acute u |
|
.It \e(`A |
|
.Pq upper-case grave A |
|
.It \e(`E |
|
.Pq upper-case grave E |
|
.It \e(`I |
|
.Pq upper-case grave I |
|
.It \e(`O |
|
.Pq upper-case grave O |
|
.It \e(`U |
|
.Pq upper-case grave U |
|
.It \e(`a |
|
.Pq lower-case grave a |
|
.It \e(`e |
|
.Pq lower-case grave e |
|
.It \e(`i |
|
.Pq lower-case grave i |
|
.It \e(`o |
|
.Pq lower-case grave o |
|
.It \e(`u |
|
.Pq lower-case grave u |
|
.It \e(~A |
|
.Pq upper-case tilde A |
|
.It \e(~N |
|
.Pq upper-case tilde N |
|
.It \e(~O |
|
.Pq upper-case tilde O |
|
.It \e(~a |
|
.Pq lower-case tilde a |
|
.It \e(~n |
|
.Pq lower-case tilde n |
|
.It \e(~o |
|
.Pq lower-case tilde o |
|
.It \e(:A |
|
.Pq upper-case dieresis A |
|
.It \e(:E |
|
.Pq upper-case dieresis E |
|
.It \e(:I |
|
.Pq upper-case dieresis I |
|
.It \e(:O |
|
.Pq upper-case dieresis O |
|
.It \e(:U |
|
.Pq upper-case dieresis U |
|
.It \e(:a |
|
.Pq lower-case dieresis a |
|
.It \e(:e |
|
.Pq lower-case dieresis e |
|
.It \e(:i |
|
.Pq lower-case dieresis i |
|
.It \e(:o |
|
.Pq lower-case dieresis o |
|
.It \e(:u |
|
.Pq lower-case dieresis u |
|
.It \e(:y |
|
.Pq lower-case dieresis y |
|
.It \e(^A |
|
.Pq upper-case circumflex A |
|
.It \e(^E |
|
.Pq upper-case circumflex E |
|
.It \e(^I |
|
.Pq upper-case circumflex I |
|
.It \e(^O |
|
.Pq upper-case circumflex O |
|
.It \e(^U |
|
.Pq upper-case circumflex U |
|
.It \e(^a |
|
.Pq lower-case circumflex a |
|
.It \e(^e |
|
.Pq lower-case circumflex e |
|
.It \e(^i |
|
.Pq lower-case circumflex i |
|
.It \e(^o |
|
.Pq lower-case circumflex o |
|
.It \e(^u |
|
.Pq lower-case circumflex u |
|
.It \e(,C |
|
.Pq upper-case cedilla C |
|
.It \e(,c |
|
.Pq lower-case cedilla c |
|
.It \e(/L |
|
.Pq upper-case stroke L |
|
.It \e(/l |
|
.Pq lower-case stroke l |
|
.It \e(/O |
|
.Pq upper-case stroke O |
|
.It \e(/o |
|
.Pq lower-case stroke o |
|
.It \e(oA |
|
.Pq upper-case ring A |
|
.It \e(oa |
|
.Pq lower-case ring a |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Monetary: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \e(Cs |
|
.Pq Scandinavian |
|
.It \e(Do |
|
.Pq dollar |
|
.It \e(Po |
|
.Pq pound |
|
.It \e(Ye |
|
.Pq yen |
|
.It \e(Fn |
|
.Pq florin |
|
.It \e(ct |
|
.Pq cent |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
Special symbols: |
Special symbols: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(bu |
.It \e(de |
.Pq bullet |
.Pq degree |
.It \\(ba |
.It \e(ps |
|
.Pq paragraph |
|
.It \e(sc |
|
.Pq section |
|
.It \e(dg |
|
.Pq dagger |
|
.It \e(dd |
|
.Pq double dagger |
|
.It \e(ci |
|
.Pq circle |
|
.It \e(ba |
.Pq bar |
.Pq bar |
.It \\(Ba |
.It \e(bb |
|
.Pq broken bar |
|
.It \e(Ba |
.Pq bar, deprecated |
.Pq bar, deprecated |
.It \\(co |
.It \e(co |
.Pq copyright |
.Pq copyright |
.It \\& |
.It \e(rg |
|
.Pq registered |
|
.It \e(tm |
|
.Pq trademarked |
|
.It \e& |
.Pq non-breaking space |
.Pq non-breaking space |
.It \\e |
.It \ee |
.Pq escape |
.Pq escape |
.It \\(Am |
.It \e(Am |
.Pq ampersand, deprecated |
.Pq ampersand, deprecated |
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh ONTOLOGY |
.Sh STRUCTURE |
Macros are classified in an ontology described by scope rules. |
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 |
.\" SUB-SECTION |
.Ss Scope |
.Ss Scope |
.Bl -inset |
.Bl -inset |
Line 239 may span multiple lines. |
|
Line 554 may span multiple lines. |
|
.Bl -inset -offset XXXX |
.Bl -inset -offset XXXX |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Full-block |
.It Em Full-block |
macros always span multiple lines. They consist optionally of one or |
macros always span multiple lines. They consist of zero or |
more |
more |
.Qq heads , |
.Qq heads , |
subsequent macros or text on the same line following invocation; a |
subsequent macros or text on the same line following invocation; an |
|
optional |
.Qq body , |
.Qq body , |
which spans subsequent lines of text or macros; and an optional |
which spans subsequent lines of text or macros; and an optional |
.Qq tail , |
.Qq tail , |
macros or text on the same line following closure. |
macros or text on the same line following closure. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Partial-block |
.It Em Partial-block |
macros may span multiple lines. They consists optionally of a |
macros may span multiple lines. They consists of a optional |
.Qq head , |
.Qq head , |
text immediately following invocation; always a |
text immediately following invocation; always a |
.Qq body , |
.Qq body , |
Line 307 are followed by non-reserved characters, the behaviour |
|
Line 623 are followed by non-reserved characters, the behaviour |
|
macro. In general, scope of the macro is closed and re-opened: |
macro. In general, scope of the macro is closed and re-opened: |
subsequent tokens are interpreted as if the scope had just been opened. |
subsequent tokens are interpreted as if the scope had just been opened. |
In other circumstances, scope is simply closed out. |
In other circumstances, scope is simply closed out. |
.\" .\" SUB-SECTION |
|
.\" .Ss Examples |
|
.\" The following examples illustrate each macro classification. |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit full-block. Has head, body and no tail. Scope closed by |
|
.\" second |
|
.\" .Sq \&Sh |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested implicit full-block, where the subsection |
|
.\" .Sq \&Ss |
|
.\" is within the scope of the parent section |
|
.\" .Sq \&Sh |
|
.\" and closed along with its parent by the subsequent |
|
.\" .Sq \&Sh . |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" \&.Ss Subsection 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit full-block. Has a head, a body and no tail. Scope closed by |
|
.\" .Sq \&Ef |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bf symbolic |
|
.\" body... |
|
.\" \&.Ef |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested explicit/implicit scope. |
|
.\" .Sq \&It |
|
.\" macro is an implicit block whose scope is closed by the explicit |
|
.\" .Sq \&El |
|
.\" closure. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bl \-bullet |
|
.\" \&.It head |
|
.\" body... |
|
.\" \&.El |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block. Has head, body and tail. Scope closed by |
|
.\" .Sq \&Ec |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Eo head body... \&Ec tail |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block. Has only body. Scope is closed by end-of-line. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block with only body and scope closed by |
|
.\" .Sq \&Ac |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block enclosing explicit partial-block. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... \&Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Inline macros, several in sequence. Scope is closed for |
|
.\" .Sq \&Fl |
|
.\" by the punctuation delimiter and |
|
.\" .Sq \&Ar |
|
.\" by the end-of-line. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Fl text0 text1 ; Ar text0 text1 |
|
.\" .Ed |
|
.\" SECTION |
.\" SECTION |
.Sh SYNTAX |
.Sh SYNTAX |
Macros are generally two and at times three characters in length. The |
Macros are two or three characters in length. The syntax of macro |
syntax of macro invocation depends on its classification. |
invocation depends on its classification. |
.Qq \-arg |
.Qq \-arg |
refers to the macro arguments (which may contain zero or more values). |
refers to the macro arguments (which may contain zero or more values). |
In these illustrations, |
In these illustrations, |
Line 457 This section contains a complete list of all |
|
Line 684 This section contains a complete list of all |
|
.Nm |
.Nm |
macros, arranged ontologically. A |
macros, arranged ontologically. A |
.Qq callable |
.Qq callable |
macro is may be invoked subsequent to the initial macro-line macro. A |
macro is invoked subsequent to the initial macro-line macro. A |
.Qq parsable |
.Qq parsable |
macro may be followed by further (ostensibly callable) macros. |
macro may be followed by further (ostensibly callable) macros. |
.\" SUB-SECTION |
.\" SUB-SECTION |
Line 466 The head of these macros follows invocation; the body |
|
Line 693 The head of these macros follows invocation; the body |
|
subsequent lines prior to closure. None of these macros have tails; |
subsequent lines prior to closure. None of these macros have tails; |
some |
some |
.Po |
.Po |
.Sq \&It \-bullet , |
.Sq \&.It \-bullet , |
.Sq \-hyphen , |
.Sq \-hyphen , |
.Sq \-dash , |
.Sq \-dash , |
.Sq \-enum , |
.Sq \-enum , |
Line 516 close at the invocation's end-of-line. |
|
Line 743 close at the invocation's end-of-line. |
|
.It \&.Dl Ta \&No Ta Yes |
.It \&.Dl Ta \&No Ta Yes |
.It \&.Ql Ta Yes Ta Yes |
.It \&.Ql Ta Yes Ta Yes |
.El |
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
The |
|
.Sq \&.Op |
|
may be broken by |
|
.Sq \&.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 |
.\" SUB-SECTION |
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Each of these contains at least a body and, in limited circumstances, a |
Each of these contains at least a body and, in limited circumstances, a |
head |
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 . |
.Pp |
.Pp |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX |
.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -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 |
Line 569 then the macro accepts an arbitrary number of argument |
|
Line 814 then the macro accepts an arbitrary number of argument |
|
.It \&.Ar Ta Yes Ta Yes Ta n |
.It \&.Ar Ta Yes Ta Yes Ta n |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
.It \&.Cd Ta Yes Ta \&No Ta >0 |
.It \&.Cm Ta Yes Ta Yes Ta n |
.It \&.Cm Ta Yes Ta Yes Ta n |
.It \&.Dv Ta Yes Ta Yes Ta >0 |
.It \&.Dv Ta Yes Ta Yes Ta n |
.It \&.Er Ta Yes Ta Yes Ta >0 |
.It \&.Er Ta Yes Ta Yes Ta >0 |
.It \&.Ev Ta Yes Ta Yes Ta >0 |
.It \&.Ev Ta Yes Ta Yes Ta n |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
.It \&.Ex Ta \&No Ta \&No Ta 0 |
.It \&.Fa Ta Yes Ta Yes Ta >0 |
.It \&.Fa Ta Yes Ta Yes Ta n |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
.It \&.Fd Ta \&No Ta \&No Ta >0 |
.It \&.Fl Ta Yes Ta Yes Ta n |
.It \&.Fl Ta Yes Ta Yes Ta n |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
.It \&.Fn Ta Yes Ta Yes Ta >0 |
.It \&.Ft Ta \&No Ta Yes Ta n |
.It \&.Ft Ta \&No Ta Yes Ta n |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
.It \&.Ic Ta Yes Ta Yes Ta >0 |
.It \&.In Ta \&No Ta \&No Ta n |
.It \&.In Ta \&No Ta \&No Ta n |
.It \&.Li Ta Yes Ta Yes Ta >0 |
.It \&.Li Ta Yes Ta Yes Ta n |
.It \&.Nd Ta \&No Ta \&No Ta n |
.It \&.Nd Ta \&No Ta \&No Ta n |
.It \&.Nm Ta Yes Ta Yes Ta n |
.It \&.Nm Ta Yes Ta Yes Ta n |
.It \&.Ot Ta \&No Ta \&No Ta n |
.It \&.Ot Ta \&No Ta \&No Ta n |
.It \&.Pa Ta Yes Ta Yes Ta n |
.It \&.Pa Ta Yes Ta Yes Ta n |
.It \&.Rv Ta \&No Ta \&No Ta 0 |
.It \&.Rv Ta \&No Ta \&No Ta 0 |
.It \&.St Ta \&No Ta Yes Ta 1 |
.It \&.St Ta \&No Ta Yes Ta 1 |
.It \&.Va Ta Yes Ta Yes Ta >0 |
.It \&.Va Ta Yes Ta Yes Ta n |
.It \&.Vt Ta Yes Ta Yes Ta >0 |
.It \&.Vt Ta Yes Ta Yes Ta >0 |
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&.Xr Ta Yes Ta Yes Ta >0, <3 |
.It \&.%A Ta \&No Ta \&No Ta >0 |
.It \&.%A Ta \&No Ta \&No Ta >0 |
Line 606 then the macro accepts an arbitrary number of argument |
|
Line 851 then the macro accepts an arbitrary number of argument |
|
.It \&.Bsx Ta Yes Ta Yes Ta n |
.It \&.Bsx Ta Yes Ta Yes Ta n |
.It \&.Bx Ta Yes Ta Yes Ta n |
.It \&.Bx Ta Yes Ta Yes Ta n |
.It \&.Db Ta \&No Ta \&No Ta 1 |
.It \&.Db Ta \&No Ta \&No Ta 1 |
.It \&.Em Ta Yes Ta Yes Ta >0 |
.It \&.Em Ta Yes Ta Yes Ta n |
.It \&.Fx Ta Yes Ta Yes Ta n |
.It \&.Fx Ta Yes Ta Yes Ta n |
.It \&.Ms Ta \&No Ta Yes Ta >0 |
.It \&.Ms Ta \&No Ta Yes Ta >0 |
.It \&.No Ta Yes Ta Yes Ta 0 |
.It \&.No Ta Yes Ta Yes Ta 0 |
Line 619 then the macro accepts an arbitrary number of argument |
|
Line 864 then the macro accepts an arbitrary number of argument |
|
.It \&.Sy Ta Yes Ta Yes Ta >0 |
.It \&.Sy Ta Yes Ta Yes Ta >0 |
.It \&.Tn Ta Yes Ta Yes Ta >0 |
.It \&.Tn Ta Yes Ta Yes Ta >0 |
.It \&.Ux Ta Yes Ta Yes Ta n |
.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 \&.Bt Ta \&No Ta \&No Ta 0 |
.It \&.Hf Ta \&No Ta \&No Ta n |
.It \&.Hf Ta \&No Ta \&No Ta n |
.It \&.Fr Ta \&No Ta \&No Ta n |
.It \&.Fr Ta \&No Ta \&No Ta n |
Line 628 then the macro accepts an arbitrary number of argument |
|
Line 874 then the macro accepts an arbitrary number of argument |
|
.It \&.Lp Ta \&No Ta \&No Ta 0 |
.It \&.Lp Ta \&No Ta \&No Ta 0 |
.It \&.Lk Ta \&No Ta Yes Ta >0 |
.It \&.Lk Ta \&No Ta Yes Ta >0 |
.It \&.Mt 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 |
.El |
|
.Pp |
|
The |
|
.Sq \&.Ot , |
|
.Sq \&.Fr , |
|
.Sq \&.Es |
|
and |
|
.Sq \&.En , |
|
macros are obsolete. |
.\" SECTION |
.\" SECTION |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
The mdoc language was traditionally a |
The mdoc language was traditionally a |
Line 640 compatibility with these systems. |
|
Line 896 compatibility with these systems. |
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
.Sq \&It \-nested |
.Sq \&.Fo |
|
and |
|
.Sq \&.St |
|
historically weren't always callable. Both are now correctly callable. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&.It \-nested |
is assumed for all lists: any list may be nested and |
is assumed for all lists: 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 preceeded by other arguments (instead |
of proceeded) is not supported. |
of proceeded) is not supported. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The |
The |
.Sq \&At |
.Sq \&.At |
macro only accepts a single parameter. |
macro only accepts a single parameter. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The system-name macros ( |
The system-name macros ( |
.Ns Sq \&At , |
.Ns Sq \&.At , |
.Sq \&Bsx , |
.Sq \&.Bsx , |
.Sq \&Bx , |
.Sq \&.Bx , |
.Sq \&Fx , |
.Sq \&.Fx , |
.Sq \&Nx , |
.Sq \&.Nx , |
.Sq \&Ox , |
.Sq \&.Ox , |
and |
and |
.Sq \&Ux ) |
.Sq \&.Ux ) |
are callable. |
are callable. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.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 |
.Sq \&.Cd |
is callable. |
is callable. |
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mandoc 1 |
.Xr mdoclint 1 , |
|
.Xr mdocterm 1 , |
|
.Xr mdoc 3 |
|
.\" SECTION |
.\" SECTION |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
|
.\" SECTION |
|
.Sh CAVEATS |
|
There are several ambiguous parts of mdoc. |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&.Fa |
|
should be |
|
.Sq \&.Va |
|
as function arguments are variables. |
|
.\" LIST-ITEM |
|
.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 . |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&.Va |
|
should formalise that only one or two arguments are acceptable: a |
|
variable name and optional, preceeding type. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&.Fd |
|
is ambiguous. It's commonly used to indicate an include file in the |
|
synopsis section. |
|
.Sq \&.In |
|
should be used, instead. |
|
.\" LIST-ITEM |
|
.It |
|
Only the |
|
.Sq \-literal |
|
argument to |
|
.Sq \&.Bd |
|
makes sense. The remaining ones should be removed. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&.Xo |
|
and |
|
.Sq \&.Xc |
|
macros should be deprecated. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&.Dt |
|
macro lacks clarity. It should be absolutely clear which title will |
|
render when formatting the manual page. |
|
.\" LIST-ITEM |
|
.It |
|
A |
|
.Sq \&.Lx |
|
should be provided for Linux (\(`a la |
|
.Sq \&.Ox , |
|
.Sq \&.Nx |
|
etc.). |
|
.\" LIST-ITEM |
|
.It |
|
There's no way to refer to references in |
|
.Sq \&.Rs/.Re |
|
blocks. |
|
.El |