=================================================================== RCS file: /cvs/mandoc/mdoc.7,v retrieving revision 1.1 retrieving revision 1.9 diff -u -p -r1.1 -r1.9 --- mandoc/mdoc.7 2009/03/13 07:46:10 1.1 +++ mandoc/mdoc.7 2009/03/19 20:43:13 1.9 @@ -1,6 +1,6 @@ -.\" $Id: mdoc.7,v 1.1 2009/03/13 07:46:10 kristaps Exp $ +.\" $Id: mdoc.7,v 1.9 2009/03/19 20:43:13 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 13 2009 $ +.Dd $Mdocdate: March 19 2009 $ .Dt mdoc 7 .Os .\" SECTION @@ -36,12 +36,12 @@ document follows simple rules: lines beginning with t character .Sq \. are parsed for macros. Other lines are interpreted within the scope of -prior macros. Macros are either two or three characters in length. +prior macros. This document describes the encoding, ontology and syntax +of these macros. .\" SECTION .Sh CHARACTER ENCODING .Nm -documents may contain only printable alphanumeric characters, the space -character +documents may contain only printable characters, the space character .Sq \ , and, in certain circumstances, the tab character .Sq \et . @@ -49,41 +49,43 @@ All manuals must have .Sq \en line termination. .\" SUB-SECTION -.Ss Special Characters -Within a macro line, the following characters are special: -.\" PARAGRAPH -.Pp -.Bl -tag -width Ds -offset XXXX -compact +.Ss Reserved Characters +Within a macro line, the following characters are reserved: +.Bl -tag -width 12n -offset XXXX -compact .It \&. -period +.Pq period .It \&, -comma +.Pq comma .It \&: -colon +.Pq colon .It \&; -semicolon +.Pq semicolon .It \&( -left-parenthesis +.Pq left-parenthesis .It \&) -right-parenthesis +.Pq right-parenthesis .It \&[ -left-bracket +.Pq left-bracket .It \&] -right-bracket +.Pq right-bracket .It \&? -question +.Pq question .It \&! -exclmamation +.Pq exclamation .El +.\" PARAGRAPH .Pp -Use of these characters must either be escaped with a non-breaking space +Use of reserved characters is described in +.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. +or, if applicable, an appropriate escape-sequence used. .\" SUB-SECTION .Ss Special Characters Special character sequences begin with the escape character .Sq \\ -and followed by either an open-parenthesis +followed by either an open-parenthesis .Sq \&( for two-character sequences; an open-bracket .Sq \&[ @@ -93,12 +95,11 @@ or a single one-character sequence. .Pp Characters may alternatively be escaped by a slash-asterisk, .Sq \\* , -with the same combinations as described above. This form, however, is -deprecated. The following is a table of all available escapes, arranged -by classification. +with the same combinations as described above. This form is deprecated. .Pp -Grammatic: +The following is a table of all available escapes. .Pp +Grammatic: .Bl -tag -width 12n -offset "XXXX" -compact .It \\(em .Pq em-dash @@ -116,12 +117,27 @@ Grammatic: .Pq space .It \\. .Pq period +.It \\(r! +.Pq upside-down exclamation +.It \\(r? +.Pq upside-down question .El .\" PARAGRAPH .Pp Enclosures: -.Pp .Bl -tag -width 12n -offset "XXXX" -compact +.It \\(lh +.Pq left hand +.It \\(rh +.Pq right hand +.It \\(Fo +.Pq left guillemet +.It \\(Fc +.Pq right guillemet +.It \\(fo +.Pq left guilsing +.It \\(fc +.Pq right guilsing .It \\(rC .Pq right brace .It \\(lC @@ -148,11 +164,14 @@ Enclosures: .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 Indicatives: -.Pp .Bl -tag -width 12n -offset "XXXX" -compact .It \\(<- .Pq left arrow @@ -162,12 +181,77 @@ Indicatives: .Pq up arrow .It \\(da .Pq down arrow +.It \\(<> +.Pq left-right arrow +.It \\(lA +.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 Mathematical: -.Pp .Bl -tag -width 12n -offset "XXXX" -compact +.It \\(es +.Pq empty set +.It \\(ca +.Pq intersection +.It \\(cu +.Pq union +.It \\(gr +.Pq gradient +.It \\(pd +.Pq partial differential +.It \\(ap +.Pq similarity +.It \\(=) +.Pq proper superset +.It \\((= +.Pq proper subset +.It \\(eq +.Pq equals +.It \\(di +.Pq division +.It \\(mu +.Pq multiplication +.It \\(pl +.Pq addition +.It \\(nm +.Pq not element +.It \\(mo +.Pq element +.It \\(Im +.Pq imaginary +.It \\(Re +.Pq real +.It \\(Ah +.Pq aleph +.It \\(te +.Pq existential quantifier +.It \\(fa +.Pq universal quantifier +.It \\(AN +.Pq logical AND +.It \\(OR +.Pq logical OR +.It \\(no +.Pq logical NOT +.It \\(st +.Pq such that +.It \\(tf +.Pq therefore +.It \\(~~ +.Pq approximate +.It \\(~= +.Pq approximately equals +.It \\(=~ +.Pq congruent .It \\(Gt .Pq greater-than, deprecated .It \\(Lt @@ -203,27 +287,223 @@ Mathematical: .El .\" PARAGRAPH .Pp -Diacritics: +Ligatures: +.Bl -tag -width 12n -offset "XXXX" -compact +.It \\(ss +.Pq German eszett +.It \\(AE +.Pq upper-case AE +.It \\(ae +.Pq lower-case AE +.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 +Diacritics and letters: .Bl -tag -width 12n -offset "XXXX" -compact .It \\(ga -.Pq accent grave +.Pq grave accent .It \\(aa -.Pq accent accute +.Pq accute accent +.It \\(a" +.Pq umlaut accent +.It \\(ad +.Pq dieresis accent +.It \\(a~ +.Pq tilde accent +.It \\(a^ +.Pq circumflex accent +.It \\(ac +.Pq cedilla accent +.It \\(ad +.Pq dieresis accent +.It \\(ah +.Pq caron accent +.It \\(ao +.Pq ring accent +.It \\(ho +.Pq hook accent +.It \\(ab +.Pq breve accent +.It \\(a- +.Pq macron accent +.It \\(-D +.Pq upper-case eth +.It \\(Sd +.Pq lower-case eth +.It \\(TP +.Pq upper-case thorn +.It \\(Tp +.Pq lower-case thorn +.It \\('A +.Pq upper-case acute A +.It \\('E +.Pq upper-case acute E +.It \\('I +.Pq upper-case acute I +.It \\('O +.Pq upper-case acute O +.It \\('U +.Pq upper-case acute U +.It \\('a +.Pq lower-case acute a +.It \\('e +.Pq lower-case acute e +.It \\('i +.Pq lower-case acute i +.It \\('o +.Pq lower-case acute o +.It \\('u +.Pq lower-case acute u +.It \\(`A +.Pq upper-case grave A +.It \\(`E +.Pq upper-case grave E +.It \\(`I +.Pq upper-case grave I +.It \\(`O +.Pq upper-case grave O +.It \\(`U +.Pq upper-case grave U +.It \\(`a +.Pq lower-case grave a +.It \\(`e +.Pq lower-case grave e +.It \\(`i +.Pq lower-case grave i +.It \\(`o +.Pq lower-case grave o +.It \\(`u +.Pq lower-case grave u +.It \\(~A +.Pq upper-case tilde A +.It \\(~N +.Pq upper-case tilde N +.It \\(~O +.Pq upper-case tilde O +.It \\(~a +.Pq lower-case tilde a +.It \\(~n +.Pq lower-case tilde n +.It \\(~o +.Pq lower-case tilde o +.It \\(:A +.Pq upper-case dieresis A +.It \\(:E +.Pq upper-case dieresis E +.It \\(:I +.Pq upper-case dieresis I +.It \\(:O +.Pq upper-case dieresis O +.It \\(:U +.Pq upper-case dieresis U +.It \\(:a +.Pq lower-case dieresis a +.It \\(:e +.Pq lower-case dieresis e +.It \\(:i +.Pq lower-case dieresis i +.It \\(:o +.Pq lower-case dieresis o +.It \\(:u +.Pq lower-case dieresis u +.It \\(:y +.Pq lower-case dieresis y +.It \\(^A +.Pq upper-case circumflex A +.It \\(^E +.Pq upper-case circumflex E +.It \\(^I +.Pq upper-case circumflex I +.It \\(^O +.Pq upper-case circumflex O +.It \\(^U +.Pq upper-case circumflex U +.It \\(^a +.Pq lower-case circumflex a +.It \\(^e +.Pq lower-case circumflex e +.It \\(^i +.Pq lower-case circumflex i +.It \\(^o +.Pq lower-case circumflex o +.It \\(^u +.Pq lower-case circumflex u +.It \\(,C +.Pq upper-case cedilla C +.It \\(,c +.Pq lower-case cedilla c +.It \\(/L +.Pq upper-case stroke L +.It \\(/l +.Pq lower-case stroke l +.It \\(/O +.Pq upper-case stroke O +.It \\(/o +.Pq lower-case stroke o +.It \\(oA +.Pq upper-case ring A +.It \\(oa +.Pq lower-case ring a .El .\" PARAGRAPH .Pp -Special symbols: +Monetary: +.Bl -tag -width 12n -offset "XXXX" -compact +.It \\(Cs +.Pq Scandinavian +.It \\(Do +.Pq dollar +.It \\(Po +.Pq pound +.It \\(Ye +.Pq yen +.It \\(Fn +.Pq florin +.It \\(ct +.Pq cent +.El +.\" PARAGRAPH .Pp +Special symbols: .Bl -tag -width 12n -offset "XXXX" -compact -.It \\(bu -.Pq bullet +.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 @@ -232,31 +512,30 @@ Special symbols: .Pq ampersand, deprecated .El .\" SECTION -.Sh CLASSIFICATION +.Sh ONTOLOGY Macros are classified in an ontology described by scope rules. -.Bl -tag -width "in-lineX" +.\" SUB-SECTION +.Ss Scope +.Bl -inset .\" LIST-ITEM .It Em Block -Block macros enclose other block macros, in-line macros or text, and -may span multiple lines. -.Qq Implicit -block scope is closed by a subsequent invocation of the same macro, -one of a set of corresponding closure macros or end-of-file. -.Qq Explicit -block scope is closed by a corresponding closure macro. -.Bl -tag -width "partial-blockX" +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 -Always spans multiple lines. Consists optionally of one or more +macros always span multiple lines. They consist of zero or +more .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 , 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 -May span multiple lines. Consists optionally of a +macros may span multiple lines. They consists of a optional .Qq head , text immediately following invocation; always a .Qq body , @@ -264,114 +543,120 @@ text or macros following the head on the same and subs optionally a .Qq tail , text immediately following closure. -.El .\" LIST-ITEM .It Em In-line -In-line macros may only enclose text and span at most a single line. If -a macro is parsable, its scope may be closed by subsequent macros or -delimiting punctuation. In-line macros follow different conventions for -closure; see -.Sx MACROS -for per-macro details. +macros may only enclose text and span at most a single line. .El -.\" .\" 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 +.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 +\&.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 +.Ed +.\" PARAGRAPH +.Pp +Block partial-explicit (may contain head, multi-line body, tail). +.Bd -literal -offset XXXX +\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB +\(lBbody...\(rB +\&.Yc \(lBtail...\(rB + +\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \ +\(lBbody...\(rB \&Yc \(lBtail...\(rB +.Ed +.\" PARAGRAPH +.Pp +Block partial-implicit (no head, body, no tail). Note that the body +section may be followed by zero or more +.Sx Reserved Words . +These are in the block scope, but not in the body scope. +.Bd -literal -offset XXXX +\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB +.Ed +.\" PARAGRAPH +.Pp +In-lines have \(>=0 scoped arguments. +.Bd -literal -offset XXX +\&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB + +\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN +.Ed +.\" .Sh MACROS This section contains a complete list of all .Nm -macros, arranged ontologically then alphanumerically by macro name. A +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. +macro may be followed by further (ostensibly callable) macros. .\" SUB-SECTION .Ss Block full-implicit The head of these macros follows invocation; the body is the content of @@ -381,7 +666,8 @@ some .Sq \&It \-bullet , .Sq \-hyphen , .Sq \-dash , -.Sq \-enum +.Sq \-enum , +.Sq \-item .Pc don't have heads. .Pp @@ -405,6 +691,8 @@ the explicit scope rules. All contains bodies, some m .It \&.El Ta \&No Ta \&No Ta opened by \&.Bl .It \&.Bf Ta \&No Ta \&No Ta closed by \&.Ef .It \&.Ef Ta \&No Ta \&No Ta opened by \&.Bf +.It \&.Bk Ta \&No Ta \&No Ta closed by \&.Ek +.It \&.Ek Ta \&No Ta \&No Ta opened by \&.Bk .El .\" SUB-SECTION .Ss Block partial-implicit @@ -421,6 +709,9 @@ close at the invocation's end-of-line. .It \&.Qq Ta Yes Ta Yes .It \&.Sq Ta Yes Ta Yes .It \&.Brq Ta Yes Ta Yes +.It \&.D1 Ta \&No Ta \&Yes +.It \&.Dl Ta \&No Ta Yes +.It \&.Ql Ta Yes Ta Yes .El .\" SUB-SECTION .Ss Block partial-explicit @@ -454,84 +745,224 @@ and/or tail .It \&.Eo Ta Yes Ta Yes Ta closed by \&.Ec .It \&.Qc Ta Yes Ta Yes Ta opened by \&.Oo .It \&.Qo Ta Yes Ta Yes Ta closed by \&.Oc +.It \&.Re Ta \&No Ta \&No Ta opened by \&.Rs +.It \&.Rs Ta \&No Ta \&No Ta closed by \&.Re .El .\" SUB-SECTION -.Ss General -.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX -.It Em Macro Ta Em Callable Ta Em Parsable -.It \&.Dd Ta \& Ta \& -.It \&.Dt Ta \& Ta \& -.It \&.Os Ta \& Ta \& -.It \&.Pp Ta \& Ta \& -.It \&.D1 Ta \& Ta \& -.It \&.Dl Ta \& Ta Yes -.It \&.Ad Ta Yes Ta Yes -.It \&.An Ta \& Ta Yes -.It \&.Ar Ta Yes Ta Yes -.It \&.Cd Ta Yes Ta \& -.It \&.Cm Ta Yes Ta Yes -.It \&.Dv Ta Yes Ta Yes -.It \&.Er Ta Yes Ta Yes -.It \&.Ev Ta Yes Ta Yes -.It \&.Ex Ta \& Ta \& -.It \&.Fa Ta Yes Ta Yes -.It \&.Fd Ta \& Ta \& -.It \&.Fl Ta Yes Ta Yes -.It \&.Fn Ta Yes Ta Yes -.It \&.Ft Ta \& Ta \& -.It \&.Ic Ta Yes Ta Yes -.It \&.In Ta \& Ta \& -.It \&.Li Ta Yes Ta Yes -.It \&.Nd Ta \& Ta \& -.It \&.Nm Ta Yes Ta Yes -.It \&.Ot Ta \& Ta \& -.It \&.Pa Ta Yes Ta Yes -.It \&.Rv Ta \& Ta \& -.It \&.St Ta Yes Ta \& -.It \&.Va Ta Yes Ta Yes -.It \&.Vt Ta Yes Ta Yes -.It \&.Xr Ta Yes Ta Yes -.It \&.%A Ta \& Ta \& -.It \&.%B Ta \& Ta \& -.It \&.%C Ta \& Ta \& -.It \&.%D Ta \& Ta \& -.It \&.%I Ta \& Ta \& -.It \&.%J Ta \& Ta \& -.It \&.%N Ta \& Ta \& -.It \&.%O Ta \& Ta \& -.It \&.%P Ta \& Ta \& -.It \&.%R Ta \& Ta \& -.It \&.%T Ta \& Ta \& -.It \&.%V Ta \& Ta \& -.It \&.At Ta Yes Ta Yes -.It \&.Bsx Ta Yes Ta Yes -.It \&.Bx Ta Yes Ta Yes -.It \&.Db Ta \& Ta \& -.It \&.Em Ta Yes Ta Yes -.It \&.Fx Ta Yes Ta Yes -.It \&.Ms Ta \& Ta Yes -.It \&.No Ta Yes Ta Yes -.It \&.Ns Ta Yes Ta Yes -.It \&.Nx Ta Yes Ta Yes -.It \&.Ox Ta Yes Ta Yes -.It \&.Pf Ta \& Ta Yes -.It \&.Ql Ta Yes Ta Yes -.It \&.Re Ta \& Ta \& -.It \&.Rs Ta \& Ta \& -.It \&.Sm Ta \& Ta \& -.It \&.Sx Ta Yes Ta Yes -.It \&.Sy Ta Yes Ta Yes -.It \&.Tn Ta Yes Ta Yes -.It \&.Ux Ta Yes Ta Yes -.It \&.Bk Ta \& Ta \& -.It \&.Ek Ta \& Ta \& -.It \&.Bt Ta \& Ta \& -.It \&.Hf Ta \& Ta \& -.It \&.Fr Ta \& Ta \& -.It \&.Ud Ta \& Ta \& -.It \&.Lb Ta \& Ta \& -.It \&.Ap Ta Yes Ta Yes -.It \&.Lp Ta \& Ta \& -.It \&.Lk Ta \& Ta Yes -.It \&.Mt Ta \& Ta Yes +.Ss In-line +In-line macros have only text children. If a number (or inequality) of +arguments is +.Pq n , +then the macro accepts an arbitrary number of arguments. +.Pp +.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX +.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments +.It \&.Dd Ta \&No Ta \&No Ta >0 +.It \&.Dt Ta \&No Ta \&No Ta n +.It \&.Os Ta \&No Ta \&No Ta n +.It \&.Pp Ta \&No Ta \&No Ta 0 +.It \&.Ad Ta Yes Ta Yes Ta n +.It \&.An Ta \&No Ta Yes Ta n +.It \&.Ar Ta Yes Ta Yes Ta n +.It \&.Cd Ta Yes Ta \&No Ta >0 +.It \&.Cm Ta Yes Ta Yes Ta n +.It \&.Dv Ta Yes Ta Yes Ta >0 +.It \&.Er Ta Yes Ta Yes Ta >0 +.It \&.Ev Ta Yes Ta Yes Ta >0 +.It \&.Ex Ta \&No Ta \&No Ta 0 +.It \&.Fa Ta Yes Ta Yes Ta >0 +.It \&.Fd Ta \&No Ta \&No Ta >0 +.It \&.Fl Ta Yes Ta Yes Ta n +.It \&.Fn Ta Yes Ta Yes Ta >0 +.It \&.Ft Ta \&No Ta Yes Ta n +.It \&.Ic Ta Yes Ta Yes Ta >0 +.It \&.In Ta \&No Ta \&No Ta n +.It \&.Li Ta Yes Ta Yes Ta >0 +.It \&.Nd Ta \&No Ta \&No Ta n +.It \&.Nm Ta Yes Ta Yes Ta n +.It \&.Ot Ta \&No Ta \&No Ta n +.It \&.Pa Ta Yes Ta Yes Ta n +.It \&.Rv Ta \&No Ta \&No Ta 0 +.It \&.St Ta \&No Ta Yes Ta 1 +.It \&.Va Ta Yes Ta Yes Ta >0 +.It \&.Vt Ta Yes Ta Yes Ta >0 +.It \&.Xr Ta Yes Ta Yes Ta >0, <3 +.It \&.%A Ta \&No Ta \&No Ta >0 +.It \&.%B Ta \&No Ta \&No Ta >0 +.It \&.%C Ta \&No Ta \&No Ta >0 +.It \&.%D Ta \&No Ta \&No Ta >0 +.It \&.%I Ta \&No Ta \&No Ta >0 +.It \&.%J Ta \&No Ta \&No Ta >0 +.It \&.%N Ta \&No Ta \&No Ta >0 +.It \&.%O Ta \&No Ta \&No Ta >0 +.It \&.%P Ta \&No Ta \&No Ta >0 +.It \&.%R Ta \&No Ta \&No Ta >0 +.It \&.%T Ta \&No Ta \&No Ta >0 +.It \&.%V Ta \&No Ta \&No Ta >0 +.It \&.At Ta Yes Ta Yes Ta 1 +.It \&.Bsx Ta Yes Ta Yes Ta n +.It \&.Bx Ta Yes Ta Yes Ta n +.It \&.Db Ta \&No Ta \&No Ta 1 +.It \&.Em Ta Yes Ta Yes Ta >0 +.It \&.Fx Ta Yes Ta Yes Ta n +.It \&.Ms Ta \&No Ta Yes Ta >0 +.It \&.No Ta Yes Ta Yes Ta 0 +.It \&.Ns Ta Yes Ta Yes Ta 0 +.It \&.Nx Ta Yes Ta Yes Ta n +.It \&.Ox Ta Yes Ta Yes Ta n +.It \&.Pf Ta \&No Ta Yes Ta 1 +.It \&.Sm Ta \&No Ta \&No Ta 1 +.It \&.Sx Ta Yes Ta Yes Ta >0 +.It \&.Sy Ta Yes Ta Yes Ta >0 +.It \&.Tn Ta Yes Ta Yes Ta >0 +.It \&.Ux Ta Yes Ta Yes Ta n +.It \&.Dx Ta Yes Ta Yes Ta n +.It \&.Bt Ta \&No Ta \&No Ta 0 +.It \&.Hf Ta \&No Ta \&No Ta n +.It \&.Fr Ta \&No Ta \&No Ta n +.It \&.Ud Ta \&No Ta \&No Ta 0 +.It \&.Lb Ta \&No Ta \&No Ta 1 +.It \&.Ap Ta Yes Ta Yes Ta 0 +.It \&.Lp Ta \&No Ta \&No Ta 0 +.It \&.Lk Ta \&No Ta Yes Ta >0 +.It \&.Mt Ta \&No Ta Yes Ta >0 +.It \&.Es Ta \&No Ta \&No Ta 0 +.It \&.En Ta \&No Ta \&No Ta 0 +.El +.Pp +The +.Sq \&Ot , +.Sq \&Fr , +.Sq \&Es +and +.Sq \&En , +macros are obsolete. +.\" SECTION +.Sh COMPATIBILITY +The mdoc language was traditionally a +.Qq roff +macro package; most existing manuals were written with mdoc syntax +dictated by system-dependent roff installations. This section documents +compatibility with these systems. +.Pp +.Bl -dash -compact +.\" LIST-ITEM +.It +.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 +.Sq \-enum +lists will restart the sequence only for the sub-list. +.\" LIST-ITEM +.It +.Sq \&It \-column +syntax where column widths may be preceeded by other arguments (instead +of proceeded) is not supported. +.\" LIST-ITEM +.It +The +.Sq \&At +macro only accepts a single parameter. +.\" LIST-ITEM +.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 +.Sq \&Li +incorrectly by following it with a reserved character and expecting the +delimiter to render. This is not supported. +.\" LIST-ITEM +.It +.Sq \&Cd +is callable. +.El +.\" SECTION +.Sh SEE ALSO +.Xr mdoctree 1 , +.Xr mdoclint 1 , +.Xr mdocterm 1 , +.Xr mdoc 3 +.\" SECTION +.Sh AUTHORS +The +.Nm +utility was written by +.An Kristaps Dzonsons Aq kristaps@openbsd.org . +.\" SECTION +.Sh CAVEATS +There are several ambiguous parts of mdoc. +.Pp +.Bl -dash -compact +.\" LIST-ITEM +.It +.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.). .El