[BACK]Return to mdoc.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdoc.7, Revision 1.17

1.17    ! kristaps    1: .\" $Id: mdoc.7,v 1.16 2009/03/26 16:23:22 kristaps Exp $
1.1       kristaps    2: .\"
1.6       kristaps    3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
1.1       kristaps    4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the
                      7: .\" above copyright notice and this permission notice appear in all
                      8: .\" copies.
                      9: .\"
                     10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11: .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13: .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14: .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15: .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16: .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17: .\" PERFORMANCE OF THIS SOFTWARE.
                     18: .\"
                     19: .Dd $Mdocdate$
                     20: .Dt mdoc 7
                     21: .Os
                     22: .\" SECTION
                     23: .Sh NAME
                     24: .Nm mdoc
1.15      kristaps   25: .Nd mdoc language reference
1.1       kristaps   26: .\" SECTION
                     27: .Sh DESCRIPTION
                     28: The
                     29: .Nm mdoc
                     30: language is used to format
                     31: .Bx
                     32: .Ux
1.13      kristaps   33: manuals.  In this reference document, we describe the syntax, ontology
                     34: and structure of the
                     35: .Nm
                     36: language.
                     37: .\" PARAGRAPH
                     38: .Pp
                     39: An
1.1       kristaps   40: .Nm
                     41: document follows simple rules:  lines beginning with the control
1.13      kristaps   42: character
1.1       kristaps   43: .Sq \.
                     44: are parsed for macros.  Other lines are interpreted within the scope of
1.13      kristaps   45: prior macros:
                     46: .Bd -literal -offset XXX
                     47: \&.Sh Macro lines change control state.
                     48: Other lines are interpreted within the current state.
                     49: .Ed
1.1       kristaps   50: .\" SECTION
1.13      kristaps   51: .Sh INPUT ENCODING
1.1       kristaps   52: .Nm
1.13      kristaps   53: documents may contain only graphable 7-bit ASCII characters, the space
                     54: character
1.1       kristaps   55: .Sq \  ,
                     56: and, in certain circumstances, the tab character
                     57: .Sq \et .
                     58: All manuals must have
                     59: .Sq \en
1.10      kristaps   60: line termination.
                     61: .Pp
                     62: The only time a blank line is acceptable is within
                     63: the context of
1.16      kristaps   64: .Sq \&.Bd \-literal
1.10      kristaps   65: or
1.16      kristaps   66: .Sq \&.Bd \-unfilled .
1.10      kristaps   67: .Pp
                     68: Tab characters
                     69: .Pq \et
                     70: are only acceptable when delimiting
1.16      kristaps   71: .Sq \&.Bl \-column
1.10      kristaps   72: and in
1.16      kristaps   73: .Sq \&.Bd \-literal
1.10      kristaps   74: or
1.16      kristaps   75: .Sq \&.Bd \-unfilled
1.10      kristaps   76: contexts.
1.1       kristaps   77: .\" SUB-SECTION
1.2       kristaps   78: .Ss Reserved Characters
                     79: Within a macro line, the following characters are reserved:
                     80: .Bl -tag -width 12n -offset XXXX -compact
1.1       kristaps   81: .It \&.
1.2       kristaps   82: .Pq period
1.1       kristaps   83: .It \&,
1.2       kristaps   84: .Pq comma
1.1       kristaps   85: .It \&:
1.2       kristaps   86: .Pq colon
1.1       kristaps   87: .It \&;
1.2       kristaps   88: .Pq semicolon
1.1       kristaps   89: .It \&(
1.2       kristaps   90: .Pq left-parenthesis
1.1       kristaps   91: .It \&)
1.2       kristaps   92: .Pq right-parenthesis
1.1       kristaps   93: .It \&[
1.2       kristaps   94: .Pq left-bracket
1.1       kristaps   95: .It \&]
1.2       kristaps   96: .Pq right-bracket
1.1       kristaps   97: .It \&?
1.2       kristaps   98: .Pq question
1.1       kristaps   99: .It \&!
1.5       kristaps  100: .Pq exclamation
1.1       kristaps  101: .El
1.5       kristaps  102: .\" PARAGRAPH
1.1       kristaps  103: .Pp
1.5       kristaps  104: Use of reserved characters is described in
                    105: .Sx Closure .
                    106: For general non-reserved use, characters must either be escaped with a
                    107: non-breaking space
1.1       kristaps  108: .Pq Sq \e&
1.5       kristaps  109: or, if applicable, an appropriate escape-sequence used.
1.1       kristaps  110: .\" SUB-SECTION
                    111: .Ss Special Characters
                    112: Special character sequences begin with the escape character
1.16      kristaps  113: .Sq \e
1.4       kristaps  114: followed by either an open-parenthesis
1.1       kristaps  115: .Sq \&(
                    116: for two-character sequences; an open-bracket
                    117: .Sq \&[
                    118: for n-character sequences (terminated at a close-bracket
                    119: .Sq \&] ) ;
                    120: or a single one-character sequence.
                    121: .Pp
                    122: Characters may alternatively be escaped by a slash-asterisk,
1.16      kristaps  123: .Sq \e* ,
1.4       kristaps  124: with the same combinations as described above.  This form is deprecated.
                    125: .Pp
                    126: The following is a table of all available escapes.
1.1       kristaps  127: .Pp
                    128: Grammatic:
                    129: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  130: .It \e(em
1.1       kristaps  131: .Pq em-dash
1.16      kristaps  132: .It \e(en
1.1       kristaps  133: .Pq en-dash
                    134: .It \e-
                    135: .Pq hyphen
1.16      kristaps  136: .It \e\e
1.1       kristaps  137: .Pq back-slash
                    138: .It \e'
                    139: .Pq apostrophe
                    140: .It \e`
                    141: .Pq back-tick
1.16      kristaps  142: .It \e
1.1       kristaps  143: .Pq space
1.16      kristaps  144: .It \e.
1.1       kristaps  145: .Pq period
1.16      kristaps  146: .It \e(r!
1.8       kristaps  147: .Pq upside-down exclamation
1.16      kristaps  148: .It \e(r?
1.8       kristaps  149: .Pq upside-down question
1.1       kristaps  150: .El
                    151: .\" PARAGRAPH
                    152: .Pp
                    153: Enclosures:
                    154: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  155: .It \e(lh
1.5       kristaps  156: .Pq left hand
1.16      kristaps  157: .It \e(rh
1.5       kristaps  158: .Pq right hand
1.16      kristaps  159: .It \e(Fo
1.7       kristaps  160: .Pq left guillemet
1.16      kristaps  161: .It \e(Fc
1.7       kristaps  162: .Pq right guillemet
1.16      kristaps  163: .It \e(fo
1.7       kristaps  164: .Pq left guilsing
1.16      kristaps  165: .It \e(fc
1.7       kristaps  166: .Pq right guilsing
1.16      kristaps  167: .It \e(rC
1.1       kristaps  168: .Pq right brace
1.16      kristaps  169: .It \e(lC
1.1       kristaps  170: .Pq left brace
1.16      kristaps  171: .It \e(ra
1.1       kristaps  172: .Pq right angle
1.16      kristaps  173: .It \e(la
1.1       kristaps  174: .Pq left angle
1.16      kristaps  175: .It \e(rB
1.1       kristaps  176: .Pq right bracket
1.16      kristaps  177: .It \e(lB
1.1       kristaps  178: .Pq left bracket
1.16      kristaps  179: .It \eq
1.1       kristaps  180: .Pq double-quote
1.16      kristaps  181: .It \e(lq
1.1       kristaps  182: .Pq left double-quote
1.16      kristaps  183: .It \e(Lq
1.1       kristaps  184: .Pq left double-quote, deprecated
1.16      kristaps  185: .It \e(rq
1.1       kristaps  186: .Pq right double-quote
1.16      kristaps  187: .It \e(Rq
1.1       kristaps  188: .Pq right double-quote, deprecated
1.16      kristaps  189: .It \e(oq
1.1       kristaps  190: .Pq left single-quote
1.16      kristaps  191: .It \e(aq
1.1       kristaps  192: .Pq right single-quote
1.16      kristaps  193: .It \e(Bq
1.8       kristaps  194: .Pq right low double-quote
1.16      kristaps  195: .It \e(bq
1.8       kristaps  196: .Pq right low single-quote
1.1       kristaps  197: .El
                    198: .\" PARAGRAPH
                    199: .Pp
                    200: Indicatives:
                    201: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  202: .It \e(<-
1.1       kristaps  203: .Pq left arrow
1.16      kristaps  204: .It \e(->
1.1       kristaps  205: .Pq right arrow
1.16      kristaps  206: .It \e(ua
1.1       kristaps  207: .Pq up arrow
1.16      kristaps  208: .It \e(da
1.1       kristaps  209: .Pq down arrow
1.16      kristaps  210: .It \e(<>
1.5       kristaps  211: .Pq left-right arrow
1.16      kristaps  212: .It \e(lA
1.5       kristaps  213: .Pq left double-arrow
1.16      kristaps  214: .It \e(rA
1.5       kristaps  215: .Pq right double-arrow
1.16      kristaps  216: .It \e(uA
1.5       kristaps  217: .Pq up double-arrow
1.16      kristaps  218: .It \e(dA
1.5       kristaps  219: .Pq down double-arrow
1.16      kristaps  220: .It \e(hA
1.5       kristaps  221: .Pq left-right double-arrow
1.1       kristaps  222: .El
                    223: .\" PARAGRAPH
                    224: .Pp
                    225: Mathematical:
                    226: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  227: .It \e(es
1.9       kristaps  228: .Pq empty set
1.16      kristaps  229: .It \e(ca
1.9       kristaps  230: .Pq intersection
1.16      kristaps  231: .It \e(cu
1.9       kristaps  232: .Pq union
1.16      kristaps  233: .It \e(gr
1.9       kristaps  234: .Pq gradient
1.16      kristaps  235: .It \e(pd
1.9       kristaps  236: .Pq partial differential
1.16      kristaps  237: .It \e(ap
1.9       kristaps  238: .Pq similarity
1.16      kristaps  239: .It \e(=)
1.9       kristaps  240: .Pq proper superset
1.16      kristaps  241: .It \e((=
1.9       kristaps  242: .Pq proper subset
1.16      kristaps  243: .It \e(eq
1.9       kristaps  244: .Pq equals
1.16      kristaps  245: .It \e(di
1.9       kristaps  246: .Pq division
1.16      kristaps  247: .It \e(mu
1.9       kristaps  248: .Pq multiplication
1.16      kristaps  249: .It \e(pl
1.9       kristaps  250: .Pq addition
1.16      kristaps  251: .It \e(nm
1.9       kristaps  252: .Pq not element
1.16      kristaps  253: .It \e(mo
1.9       kristaps  254: .Pq element
1.16      kristaps  255: .It \e(Im
1.9       kristaps  256: .Pq imaginary
1.16      kristaps  257: .It \e(Re
1.9       kristaps  258: .Pq real
1.16      kristaps  259: .It \e(Ah
1.9       kristaps  260: .Pq aleph
1.16      kristaps  261: .It \e(te
1.9       kristaps  262: .Pq existential quantifier
1.16      kristaps  263: .It \e(fa
1.9       kristaps  264: .Pq universal quantifier
1.16      kristaps  265: .It \e(AN
1.9       kristaps  266: .Pq logical AND
1.16      kristaps  267: .It \e(OR
1.9       kristaps  268: .Pq logical OR
1.16      kristaps  269: .It \e(no
1.9       kristaps  270: .Pq logical NOT
1.16      kristaps  271: .It \e(st
1.9       kristaps  272: .Pq such that
1.16      kristaps  273: .It \e(tf
1.9       kristaps  274: .Pq therefore
1.16      kristaps  275: .It \e(~~
1.9       kristaps  276: .Pq approximate
1.16      kristaps  277: .It \e(~=
1.9       kristaps  278: .Pq approximately equals
1.16      kristaps  279: .It \e(=~
1.9       kristaps  280: .Pq congruent
1.16      kristaps  281: .It \e(Gt
1.1       kristaps  282: .Pq greater-than, deprecated
1.16      kristaps  283: .It \e(Lt
1.1       kristaps  284: .Pq less-than, deprecated
1.16      kristaps  285: .It \e(<=
1.1       kristaps  286: .Pq less-than-equal
1.16      kristaps  287: .It \e(Le
1.1       kristaps  288: .Pq less-than-equal, deprecated
1.16      kristaps  289: .It \e(>=
1.1       kristaps  290: .Pq greater-than-equal
1.16      kristaps  291: .It \e(Ge
1.1       kristaps  292: .Pq greater-than-equal
1.16      kristaps  293: .It \e(==
1.1       kristaps  294: .Pq equal
1.16      kristaps  295: .It \e(!=
1.1       kristaps  296: .Pq not equal
1.16      kristaps  297: .It \e(Ne
1.1       kristaps  298: .Pq not equal, deprecated
1.16      kristaps  299: .It \e(if
1.1       kristaps  300: .Pq infinity
1.16      kristaps  301: .It \e(If
1.1       kristaps  302: .Pq infinity, deprecated
1.16      kristaps  303: .It \e(na
1.1       kristaps  304: .Pq NaN , an extension
1.16      kristaps  305: .It \e(Na
1.1       kristaps  306: .Pq NaN, deprecated
1.16      kristaps  307: .It \e(+-
1.1       kristaps  308: .Pq plus-minus
1.16      kristaps  309: .It \e(Pm
1.1       kristaps  310: .Pq plus-minus, deprecated
1.16      kristaps  311: .It \e(**
1.1       kristaps  312: .Pq asterisk
                    313: .El
                    314: .\" PARAGRAPH
                    315: .Pp
1.7       kristaps  316: Ligatures:
1.1       kristaps  317: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  318: .It \e(ss
1.7       kristaps  319: .Pq German eszett
1.16      kristaps  320: .It \e(AE
1.5       kristaps  321: .Pq upper-case AE
1.16      kristaps  322: .It \e(ae
1.5       kristaps  323: .Pq lower-case AE
1.16      kristaps  324: .It \e(OE
1.5       kristaps  325: .Pq upper-case OE
1.16      kristaps  326: .It \e(oe
1.5       kristaps  327: .Pq lower-case OE
1.16      kristaps  328: .It \e(ff
1.7       kristaps  329: .Pq ff ligature
1.16      kristaps  330: .It \e(fi
1.7       kristaps  331: .Pq fi ligature
1.16      kristaps  332: .It \e(fl
1.7       kristaps  333: .Pq fl ligature
1.16      kristaps  334: .It \e(Fi
1.7       kristaps  335: .Pq ffi ligature
1.16      kristaps  336: .It \e(Fl
1.7       kristaps  337: .Pq ffl ligature
                    338: .El
                    339: .\" PARAGRAPH
                    340: .Pp
                    341: Diacritics and letters:
                    342: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  343: .It \e(ga
1.7       kristaps  344: .Pq grave accent
1.16      kristaps  345: .It \e(aa
1.7       kristaps  346: .Pq accute accent
1.16      kristaps  347: .It \e(a"
1.8       kristaps  348: .Pq umlaut accent
1.16      kristaps  349: .It \e(ad
1.7       kristaps  350: .Pq dieresis accent
1.16      kristaps  351: .It \e(a~
1.7       kristaps  352: .Pq tilde accent
1.16      kristaps  353: .It \e(a^
1.7       kristaps  354: .Pq circumflex accent
1.16      kristaps  355: .It \e(ac
1.7       kristaps  356: .Pq cedilla accent
1.16      kristaps  357: .It \e(ad
1.7       kristaps  358: .Pq dieresis accent
1.16      kristaps  359: .It \e(ah
1.7       kristaps  360: .Pq caron accent
1.16      kristaps  361: .It \e(ao
1.7       kristaps  362: .Pq ring accent
1.16      kristaps  363: .It \e(ho
1.7       kristaps  364: .Pq hook accent
1.16      kristaps  365: .It \e(ab
1.7       kristaps  366: .Pq breve accent
1.16      kristaps  367: .It \e(a-
1.7       kristaps  368: .Pq macron accent
1.16      kristaps  369: .It \e(-D
1.7       kristaps  370: .Pq upper-case eth
1.16      kristaps  371: .It \e(Sd
1.7       kristaps  372: .Pq lower-case eth
1.16      kristaps  373: .It \e(TP
1.7       kristaps  374: .Pq upper-case thorn
1.16      kristaps  375: .It \e(Tp
1.7       kristaps  376: .Pq lower-case thorn
1.16      kristaps  377: .It \e('A
1.5       kristaps  378: .Pq upper-case acute A
1.16      kristaps  379: .It \e('E
1.5       kristaps  380: .Pq upper-case acute E
1.16      kristaps  381: .It \e('I
1.5       kristaps  382: .Pq upper-case acute I
1.16      kristaps  383: .It \e('O
1.5       kristaps  384: .Pq upper-case acute O
1.16      kristaps  385: .It \e('U
1.5       kristaps  386: .Pq upper-case acute U
1.16      kristaps  387: .It \e('a
1.5       kristaps  388: .Pq lower-case acute a
1.16      kristaps  389: .It \e('e
1.5       kristaps  390: .Pq lower-case acute e
1.16      kristaps  391: .It \e('i
1.5       kristaps  392: .Pq lower-case acute i
1.16      kristaps  393: .It \e('o
1.5       kristaps  394: .Pq lower-case acute o
1.16      kristaps  395: .It \e('u
1.5       kristaps  396: .Pq lower-case acute u
1.16      kristaps  397: .It \e(`A
1.5       kristaps  398: .Pq upper-case grave A
1.16      kristaps  399: .It \e(`E
1.5       kristaps  400: .Pq upper-case grave E
1.16      kristaps  401: .It \e(`I
1.5       kristaps  402: .Pq upper-case grave I
1.16      kristaps  403: .It \e(`O
1.5       kristaps  404: .Pq upper-case grave O
1.16      kristaps  405: .It \e(`U
1.5       kristaps  406: .Pq upper-case grave U
1.16      kristaps  407: .It \e(`a
1.5       kristaps  408: .Pq lower-case grave a
1.16      kristaps  409: .It \e(`e
1.5       kristaps  410: .Pq lower-case grave e
1.16      kristaps  411: .It \e(`i
1.5       kristaps  412: .Pq lower-case grave i
1.16      kristaps  413: .It \e(`o
1.5       kristaps  414: .Pq lower-case grave o
1.16      kristaps  415: .It \e(`u
1.5       kristaps  416: .Pq lower-case grave u
1.16      kristaps  417: .It \e(~A
1.5       kristaps  418: .Pq upper-case tilde A
1.16      kristaps  419: .It \e(~N
1.5       kristaps  420: .Pq upper-case tilde N
1.16      kristaps  421: .It \e(~O
1.5       kristaps  422: .Pq upper-case tilde O
1.16      kristaps  423: .It \e(~a
1.5       kristaps  424: .Pq lower-case tilde a
1.16      kristaps  425: .It \e(~n
1.5       kristaps  426: .Pq lower-case tilde n
1.16      kristaps  427: .It \e(~o
1.5       kristaps  428: .Pq lower-case tilde o
1.16      kristaps  429: .It \e(:A
1.5       kristaps  430: .Pq upper-case dieresis A
1.16      kristaps  431: .It \e(:E
1.5       kristaps  432: .Pq upper-case dieresis E
1.16      kristaps  433: .It \e(:I
1.5       kristaps  434: .Pq upper-case dieresis I
1.16      kristaps  435: .It \e(:O
1.5       kristaps  436: .Pq upper-case dieresis O
1.16      kristaps  437: .It \e(:U
1.5       kristaps  438: .Pq upper-case dieresis U
1.16      kristaps  439: .It \e(:a
1.5       kristaps  440: .Pq lower-case dieresis a
1.16      kristaps  441: .It \e(:e
1.5       kristaps  442: .Pq lower-case dieresis e
1.16      kristaps  443: .It \e(:i
1.5       kristaps  444: .Pq lower-case dieresis i
1.16      kristaps  445: .It \e(:o
1.5       kristaps  446: .Pq lower-case dieresis o
1.16      kristaps  447: .It \e(:u
1.5       kristaps  448: .Pq lower-case dieresis u
1.16      kristaps  449: .It \e(:y
1.5       kristaps  450: .Pq lower-case dieresis y
1.16      kristaps  451: .It \e(^A
1.7       kristaps  452: .Pq upper-case circumflex A
1.16      kristaps  453: .It \e(^E
1.7       kristaps  454: .Pq upper-case circumflex E
1.16      kristaps  455: .It \e(^I
1.7       kristaps  456: .Pq upper-case circumflex I
1.16      kristaps  457: .It \e(^O
1.7       kristaps  458: .Pq upper-case circumflex O
1.16      kristaps  459: .It \e(^U
1.7       kristaps  460: .Pq upper-case circumflex U
1.16      kristaps  461: .It \e(^a
1.7       kristaps  462: .Pq lower-case circumflex a
1.16      kristaps  463: .It \e(^e
1.7       kristaps  464: .Pq lower-case circumflex e
1.16      kristaps  465: .It \e(^i
1.7       kristaps  466: .Pq lower-case circumflex i
1.16      kristaps  467: .It \e(^o
1.7       kristaps  468: .Pq lower-case circumflex o
1.16      kristaps  469: .It \e(^u
1.7       kristaps  470: .Pq lower-case circumflex u
1.16      kristaps  471: .It \e(,C
1.7       kristaps  472: .Pq upper-case cedilla C
1.16      kristaps  473: .It \e(,c
1.7       kristaps  474: .Pq lower-case cedilla c
1.16      kristaps  475: .It \e(/L
1.7       kristaps  476: .Pq upper-case stroke L
1.16      kristaps  477: .It \e(/l
1.7       kristaps  478: .Pq lower-case stroke l
1.16      kristaps  479: .It \e(/O
1.7       kristaps  480: .Pq upper-case stroke O
1.16      kristaps  481: .It \e(/o
1.7       kristaps  482: .Pq lower-case stroke o
1.16      kristaps  483: .It \e(oA
1.7       kristaps  484: .Pq upper-case ring A
1.16      kristaps  485: .It \e(oa
1.7       kristaps  486: .Pq lower-case ring a
                    487: .El
                    488: .\" PARAGRAPH
                    489: .Pp
                    490: Monetary:
                    491: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  492: .It \e(Cs
1.7       kristaps  493: .Pq Scandinavian
1.16      kristaps  494: .It \e(Do
1.7       kristaps  495: .Pq dollar
1.16      kristaps  496: .It \e(Po
1.7       kristaps  497: .Pq pound
1.16      kristaps  498: .It \e(Ye
1.7       kristaps  499: .Pq yen
1.16      kristaps  500: .It \e(Fn
1.7       kristaps  501: .Pq florin
1.16      kristaps  502: .It \e(ct
1.7       kristaps  503: .Pq cent
1.1       kristaps  504: .El
                    505: .\" PARAGRAPH
                    506: .Pp
                    507: Special symbols:
                    508: .Bl -tag -width 12n -offset "XXXX" -compact
1.16      kristaps  509: .It \e(de
1.9       kristaps  510: .Pq degree
1.16      kristaps  511: .It \e(ps
1.9       kristaps  512: .Pq paragraph
1.16      kristaps  513: .It \e(sc
1.9       kristaps  514: .Pq section
1.16      kristaps  515: .It \e(dg
1.9       kristaps  516: .Pq dagger
1.16      kristaps  517: .It \e(dd
1.9       kristaps  518: .Pq double dagger
1.16      kristaps  519: .It \e(ci
1.8       kristaps  520: .Pq circle
1.16      kristaps  521: .It \e(ba
1.1       kristaps  522: .Pq bar
1.16      kristaps  523: .It \e(bb
1.8       kristaps  524: .Pq broken bar
1.16      kristaps  525: .It \e(Ba
1.1       kristaps  526: .Pq bar, deprecated
1.16      kristaps  527: .It \e(co
1.1       kristaps  528: .Pq copyright
1.16      kristaps  529: .It \e(rg
1.5       kristaps  530: .Pq registered
1.16      kristaps  531: .It \e(tm
1.5       kristaps  532: .Pq trademarked
1.16      kristaps  533: .It \e&
1.1       kristaps  534: .Pq non-breaking space
1.16      kristaps  535: .It \ee
1.1       kristaps  536: .Pq escape
1.16      kristaps  537: .It \e(Am
1.1       kristaps  538: .Pq ampersand, deprecated
                    539: .El
                    540: .\" SECTION
1.17    ! kristaps  541: .Sh STRUCTURE
1.13      kristaps  542: Macros are classified in an ontology described by their scope rules.
                    543: Some macros are allowed to deviate from their classifications to
                    544: preserve backward-compatibility with old macro combinations still found
                    545: in the manual corpus.  These are specifically noted on a per-macro
                    546: basis.
1.4       kristaps  547: .\" SUB-SECTION
                    548: .Ss Scope
1.2       kristaps  549: .Bl -inset
1.1       kristaps  550: .\" LIST-ITEM
                    551: .It Em Block
1.2       kristaps  552: macros enclose other block macros, in-line macros or text, and
1.4       kristaps  553: may span multiple lines.
1.2       kristaps  554: .Bl -inset -offset XXXX
1.1       kristaps  555: .\" LIST-ITEM
                    556: .It Em Full-block
1.5       kristaps  557: macros always span multiple lines.  They consist of zero or
1.2       kristaps  558: more
1.1       kristaps  559: .Qq heads ,
1.5       kristaps  560: subsequent macros or text on the same line following invocation; an
                    561: optional
1.1       kristaps  562: .Qq body ,
                    563: which spans subsequent lines of text or macros; and an optional
                    564: .Qq tail ,
                    565: macros or text on the same line following closure.
                    566: .\" LIST-ITEM
                    567: .It Em Partial-block
1.5       kristaps  568: macros may span multiple lines.  They consists of a optional
1.1       kristaps  569: .Qq head ,
                    570: text immediately following invocation; always a
                    571: .Qq body ,
                    572: text or macros following the head on the same and subsequent lines; and
                    573: optionally a
                    574: .Qq tail ,
                    575: text immediately following closure.
                    576: .\" LIST-ITEM
                    577: .It Em In-line
1.4       kristaps  578: macros may only enclose text and span at most a single line.
                    579: .El
                    580: .El
                    581: .\" SUB-SECTION
                    582: .Ss Closure
                    583: Closure of a macro's scope depends first on its classification, then
                    584: on whether it's parsable.  In this table,
                    585: .Sq BFE
                    586: refers to block full-explicit and so on.
                    587: .\" PARAGRAPH
                    588: .Pp
                    589: .Bl -tag -width 12n -offset XXXX -compact
                    590: .It BPE , BFE
                    591: corresponding explicit closure macro
                    592: .It BFI
                    593: end-of-file or a corresponding implicit closure macro
                    594: .It BPI
                    595: end-of-line (body may be closed by >0 space-separated
                    596: .Sx Reserved Characters ,
                    597: although block scope will still be open)
                    598: .It INL
                    599: end-of-line
1.1       kristaps  600: .El
1.4       kristaps  601: .\" PARAGRAPH
                    602: .Pp
                    603: If a macro (block or in-line) is parsable, it may also be closed out by
                    604: one of the following scenarios (unless specifically noted otherwise):
                    605: .\" PARAGRAPH
                    606: .Pp
                    607: .Bl -dash -offset XXXX -compact
                    608: .It
                    609: a sequence of >0 space-separated
                    610: .Sx Reserved Characters ,
                    611: .It
                    612: another macro,
                    613: .It
                    614: end-of-line, or
                    615: .It
                    616: completion of a set number of arguments.
                    617: .El
                    618: .\" PARAGRAPH
                    619: .Pp
                    620: If >0 space-separated
                    621: .Sx Reserved Characters
                    622: are followed by non-reserved characters, the behaviour differs per
                    623: macro.  In general, scope of the macro is closed and re-opened:
                    624: subsequent tokens are interpreted as if the scope had just been opened.
                    625: In other circumstances, scope is simply closed out.
1.1       kristaps  626: .\" SECTION
1.2       kristaps  627: .Sh SYNTAX
1.17    ! kristaps  628: Macros are two or three characters in length.  The syntax of macro
        !           629: invocation depends on its classification.
1.2       kristaps  630: .Qq \-arg
                    631: refers to the macro arguments (which may contain zero or more values).
                    632: In these illustrations,
                    633: .Sq \&.Yo
                    634: opens the scope of a macro, and if specified,
                    635: .Sq \&.Yc
                    636: closes it out (closure may be implicit at end-of-line or end-of-file).
1.4       kristaps  637: .\" PARAGRAPH
1.2       kristaps  638: .Pp
1.4       kristaps  639: Block full-explicit (may contain head, body, tail).
1.2       kristaps  640: .Bd -literal -offset XXXX
1.4       kristaps  641: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
                    642: \(lBbody...\(rB
                    643: \&.Yc \(lBtail...\(rB
1.2       kristaps  644: .Ed
1.4       kristaps  645: .\" PARAGRAPH
1.2       kristaps  646: .Pp
1.4       kristaps  647: Block full-implicit (may contain zero or more heads, body, no tail).
1.2       kristaps  648: .Bd -literal -offset XXXX
1.4       kristaps  649: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
                    650: \(lBbody...\(rB
1.2       kristaps  651: \&.Yc
                    652: .Ed
1.4       kristaps  653: .\" PARAGRAPH
1.2       kristaps  654: .Pp
1.4       kristaps  655: Block partial-explicit (may contain head, multi-line body, tail).
1.2       kristaps  656: .Bd -literal -offset XXXX
                    657: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB
1.4       kristaps  658: \(lBbody...\(rB
                    659: \&.Yc \(lBtail...\(rB
1.2       kristaps  660:
                    661: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBhead...\(rB \
1.4       kristaps  662: \(lBbody...\(rB \&Yc \(lBtail...\(rB
1.2       kristaps  663: .Ed
1.4       kristaps  664: .\" PARAGRAPH
1.2       kristaps  665: .Pp
1.4       kristaps  666: Block partial-implicit (no head, body, no tail).  Note that the body
                    667: section may be followed by zero or more
                    668: .Sx Reserved Words .
                    669: These are in the block scope, but not in the body scope.
1.2       kristaps  670: .Bd -literal -offset XXXX
1.4       kristaps  671: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBreserved...\(rB
1.2       kristaps  672: .Ed
1.4       kristaps  673: .\" PARAGRAPH
1.2       kristaps  674: .Pp
1.4       kristaps  675: In-lines have \(>=0 scoped arguments.
1.2       kristaps  676: .Bd -literal -offset XXX
1.4       kristaps  677: \&.Yy \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB
1.2       kristaps  678:
                    679: \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
                    680: .Ed
                    681: .\"
1.1       kristaps  682: .Sh MACROS
                    683: This section contains a complete list of all
                    684: .Nm
1.2       kristaps  685: macros, arranged ontologically.  A
1.1       kristaps  686: .Qq callable
1.17    ! kristaps  687: macro is invoked subsequent to the initial macro-line macro.  A
1.1       kristaps  688: .Qq parsable
1.2       kristaps  689: macro may be followed by further (ostensibly callable) macros.
1.1       kristaps  690: .\" SUB-SECTION
                    691: .Ss Block full-implicit
                    692: The head of these macros follows invocation; the body is the content of
                    693: subsequent lines prior to closure.  None of these macros have tails;
                    694: some
                    695: .Po
1.16      kristaps  696: .Sq \&.It \-bullet ,
1.1       kristaps  697: .Sq \-hyphen ,
                    698: .Sq \-dash ,
1.2       kristaps  699: .Sq \-enum ,
                    700: .Sq \-item
1.1       kristaps  701: .Pc
                    702: don't have heads.
                    703: .Pp
                    704: .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX
                    705: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing
                    706: .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh
                    707: .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss
                    708: .It \&.It    Ta    \&No    Ta    Yes     Ta    \&.It, \&.El
                    709: .El
                    710: .\" SUB-SECTION
                    711: .Ss Block full-explicit
                    712: None of these macros are callable or parsed.  The last column indicates
                    713: the explicit scope rules.  All contains bodies, some may contain heads
                    714: .Pq So \&Bf Sc .
                    715: .Pp
                    716: .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX
                    717: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
                    718: .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed
                    719: .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd
                    720: .It \&.Bl    Ta    \&No    Ta    \&No    Ta    closed by \&.El
                    721: .It \&.El    Ta    \&No    Ta    \&No    Ta    opened by \&.Bl
                    722: .It \&.Bf    Ta    \&No    Ta    \&No    Ta    closed by \&.Ef
                    723: .It \&.Ef    Ta    \&No    Ta    \&No    Ta    opened by \&.Bf
1.2       kristaps  724: .It \&.Bk    Ta    \&No    Ta    \&No    Ta    closed by \&.Ek
                    725: .It \&.Ek    Ta    \&No    Ta    \&No    Ta    opened by \&.Bk
1.1       kristaps  726: .El
                    727: .\" SUB-SECTION
                    728: .Ss Block partial-implicit
                    729: All of these are callable and parsed for further macros.  Their scopes
                    730: close at the invocation's end-of-line.
                    731: .Pp
                    732: .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset XXXX
                    733: .It Em Macro Ta Em Callable Ta Em Parsable
                    734: .It \&.Aq    Ta    Yes   Ta    Yes
                    735: .It \&.Op    Ta    Yes   Ta    Yes
                    736: .It \&.Bq    Ta    Yes   Ta    Yes
                    737: .It \&.Dq    Ta    Yes   Ta    Yes
                    738: .It \&.Pq    Ta    Yes   Ta    Yes
                    739: .It \&.Qq    Ta    Yes   Ta    Yes
                    740: .It \&.Sq    Ta    Yes   Ta    Yes
                    741: .It \&.Brq   Ta    Yes   Ta    Yes
1.2       kristaps  742: .It \&.D1    Ta    \&No  Ta    \&Yes
                    743: .It \&.Dl    Ta    \&No  Ta    Yes
                    744: .It \&.Ql    Ta    Yes   Ta    Yes
1.1       kristaps  745: .El
1.13      kristaps  746: .\" PARAGRAPH
                    747: .Pp
                    748: The
1.16      kristaps  749: .Sq \&.Op
                    750: may be broken by
                    751: .Sq \&.Oc
                    752: as in the following example:
1.13      kristaps  753: .Bd -literal -offset XXXX
                    754: \&.Oo
                    755: \&.Op Fl a Oc
                    756: .Ed
                    757: .Pp
                    758: In the above example, the scope of
1.16      kristaps  759: .Sq \&.Op
1.13      kristaps  760: is technically broken by
1.16      kristaps  761: .Sq \&.Oc ,
1.13      kristaps  762: however, due to the overwhelming existence of this sequence, it's
                    763: allowed.
1.1       kristaps  764: .\" SUB-SECTION
                    765: .Ss Block partial-explicit
                    766: Each of these contains at least a body and, in limited circumstances, a
                    767: head
1.16      kristaps  768: .Pq So \&.Fo Sc , So \&.Eo Sc
1.1       kristaps  769: and/or tail
1.16      kristaps  770: .Pq So \&.Ec Sc .
1.1       kristaps  771: .Pp
                    772: .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset XXXX
                    773: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
                    774: .It \&.Ao    Ta    Yes   Ta    Yes    Ta    closed by \&.Ac
                    775: .It \&.Ac    Ta    Yes   Ta    Yes    Ta    opened by \&.Ao
                    776: .It \&.Bc    Ta    Yes   Ta    Yes    Ta    closed by \&.Bo
                    777: .It \&.Bo    Ta    Yes   Ta    Yes    Ta    opened by \&.Bc
                    778: .It \&.Pc    Ta    Yes   Ta    Yes    Ta    closed by \&.Po
                    779: .It \&.Po    Ta    Yes   Ta    Yes    Ta    opened by \&.Pc
                    780: .It \&.Do    Ta    Yes   Ta    Yes    Ta    closed by \&.Dc
                    781: .It \&.Dc    Ta    Yes   Ta    Yes    Ta    opened by \&.Do
                    782: .It \&.Xo    Ta    Yes   Ta    Yes    Ta    closed by \&.Xc
                    783: .It \&.Xc    Ta    Yes   Ta    Yes    Ta    opened by \&.Xo
                    784: .It \&.Bro   Ta    Yes   Ta    Yes    Ta    closed by \&.Brc
                    785: .It \&.Brc   Ta    Yes   Ta    Yes    Ta    opened by \&.Bro
                    786: .It \&.Oc    Ta    Yes   Ta    Yes    Ta    closed by \&.Oo
                    787: .It \&.Oo    Ta    Yes   Ta    Yes    Ta    opened by \&.Oc
                    788: .It \&.So    Ta    Yes   Ta    Yes    Ta    closed by \&.Sc
                    789: .It \&.Sc    Ta    Yes   Ta    Yes    Ta    opened by \&.So
                    790: .It \&.Fc    Ta    Yes   Ta    Yes    Ta    opened by \&.Fo
                    791: .It \&.Fo    Ta    \&No  Ta    \&No   Ta    closed by \&.Fc
                    792: .It \&.Ec    Ta    Yes   Ta    Yes    Ta    opened by \&.Eo
                    793: .It \&.Eo    Ta    Yes   Ta    Yes    Ta    closed by \&.Ec
                    794: .It \&.Qc    Ta    Yes   Ta    Yes    Ta    opened by \&.Oo
                    795: .It \&.Qo    Ta    Yes   Ta    Yes    Ta    closed by \&.Oc
1.2       kristaps  796: .It \&.Re    Ta    \&No  Ta    \&No   Ta    opened by \&.Rs
                    797: .It \&.Rs    Ta    \&No  Ta    \&No   Ta    closed by \&.Re
1.1       kristaps  798: .El
                    799: .\" SUB-SECTION
1.2       kristaps  800: .Ss In-line
1.3       kristaps  801: In-line macros have only text children.  If a number (or inequality) of
                    802: arguments is
                    803: .Pq n ,
                    804: then the macro accepts an arbitrary number of arguments.
1.2       kristaps  805: .Pp
                    806: .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset XXXX
                    807: .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
1.3       kristaps  808: .It \&.Dd    Ta    \&No  Ta    \&No    Ta    >0
                    809: .It \&.Dt    Ta    \&No  Ta    \&No    Ta    n
                    810: .It \&.Os    Ta    \&No  Ta    \&No    Ta    n
1.2       kristaps  811: .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0
1.3       kristaps  812: .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n
                    813: .It \&.An    Ta    \&No  Ta    Yes     Ta    n
                    814: .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n
                    815: .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0
                    816: .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n
1.11      kristaps  817: .It \&.Dv    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  818: .It \&.Er    Ta    Yes   Ta    Yes     Ta    >0
1.11      kristaps  819: .It \&.Ev    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  820: .It \&.Ex    Ta    \&No  Ta    \&No    Ta    0
1.12      kristaps  821: .It \&.Fa    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  822: .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0
                    823: .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n
                    824: .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0
                    825: .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n
                    826: .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0
                    827: .It \&.In    Ta    \&No  Ta    \&No    Ta    n
1.11      kristaps  828: .It \&.Li    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  829: .It \&.Nd    Ta    \&No  Ta    \&No    Ta    n
                    830: .It \&.Nm    Ta    Yes   Ta    Yes     Ta    n
                    831: .It \&.Ot    Ta    \&No  Ta    \&No    Ta    n
                    832: .It \&.Pa    Ta    Yes   Ta    Yes     Ta    n
                    833: .It \&.Rv    Ta    \&No  Ta    \&No    Ta    0
                    834: .It \&.St    Ta    \&No  Ta    Yes     Ta    1
1.11      kristaps  835: .It \&.Va    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  836: .It \&.Vt    Ta    Yes   Ta    Yes     Ta    >0
                    837: .It \&.Xr    Ta    Yes   Ta    Yes     Ta    >0, <3
                    838: .It \&.%A    Ta    \&No  Ta    \&No    Ta    >0
                    839: .It \&.%B    Ta    \&No  Ta    \&No    Ta    >0
                    840: .It \&.%C    Ta    \&No  Ta    \&No    Ta    >0
                    841: .It \&.%D    Ta    \&No  Ta    \&No    Ta    >0
                    842: .It \&.%I    Ta    \&No  Ta    \&No    Ta    >0
                    843: .It \&.%J    Ta    \&No  Ta    \&No    Ta    >0
                    844: .It \&.%N    Ta    \&No  Ta    \&No    Ta    >0
                    845: .It \&.%O    Ta    \&No  Ta    \&No    Ta    >0
                    846: .It \&.%P    Ta    \&No  Ta    \&No    Ta    >0
                    847: .It \&.%R    Ta    \&No  Ta    \&No    Ta    >0
                    848: .It \&.%T    Ta    \&No  Ta    \&No    Ta    >0
                    849: .It \&.%V    Ta    \&No  Ta    \&No    Ta    >0
                    850: .It \&.At    Ta    Yes   Ta    Yes     Ta    1
                    851: .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
                    852: .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
                    853: .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
1.11      kristaps  854: .It \&.Em    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  855: .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
                    856: .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0
                    857: .It \&.No    Ta    Yes   Ta    Yes     Ta    0
                    858: .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0
                    859: .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n
                    860: .It \&.Ox    Ta    Yes   Ta    Yes     Ta    n
                    861: .It \&.Pf    Ta    \&No  Ta    Yes     Ta    1
                    862: .It \&.Sm    Ta    \&No  Ta    \&No    Ta    1
                    863: .It \&.Sx    Ta    Yes   Ta    Yes     Ta    >0
                    864: .It \&.Sy    Ta    Yes   Ta    Yes     Ta    >0
                    865: .It \&.Tn    Ta    Yes   Ta    Yes     Ta    >0
                    866: .It \&.Ux    Ta    Yes   Ta    Yes     Ta    n
1.6       kristaps  867: .It \&.Dx    Ta    Yes   Ta    Yes     Ta    n
1.3       kristaps  868: .It \&.Bt    Ta    \&No  Ta    \&No    Ta    0
                    869: .It \&.Hf    Ta    \&No  Ta    \&No    Ta    n
                    870: .It \&.Fr    Ta    \&No  Ta    \&No    Ta    n
                    871: .It \&.Ud    Ta    \&No  Ta    \&No    Ta    0
                    872: .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1
                    873: .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0
                    874: .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0
                    875: .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0
                    876: .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0
1.6       kristaps  877: .It \&.Es    Ta    \&No  Ta    \&No    Ta    0
                    878: .It \&.En    Ta    \&No  Ta    \&No    Ta    0
1.1       kristaps  879: .El
1.6       kristaps  880: .Pp
                    881: The
1.16      kristaps  882: .Sq \&.Ot ,
                    883: .Sq \&.Fr ,
                    884: .Sq \&.Es
1.6       kristaps  885: and
1.16      kristaps  886: .Sq \&.En ,
1.6       kristaps  887: macros are obsolete.
1.2       kristaps  888: .\" SECTION
1.4       kristaps  889: .Sh COMPATIBILITY
                    890: The mdoc language was traditionally a
                    891: .Qq roff
                    892: macro package; most existing manuals were written with mdoc syntax
                    893: dictated by system-dependent roff installations.  This section documents
                    894: compatibility with these systems.
                    895: .Pp
                    896: .Bl -dash -compact
                    897: .\" LIST-ITEM
                    898: .It
1.16      kristaps  899: .Sq \&.Fo
1.5       kristaps  900: and
1.16      kristaps  901: .Sq \&.St
1.5       kristaps  902: historically weren't always callable.  Both are now correctly callable.
                    903: .\" LIST-ITEM
                    904: .It
1.16      kristaps  905: .Sq \&.It \-nested
1.4       kristaps  906: is assumed for all lists: any list may be nested and
                    907: .Sq \-enum
                    908: lists will restart the sequence only for the sub-list.
                    909: .\" LIST-ITEM
                    910: .It
1.16      kristaps  911: .Sq \&.It \-column
1.4       kristaps  912: syntax where column widths may be preceeded by other arguments (instead
                    913: of proceeded) is not supported.
                    914: .\" LIST-ITEM
                    915: .It
                    916: The
1.16      kristaps  917: .Sq \&.At
1.4       kristaps  918: macro only accepts a single parameter.
                    919: .\" LIST-ITEM
                    920: .It
                    921: The system-name macros (
1.16      kristaps  922: .Ns Sq \&.At ,
                    923: .Sq \&.Bsx ,
                    924: .Sq \&.Bx ,
                    925: .Sq \&.Fx ,
                    926: .Sq \&.Nx ,
                    927: .Sq \&.Ox ,
1.4       kristaps  928: and
1.16      kristaps  929: .Sq \&.Ux )
1.4       kristaps  930: are callable.
                    931: .\" LIST-ITEM
                    932: .It
                    933: Some manuals use
1.16      kristaps  934: .Sq \&.Li
1.4       kristaps  935: incorrectly by following it with a reserved character and expecting the
                    936: delimiter to render.  This is not supported.
                    937: .\" LIST-ITEM
                    938: .It
1.16      kristaps  939: .Sq \&.Cd
1.4       kristaps  940: is callable.
                    941: .El
                    942: .\" SECTION
1.2       kristaps  943: .Sh SEE ALSO
1.15      kristaps  944: .Xr mandoc 1
1.2       kristaps  945: .\" SECTION
                    946: .Sh AUTHORS
                    947: The
                    948: .Nm
                    949: utility was written by
1.6       kristaps  950: .An Kristaps Dzonsons Aq kristaps@openbsd.org .
1.5       kristaps  951: .\" SECTION
                    952: .Sh CAVEATS
                    953: There are several ambiguous parts of mdoc.
                    954: .Pp
                    955: .Bl -dash -compact
                    956: .\" LIST-ITEM
                    957: .It
1.16      kristaps  958: .Sq \&.Fa
1.5       kristaps  959: should be
1.16      kristaps  960: .Sq \&.Va
1.5       kristaps  961: as function arguments are variables.
                    962: .\" LIST-ITEM
                    963: .It
1.16      kristaps  964: .Sq \&.Ft
1.5       kristaps  965: should be
1.16      kristaps  966: .Sq \&.Vt
1.5       kristaps  967: as function return types are still types.  Furthermore, the
1.16      kristaps  968: .Sq \&.Ft
1.5       kristaps  969: should be removed and
1.16      kristaps  970: .Sq \&.Fo ,
1.5       kristaps  971: which ostensibly follows it, should follow the same convention as
1.16      kristaps  972: .Sq \&.Va .
1.5       kristaps  973: .\" LIST-ITEM
                    974: .It
1.16      kristaps  975: .Sq \&.Va
1.5       kristaps  976: should formalise that only one or two arguments are acceptable: a
                    977: variable name and optional, preceeding type.
                    978: .\" LIST-ITEM
                    979: .It
1.16      kristaps  980: .Sq \&.Fd
1.5       kristaps  981: is ambiguous.  It's commonly used to indicate an include file in the
                    982: synopsis section.
1.16      kristaps  983: .Sq \&.In
1.5       kristaps  984: should be used, instead.
                    985: .\" LIST-ITEM
                    986: .It
                    987: Only the
                    988: .Sq \-literal
                    989: argument to
1.16      kristaps  990: .Sq \&.Bd
1.5       kristaps  991: makes sense.  The remaining ones should be removed.
                    992: .\" LIST-ITEM
                    993: .It
                    994: The
1.16      kristaps  995: .Sq \&.Xo
1.5       kristaps  996: and
1.16      kristaps  997: .Sq \&.Xc
1.5       kristaps  998: macros should be deprecated.
                    999: .\" LIST-ITEM
                   1000: .It
                   1001: The
1.16      kristaps 1002: .Sq \&.Dt
1.5       kristaps 1003: macro lacks clarity.  It should be absolutely clear which title will
                   1004: render when formatting the manual page.
1.6       kristaps 1005: .\" LIST-ITEM
                   1006: .It
                   1007: A
1.16      kristaps 1008: .Sq \&.Lx
1.6       kristaps 1009: should be provided for Linux (\(`a la
1.16      kristaps 1010: .Sq \&.Ox ,
                   1011: .Sq \&.Nx
1.6       kristaps 1012: etc.).
1.14      kristaps 1013: .\" LIST-ITEM
                   1014: .It
                   1015: There's no way to refer to references in
1.16      kristaps 1016: .Sq \&.Rs/.Re
1.14      kristaps 1017: blocks.
1.5       kristaps 1018: .El

CVSweb