version 1.14, 2009/03/23 14:22:11 |
version 1.17, 2009/03/26 23:01:26 |
|
|
.\" 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 |
|
|
\&.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 |
|
.Pp |
|
Macros are two- or three-character sequences whose scope rules, rules |
|
that dictate handling of subsequent-line or same-line arguments, are |
|
governed by one of five classifications described in this document. |
|
.\" SECTION |
.\" SECTION |
.Sh INPUT ENCODING |
.Sh INPUT ENCODING |
.Nm |
.Nm |
Line 66 line termination. |
|
Line 61 line termination. |
|
.Pp |
.Pp |
The only time a blank line is acceptable is within |
The only time a blank line is acceptable is within |
the context of |
the context of |
.Sq \&Bd \-literal |
.Sq \&.Bd \-literal |
or |
or |
.Sq \&Bd \-unfilled . |
.Sq \&.Bd \-unfilled . |
.Pp |
.Pp |
Tab characters |
Tab characters |
.Pq \et |
.Pq \et |
are only acceptable when delimiting |
are only acceptable when delimiting |
.Sq \&Bl \-column |
.Sq \&.Bl \-column |
and in |
and in |
.Sq \&Bd \-literal |
.Sq \&.Bd \-literal |
or |
or |
.Sq \&Bd \-unfilled |
.Sq \&.Bd \-unfilled |
contexts. |
contexts. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Reserved Characters |
.Ss Reserved Characters |
Line 115 or, if applicable, an appropriate escape-sequence used |
|
Line 110 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 125 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 \\(r! |
.It \e(r! |
.Pq upside-down exclamation |
.Pq upside-down exclamation |
.It \\(r? |
.It \e(r? |
.Pq upside-down question |
.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 \\(lh |
.It \e(lh |
.Pq left hand |
.Pq left hand |
.It \\(rh |
.It \e(rh |
.Pq right hand |
.Pq right hand |
.It \\(Fo |
.It \e(Fo |
.Pq left guillemet |
.Pq left guillemet |
.It \\(Fc |
.It \e(Fc |
.Pq right guillemet |
.Pq right guillemet |
.It \\(fo |
.It \e(fo |
.Pq left guilsing |
.Pq left guilsing |
.It \\(fc |
.It \e(fc |
.Pq right guilsing |
.Pq right guilsing |
.It \\(rC |
.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 \\(Bq |
.It \e(Bq |
.Pq right low double-quote |
.Pq right low double-quote |
.It \\(bq |
.It \e(bq |
.Pq right low single-quote |
.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 \\(<> |
.It \e(<> |
.Pq left-right arrow |
.Pq left-right arrow |
.It \\(lA |
.It \e(lA |
.Pq left double-arrow |
.Pq left double-arrow |
.It \\(rA |
.It \e(rA |
.Pq right double-arrow |
.Pq right double-arrow |
.It \\(uA |
.It \e(uA |
.Pq up double-arrow |
.Pq up double-arrow |
.It \\(dA |
.It \e(dA |
.Pq down double-arrow |
.Pq down double-arrow |
.It \\(hA |
.It \e(hA |
.Pq left-right double-arrow |
.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 \\(es |
.It \e(es |
.Pq empty set |
.Pq empty set |
.It \\(ca |
.It \e(ca |
.Pq intersection |
.Pq intersection |
.It \\(cu |
.It \e(cu |
.Pq union |
.Pq union |
.It \\(gr |
.It \e(gr |
.Pq gradient |
.Pq gradient |
.It \\(pd |
.It \e(pd |
.Pq partial differential |
.Pq partial differential |
.It \\(ap |
.It \e(ap |
.Pq similarity |
.Pq similarity |
.It \\(=) |
.It \e(=) |
.Pq proper superset |
.Pq proper superset |
.It \\((= |
.It \e((= |
.Pq proper subset |
.Pq proper subset |
.It \\(eq |
.It \e(eq |
.Pq equals |
.Pq equals |
.It \\(di |
.It \e(di |
.Pq division |
.Pq division |
.It \\(mu |
.It \e(mu |
.Pq multiplication |
.Pq multiplication |
.It \\(pl |
.It \e(pl |
.Pq addition |
.Pq addition |
.It \\(nm |
.It \e(nm |
.Pq not element |
.Pq not element |
.It \\(mo |
.It \e(mo |
.Pq element |
.Pq element |
.It \\(Im |
.It \e(Im |
.Pq imaginary |
.Pq imaginary |
.It \\(Re |
.It \e(Re |
.Pq real |
.Pq real |
.It \\(Ah |
.It \e(Ah |
.Pq aleph |
.Pq aleph |
.It \\(te |
.It \e(te |
.Pq existential quantifier |
.Pq existential quantifier |
.It \\(fa |
.It \e(fa |
.Pq universal quantifier |
.Pq universal quantifier |
.It \\(AN |
.It \e(AN |
.Pq logical AND |
.Pq logical AND |
.It \\(OR |
.It \e(OR |
.Pq logical OR |
.Pq logical OR |
.It \\(no |
.It \e(no |
.Pq logical NOT |
.Pq logical NOT |
.It \\(st |
.It \e(st |
.Pq such that |
.Pq such that |
.It \\(tf |
.It \e(tf |
.Pq therefore |
.Pq therefore |
.It \\(~~ |
.It \e(~~ |
.Pq approximate |
.Pq approximate |
.It \\(~= |
.It \e(~= |
.Pq approximately equals |
.Pq approximately equals |
.It \\(=~ |
.It \e(=~ |
.Pq congruent |
.Pq congruent |
.It \\(Gt |
.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 |
Ligatures: |
Ligatures: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(ss |
.It \e(ss |
.Pq German eszett |
.Pq German eszett |
.It \\(AE |
.It \e(AE |
.Pq upper-case AE |
.Pq upper-case AE |
.It \\(ae |
.It \e(ae |
.Pq lower-case AE |
.Pq lower-case AE |
.It \\(OE |
.It \e(OE |
.Pq upper-case OE |
.Pq upper-case OE |
.It \\(oe |
.It \e(oe |
.Pq lower-case OE |
.Pq lower-case OE |
.It \\(ff |
.It \e(ff |
.Pq ff ligature |
.Pq ff ligature |
.It \\(fi |
.It \e(fi |
.Pq fi ligature |
.Pq fi ligature |
.It \\(fl |
.It \e(fl |
.Pq fl ligature |
.Pq fl ligature |
.It \\(Fi |
.It \e(Fi |
.Pq ffi ligature |
.Pq ffi ligature |
.It \\(Fl |
.It \e(Fl |
.Pq ffl ligature |
.Pq ffl ligature |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Diacritics and letters: |
Diacritics and letters: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(ga |
.It \e(ga |
.Pq grave accent |
.Pq grave accent |
.It \\(aa |
.It \e(aa |
.Pq accute accent |
.Pq accute accent |
.It \\(a" |
.It \e(a" |
.Pq umlaut accent |
.Pq umlaut accent |
.It \\(ad |
.It \e(ad |
.Pq dieresis accent |
.Pq dieresis accent |
.It \\(a~ |
.It \e(a~ |
.Pq tilde accent |
.Pq tilde accent |
.It \\(a^ |
.It \e(a^ |
.Pq circumflex accent |
.Pq circumflex accent |
.It \\(ac |
.It \e(ac |
.Pq cedilla accent |
.Pq cedilla accent |
.It \\(ad |
.It \e(ad |
.Pq dieresis accent |
.Pq dieresis accent |
.It \\(ah |
.It \e(ah |
.Pq caron accent |
.Pq caron accent |
.It \\(ao |
.It \e(ao |
.Pq ring accent |
.Pq ring accent |
.It \\(ho |
.It \e(ho |
.Pq hook accent |
.Pq hook accent |
.It \\(ab |
.It \e(ab |
.Pq breve accent |
.Pq breve accent |
.It \\(a- |
.It \e(a- |
.Pq macron accent |
.Pq macron accent |
.It \\(-D |
.It \e(-D |
.Pq upper-case eth |
.Pq upper-case eth |
.It \\(Sd |
.It \e(Sd |
.Pq lower-case eth |
.Pq lower-case eth |
.It \\(TP |
.It \e(TP |
.Pq upper-case thorn |
.Pq upper-case thorn |
.It \\(Tp |
.It \e(Tp |
.Pq lower-case thorn |
.Pq lower-case thorn |
.It \\('A |
.It \e('A |
.Pq upper-case acute A |
.Pq upper-case acute A |
.It \\('E |
.It \e('E |
.Pq upper-case acute E |
.Pq upper-case acute E |
.It \\('I |
.It \e('I |
.Pq upper-case acute I |
.Pq upper-case acute I |
.It \\('O |
.It \e('O |
.Pq upper-case acute O |
.Pq upper-case acute O |
.It \\('U |
.It \e('U |
.Pq upper-case acute U |
.Pq upper-case acute U |
.It \\('a |
.It \e('a |
.Pq lower-case acute a |
.Pq lower-case acute a |
.It \\('e |
.It \e('e |
.Pq lower-case acute e |
.Pq lower-case acute e |
.It \\('i |
.It \e('i |
.Pq lower-case acute i |
.Pq lower-case acute i |
.It \\('o |
.It \e('o |
.Pq lower-case acute o |
.Pq lower-case acute o |
.It \\('u |
.It \e('u |
.Pq lower-case acute u |
.Pq lower-case acute u |
.It \\(`A |
.It \e(`A |
.Pq upper-case grave A |
.Pq upper-case grave A |
.It \\(`E |
.It \e(`E |
.Pq upper-case grave E |
.Pq upper-case grave E |
.It \\(`I |
.It \e(`I |
.Pq upper-case grave I |
.Pq upper-case grave I |
.It \\(`O |
.It \e(`O |
.Pq upper-case grave O |
.Pq upper-case grave O |
.It \\(`U |
.It \e(`U |
.Pq upper-case grave U |
.Pq upper-case grave U |
.It \\(`a |
.It \e(`a |
.Pq lower-case grave a |
.Pq lower-case grave a |
.It \\(`e |
.It \e(`e |
.Pq lower-case grave e |
.Pq lower-case grave e |
.It \\(`i |
.It \e(`i |
.Pq lower-case grave i |
.Pq lower-case grave i |
.It \\(`o |
.It \e(`o |
.Pq lower-case grave o |
.Pq lower-case grave o |
.It \\(`u |
.It \e(`u |
.Pq lower-case grave u |
.Pq lower-case grave u |
.It \\(~A |
.It \e(~A |
.Pq upper-case tilde A |
.Pq upper-case tilde A |
.It \\(~N |
.It \e(~N |
.Pq upper-case tilde N |
.Pq upper-case tilde N |
.It \\(~O |
.It \e(~O |
.Pq upper-case tilde O |
.Pq upper-case tilde O |
.It \\(~a |
.It \e(~a |
.Pq lower-case tilde a |
.Pq lower-case tilde a |
.It \\(~n |
.It \e(~n |
.Pq lower-case tilde n |
.Pq lower-case tilde n |
.It \\(~o |
.It \e(~o |
.Pq lower-case tilde o |
.Pq lower-case tilde o |
.It \\(:A |
.It \e(:A |
.Pq upper-case dieresis A |
.Pq upper-case dieresis A |
.It \\(:E |
.It \e(:E |
.Pq upper-case dieresis E |
.Pq upper-case dieresis E |
.It \\(:I |
.It \e(:I |
.Pq upper-case dieresis I |
.Pq upper-case dieresis I |
.It \\(:O |
.It \e(:O |
.Pq upper-case dieresis O |
.Pq upper-case dieresis O |
.It \\(:U |
.It \e(:U |
.Pq upper-case dieresis U |
.Pq upper-case dieresis U |
.It \\(:a |
.It \e(:a |
.Pq lower-case dieresis a |
.Pq lower-case dieresis a |
.It \\(:e |
.It \e(:e |
.Pq lower-case dieresis e |
.Pq lower-case dieresis e |
.It \\(:i |
.It \e(:i |
.Pq lower-case dieresis i |
.Pq lower-case dieresis i |
.It \\(:o |
.It \e(:o |
.Pq lower-case dieresis o |
.Pq lower-case dieresis o |
.It \\(:u |
.It \e(:u |
.Pq lower-case dieresis u |
.Pq lower-case dieresis u |
.It \\(:y |
.It \e(:y |
.Pq lower-case dieresis y |
.Pq lower-case dieresis y |
.It \\(^A |
.It \e(^A |
.Pq upper-case circumflex A |
.Pq upper-case circumflex A |
.It \\(^E |
.It \e(^E |
.Pq upper-case circumflex E |
.Pq upper-case circumflex E |
.It \\(^I |
.It \e(^I |
.Pq upper-case circumflex I |
.Pq upper-case circumflex I |
.It \\(^O |
.It \e(^O |
.Pq upper-case circumflex O |
.Pq upper-case circumflex O |
.It \\(^U |
.It \e(^U |
.Pq upper-case circumflex U |
.Pq upper-case circumflex U |
.It \\(^a |
.It \e(^a |
.Pq lower-case circumflex a |
.Pq lower-case circumflex a |
.It \\(^e |
.It \e(^e |
.Pq lower-case circumflex e |
.Pq lower-case circumflex e |
.It \\(^i |
.It \e(^i |
.Pq lower-case circumflex i |
.Pq lower-case circumflex i |
.It \\(^o |
.It \e(^o |
.Pq lower-case circumflex o |
.Pq lower-case circumflex o |
.It \\(^u |
.It \e(^u |
.Pq lower-case circumflex u |
.Pq lower-case circumflex u |
.It \\(,C |
.It \e(,C |
.Pq upper-case cedilla C |
.Pq upper-case cedilla C |
.It \\(,c |
.It \e(,c |
.Pq lower-case cedilla c |
.Pq lower-case cedilla c |
.It \\(/L |
.It \e(/L |
.Pq upper-case stroke L |
.Pq upper-case stroke L |
.It \\(/l |
.It \e(/l |
.Pq lower-case stroke l |
.Pq lower-case stroke l |
.It \\(/O |
.It \e(/O |
.Pq upper-case stroke O |
.Pq upper-case stroke O |
.It \\(/o |
.It \e(/o |
.Pq lower-case stroke o |
.Pq lower-case stroke o |
.It \\(oA |
.It \e(oA |
.Pq upper-case ring A |
.Pq upper-case ring A |
.It \\(oa |
.It \e(oa |
.Pq lower-case ring a |
.Pq lower-case ring a |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Monetary: |
Monetary: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(Cs |
.It \e(Cs |
.Pq Scandinavian |
.Pq Scandinavian |
.It \\(Do |
.It \e(Do |
.Pq dollar |
.Pq dollar |
.It \\(Po |
.It \e(Po |
.Pq pound |
.Pq pound |
.It \\(Ye |
.It \e(Ye |
.Pq yen |
.Pq yen |
.It \\(Fn |
.It \e(Fn |
.Pq florin |
.Pq florin |
.It \\(ct |
.It \e(ct |
.Pq cent |
.Pq cent |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Special symbols: |
Special symbols: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(de |
.It \e(de |
.Pq degree |
.Pq degree |
.It \\(ps |
.It \e(ps |
.Pq paragraph |
.Pq paragraph |
.It \\(sc |
.It \e(sc |
.Pq section |
.Pq section |
.It \\(dg |
.It \e(dg |
.Pq dagger |
.Pq dagger |
.It \\(dd |
.It \e(dd |
.Pq double dagger |
.Pq double dagger |
.It \\(ci |
.It \e(ci |
.Pq circle |
.Pq circle |
.It \\(ba |
.It \e(ba |
.Pq bar |
.Pq bar |
.It \\(bb |
.It \e(bb |
.Pq broken bar |
.Pq broken bar |
.It \\(Ba |
.It \e(Ba |
.Pq bar, deprecated |
.Pq bar, deprecated |
.It \\(co |
.It \e(co |
.Pq copyright |
.Pq copyright |
.It \\(rg |
.It \e(rg |
.Pq registered |
.Pq registered |
.It \\(tm |
.It \e(tm |
.Pq trademarked |
.Pq trademarked |
.It \\& |
.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 their scope rules. |
Macros are classified in an ontology described by their scope rules. |
Some macros are allowed to deviate from their classifications to |
Some macros are allowed to deviate from their classifications to |
preserve backward-compatibility with old macro combinations still found |
preserve backward-compatibility with old macro combinations still found |
Line 630 subsequent tokens are interpreted as if the scope had |
|
Line 625 subsequent tokens are interpreted as if the scope had |
|
In other circumstances, scope is simply closed out. |
In other circumstances, scope is simply closed out. |
.\" 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 689 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 698 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 751 close at the invocation's end-of-line. |
|
Line 746 close at the invocation's end-of-line. |
|
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
The |
The |
.Sq \&Op |
.Sq \&.Op |
may be broken by \&Oc as in the following example: |
may be broken by |
|
.Sq \&.Oc |
|
as in the following example: |
.Bd -literal -offset XXXX |
.Bd -literal -offset XXXX |
\&.Oo |
\&.Oo |
\&.Op Fl a Oc |
\&.Op Fl a Oc |
.Ed |
.Ed |
.Pp |
.Pp |
In the above example, the scope of |
In the above example, the scope of |
.Sq \&Op |
.Sq \&.Op |
is technically broken by |
is technically broken by |
.Sq \&Oc , |
.Sq \&.Oc , |
however, due to the overwhelming existence of this sequence, it's |
however, due to the overwhelming existence of this sequence, it's |
allowed. |
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 882 then the macro accepts an arbitrary number of argument |
|
Line 879 then the macro accepts an arbitrary number of argument |
|
.El |
.El |
.Pp |
.Pp |
The |
The |
.Sq \&Ot , |
.Sq \&.Ot , |
.Sq \&Fr , |
.Sq \&.Fr , |
.Sq \&Es |
.Sq \&.Es |
and |
and |
.Sq \&En , |
.Sq \&.En , |
macros are obsolete. |
macros are obsolete. |
.\" SECTION |
.\" SECTION |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
Line 899 compatibility with these systems. |
|
Line 896 compatibility with these systems. |
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
.Sq \&Fo |
.Sq \&.Fo |
and |
and |
.Sq \&St |
.Sq \&.St |
historically weren't always callable. Both are now correctly callable. |
historically weren't always callable. Both are now correctly callable. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
.Sq \&It \-nested |
.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 |
Line 961 There are several ambiguous parts of mdoc. |
|
Line 955 There are several ambiguous parts of mdoc. |
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" 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 |
.\" LIST-ITEM |
.It |
.It |
.Sq \&Ft |
.Sq \&.Ft |
should be |
should be |
.Sq \&Vt |
.Sq \&.Vt |
as function return types are still types. Furthermore, the |
as function return types are still types. Furthermore, the |
.Sq \&Ft |
.Sq \&.Ft |
should be removed and |
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 |
.\" 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, preceeding type. |
.\" LIST-ITEM |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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 |
.\" 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.). |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
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. |
.El |
.El |