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

Annotation of mandoc/mdoc.7, Revision 1.193

1.193   ! schwarze    1: .\"    $Id: mdoc.7,v 1.192 2011/07/31 17:30:33 schwarze Exp $
1.1       kristaps    2: .\"
1.179     schwarze    3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.130     schwarze    4: .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5: .\"
                      6: .\" Permission to use, copy, modify, and distribute this software for any
1.22      kristaps    7: .\" purpose with or without fee is hereby granted, provided that the above
                      8: .\" copyright notice and this permission notice appear in all copies.
1.1       kristaps    9: .\"
1.22      kristaps   10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.50      kristaps   17: .\"
1.193   ! schwarze   18: .Dd $Mdocdate: July 31 2011 $
1.20      kristaps   19: .Dt MDOC 7
1.1       kristaps   20: .Os
                     21: .Sh NAME
1.57      kristaps   22: .Nm mdoc
                     23: .Nd mdoc language reference
1.1       kristaps   24: .Sh DESCRIPTION
                     25: The
1.57      kristaps   26: .Nm mdoc
1.50      kristaps   27: language is used to format
1.57      kristaps   28: .Bx
                     29: .Ux
1.138     kristaps   30: manuals.
1.144     schwarze   31: This reference document describes its syntax, structure, and
1.138     kristaps   32: usage.
1.144     schwarze   33: The reference implementation is
                     34: .Xr mandoc 1 ;
                     35: the
1.57      kristaps   36: .Sx COMPATIBILITY
1.93      kristaps   37: section describes compatibility with other troff \-mdoc implementations.
1.57      kristaps   38: .Pp
1.13      kristaps   39: An
1.57      kristaps   40: .Nm
1.118     kristaps   41: document follows simple rules: lines beginning with the control
1.50      kristaps   42: character
1.185     kristaps   43: .Sq \&.
1.138     kristaps   44: are parsed for macros.
1.185     kristaps   45: Text lines, those not beginning with the control character, are
                     46: interpreted within the scope of prior macros:
1.57      kristaps   47: .Bd -literal -offset indent
1.13      kristaps   48: \&.Sh Macro lines change control state.
1.185     kristaps   49: Text lines are interpreted within the current state.
1.57      kristaps   50: .Ed
1.46      kristaps   51: .Sh LANGUAGE SYNTAX
1.57      kristaps   52: .Nm
1.13      kristaps   53: documents may contain only graphable 7-bit ASCII characters, the space
1.138     kristaps   54: character, and, in certain circumstances, the tab character.
1.175     kristaps   55: .Pp
1.185     kristaps   56: If the first character of a text line is a space, that line is printed
1.175     kristaps   57: with a leading newline.
1.57      kristaps   58: .Ss Comments
1.43      kristaps   59: Text following a
1.135     kristaps   60: .Sq \e\*q ,
1.185     kristaps   61: whether in a macro or text line, is ignored to the end of
1.138     kristaps   62: line.
                     63: A macro line with only a control character and comment escape,
1.135     kristaps   64: .Sq \&.\e\*q ,
1.138     kristaps   65: is also ignored.
1.144     schwarze   66: Macro lines with only a control character and optional whitespace are
1.138     kristaps   67: stripped from input.
1.182     kristaps   68: .Ss Reserved Terms
                     69: Within a macro line, the following terms are reserved:
1.61      kristaps   70: .Pp
1.57      kristaps   71: .Bl -tag -width Ds -offset indent -compact
                     72: .It \&.
                     73: .Pq period
1.182     kristaps   74: .It \e.
                     75: .Pq escaped period
1.57      kristaps   76: .It \&,
                     77: .Pq comma
                     78: .It \&:
                     79: .Pq colon
                     80: .It \&;
                     81: .Pq semicolon
                     82: .It \&(
                     83: .Pq left-parenthesis
                     84: .It \&)
                     85: .Pq right-parenthesis
                     86: .It \&[
                     87: .Pq left-bracket
                     88: .It \&]
                     89: .Pq right-bracket
                     90: .It \&?
                     91: .Pq question
                     92: .It \&!
                     93: .Pq exclamation
                     94: .It \&|
                     95: .Pq vertical bar
1.182     kristaps   96: .It \e*(Ba
                     97: .Pq reserved-word vertical bar
1.57      kristaps   98: .El
                     99: .Pp
1.182     kristaps  100: For general use in macro lines, these can be escaped with a non-breaking
                    101: space
                    102: .Pq Sq \e& .
1.185     kristaps  103: In text lines, these may be used as normal punctuation.
1.57      kristaps  104: .Ss Special Characters
1.185     kristaps  105: Special characters may occur in both macro and text lines.
1.43      kristaps  106: Sequences begin with the escape character
1.57      kristaps  107: .Sq \e
1.50      kristaps  108: followed by either an open-parenthesis
1.57      kristaps  109: .Sq \&(
1.1       kristaps  110: for two-character sequences; an open-bracket
1.57      kristaps  111: .Sq \&[
1.1       kristaps  112: for n-character sequences (terminated at a close-bracket
1.57      kristaps  113: .Sq \&] ) ;
1.144     schwarze  114: or a single one character sequence.
1.100     kristaps  115: See
1.57      kristaps  116: .Xr mandoc_char 7
1.100     kristaps  117: for a complete list.
                    118: Examples include
1.57      kristaps  119: .Sq \e(em
                    120: .Pq em-dash
1.50      kristaps  121: and
1.57      kristaps  122: .Sq \ee
                    123: .Pq back-slash .
                    124: .Ss Text Decoration
1.54      kristaps  125: Terms may be text-decorated using the
1.57      kristaps  126: .Sq \ef
1.144     schwarze  127: escape followed by an indicator: B (bold), I (italic), R (Roman), or P
1.82      kristaps  128: (revert to previous mode):
1.75      kristaps  129: .Pp
1.173     kristaps  130: .Dl \efBbold\efR \efIitalic\efP
1.76      kristaps  131: .Pp
                    132: A numerical representation 3, 2, or 1 (bold, italic, and Roman,
1.100     kristaps  133: respectively) may be used instead.
1.185     kristaps  134: If a macro opens a font scope after calling
                    135: .Sq \ef ,
                    136: such as with
                    137: .Sx \&Bf ,
                    138: the
                    139: .Sq \ef
                    140: mode will be restored upon exiting the
1.78      kristaps  141: .Sx \&Bf
1.185     kristaps  142: scope.
1.76      kristaps  143: .Pp
1.136     kristaps  144: Note this form is
1.76      kristaps  145: .Em not
1.82      kristaps  146: recommended for
1.57      kristaps  147: .Nm ,
1.74      kristaps  148: which encourages semantic annotation.
1.57      kristaps  149: .Ss Predefined Strings
1.82      kristaps  150: Historically,
1.145     kristaps  151: troff
1.82      kristaps  152: also defined a set of package-specific
1.57      kristaps  153: .Dq predefined strings ,
1.82      kristaps  154: which, like
1.57      kristaps  155: .Sx Special Characters ,
1.124     kristaps  156: mark special output characters and strings by way of input codes.
1.54      kristaps  157: Predefined strings are escaped with the slash-asterisk,
1.57      kristaps  158: .Sq \e* :
1.54      kristaps  159: single-character
1.57      kristaps  160: .Sq \e*X ,
1.54      kristaps  161: two-character
1.57      kristaps  162: .Sq \e*(XX ,
1.54      kristaps  163: and N-character
1.57      kristaps  164: .Sq \e*[N] .
1.54      kristaps  165: See
1.57      kristaps  166: .Xr mandoc_char 7
1.100     kristaps  167: for a complete list.
                    168: Examples include
1.57      kristaps  169: .Sq \e*(Am
                    170: .Pq ampersand
1.54      kristaps  171: and
1.57      kristaps  172: .Sq \e*(Ba
                    173: .Pq vertical bar .
                    174: .Ss Whitespace
1.98      kristaps  175: Whitespace consists of the space character.
1.185     kristaps  176: In text lines, whitespace is preserved within a line; unescaped
1.96      kristaps  177: trailing spaces are stripped from input (unless in a literal context).
1.185     kristaps  178: Blank text lines, which may include whitespace, are only permitted
1.96      kristaps  179: within literal contexts.
1.57      kristaps  180: .Pp
1.100     kristaps  181: In macro lines, whitespace delimits arguments and is discarded.
                    182: If arguments are quoted, whitespace within the quotes is retained.
1.57      kristaps  183: .Ss Quotation
1.141     kristaps  184: Macro arguments may be quoted with double-quotes to group
1.100     kristaps  185: space-delimited terms or to retain blocks of whitespace.
                    186: A quoted argument begins with a double-quote preceded by whitespace.
1.144     schwarze  187: The next double-quote not pairwise adjacent to another double-quote
1.100     kristaps  188: terminates the literal, regardless of surrounding whitespace.
1.57      kristaps  189: .Pp
1.141     kristaps  190: Note that any quoted text, even if it would cause a macro invocation
                    191: when unquoted, is considered literal text.
1.100     kristaps  192: Thus, the following produces
1.141     kristaps  193: .Sq Op "Fl a" :
1.57      kristaps  194: .Bd -literal -offset indent
1.141     kristaps  195: \&.Op "Fl a"
1.57      kristaps  196: .Ed
                    197: .Pp
1.185     kristaps  198: In text lines, quotes are regarded as opaque text.
1.61      kristaps  199: .Ss Scaling Widths
                    200: Many macros support scaled widths for their arguments, such as
                    201: stipulating a two-inch list indentation with the following:
                    202: .Bd -literal -offset indent
                    203: \&.Bl -tag -width 2i
                    204: .Ed
                    205: .Pp
                    206: The syntax for scaled widths is
1.62      kristaps  207: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
1.61      kristaps  208: where a decimal must be preceded or proceeded by at least one digit.
1.100     kristaps  209: Negative numbers, while accepted, are truncated to zero.
                    210: The following scaling units are accepted:
1.61      kristaps  211: .Pp
                    212: .Bl -tag -width Ds -offset indent -compact
                    213: .It c
                    214: centimetre
                    215: .It i
                    216: inch
                    217: .It P
                    218: pica (~1/6 inch)
                    219: .It p
                    220: point (~1/72 inch)
                    221: .It f
                    222: synonym for
                    223: .Sq u
                    224: .It v
                    225: default vertical span
                    226: .It m
                    227: width of rendered
                    228: .Sq m
                    229: .Pq em
                    230: character
                    231: .It n
                    232: width of rendered
                    233: .Sq n
                    234: .Pq en
                    235: character
                    236: .It u
                    237: default horizontal span
                    238: .It M
                    239: mini-em (~1/100 em)
                    240: .El
                    241: .Pp
                    242: Using anything other than
                    243: .Sq m ,
                    244: .Sq n ,
                    245: .Sq u ,
                    246: or
                    247: .Sq v
1.100     kristaps  248: is necessarily non-portable across output media.
                    249: See
1.61      kristaps  250: .Sx COMPATIBILITY .
1.101     kristaps  251: .Ss Sentence Spacing
1.144     schwarze  252: When composing a manual, make sure that sentences end at the end of
1.101     kristaps  253: a line.
                    254: By doing so, front-ends will be able to apply the proper amount of
                    255: spacing after the end of sentence (unescaped) period, exclamation mark,
1.107     kristaps  256: or question mark followed by zero or more non-sentence closing
1.179     schwarze  257: delimiters
                    258: .Po
                    259: .Sq \&) ,
1.107     kristaps  260: .Sq \&] ,
                    261: .Sq \&' ,
1.179     schwarze  262: .Sq \&"
                    263: .Pc .
1.102     kristaps  264: .Pp
                    265: The proper spacing is also intelligently preserved if a sentence ends at
1.144     schwarze  266: the boundary of a macro line.
                    267: For example:
1.107     kristaps  268: .Pp
1.185     kristaps  269: .Dl \&.Xr mandoc 1 \&.
                    270: .Dl \&.Fl T \&Ns \&Cm ascii \&.
1.43      kristaps  271: .Sh MANUAL STRUCTURE
1.66      kristaps  272: A well-formed
1.57      kristaps  273: .Nm
1.66      kristaps  274: document consists of a document prologue followed by one or more
                    275: sections.
                    276: .Pp
1.141     kristaps  277: The prologue, which consists of the
1.64      kristaps  278: .Sx \&Dd ,
                    279: .Sx \&Dt ,
1.33      kristaps  280: and
1.66      kristaps  281: .Sx \&Os
1.141     kristaps  282: macros in that order, is required for every document.
1.66      kristaps  283: .Pp
1.82      kristaps  284: The first section (sections are denoted by
1.66      kristaps  285: .Sx \&Sh )
                    286: must be the NAME section, consisting of at least one
1.64      kristaps  287: .Sx \&Nm
1.50      kristaps  288: followed by
1.66      kristaps  289: .Sx \&Nd .
                    290: .Pp
1.122     kristaps  291: Following that, convention dictates specifying at least the
                    292: .Em SYNOPSIS
                    293: and
                    294: .Em DESCRIPTION
                    295: sections, although this varies between manual sections.
1.66      kristaps  296: .Pp
                    297: The following is a well-formed skeleton
                    298: .Nm
1.188     kristaps  299: file for a utility
                    300: .Qq progname :
1.57      kristaps  301: .Bd -literal -offset indent
1.43      kristaps  302: \&.Dd $\&Mdocdate$
1.188     kristaps  303: \&.Dt PROGNAME section
1.43      kristaps  304: \&.Os
                    305: \&.Sh NAME
1.188     kristaps  306: \&.Nm progname
1.58      kristaps  307: \&.Nd a description goes here
                    308: \&.\e\*q .Sh LIBRARY
1.156     kristaps  309: \&.\e\*q For sections 2, 3, & 9 only.
                    310: \&.\e\*q Not used in OpenBSD.
1.58      kristaps  311: \&.Sh SYNOPSIS
1.188     kristaps  312: \&.Nm progname
1.58      kristaps  313: \&.Op Fl options
                    314: \&.Ar
                    315: \&.Sh DESCRIPTION
                    316: The
                    317: \&.Nm
                    318: utility processes files ...
1.59      kristaps  319: \&.\e\*q .Sh IMPLEMENTATION NOTES
1.159     schwarze  320: \&.\e\*q Not used in OpenBSD.
1.58      kristaps  321: \&.\e\*q .Sh RETURN VALUES
1.156     kristaps  322: \&.\e\*q For sections 2, 3, & 9 only.
1.58      kristaps  323: \&.\e\*q .Sh ENVIRONMENT
1.156     kristaps  324: \&.\e\*q For sections 1, 6, 7, & 8 only.
1.58      kristaps  325: \&.\e\*q .Sh FILES
1.99      kristaps  326: \&.\e\*q .Sh EXIT STATUS
1.159     schwarze  327: \&.\e\*q For sections 1, 6, & 8 only.
1.58      kristaps  328: \&.\e\*q .Sh EXAMPLES
                    329: \&.\e\*q .Sh DIAGNOSTICS
1.156     kristaps  330: \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
1.58      kristaps  331: \&.\e\*q .Sh ERRORS
1.156     kristaps  332: \&.\e\*q For sections 2, 3, & 9 only.
1.58      kristaps  333: \&.\e\*q .Sh SEE ALSO
                    334: \&.\e\*q .Xr foobar 1
                    335: \&.\e\*q .Sh STANDARDS
                    336: \&.\e\*q .Sh HISTORY
                    337: \&.\e\*q .Sh AUTHORS
                    338: \&.\e\*q .Sh CAVEATS
                    339: \&.\e\*q .Sh BUGS
                    340: \&.\e\*q .Sh SECURITY CONSIDERATIONS
1.156     kristaps  341: \&.\e\*q Not used in OpenBSD.
1.57      kristaps  342: .Ed
                    343: .Pp
1.144     schwarze  344: The sections in an
1.66      kristaps  345: .Nm
1.100     kristaps  346: document are conventionally ordered as they appear above.
                    347: Sections should be composed as follows:
1.73      kristaps  348: .Bl -ohang -offset Ds
                    349: .It Em NAME
1.144     schwarze  350: The name(s) and a one line description of the documented material.
1.100     kristaps  351: The syntax for this as follows:
1.73      kristaps  352: .Bd -literal -offset indent
1.144     schwarze  353: \&.Nm name0 ,
                    354: \&.Nm name1 ,
1.73      kristaps  355: \&.Nm name2
1.144     schwarze  356: \&.Nd a one line description
1.73      kristaps  357: .Ed
                    358: .Pp
1.185     kristaps  359: Multiple
                    360: .Sq \&Nm
                    361: names should be separated by commas.
                    362: .Pp
1.73      kristaps  363: The
1.66      kristaps  364: .Sx \&Nm
1.73      kristaps  365: macro(s) must precede the
                    366: .Sx \&Nd
                    367: macro.
1.80      kristaps  368: .Pp
1.82      kristaps  369: See
1.80      kristaps  370: .Sx \&Nm
                    371: and
                    372: .Sx \&Nd .
1.73      kristaps  373: .It Em LIBRARY
                    374: The name of the library containing the documented material, which is
1.108     kristaps  375: assumed to be a function in a section 2, 3, or 9 manual.
1.100     kristaps  376: The syntax for this is as follows:
1.73      kristaps  377: .Bd -literal -offset indent
                    378: \&.Lb libarm
                    379: .Ed
                    380: .Pp
                    381: See
1.80      kristaps  382: .Sx \&Lb .
1.73      kristaps  383: .It Em SYNOPSIS
                    384: Documents the utility invocation syntax, function call syntax, or device
1.82      kristaps  385: configuration.
1.73      kristaps  386: .Pp
                    387: For the first, utilities (sections 1, 6, and 8), this is
                    388: generally structured as follows:
                    389: .Bd -literal -offset indent
1.185     kristaps  390: \&.Nm bar
1.73      kristaps  391: \&.Op Fl v
                    392: \&.Op Fl o Ar file
                    393: \&.Op Ar
1.185     kristaps  394: \&.Nm foo
1.73      kristaps  395: \&.Op Fl v
                    396: \&.Op Fl o Ar file
                    397: \&.Op Ar
                    398: .Ed
                    399: .Pp
1.185     kristaps  400: Commands should be ordered alphabetically.
                    401: .Pp
1.73      kristaps  402: For the second, function calls (sections 2, 3, 9):
                    403: .Bd -literal -offset indent
1.146     kristaps  404: \&.In header.h
1.73      kristaps  405: \&.Vt extern const char *global;
                    406: \&.Ft "char *"
                    407: \&.Fn foo "const char *src"
                    408: \&.Ft "char *"
                    409: \&.Fn bar "const char *src"
                    410: .Ed
                    411: .Pp
1.185     kristaps  412: Ordering of
                    413: .Sx \&In ,
                    414: .Sx \&Vt ,
                    415: .Sx \&Fn ,
                    416: and
                    417: .Sx \&Fo
                    418: macros should follow C header-file conventions.
                    419: .Pp
1.73      kristaps  420: And for the third, configurations (section 4):
                    421: .Bd -literal -offset indent
                    422: \&.Cd \*qit* at isa? port 0x2e\*q
                    423: \&.Cd \*qit* at isa? port 0x4e\*q
                    424: .Ed
                    425: .Pp
1.82      kristaps  426: Manuals not in these sections generally don't need a
1.73      kristaps  427: .Em SYNOPSIS .
1.80      kristaps  428: .Pp
1.122     kristaps  429: Some macros are displayed differently in the
                    430: .Em SYNOPSIS
                    431: section, particularly
                    432: .Sx \&Nm ,
1.80      kristaps  433: .Sx \&Cd ,
1.122     kristaps  434: .Sx \&Fd ,
                    435: .Sx \&Fn ,
                    436: .Sx \&Fo ,
                    437: .Sx \&In ,
                    438: .Sx \&Vt ,
                    439: and
                    440: .Sx \&Ft .
1.138     kristaps  441: All of these macros are output on their own line.
1.144     schwarze  442: If two such dissimilar macros are pairwise invoked (except for
1.122     kristaps  443: .Sx \&Ft
                    444: before
                    445: .Sx \&Fo
                    446: or
1.123     kristaps  447: .Sx \&Fn ) ,
1.122     kristaps  448: they are separated by a vertical space, unless in the case of
                    449: .Sx \&Fo ,
1.80      kristaps  450: .Sx \&Fn ,
1.122     kristaps  451: and
1.80      kristaps  452: .Sx \&Ft ,
1.122     kristaps  453: which are always separated by vertical space.
1.128     schwarze  454: .Pp
                    455: When text and macros following an
                    456: .Sx \&Nm
                    457: macro starting an input line span multiple output lines,
                    458: all output lines but the first will be indented to align
                    459: with the text immediately following the
                    460: .Sx \&Nm
                    461: macro, up to the next
                    462: .Sx \&Nm ,
1.141     kristaps  463: .Sx \&Sh ,
1.128     schwarze  464: or
                    465: .Sx \&Ss
                    466: macro or the end of an enclosing block, whichever comes first.
1.73      kristaps  467: .It Em DESCRIPTION
1.185     kristaps  468: This begins with an expansion of the brief, one line description in
                    469: .Em NAME :
                    470: .Bd -literal -offset indent
                    471: The
                    472: \&.Nm
                    473: utility does this, that, and the other.
                    474: .Ed
                    475: .Pp
                    476: It usually follows with a breakdown of the options (if documenting a
1.73      kristaps  477: command), such as:
                    478: .Bd -literal -offset indent
                    479: The arguments are as follows:
                    480: \&.Bl \-tag \-width Ds
                    481: \&.It Fl v
                    482: Print verbose information.
                    483: \&.El
                    484: .Ed
1.80      kristaps  485: .Pp
1.73      kristaps  486: Manuals not documenting a command won't include the above fragment.
                    487: .It Em IMPLEMENTATION NOTES
1.100     kristaps  488: Implementation-specific notes should be kept here.
                    489: This is useful when implementing standard functions that may have side
                    490: effects or notable algorithmic implications.
1.73      kristaps  491: .It Em RETURN VALUES
1.144     schwarze  492: This section documents the
                    493: return values of functions in sections 2, 3, and 9.
1.73      kristaps  494: .Pp
                    495: See
                    496: .Sx \&Rv .
                    497: .It Em ENVIRONMENT
1.141     kristaps  498: Lists the environment variables used by the utility,
                    499: and explains the syntax and semantics of their values.
                    500: The
                    501: .Xr environ 7
                    502: manual provides examples of typical content and formatting.
1.73      kristaps  503: .Pp
                    504: See
                    505: .Sx \&Ev .
                    506: .It Em FILES
1.100     kristaps  507: Documents files used.
1.141     kristaps  508: It's helpful to document both the file name and a short description of how
1.100     kristaps  509: the file is used (created, modified, etc.).
1.73      kristaps  510: .Pp
                    511: See
                    512: .Sx \&Pa .
1.99      kristaps  513: .It Em EXIT STATUS
1.144     schwarze  514: This section documents the
                    515: command exit status for section 1, 6, and 8 utilities.
1.100     kristaps  516: Historically, this information was described in
1.99      kristaps  517: .Em DIAGNOSTICS ,
                    518: a practise that is now discouraged.
                    519: .Pp
                    520: See
                    521: .Sx \&Ex .
1.73      kristaps  522: .It Em EXAMPLES
1.100     kristaps  523: Example usages.
                    524: This often contains snippets of well-formed, well-tested invocations.
1.144     schwarze  525: Make sure that examples work properly!
1.73      kristaps  526: .It Em DIAGNOSTICS
1.100     kristaps  527: Documents error conditions.
                    528: This is most useful in section 4 manuals.
1.73      kristaps  529: Historically, this section was used in place of
                    530: .Em EXIT STATUS
                    531: for manuals in sections 1, 6, and 8; however, this practise is
                    532: discouraged.
                    533: .Pp
                    534: See
1.80      kristaps  535: .Sx \&Bl
                    536: .Fl diag .
1.73      kristaps  537: .It Em ERRORS
                    538: Documents error handling in sections 2, 3, and 9.
                    539: .Pp
                    540: See
                    541: .Sx \&Er .
                    542: .It Em SEE ALSO
1.100     kristaps  543: References other manuals with related topics.
                    544: This section should exist for most manuals.
                    545: Cross-references should conventionally be ordered first by section, then
                    546: alphabetically.
1.73      kristaps  547: .Pp
                    548: See
                    549: .Sx \&Xr .
                    550: .It Em STANDARDS
1.100     kristaps  551: References any standards implemented or used.
                    552: If not adhering to any standards, the
1.73      kristaps  553: .Em HISTORY
                    554: section should be used instead.
                    555: .Pp
                    556: See
                    557: .Sx \&St .
                    558: .It Em HISTORY
1.143     schwarze  559: A brief history of the subject, including where support first appeared.
1.73      kristaps  560: .It Em AUTHORS
1.143     schwarze  561: Credits to the person or persons who wrote the code and/or documentation.
1.141     kristaps  562: Authors should generally be noted by both name and email address.
1.73      kristaps  563: .Pp
                    564: See
                    565: .Sx \&An .
                    566: .It Em CAVEATS
1.141     kristaps  567: Common misuses and misunderstandings should be explained
1.73      kristaps  568: in this section.
                    569: .It Em BUGS
1.147     kristaps  570: Known bugs, limitations, and work-arounds should be described
1.141     kristaps  571: in this section.
1.73      kristaps  572: .It Em SECURITY CONSIDERATIONS
                    573: Documents any security precautions that operators should consider.
1.66      kristaps  574: .El
1.43      kristaps  575: .Sh MACRO SYNTAX
1.56      kristaps  576: Macros are one to three three characters in length and begin with a
1.141     kristaps  577: control character,
1.57      kristaps  578: .Sq \&. ,
1.100     kristaps  579: at the beginning of the line.
                    580: An arbitrary amount of whitespace may sit between the control character
                    581: and the macro name.
                    582: Thus, the following are equivalent:
1.64      kristaps  583: .Bd -literal -offset indent
                    584: \&.Pp
                    585: \&.\ \ \ \&Pp
                    586: .Ed
1.57      kristaps  587: .Pp
1.100     kristaps  588: The syntax of a macro depends on its classification.
                    589: In this section,
1.57      kristaps  590: .Sq \-arg
1.43      kristaps  591: refers to macro arguments, which may be followed by zero or more
1.57      kristaps  592: .Sq parm
1.43      kristaps  593: parameters;
1.57      kristaps  594: .Sq \&Yo
1.43      kristaps  595: opens the scope of a macro; and if specified,
1.57      kristaps  596: .Sq \&Yc
1.43      kristaps  597: closes it out.
1.57      kristaps  598: .Pp
1.43      kristaps  599: The
1.57      kristaps  600: .Em Callable
1.166     schwarze  601: column indicates that the macro may also be called by passing its name
                    602: as an argument to another macro.
                    603: If a macro is not callable but its name appears as an argument
                    604: to another macro, it is interpreted as opaque text.
                    605: For example,
1.60      kristaps  606: .Sq \&.Fl \&Sh
1.55      kristaps  607: produces
1.60      kristaps  608: .Sq Fl \&Sh .
1.57      kristaps  609: .Pp
1.55      kristaps  610: The
1.141     kristaps  611: .Em Parsed
1.166     schwarze  612: column indicates whether the macro may call other macros by receiving
                    613: their names as arguments.
                    614: If a macro is not parsed but the name of another macro appears
                    615: as an argument, it is interpreted as opaque text.
1.57      kristaps  616: .Pp
1.55      kristaps  617: The
1.57      kristaps  618: .Em Scope
1.43      kristaps  619: column, if applicable, describes closure rules.
1.57      kristaps  620: .Ss Block full-explicit
1.100     kristaps  621: Multi-line scope closed by an explicit closing macro.
                    622: All macros contains bodies; only
1.64      kristaps  623: .Sx \&Bf
1.185     kristaps  624: and
                    625: .Pq optionally
                    626: .Sx \&Bl
                    627: contain a head.
1.57      kristaps  628: .Bd -literal -offset indent
1.50      kristaps  629: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
                    630: \(lBbody...\(rB
1.43      kristaps  631: \&.Yc
1.57      kristaps  632: .Ed
                    633: .Pp
1.141     kristaps  634: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"
                    635: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64      kristaps  636: .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
                    637: .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
                    638: .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
                    639: .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El
                    640: .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd
                    641: .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf
                    642: .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
                    643: .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
1.57      kristaps  644: .El
                    645: .Ss Block full-implicit
1.43      kristaps  646: Multi-line scope closed by end-of-file or implicitly by another macro.
1.50      kristaps  647: All macros have bodies; some
1.57      kristaps  648: .Po
1.64      kristaps  649: .Sx \&It Fl bullet ,
                    650: .Fl hyphen ,
                    651: .Fl dash ,
                    652: .Fl enum ,
                    653: .Fl item
1.57      kristaps  654: .Pc
1.64      kristaps  655: don't have heads; only one
                    656: .Po
1.141     kristaps  657: .Sx \&It
                    658: in
                    659: .Sx \&Bl Fl column
1.82      kristaps  660: .Pc
1.64      kristaps  661: has multiple heads.
1.57      kristaps  662: .Bd -literal -offset indent
1.50      kristaps  663: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
                    664: \(lBbody...\(rB
1.57      kristaps  665: .Ed
                    666: .Pp
1.141     kristaps  667: .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
                    668: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64      kristaps  669: .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
                    670: .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
1.128     schwarze  671: .It Sx \&Nm  Ta    \&No     Ta  Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
1.64      kristaps  672: .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
                    673: .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
1.57      kristaps  674: .El
1.128     schwarze  675: .Pp
                    676: Note that the
                    677: .Sx \&Nm
                    678: macro is a
                    679: .Sx Block full-implicit
                    680: macro only when invoked as the first macro
                    681: in a
                    682: .Em SYNOPSIS
                    683: section line, else it is
                    684: .Sx In-line .
1.57      kristaps  685: .Ss Block partial-explicit
1.100     kristaps  686: Like block full-explicit, but also with single-line scope.
                    687: Each has at least a body and, in limited circumstances, a head
1.64      kristaps  688: .Po
                    689: .Sx \&Fo ,
                    690: .Sx \&Eo
                    691: .Pc
1.50      kristaps  692: and/or tail
1.64      kristaps  693: .Pq Sx \&Ec .
1.57      kristaps  694: .Bd -literal -offset indent
1.50      kristaps  695: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
                    696: \(lBbody...\(rB
                    697: \&.Yc \(lBtail...\(rB
1.2       kristaps  698:
1.43      kristaps  699: \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
1.50      kristaps  700: \(lBbody...\(rB \&Yc \(lBtail...\(rB
1.57      kristaps  701: .Ed
                    702: .Pp
1.141     kristaps  703: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
                    704: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
1.64      kristaps  705: .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
1.63      kristaps  706: .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
1.64      kristaps  707: .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
                    708: .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc
                    709: .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro
                    710: .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc
                    711: .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do
                    712: .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc
                    713: .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo
                    714: .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec
                    715: .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo
                    716: .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc
                    717: .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo
                    718: .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc
                    719: .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po
                    720: .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc
                    721: .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo
                    722: .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc
1.63      kristaps  723: .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs
                    724: .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re
1.64      kristaps  725: .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So
                    726: .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc
                    727: .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo
                    728: .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc
1.57      kristaps  729: .El
                    730: .Ss Block partial-implicit
1.50      kristaps  731: Like block full-implicit, but with single-line scope closed by
1.182     kristaps  732: .Sx Reserved Terms
1.43      kristaps  733: or end of line.
1.57      kristaps  734: .Bd -literal -offset indent
1.43      kristaps  735: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
1.57      kristaps  736: .Ed
                    737: .Pp
1.141     kristaps  738: .Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent
                    739: .It Em Macro Ta Em Callable Ta Em Parsed
1.64      kristaps  740: .It Sx \&Aq  Ta    Yes      Ta    Yes
                    741: .It Sx \&Bq  Ta    Yes      Ta    Yes
                    742: .It Sx \&Brq Ta    Yes      Ta    Yes
                    743: .It Sx \&D1  Ta    \&No     Ta    \&Yes
                    744: .It Sx \&Dl  Ta    \&No     Ta    Yes
                    745: .It Sx \&Dq  Ta    Yes      Ta    Yes
                    746: .It Sx \&Op  Ta    Yes      Ta    Yes
                    747: .It Sx \&Pq  Ta    Yes      Ta    Yes
                    748: .It Sx \&Ql  Ta    Yes      Ta    Yes
                    749: .It Sx \&Qq  Ta    Yes      Ta    Yes
                    750: .It Sx \&Sq  Ta    Yes      Ta    Yes
1.83      kristaps  751: .It Sx \&Vt  Ta    Yes      Ta    Yes
1.57      kristaps  752: .El
1.83      kristaps  753: .Pp
                    754: Note that the
                    755: .Sx \&Vt
                    756: macro is a
                    757: .Sx Block partial-implicit
                    758: only when invoked as the first macro
1.109     kristaps  759: in a
                    760: .Em SYNOPSIS
                    761: section line, else it is
1.83      kristaps  762: .Sx In-line .
1.190     schwarze  763: .Ss Special block macro
                    764: The
                    765: .Sx \&Ta
                    766: macro can only be used below
                    767: .Sx \&It
                    768: in
                    769: .Sx \&Bl Fl column
                    770: lists.
                    771: It delimits blocks representing table cells;
                    772: these blocks have bodies, but no heads.
                    773: .Pp
                    774: .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
                    775: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
                    776: .It Sx \&Ta  Ta    Yes      Ta    Yes    Ta closed by Sx \&Ta , Sx \&It
                    777: .El
1.57      kristaps  778: .Ss In-line
1.50      kristaps  779: Closed by
1.182     kristaps  780: .Sx Reserved Terms ,
1.100     kristaps  781: end of line, fixed argument lengths, and/or subsequent macros.
                    782: In-line macros have only text children.
                    783: If a number (or inequality) of arguments is
1.57      kristaps  784: .Pq n ,
1.3       kristaps  785: then the macro accepts an arbitrary number of arguments.
1.57      kristaps  786: .Bd -literal -offset indent
1.144     schwarze  787: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
1.43      kristaps  788:
                    789: \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
                    790:
                    791: \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
1.57      kristaps  792: .Ed
                    793: .Pp
1.141     kristaps  794: .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
                    795: .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
1.63      kristaps  796: .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
                    797: .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
                    798: .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
                    799: .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0
                    800: .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0
                    801: .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0
                    802: .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
                    803: .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
                    804: .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
1.69      kristaps  805: .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0
1.63      kristaps  806: .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
                    807: .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
1.69      kristaps  808: .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0
1.63      kristaps  809: .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
1.176     schwarze  810: .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0
                    811: .It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  812: .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
                    813: .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
                    814: .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
                    815: .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n
                    816: .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
                    817: .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
                    818: .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
1.176     schwarze  819: .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  820: .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
1.142     kristaps  821: .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n
1.64      kristaps  822: .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
1.176     schwarze  823: .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  824: .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
                    825: .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0
                    826: .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0
                    827: .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0
                    828: .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0
1.176     schwarze  829: .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  830: .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n
1.176     schwarze  831: .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  832: .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0
                    833: .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n
                    834: .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0
                    835: .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n
1.176     schwarze  836: .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  837: .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n
                    838: .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n
                    839: .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0
1.184     kristaps  840: .It Sx \&In  Ta    \&No     Ta    \&No     Ta    1
1.64      kristaps  841: .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1
1.176     schwarze  842: .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    >0
                    843: .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  844: .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0
                    845: .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0
                    846: .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0
                    847: .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n
                    848: .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0
                    849: .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0
                    850: .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n
                    851: .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n
                    852: .It Sx \&Ot  Ta    \&No     Ta    \&No     Ta    n
                    853: .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n
                    854: .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n
1.88      kristaps  855: .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1
1.64      kristaps  856: .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
                    857: .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
                    858: .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1
                    859: .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1
                    860: .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0
                    861: .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0
                    862: .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0
                    863: .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0
                    864: .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
                    865: .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n
                    866: .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0
1.84      kristaps  867: .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0
1.64      kristaps  868: .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
                    869: .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
1.82      kristaps  870: .El
1.63      kristaps  871: .Sh REFERENCE
                    872: This section is a canonical reference of all macros, arranged
1.100     kristaps  873: alphabetically.
                    874: For the scoping of individual macros, see
1.63      kristaps  875: .Sx MACRO SYNTAX .
                    876: .Ss \&%A
                    877: Author name of an
                    878: .Sx \&Rs
1.138     kristaps  879: block.
                    880: Multiple authors should each be accorded their own
1.64      kristaps  881: .Sx \%%A
1.138     kristaps  882: line.
                    883: Author names should be ordered with full or abbreviated forename(s)
                    884: first, then full surname.
1.63      kristaps  885: .Ss \&%B
                    886: Book title of an
                    887: .Sx \&Rs
1.138     kristaps  888: block.
                    889: This macro may also be used in a non-bibliographic context when
1.63      kristaps  890: referring to book titles.
                    891: .Ss \&%C
                    892: Publication city or location of an
                    893: .Sx \&Rs
                    894: block.
                    895: .Ss \&%D
                    896: Publication date of an
                    897: .Sx \&Rs
1.138     kristaps  898: block.
1.181     schwarze  899: Recommended formats of arguments are
                    900: .Ar month day , year
                    901: or just
                    902: .Ar year .
1.63      kristaps  903: .Ss \&%I
                    904: Publisher or issuer name of an
                    905: .Sx \&Rs
                    906: block.
                    907: .Ss \&%J
                    908: Journal name of an
                    909: .Sx \&Rs
                    910: block.
                    911: .Ss \&%N
                    912: Issue number (usually for journals) of an
                    913: .Sx \&Rs
                    914: block.
                    915: .Ss \&%O
                    916: Optional information of an
                    917: .Sx \&Rs
                    918: block.
                    919: .Ss \&%P
                    920: Book or journal page number of an
                    921: .Sx \&Rs
                    922: block.
                    923: .Ss \&%Q
                    924: Institutional author (school, government, etc.) of an
                    925: .Sx \&Rs
1.138     kristaps  926: block.
                    927: Multiple institutional authors should each be accorded their own
1.64      kristaps  928: .Sx \&%Q
1.63      kristaps  929: line.
                    930: .Ss \&%R
                    931: Technical report name of an
                    932: .Sx \&Rs
                    933: block.
                    934: .Ss \&%T
                    935: Article title of an
                    936: .Sx \&Rs
1.138     kristaps  937: block.
                    938: This macro may also be used in a non-bibliographical context when
                    939: referring to article titles.
1.69      kristaps  940: .Ss \&%U
1.70      kristaps  941: URI of reference document.
1.63      kristaps  942: .Ss \&%V
                    943: Volume number of an
                    944: .Sx \&Rs
                    945: block.
                    946: .Ss \&Ac
1.141     kristaps  947: Close an
1.63      kristaps  948: .Sx \&Ao
1.138     kristaps  949: block.
                    950: Does not have any tail arguments.
1.63      kristaps  951: .Ss \&Ad
1.141     kristaps  952: Memory address.
                    953: Do not use this for postal addresses.
1.63      kristaps  954: .Pp
1.64      kristaps  955: Examples:
1.173     kristaps  956: .Dl \&.Ad [0,$]
                    957: .Dl \&.Ad 0x00000000
1.63      kristaps  958: .Ss \&An
1.100     kristaps  959: Author name.
1.141     kristaps  960: Requires either the name of an author or one of the following arguments:
1.140     kristaps  961: .Pp
                    962: .Bl -tag -width "-nosplitX" -offset indent -compact
1.64      kristaps  963: .It Fl split
1.141     kristaps  964: Start a new output line before each subsequent invocation of
                    965: .Sx \&An .
1.64      kristaps  966: .It Fl nosplit
                    967: The opposite of
                    968: .Fl split .
                    969: .El
                    970: .Pp
1.141     kristaps  971: The default is
                    972: .Fl nosplit .
                    973: The effect of selecting either of the
                    974: .Fl split
                    975: modes ends at the beginning of the
                    976: .Em AUTHORS
                    977: section.
1.140     kristaps  978: In the
                    979: .Em AUTHORS
1.141     kristaps  980: section, the default is
                    981: .Fl nosplit
                    982: for the first author listing and
1.64      kristaps  983: .Fl split
1.141     kristaps  984: for all other author listings.
1.64      kristaps  985: .Pp
                    986: Examples:
1.173     kristaps  987: .Dl \&.An -nosplit
                    988: .Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
1.63      kristaps  989: .Ss \&Ao
1.141     kristaps  990: Begin a block enclosed by angle brackets.
1.100     kristaps  991: Does not have any head arguments.
1.63      kristaps  992: .Pp
1.64      kristaps  993: Examples:
1.173     kristaps  994: .Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
1.63      kristaps  995: .Pp
1.64      kristaps  996: See also
                    997: .Sx \&Aq .
1.63      kristaps  998: .Ss \&Ap
1.138     kristaps  999: Inserts an apostrophe without any surrounding whitespace.
1.124     kristaps 1000: This is generally used as a grammatical device when referring to the verb
1.140     kristaps 1001: form of a function.
                   1002: .Pp
                   1003: Examples:
1.173     kristaps 1004: .Dl \&.Fn execve \&Ap d
1.63      kristaps 1005: .Ss \&Aq
1.141     kristaps 1006: Encloses its arguments in angle brackets.
1.64      kristaps 1007: .Pp
                   1008: Examples:
1.173     kristaps 1009: .Dl \&.Fl -key= \&Ns \&Aq \&Ar val
1.64      kristaps 1010: .Pp
                   1011: .Em Remarks :
                   1012: this macro is often abused for rendering URIs, which should instead use
                   1013: .Sx \&Lk
                   1014: or
                   1015: .Sx \&Mt ,
                   1016: or to note pre-processor
                   1017: .Dq Li #include
                   1018: statements, which should use
                   1019: .Sx \&In .
                   1020: .Pp
                   1021: See also
                   1022: .Sx \&Ao .
1.63      kristaps 1023: .Ss \&Ar
1.100     kristaps 1024: Command arguments.
                   1025: If an argument is not provided, the string
1.141     kristaps 1026: .Dq file ...\&
1.66      kristaps 1027: is used as a default.
1.64      kristaps 1028: .Pp
                   1029: Examples:
1.173     kristaps 1030: .Dl \&.Fl o \&Ns \&Ar file1
                   1031: .Dl \&.Ar
                   1032: .Dl \&.Ar arg1 , arg2 .
1.63      kristaps 1033: .Ss \&At
1.100     kristaps 1034: Formats an AT&T version.
1.141     kristaps 1035: Accepts one optional argument:
1.140     kristaps 1036: .Pp
                   1037: .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
1.64      kristaps 1038: .It Cm v[1-7] | 32v
                   1039: A version of
                   1040: .At .
1.192     schwarze 1041: .It Cm III
                   1042: .At III .
1.64      kristaps 1043: .It Cm V[.[1-4]]?
1.141     kristaps 1044: A version of
                   1045: .At V .
1.64      kristaps 1046: .El
                   1047: .Pp
1.141     kristaps 1048: Note that these arguments do not begin with a hyphen.
1.64      kristaps 1049: .Pp
                   1050: Examples:
1.173     kristaps 1051: .Dl \&.At
1.192     schwarze 1052: .Dl \&.At III
1.173     kristaps 1053: .Dl \&.At V.1
1.65      kristaps 1054: .Pp
                   1055: See also
1.66      kristaps 1056: .Sx \&Bsx ,
1.65      kristaps 1057: .Sx \&Bx ,
1.66      kristaps 1058: .Sx \&Dx ,
1.65      kristaps 1059: .Sx \&Fx ,
                   1060: .Sx \&Nx ,
                   1061: .Sx \&Ox ,
                   1062: and
                   1063: .Sx \&Ux .
1.63      kristaps 1064: .Ss \&Bc
1.141     kristaps 1065: Close a
1.64      kristaps 1066: .Sx \&Bo
1.138     kristaps 1067: block.
                   1068: Does not have any tail arguments.
1.63      kristaps 1069: .Ss \&Bd
1.141     kristaps 1070: Begin a display block.
1.131     kristaps 1071: Its syntax is as follows:
                   1072: .Bd -ragged -offset indent
                   1073: .Pf \. Sx \&Bd
1.141     kristaps 1074: .Fl Ns Ar type
1.131     kristaps 1075: .Op Fl offset Ar width
                   1076: .Op Fl compact
                   1077: .Ed
                   1078: .Pp
1.141     kristaps 1079: Display blocks are used to select a different indentation and
                   1080: justification than the one used by the surrounding text.
1.185     kristaps 1081: They may contain both macro lines and text lines.
1.141     kristaps 1082: By default, a display block is preceded by a vertical space.
1.64      kristaps 1083: .Pp
1.141     kristaps 1084: The
                   1085: .Ar type
                   1086: must be one of the following:
                   1087: .Bl -tag -width 13n -offset indent
                   1088: .It Fl centered
                   1089: Centre-justify each line.
                   1090: Using this display type is not recommended; many
                   1091: .Nm
                   1092: implementations render it poorly.
                   1093: .It Fl filled
                   1094: Left- and right-justify the block.
                   1095: .It Fl literal
                   1096: Do not justify the block at all.
1.169     kristaps 1097: Preserve white space as it appears in the input.
1.64      kristaps 1098: .It Fl ragged
                   1099: Only left-justify the block.
                   1100: .It Fl unfilled
1.141     kristaps 1101: An alias for
                   1102: .Fl literal .
1.64      kristaps 1103: .El
                   1104: .Pp
1.141     kristaps 1105: The
                   1106: .Ar type
                   1107: must be provided first.
                   1108: Additional arguments may follow:
                   1109: .Bl -tag -width 13n -offset indent
                   1110: .It Fl offset Ar width
                   1111: Indent the display by the
                   1112: .Ar width ,
                   1113: which may be one of the following:
1.64      kristaps 1114: .Bl -item
                   1115: .It
1.141     kristaps 1116: One of the pre-defined strings
                   1117: .Cm indent ,
1.64      kristaps 1118: the width of standard indentation;
1.141     kristaps 1119: .Cm indent-two ,
1.64      kristaps 1120: twice
1.141     kristaps 1121: .Cm indent ;
                   1122: .Cm left ,
1.131     kristaps 1123: which has no effect;
1.141     kristaps 1124: .Cm right ,
                   1125: which justifies to the right margin; or
                   1126: .Cm center ,
1.64      kristaps 1127: which aligns around an imagined centre axis.
                   1128: .It
1.141     kristaps 1129: A macro invocation, which selects a predefined width
                   1130: associated with that macro.
1.100     kristaps 1131: The most popular is the imaginary macro
1.67      kristaps 1132: .Ar \&Ds ,
1.64      kristaps 1133: which resolves to
1.141     kristaps 1134: .Sy 6n .
1.64      kristaps 1135: .It
1.141     kristaps 1136: A width using the syntax described in
1.64      kristaps 1137: .Sx Scaling Widths .
                   1138: .It
1.141     kristaps 1139: An arbitrary string, which indents by the length of this string.
1.64      kristaps 1140: .El
                   1141: .Pp
1.141     kristaps 1142: When the argument is missing,
                   1143: .Fl offset
                   1144: is ignored.
1.64      kristaps 1145: .It Fl compact
1.141     kristaps 1146: Do not assert vertical space before the display.
1.64      kristaps 1147: .El
                   1148: .Pp
                   1149: Examples:
                   1150: .Bd -literal -offset indent
1.141     kristaps 1151: \&.Bd \-literal \-offset indent \-compact
1.65      kristaps 1152:    Hello       world.
1.64      kristaps 1153: \&.Ed
                   1154: .Ed
1.66      kristaps 1155: .Pp
                   1156: See also
                   1157: .Sx \&D1
                   1158: and
                   1159: .Sx \&Dl .
1.63      kristaps 1160: .Ss \&Bf
1.129     kristaps 1161: Change the font mode for a scoped block of text.
                   1162: Its syntax is as follows:
                   1163: .Bd -ragged -offset indent
                   1164: .Pf \. Sx \&Bf
                   1165: .Oo
                   1166: .Fl emphasis | literal | symbolic |
                   1167: .Cm \&Em | \&Li | \&Sy
                   1168: .Oc
                   1169: .Ed
                   1170: .Pp
                   1171: The
                   1172: .Fl emphasis
                   1173: and
                   1174: .Cm \&Em
                   1175: argument are equivalent, as are
                   1176: .Fl symbolic
                   1177: and
1.144     schwarze 1178: .Cm \&Sy ,
1.129     kristaps 1179: and
                   1180: .Fl literal
                   1181: and
                   1182: .Cm \&Li .
                   1183: Without an argument, this macro does nothing.
                   1184: The font mode continues until broken by a new font mode in a nested
                   1185: scope or
                   1186: .Sx \&Ef
                   1187: is encountered.
                   1188: .Pp
                   1189: See also
                   1190: .Sx \&Li ,
                   1191: .Sx \&Ef ,
1.141     kristaps 1192: .Sx \&Em ,
1.129     kristaps 1193: and
                   1194: .Sx \&Sy .
1.63      kristaps 1195: .Ss \&Bk
1.186     schwarze 1196: For each macro, keep its output together on the same output line,
                   1197: until the end of the macro or the end of the input line is reached,
                   1198: whichever comes first.
1.185     kristaps 1199: Line breaks in text lines are unaffected.
1.141     kristaps 1200: The syntax is as follows:
1.131     kristaps 1201: .Pp
                   1202: .D1 Pf \. Sx \&Bk Fl words
                   1203: .Pp
1.133     kristaps 1204: The
                   1205: .Fl words
1.141     kristaps 1206: argument is required; additional arguments are ignored.
1.127     schwarze 1207: .Pp
1.141     kristaps 1208: The following example will not break within each
1.133     kristaps 1209: .Sx \&Op
                   1210: macro line:
1.127     schwarze 1211: .Bd -literal -offset indent
                   1212: \&.Bk \-words
1.133     kristaps 1213: \&.Op Fl f Ar flags
                   1214: \&.Op Fl o Ar output
1.127     schwarze 1215: \&.Ek
                   1216: .Ed
1.129     kristaps 1217: .Pp
1.133     kristaps 1218: Be careful in using over-long lines within a keep block!
                   1219: Doing so will clobber the right margin.
1.63      kristaps 1220: .Ss \&Bl
1.141     kristaps 1221: Begin a list.
1.171     schwarze 1222: Lists consist of items specified using the
1.141     kristaps 1223: .Sx \&It
                   1224: macro, containing a head or a body or both.
                   1225: The list syntax is as follows:
1.131     kristaps 1226: .Bd -ragged -offset indent
                   1227: .Pf \. Sx \&Bl
1.141     kristaps 1228: .Fl Ns Ar type
1.131     kristaps 1229: .Op Fl width Ar val
                   1230: .Op Fl offset Ar val
                   1231: .Op Fl compact
                   1232: .Op HEAD ...
                   1233: .Ed
                   1234: .Pp
1.141     kristaps 1235: The list
                   1236: .Ar type
                   1237: is mandatory and must be specified first.
                   1238: The
                   1239: .Fl width
                   1240: and
                   1241: .Fl offset
                   1242: arguments accept
1.104     kristaps 1243: .Sx Scaling Widths
1.141     kristaps 1244: or use the length of the given string.
                   1245: The
                   1246: .Fl offset
                   1247: is a global indentation for the whole list, affecting both item heads
                   1248: and bodies.
                   1249: For those list types supporting it, the
                   1250: .Fl width
                   1251: argument requests an additional indentation of item bodies,
                   1252: to be added to the
                   1253: .Fl offset .
                   1254: Unless the
                   1255: .Fl compact
                   1256: argument is specified, list entries are separated by vertical space.
                   1257: .Pp
1.103     kristaps 1258: A list must specify one of the following list types:
                   1259: .Bl -tag -width 12n -offset indent
                   1260: .It Fl bullet
1.141     kristaps 1261: No item heads can be specified, but a bullet will be printed at the head
                   1262: of each item.
                   1263: Item bodies start on the same output line as the bullet
                   1264: and are indented according to the
1.104     kristaps 1265: .Fl width
1.141     kristaps 1266: argument.
1.103     kristaps 1267: .It Fl column
                   1268: A columnated list.
1.104     kristaps 1269: The
                   1270: .Fl width
1.141     kristaps 1271: argument has no effect; instead, each argument specifies the width
                   1272: of one column, using either the
1.103     kristaps 1273: .Sx Scaling Widths
1.141     kristaps 1274: syntax or the string length of the argument.
                   1275: If the first line of the body of a
1.114     kristaps 1276: .Fl column
                   1277: list is not an
                   1278: .Sx \&It
1.141     kristaps 1279: macro line,
                   1280: .Sx \&It
                   1281: contexts spanning one input line each are implied until an
1.114     kristaps 1282: .Sx \&It
1.141     kristaps 1283: macro line is encountered, at which point items start being interpreted as
1.114     kristaps 1284: described in the
                   1285: .Sx \&It
                   1286: documentation.
1.103     kristaps 1287: .It Fl dash
1.141     kristaps 1288: Like
                   1289: .Fl bullet ,
                   1290: except that dashes are used in place of bullets.
1.103     kristaps 1291: .It Fl diag
                   1292: Like
                   1293: .Fl inset ,
1.141     kristaps 1294: except that item heads are not parsed for macro invocations.
                   1295: .\" but with additional formatting to the head.
1.103     kristaps 1296: .It Fl enum
1.141     kristaps 1297: A numbered list.
                   1298: Formatted like
                   1299: .Fl bullet ,
                   1300: except that cardinal numbers are used in place of bullets,
                   1301: starting at 1.
1.103     kristaps 1302: .It Fl hang
                   1303: Like
                   1304: .Fl tag ,
1.141     kristaps 1305: except that the first lines of item bodies are not indented, but follow
                   1306: the item heads like in
                   1307: .Fl inset
                   1308: lists.
1.103     kristaps 1309: .It Fl hyphen
                   1310: Synonym for
                   1311: .Fl dash .
                   1312: .It Fl inset
1.141     kristaps 1313: Item bodies follow items heads on the same line, using normal inter-word
                   1314: spacing.
                   1315: Bodies are not indented, and the
1.104     kristaps 1316: .Fl width
                   1317: argument is ignored.
1.103     kristaps 1318: .It Fl item
1.141     kristaps 1319: No item heads can be specified, and none are printed.
                   1320: Bodies are not indented, and the
1.104     kristaps 1321: .Fl width
                   1322: argument is ignored.
1.103     kristaps 1323: .It Fl ohang
1.141     kristaps 1324: Item bodies start on the line following item heads and are not indented.
1.104     kristaps 1325: The
                   1326: .Fl width
                   1327: argument is ignored.
1.103     kristaps 1328: .It Fl tag
1.141     kristaps 1329: Item bodies are indented according to the
1.103     kristaps 1330: .Fl width
                   1331: argument.
1.141     kristaps 1332: When an item head fits inside the indentation, the item body follows
                   1333: this head on the same output line.
                   1334: Otherwise, the body starts on the output line following the head.
1.103     kristaps 1335: .El
1.114     kristaps 1336: .Pp
                   1337: See also
1.141     kristaps 1338: .Sx \&El
                   1339: and
1.114     kristaps 1340: .Sx \&It .
1.63      kristaps 1341: .Ss \&Bo
1.141     kristaps 1342: Begin a block enclosed by square brackets.
1.100     kristaps 1343: Does not have any head arguments.
1.65      kristaps 1344: .Pp
                   1345: Examples:
1.140     kristaps 1346: .Bd -literal -offset indent -compact
1.65      kristaps 1347: \&.Bo 1 ,
1.91      kristaps 1348: \&.Dv BUFSIZ \&Bc
1.65      kristaps 1349: .Ed
                   1350: .Pp
                   1351: See also
                   1352: .Sx \&Bq .
1.63      kristaps 1353: .Ss \&Bq
1.82      kristaps 1354: Encloses its arguments in square brackets.
1.65      kristaps 1355: .Pp
                   1356: Examples:
1.173     kristaps 1357: .Dl \&.Bq 1 , \&Dv BUFSIZ
1.65      kristaps 1358: .Pp
                   1359: .Em Remarks :
                   1360: this macro is sometimes abused to emulate optional arguments for
                   1361: commands; the correct macros to use for this purpose are
                   1362: .Sx \&Op ,
                   1363: .Sx \&Oo ,
                   1364: and
                   1365: .Sx \&Oc .
                   1366: .Pp
                   1367: See also
                   1368: .Sx \&Bo .
1.63      kristaps 1369: .Ss \&Brc
1.141     kristaps 1370: Close a
1.65      kristaps 1371: .Sx \&Bro
1.138     kristaps 1372: block.
                   1373: Does not have any tail arguments.
1.63      kristaps 1374: .Ss \&Bro
1.141     kristaps 1375: Begin a block enclosed by curly braces.
1.100     kristaps 1376: Does not have any head arguments.
1.65      kristaps 1377: .Pp
                   1378: Examples:
1.140     kristaps 1379: .Bd -literal -offset indent -compact
1.65      kristaps 1380: \&.Bro 1 , ... ,
1.91      kristaps 1381: \&.Va n \&Brc
1.65      kristaps 1382: .Ed
                   1383: .Pp
                   1384: See also
                   1385: .Sx \&Brq .
1.63      kristaps 1386: .Ss \&Brq
1.65      kristaps 1387: Encloses its arguments in curly braces.
                   1388: .Pp
                   1389: Examples:
1.173     kristaps 1390: .Dl \&.Brq 1 , ... , \&Va n
1.65      kristaps 1391: .Pp
                   1392: See also
                   1393: .Sx \&Bro .
1.63      kristaps 1394: .Ss \&Bsx
1.65      kristaps 1395: Format the BSD/OS version provided as an argument, or a default value if
                   1396: no argument is provided.
                   1397: .Pp
                   1398: Examples:
1.173     kristaps 1399: .Dl \&.Bsx 1.0
                   1400: .Dl \&.Bsx
1.65      kristaps 1401: .Pp
                   1402: See also
                   1403: .Sx \&At ,
                   1404: .Sx \&Bx ,
1.66      kristaps 1405: .Sx \&Dx ,
1.65      kristaps 1406: .Sx \&Fx ,
                   1407: .Sx \&Nx ,
                   1408: .Sx \&Ox ,
                   1409: and
                   1410: .Sx \&Ux .
1.63      kristaps 1411: .Ss \&Bt
1.66      kristaps 1412: Prints
1.144     schwarze 1413: .Dq is currently in beta test .
1.63      kristaps 1414: .Ss \&Bx
1.65      kristaps 1415: Format the BSD version provided as an argument, or a default value if no
                   1416: argument is provided.
                   1417: .Pp
                   1418: Examples:
1.173     kristaps 1419: .Dl \&.Bx 4.4
                   1420: .Dl \&.Bx
1.65      kristaps 1421: .Pp
                   1422: See also
                   1423: .Sx \&At ,
                   1424: .Sx \&Bsx ,
1.66      kristaps 1425: .Sx \&Dx ,
1.65      kristaps 1426: .Sx \&Fx ,
                   1427: .Sx \&Nx ,
                   1428: .Sx \&Ox ,
                   1429: and
                   1430: .Sx \&Ux .
1.63      kristaps 1431: .Ss \&Cd
1.141     kristaps 1432: Kernel configuration declaration.
1.100     kristaps 1433: This denotes strings accepted by
1.66      kristaps 1434: .Xr config 8 .
                   1435: .Pp
                   1436: Examples:
1.173     kristaps 1437: .Dl \&.Cd device le0 at scode?
1.66      kristaps 1438: .Pp
                   1439: .Em Remarks :
                   1440: this macro is commonly abused by using quoted literals to retain
1.138     kristaps 1441: whitespace and align consecutive
1.66      kristaps 1442: .Sx \&Cd
1.100     kristaps 1443: declarations.
                   1444: This practise is discouraged.
1.63      kristaps 1445: .Ss \&Cm
1.100     kristaps 1446: Command modifiers.
                   1447: Useful when specifying configuration options or keys.
1.66      kristaps 1448: .Pp
                   1449: Examples:
1.173     kristaps 1450: .Dl \&.Cm ControlPath
                   1451: .Dl \&.Cm ControlMaster
1.66      kristaps 1452: .Pp
                   1453: See also
                   1454: .Sx \&Fl .
1.63      kristaps 1455: .Ss \&D1
1.100     kristaps 1456: One-line indented display.
                   1457: This is formatted by the default rules and is useful for simple indented
                   1458: statements.
                   1459: It is followed by a newline.
1.66      kristaps 1460: .Pp
                   1461: Examples:
1.173     kristaps 1462: .Dl \&.D1 \&Fl abcdefgh
1.66      kristaps 1463: .Pp
                   1464: See also
                   1465: .Sx \&Bd
                   1466: and
                   1467: .Sx \&Dl .
1.63      kristaps 1468: .Ss \&Db
1.141     kristaps 1469: Switch debugging mode.
1.120     kristaps 1470: Its syntax is as follows:
1.117     kristaps 1471: .Pp
1.120     kristaps 1472: .D1 Pf \. Sx \&Db Cm on | off
1.141     kristaps 1473: .Pp
                   1474: This macro is ignored by
                   1475: .Xr mandoc 1 .
1.63      kristaps 1476: .Ss \&Dc
1.141     kristaps 1477: Close a
1.66      kristaps 1478: .Sx \&Do
1.138     kristaps 1479: block.
                   1480: Does not have any tail arguments.
1.63      kristaps 1481: .Ss \&Dd
1.100     kristaps 1482: Document date.
                   1483: This is the mandatory first macro of any
1.66      kristaps 1484: .Nm
1.100     kristaps 1485: manual.
1.120     kristaps 1486: Its syntax is as follows:
1.66      kristaps 1487: .Pp
1.181     schwarze 1488: .D1 Pf \. Sx \&Dd Ar month day , year
1.66      kristaps 1489: .Pp
1.82      kristaps 1490: The
1.181     schwarze 1491: .Ar month
                   1492: is the full English month name, the
                   1493: .Ar day
                   1494: is an optionally zero-padded numeral, and the
                   1495: .Ar year
                   1496: is the full four-digit year.
                   1497: .Pp
                   1498: Other arguments are not portable; the
                   1499: .Xr mandoc 1
                   1500: utility handles them as follows:
                   1501: .Bl -dash -offset 3n -compact
                   1502: .It
                   1503: To have the date automatically filled in by the
                   1504: .Ox
                   1505: version of
1.72      kristaps 1506: .Xr cvs 1 ,
1.181     schwarze 1507: the special string
                   1508: .Dq $\&Mdocdate$
                   1509: can be given as an argument.
                   1510: .It
                   1511: A few alternative date formats are accepted as well
                   1512: and converted to the standard form.
                   1513: .It
                   1514: If a date string cannot be parsed, it is used verbatim.
                   1515: .It
                   1516: If no date string is given, the current date is used.
                   1517: .El
1.66      kristaps 1518: .Pp
                   1519: Examples:
1.173     kristaps 1520: .Dl \&.Dd $\&Mdocdate$
                   1521: .Dl \&.Dd $\&Mdocdate: July 21 2007$
                   1522: .Dl \&.Dd July 21, 2007
1.66      kristaps 1523: .Pp
                   1524: See also
                   1525: .Sx \&Dt
                   1526: and
                   1527: .Sx \&Os .
1.63      kristaps 1528: .Ss \&Dl
1.100     kristaps 1529: One-line intended display.
                   1530: This is formatted as literal text and is useful for commands and
                   1531: invocations.
                   1532: It is followed by a newline.
1.66      kristaps 1533: .Pp
                   1534: Examples:
1.173     kristaps 1535: .Dl \&.Dl % mandoc mdoc.7 \e(ba less
1.66      kristaps 1536: .Pp
                   1537: See also
                   1538: .Sx \&Bd
                   1539: and
                   1540: .Sx \&D1 .
1.63      kristaps 1541: .Ss \&Do
1.141     kristaps 1542: Begin a block enclosed by double quotes.
1.138     kristaps 1543: Does not have any head arguments.
1.66      kristaps 1544: .Pp
                   1545: Examples:
1.140     kristaps 1546: .Bd -literal -offset indent -compact
                   1547: \&.Do
                   1548: April is the cruellest month
                   1549: \&.Dc
                   1550: \e(em T.S. Eliot
                   1551: .Ed
1.66      kristaps 1552: .Pp
                   1553: See also
                   1554: .Sx \&Dq .
1.63      kristaps 1555: .Ss \&Dq
1.138     kristaps 1556: Encloses its arguments in
                   1557: .Dq typographic
                   1558: double-quotes.
1.66      kristaps 1559: .Pp
                   1560: Examples:
1.91      kristaps 1561: .Bd -literal -offset indent -compact
1.66      kristaps 1562: \&.Dq April is the cruellest month
                   1563: \e(em T.S. Eliot
                   1564: .Ed
                   1565: .Pp
                   1566: See also
1.139     kristaps 1567: .Sx \&Qq ,
                   1568: .Sx \&Sq ,
1.138     kristaps 1569: and
1.66      kristaps 1570: .Sx \&Do .
1.139     kristaps 1571: .Ss \&Dt
1.100     kristaps 1572: Document title.
                   1573: This is the mandatory second macro of any
1.66      kristaps 1574: .Nm
1.100     kristaps 1575: file.
1.120     kristaps 1576: Its syntax is as follows:
                   1577: .Bd -ragged -offset indent
                   1578: .Pf \. Sx \&Dt
                   1579: .Oo
1.141     kristaps 1580: .Ar title
1.120     kristaps 1581: .Oo
1.141     kristaps 1582: .Ar section
                   1583: .Op Ar volume | arch
1.120     kristaps 1584: .Oc
                   1585: .Oc
                   1586: .Ed
1.66      kristaps 1587: .Pp
                   1588: Its arguments are as follows:
                   1589: .Bl -tag -width Ds -offset Ds
1.141     kristaps 1590: .It Ar title
1.111     kristaps 1591: The document's title (name), defaulting to
1.138     kristaps 1592: .Dq UNKNOWN
1.111     kristaps 1593: if unspecified.
                   1594: It should be capitalised.
1.141     kristaps 1595: .It Ar section
1.100     kristaps 1596: The manual section.
                   1597: This may be one of
1.66      kristaps 1598: .Ar 1
                   1599: .Pq utilities ,
                   1600: .Ar 2
                   1601: .Pq system calls ,
                   1602: .Ar 3
                   1603: .Pq libraries ,
                   1604: .Ar 3p
                   1605: .Pq Perl libraries ,
                   1606: .Ar 4
                   1607: .Pq devices ,
                   1608: .Ar 5
                   1609: .Pq file formats ,
                   1610: .Ar 6
                   1611: .Pq games ,
                   1612: .Ar 7
                   1613: .Pq miscellaneous ,
                   1614: .Ar 8
                   1615: .Pq system utilities ,
                   1616: .Ar 9
                   1617: .Pq kernel functions ,
                   1618: .Ar X11
                   1619: .Pq X Window System ,
                   1620: .Ar X11R6
                   1621: .Pq X Window System ,
                   1622: .Ar unass
                   1623: .Pq unassociated ,
                   1624: .Ar local
                   1625: .Pq local system ,
                   1626: .Ar draft
                   1627: .Pq draft manual ,
                   1628: or
                   1629: .Ar paper
                   1630: .Pq paper .
1.111     kristaps 1631: It should correspond to the manual's filename suffix and defaults to
1.138     kristaps 1632: .Dq 1
1.111     kristaps 1633: if unspecified.
1.141     kristaps 1634: .It Ar volume
1.66      kristaps 1635: This overrides the volume inferred from
                   1636: .Ar section .
                   1637: This field is optional, and if specified, must be one of
                   1638: .Ar USD
                   1639: .Pq users' supplementary documents ,
                   1640: .Ar PS1
                   1641: .Pq programmers' supplementary documents ,
                   1642: .Ar AMD
                   1643: .Pq administrators' supplementary documents ,
                   1644: .Ar SMM
                   1645: .Pq system managers' manuals ,
                   1646: .Ar URM
                   1647: .Pq users' reference manuals ,
                   1648: .Ar PRM
                   1649: .Pq programmers' reference manuals ,
                   1650: .Ar KM
                   1651: .Pq kernel manuals ,
                   1652: .Ar IND
                   1653: .Pq master index ,
                   1654: .Ar MMI
                   1655: .Pq master index ,
                   1656: .Ar LOCAL
                   1657: .Pq local manuals ,
                   1658: .Ar LOC
                   1659: .Pq local manuals ,
                   1660: or
                   1661: .Ar CON
                   1662: .Pq contributed manuals .
1.141     kristaps 1663: .It Ar arch
1.100     kristaps 1664: This specifies a specific relevant architecture.
                   1665: If
1.141     kristaps 1666: .Ar volume
1.66      kristaps 1667: is not provided, it may be used in its place, else it may be used
1.100     kristaps 1668: subsequent that.
                   1669: It, too, is optional.
                   1670: It must be one of
1.66      kristaps 1671: .Ar alpha ,
                   1672: .Ar amd64 ,
                   1673: .Ar amiga ,
                   1674: .Ar arc ,
                   1675: .Ar arm ,
                   1676: .Ar armish ,
                   1677: .Ar aviion ,
                   1678: .Ar hp300 ,
                   1679: .Ar hppa ,
                   1680: .Ar hppa64 ,
                   1681: .Ar i386 ,
                   1682: .Ar landisk ,
1.86      kristaps 1683: .Ar loongson ,
1.66      kristaps 1684: .Ar luna88k ,
                   1685: .Ar mac68k ,
                   1686: .Ar macppc ,
1.160     kristaps 1687: .Ar mips64 ,
1.66      kristaps 1688: .Ar mvme68k ,
                   1689: .Ar mvme88k ,
                   1690: .Ar mvmeppc ,
                   1691: .Ar pmax ,
                   1692: .Ar sgi ,
                   1693: .Ar socppc ,
                   1694: .Ar sparc ,
                   1695: .Ar sparc64 ,
                   1696: .Ar sun3 ,
                   1697: .Ar vax ,
                   1698: or
                   1699: .Ar zaurus .
                   1700: .El
                   1701: .Pp
                   1702: Examples:
1.173     kristaps 1703: .Dl \&.Dt FOO 1
                   1704: .Dl \&.Dt FOO 4 KM
                   1705: .Dl \&.Dt FOO 9 i386
1.66      kristaps 1706: .Pp
                   1707: See also
                   1708: .Sx \&Dd
                   1709: and
                   1710: .Sx \&Os .
1.63      kristaps 1711: .Ss \&Dv
1.189     kristaps 1712: Defined variables such as preprocessor constants, constant symbols,
                   1713: enumeration values, and so on.
1.66      kristaps 1714: .Pp
                   1715: Examples:
1.189     kristaps 1716: .Dl \&.Dv NULL
1.173     kristaps 1717: .Dl \&.Dv BUFSIZ
                   1718: .Dl \&.Dv STDOUT_FILENO
1.66      kristaps 1719: .Pp
                   1720: See also
1.189     kristaps 1721: .Sx \&Er
                   1722: and
                   1723: .Sx \&Ev
                   1724: for special-purpose constants and
                   1725: .Sx \&Va
                   1726: for variable symbols.
1.63      kristaps 1727: .Ss \&Dx
1.71      kristaps 1728: Format the DragonFly BSD version provided as an argument, or a default
1.66      kristaps 1729: value if no argument is provided.
                   1730: .Pp
                   1731: Examples:
1.173     kristaps 1732: .Dl \&.Dx 2.4.1
                   1733: .Dl \&.Dx
1.66      kristaps 1734: .Pp
                   1735: See also
                   1736: .Sx \&At ,
                   1737: .Sx \&Bsx ,
                   1738: .Sx \&Bx ,
                   1739: .Sx \&Fx ,
                   1740: .Sx \&Nx ,
                   1741: .Sx \&Ox ,
                   1742: and
                   1743: .Sx \&Ux .
1.63      kristaps 1744: .Ss \&Ec
1.131     kristaps 1745: Close a scope started by
                   1746: .Sx \&Eo .
                   1747: Its syntax is as follows:
                   1748: .Pp
1.141     kristaps 1749: .D1 Pf \. Sx \&Ec Op Ar TERM
1.131     kristaps 1750: .Pp
                   1751: The
1.141     kristaps 1752: .Ar TERM
1.131     kristaps 1753: argument is used as the enclosure tail, for example, specifying \e(rq
                   1754: will emulate
                   1755: .Sx \&Dc .
1.63      kristaps 1756: .Ss \&Ed
1.131     kristaps 1757: End a display context started by
                   1758: .Sx \&Bd .
1.63      kristaps 1759: .Ss \&Ef
1.141     kristaps 1760: End a font mode context started by
1.129     kristaps 1761: .Sx \&Bf .
1.63      kristaps 1762: .Ss \&Ek
1.141     kristaps 1763: End a keep context started by
1.127     schwarze 1764: .Sx \&Bk .
1.63      kristaps 1765: .Ss \&El
1.141     kristaps 1766: End a list context started by
1.117     kristaps 1767: .Sx \&Bl .
                   1768: .Pp
                   1769: See also
                   1770: .Sx \&Bl
                   1771: and
                   1772: .Sx \&It .
1.63      kristaps 1773: .Ss \&Em
1.100     kristaps 1774: Denotes text that should be emphasised.
                   1775: Note that this is a presentation term and should not be used for
                   1776: stylistically decorating technical terms.
1.66      kristaps 1777: .Pp
                   1778: Examples:
1.173     kristaps 1779: .Dl \&.Em Warnings!
                   1780: .Dl \&.Em Remarks :
1.138     kristaps 1781: .Pp
                   1782: See also
                   1783: .Sx \&Bf ,
                   1784: .Sx \&Sy ,
                   1785: and
                   1786: .Sx \&Li .
1.63      kristaps 1787: .Ss \&En
1.141     kristaps 1788: This macro is obsolete and not implemented in
                   1789: .Xr mandoc 1 .
1.63      kristaps 1790: .Ss \&Eo
1.131     kristaps 1791: An arbitrary enclosure.
                   1792: Its syntax is as follows:
                   1793: .Pp
1.141     kristaps 1794: .D1 Pf \. Sx \&Eo Op Ar TERM
1.131     kristaps 1795: .Pp
                   1796: The
1.141     kristaps 1797: .Ar TERM
1.131     kristaps 1798: argument is used as the enclosure head, for example, specifying \e(lq
                   1799: will emulate
                   1800: .Sx \&Do .
1.63      kristaps 1801: .Ss \&Er
1.189     kristaps 1802: Error constants for definitions of the
                   1803: .Va errno
                   1804: libc global variable.
1.66      kristaps 1805: .Pp
                   1806: Examples:
1.173     kristaps 1807: .Dl \&.Er EPERM
                   1808: .Dl \&.Er ENOENT
1.66      kristaps 1809: .Pp
                   1810: See also
1.189     kristaps 1811: .Sx \&Dv
                   1812: for general constants.
1.63      kristaps 1813: .Ss \&Es
1.132     kristaps 1814: This macro is obsolete and not implemented.
1.63      kristaps 1815: .Ss \&Ev
1.66      kristaps 1816: Environmental variables such as those specified in
                   1817: .Xr environ 7 .
                   1818: .Pp
                   1819: Examples:
1.173     kristaps 1820: .Dl \&.Ev DISPLAY
                   1821: .Dl \&.Ev PATH
1.189     kristaps 1822: .Pp
                   1823: See also
                   1824: .Sx \&Dv
                   1825: for general constants.
1.63      kristaps 1826: .Ss \&Ex
1.191     kristaps 1827: Insert a standard sentence regarding command exit values of 0 on success
                   1828: and >0 on failure.
1.141     kristaps 1829: Its syntax is as follows:
                   1830: .Pp
1.193   ! schwarze 1831: .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
1.141     kristaps 1832: .Pp
1.191     kristaps 1833: If
1.66      kristaps 1834: .Ar utility
1.141     kristaps 1835: is not specified, the document's name set by
1.66      kristaps 1836: .Sx \&Nm
1.141     kristaps 1837: is used.
1.191     kristaps 1838: Multiple
                   1839: .Ar utility
                   1840: arguments are treated as separate utilities.
1.139     kristaps 1841: .Pp
                   1842: See also
                   1843: .Sx \&Rv .
1.63      kristaps 1844: .Ss \&Fa
1.117     kristaps 1845: Function argument.
1.120     kristaps 1846: Its syntax is as follows:
                   1847: .Bd -ragged -offset indent
                   1848: .Pf \. Sx \&Fa
                   1849: .Op Cm argtype
                   1850: .Cm argname
                   1851: .Ed
                   1852: .Pp
1.117     kristaps 1853: This may be invoked for names with or without the corresponding type.
                   1854: It is also used to specify the field name of a structure.
                   1855: Most often, the
                   1856: .Sx \&Fa
                   1857: macro is used in the
                   1858: .Em SYNOPSIS
1.120     kristaps 1859: within
                   1860: .Sx \&Fo
1.117     kristaps 1861: section when documenting multi-line function prototypes.
                   1862: If invoked with multiple arguments, the arguments are separated by a
                   1863: comma.
                   1864: Furthermore, if the following macro is another
                   1865: .Sx \&Fa ,
                   1866: the last argument will also have a trailing comma.
                   1867: .Pp
                   1868: Examples:
1.173     kristaps 1869: .Dl \&.Fa \(dqconst char *p\(dq
                   1870: .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
                   1871: .Dl \&.Fa foo
1.120     kristaps 1872: .Pp
                   1873: See also
                   1874: .Sx \&Fo .
1.63      kristaps 1875: .Ss \&Fc
1.141     kristaps 1876: End a function context started by
1.131     kristaps 1877: .Sx \&Fo .
1.63      kristaps 1878: .Ss \&Fd
1.117     kristaps 1879: Historically used to document include files.
                   1880: This usage has been deprecated in favour of
                   1881: .Sx \&In .
                   1882: Do not use this macro.
                   1883: .Pp
                   1884: See also
1.122     kristaps 1885: .Sx MANUAL STRUCTURE
                   1886: and
1.117     kristaps 1887: .Sx \&In .
1.63      kristaps 1888: .Ss \&Fl
1.100     kristaps 1889: Command-line flag.
                   1890: Used when listing arguments to command-line utilities.
                   1891: Prints a fixed-width hyphen
1.79      kristaps 1892: .Sq \-
1.100     kristaps 1893: directly followed by each argument.
                   1894: If no arguments are provided, a hyphen is printed followed by a space.
                   1895: If the argument is a macro, a hyphen is prefixed to the subsequent macro
                   1896: output.
1.79      kristaps 1897: .Pp
                   1898: Examples:
1.173     kristaps 1899: .Dl \&.Fl a b c
                   1900: .Dl \&.Fl \&Pf a b
                   1901: .Dl \&.Fl
                   1902: .Dl \&.Op \&Fl o \&Ns \&Ar file
1.79      kristaps 1903: .Pp
                   1904: See also
                   1905: .Sx \&Cm .
1.63      kristaps 1906: .Ss \&Fn
1.119     kristaps 1907: A function name.
1.120     kristaps 1908: Its syntax is as follows:
1.119     kristaps 1909: .Bd -ragged -offset indent
                   1910: .Pf \. Ns Sx \&Fn
1.185     kristaps 1911: .Op Ar functype
                   1912: .Ar funcname
                   1913: .Op Oo Ar argtype Oc Ar argname
1.119     kristaps 1914: .Ed
1.120     kristaps 1915: .Pp
1.122     kristaps 1916: Function arguments are surrounded in parenthesis and
1.119     kristaps 1917: are delimited by commas.
                   1918: If no arguments are specified, blank parenthesis are output.
                   1919: .Pp
                   1920: Examples:
1.183     kristaps 1921: .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q
                   1922: .Dl \&.Fn funcname \*qint arg0\*q
1.173     kristaps 1923: .Dl \&.Fn funcname arg0
1.120     kristaps 1924: .Bd -literal -offset indent -compact
                   1925: \&.Ft functype
                   1926: \&.Fn funcname
                   1927: .Ed
1.119     kristaps 1928: .Pp
1.163     schwarze 1929: When referring to a function documented in another manual page, use
1.162     schwarze 1930: .Sx \&Xr
1.163     schwarze 1931: instead.
1.119     kristaps 1932: See also
1.122     kristaps 1933: .Sx MANUAL STRUCTURE
1.119     kristaps 1934: and
                   1935: .Sx \&Ft .
1.63      kristaps 1936: .Ss \&Fo
1.120     kristaps 1937: Begin a function block.
                   1938: This is a multi-line version of
                   1939: .Sx \&Fn .
                   1940: Its syntax is as follows:
                   1941: .Pp
1.185     kristaps 1942: .D1 Pf \. Sx \&Fo Ar funcname
1.120     kristaps 1943: .Pp
                   1944: Invocations usually occur in the following context:
                   1945: .Bd -ragged -offset indent
1.185     kristaps 1946: .Pf \. Sx \&Ft Ar functype
1.120     kristaps 1947: .br
1.185     kristaps 1948: .Pf \. Sx \&Fo Ar funcname
1.120     kristaps 1949: .br
1.185     kristaps 1950: .Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname
1.120     kristaps 1951: .br
1.183     kristaps 1952: \&.\.\.
1.120     kristaps 1953: .br
                   1954: .Pf \. Sx \&Fc
                   1955: .Ed
                   1956: .Pp
                   1957: A
                   1958: .Sx \&Fo
                   1959: scope is closed by
                   1960: .Pp
                   1961: See also
1.122     kristaps 1962: .Sx MANUAL STRUCTURE ,
1.120     kristaps 1963: .Sx \&Fa ,
                   1964: .Sx \&Fc ,
                   1965: and
1.139     kristaps 1966: .Sx \&Ft .
1.190     schwarze 1967: .Ss \&Fr
                   1968: This macro is obsolete and not implemented.
1.63      kristaps 1969: .Ss \&Ft
1.120     kristaps 1970: A function type.
                   1971: Its syntax is as follows:
                   1972: .Pp
1.185     kristaps 1973: .D1 Pf \. Sx \&Ft Ar functype
1.120     kristaps 1974: .Pp
                   1975: Examples:
1.173     kristaps 1976: .Dl \&.Ft int
1.120     kristaps 1977: .Bd -literal -offset indent -compact
                   1978: \&.Ft functype
                   1979: \&.Fn funcname
                   1980: .Ed
                   1981: .Pp
                   1982: See also
1.122     kristaps 1983: .Sx MANUAL STRUCTURE ,
                   1984: .Sx \&Fn ,
1.120     kristaps 1985: and
1.122     kristaps 1986: .Sx \&Fo .
1.63      kristaps 1987: .Ss \&Fx
1.144     schwarze 1988: Format the
                   1989: .Fx
                   1990: version provided as an argument, or a default value
1.65      kristaps 1991: if no argument is provided.
                   1992: .Pp
                   1993: Examples:
1.173     kristaps 1994: .Dl \&.Fx 7.1
                   1995: .Dl \&.Fx
1.65      kristaps 1996: .Pp
                   1997: See also
                   1998: .Sx \&At ,
1.66      kristaps 1999: .Sx \&Bsx ,
1.65      kristaps 2000: .Sx \&Bx ,
1.66      kristaps 2001: .Sx \&Dx ,
1.65      kristaps 2002: .Sx \&Nx ,
                   2003: .Sx \&Ox ,
                   2004: and
                   2005: .Sx \&Ux .
1.63      kristaps 2006: .Ss \&Hf
1.132     kristaps 2007: This macro is obsolete and not implemented.
1.63      kristaps 2008: .Ss \&Ic
1.132     kristaps 2009: Designate an internal or interactive command.
                   2010: This is similar to
                   2011: .Sx \&Cm
                   2012: but used for instructions rather than values.
                   2013: .Pp
                   2014: Examples:
1.173     kristaps 2015: .Dl \&.Ic hash
                   2016: .Dl \&.Ic alias
1.132     kristaps 2017: .Pp
                   2018: Note that using
1.144     schwarze 2019: .Sx \&Bd Fl literal
1.132     kristaps 2020: or
                   2021: .Sx \&D1
                   2022: is preferred for displaying code; the
                   2023: .Sx \&Ic
                   2024: macro is used when referring to specific instructions.
1.63      kristaps 2025: .Ss \&In
1.118     kristaps 2026: An
1.138     kristaps 2027: .Dq include
1.118     kristaps 2028: file.
                   2029: In the
                   2030: .Em SYNOPSIS
                   2031: section (only if invoked as the line macro), the first argument is
                   2032: preceded by
1.138     kristaps 2033: .Dq #include ,
1.141     kristaps 2034: the arguments is enclosed in angle brackets.
1.118     kristaps 2035: .Pp
1.122     kristaps 2036: Examples:
1.173     kristaps 2037: .Dl \&.In sys/types
1.122     kristaps 2038: .Pp
                   2039: See also
                   2040: .Sx MANUAL STRUCTURE .
1.63      kristaps 2041: .Ss \&It
1.120     kristaps 2042: A list item.
                   2043: The syntax of this macro depends on the list type.
1.114     kristaps 2044: .Pp
                   2045: Lists
                   2046: of type
                   2047: .Fl hang ,
                   2048: .Fl ohang ,
                   2049: .Fl inset ,
                   2050: and
                   2051: .Fl diag
1.120     kristaps 2052: have the following syntax:
1.114     kristaps 2053: .Pp
1.185     kristaps 2054: .D1 Pf \. Sx \&It Ar args
1.114     kristaps 2055: .Pp
                   2056: Lists of type
                   2057: .Fl bullet ,
                   2058: .Fl dash ,
                   2059: .Fl enum ,
                   2060: .Fl hyphen
                   2061: and
                   2062: .Fl item
1.120     kristaps 2063: have the following syntax:
1.114     kristaps 2064: .Pp
1.120     kristaps 2065: .D1 Pf \. Sx \&It
1.114     kristaps 2066: .Pp
                   2067: with subsequent lines interpreted within the scope of the
                   2068: .Sx \&It
                   2069: until either a closing
                   2070: .Sx \&El
                   2071: or another
                   2072: .Sx \&It .
                   2073: .Pp
                   2074: The
                   2075: .Fl tag
1.120     kristaps 2076: list has the following syntax:
1.114     kristaps 2077: .Pp
1.120     kristaps 2078: .D1 Pf \. Sx \&It Op Cm args
1.114     kristaps 2079: .Pp
1.120     kristaps 2080: Subsequent lines are interpreted as with
1.114     kristaps 2081: .Fl bullet
                   2082: and family.
                   2083: The line arguments correspond to the list's left-hand side; body
                   2084: arguments correspond to the list's contents.
                   2085: .Pp
                   2086: The
                   2087: .Fl column
                   2088: list is the most complicated.
1.120     kristaps 2089: Its syntax is as follows:
1.114     kristaps 2090: .Pp
1.190     schwarze 2091: .D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...
                   2092: .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...
1.114     kristaps 2093: .Pp
1.190     schwarze 2094: The arguments consist of one or more lines of text and macros
                   2095: representing a complete table line.
                   2096: Cells within the line are delimited by tabs or by the special
                   2097: .Sx \&Ta
                   2098: block macro.
                   2099: The tab cell delimiter may only be used within the
1.114     kristaps 2100: .Sx \&It
1.190     schwarze 2101: line itself; on following lines, only the
                   2102: .Sx \&Ta
                   2103: macro can be used to delimit cells, and
                   2104: .Sx \&Ta
                   2105: is only recognized as a macro when called by other macros,
                   2106: not as the first macro on a line.
                   2107: .Pp
                   2108: Note that quoted strings may span tab-delimited cells on an
1.114     kristaps 2109: .Sx \&It
1.190     schwarze 2110: line.
                   2111: For example,
1.114     kristaps 2112: .Pp
1.173     kristaps 2113: .Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
1.114     kristaps 2114: .Pp
                   2115: will preserve the semicolon whitespace except for the last.
                   2116: .Pp
                   2117: See also
                   2118: .Sx \&Bl .
1.63      kristaps 2119: .Ss \&Lb
1.109     kristaps 2120: Specify a library.
1.120     kristaps 2121: The syntax is as follows:
1.109     kristaps 2122: .Pp
1.185     kristaps 2123: .D1 Pf \. Sx \&Lb Ar library
1.109     kristaps 2124: .Pp
                   2125: The
1.185     kristaps 2126: .Ar library
1.109     kristaps 2127: parameter may be a system library, such as
1.193   ! schwarze 2128: .Cm libz
1.109     kristaps 2129: or
1.193   ! schwarze 2130: .Cm libpam ,
1.109     kristaps 2131: in which case a small library description is printed next to the linker
                   2132: invocation; or a custom library, in which case the library name is
                   2133: printed in quotes.
                   2134: This is most commonly used in the
                   2135: .Em SYNOPSIS
                   2136: section as described in
                   2137: .Sx MANUAL STRUCTURE .
                   2138: .Pp
                   2139: Examples:
1.173     kristaps 2140: .Dl \&.Lb libz
                   2141: .Dl \&.Lb mdoc
1.63      kristaps 2142: .Ss \&Li
1.131     kristaps 2143: Denotes text that should be in a literal font mode.
                   2144: Note that this is a presentation term and should not be used for
                   2145: stylistically decorating technical terms.
1.138     kristaps 2146: .Pp
                   2147: See also
                   2148: .Sx \&Bf ,
                   2149: .Sx \&Sy ,
                   2150: and
                   2151: .Sx \&Em .
1.63      kristaps 2152: .Ss \&Lk
1.100     kristaps 2153: Format a hyperlink.
1.120     kristaps 2154: Its syntax is as follows:
1.70      kristaps 2155: .Pp
1.185     kristaps 2156: .D1 Pf \. Sx \&Lk Ar uri Op Ar name
1.70      kristaps 2157: .Pp
                   2158: Examples:
1.173     kristaps 2159: .Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q
                   2160: .Dl \&.Lk http://bsd.lv
1.70      kristaps 2161: .Pp
                   2162: See also
                   2163: .Sx \&Mt .
1.63      kristaps 2164: .Ss \&Lp
1.132     kristaps 2165: Synonym for
                   2166: .Sx \&Pp .
1.63      kristaps 2167: .Ss \&Ms
1.138     kristaps 2168: Display a mathematical symbol.
1.140     kristaps 2169: Its syntax is as follows:
                   2170: .Pp
1.185     kristaps 2171: .D1 Pf \. Sx \&Ms Ar symbol
1.138     kristaps 2172: .Pp
                   2173: Examples:
1.173     kristaps 2174: .Dl \&.Ms sigma
                   2175: .Dl \&.Ms aleph
1.63      kristaps 2176: .Ss \&Mt
1.116     kristaps 2177: Format a
1.138     kristaps 2178: .Dq mailto:
1.116     kristaps 2179: hyperlink.
1.120     kristaps 2180: Its syntax is as follows:
1.116     kristaps 2181: .Pp
1.185     kristaps 2182: .D1 Pf \. Sx \&Mt Ar address
1.116     kristaps 2183: .Pp
                   2184: Examples:
1.173     kristaps 2185: .Dl \&.Mt discuss@manpages.bsd.lv
1.63      kristaps 2186: .Ss \&Nd
1.144     schwarze 2187: A one line description of the manual's content.
1.132     kristaps 2188: This may only be invoked in the
                   2189: .Em SYNOPSIS
                   2190: section subsequent the
                   2191: .Sx \&Nm
                   2192: macro.
                   2193: .Pp
                   2194: Examples:
1.173     kristaps 2195: .Dl \&.Sx \&Nd mdoc language reference
                   2196: .Dl \&.Sx \&Nd format and display UNIX manuals
1.132     kristaps 2197: .Pp
                   2198: The
                   2199: .Sx \&Nd
                   2200: macro technically accepts child macros and terminates with a subsequent
                   2201: .Sx \&Sh
                   2202: invocation.
                   2203: Do not assume this behaviour: some
                   2204: .Xr whatis 1
                   2205: database generators are not smart enough to parse more than the line
                   2206: arguments and will display macros verbatim.
                   2207: .Pp
                   2208: See also
                   2209: .Sx \&Nm .
1.63      kristaps 2210: .Ss \&Nm
1.128     schwarze 2211: The name of the manual page, or \(em in particular in section 1, 6,
                   2212: and 8 pages \(em of an additional command or feature documented in
                   2213: the manual page.
                   2214: When first invoked, the
                   2215: .Sx \&Nm
                   2216: macro expects a single argument, the name of the manual page.
                   2217: Usually, the first invocation happens in the
                   2218: .Em NAME
                   2219: section of the page.
                   2220: The specified name will be remembered and used whenever the macro is
                   2221: called again without arguments later in the page.
                   2222: The
                   2223: .Sx \&Nm
                   2224: macro uses
                   2225: .Sx Block full-implicit
                   2226: semantics when invoked as the first macro on an input line in the
                   2227: .Em SYNOPSIS
                   2228: section; otherwise, it uses ordinary
                   2229: .Sx In-line
                   2230: semantics.
                   2231: .Pp
                   2232: Examples:
                   2233: .Bd -literal -offset indent
                   2234: \&.Sh SYNOPSIS
                   2235: \&.Nm cat
                   2236: \&.Op Fl benstuv
                   2237: \&.Op Ar
                   2238: .Ed
                   2239: .Pp
                   2240: In the
                   2241: .Em SYNOPSIS
                   2242: of section 2, 3 and 9 manual pages, use the
                   2243: .Sx \&Fn
                   2244: macro rather than
                   2245: .Sx \&Nm
                   2246: to mark up the name of the manual page.
1.63      kristaps 2247: .Ss \&No
1.132     kristaps 2248: A
1.138     kristaps 2249: .Dq noop
1.132     kristaps 2250: macro used to terminate prior macro contexts.
                   2251: .Pp
                   2252: Examples:
1.173     kristaps 2253: .Dl \&.Sx \&Fl ab \&No cd \&Fl ef
1.63      kristaps 2254: .Ss \&Ns
1.138     kristaps 2255: Suppress a space.
                   2256: Following invocation, text is interpreted as free-form text until a
                   2257: macro is encountered.
1.178     kristaps 2258: .Pp
                   2259: This has no effect when invoked at the start of a macro line.
1.138     kristaps 2260: .Pp
                   2261: Examples:
1.173     kristaps 2262: .Dl \&.Fl o \&Ns \&Ar output
1.138     kristaps 2263: .Pp
                   2264: See also
                   2265: .Sx \&No
                   2266: and
                   2267: .Sx \&Sm .
1.63      kristaps 2268: .Ss \&Nx
1.144     schwarze 2269: Format the
                   2270: .Nx
                   2271: version provided as an argument, or a default value if
1.65      kristaps 2272: no argument is provided.
                   2273: .Pp
                   2274: Examples:
1.173     kristaps 2275: .Dl \&.Nx 5.01
                   2276: .Dl \&.Nx
1.65      kristaps 2277: .Pp
                   2278: See also
                   2279: .Sx \&At ,
1.66      kristaps 2280: .Sx \&Bsx ,
1.65      kristaps 2281: .Sx \&Bx ,
1.66      kristaps 2282: .Sx \&Dx ,
1.65      kristaps 2283: .Sx \&Fx ,
                   2284: .Sx \&Ox ,
                   2285: and
                   2286: .Sx \&Ux .
1.63      kristaps 2287: .Ss \&Oc
1.141     kristaps 2288: Close multi-line
1.132     kristaps 2289: .Sx \&Oo
                   2290: context.
1.63      kristaps 2291: .Ss \&Oo
1.132     kristaps 2292: Multi-line version of
                   2293: .Sx \&Op .
                   2294: .Pp
                   2295: Examples:
1.138     kristaps 2296: .Bd -literal -offset indent -compact
1.132     kristaps 2297: \&.Oo
                   2298: \&.Op Fl flag Ns Ar value
                   2299: \&.Oc
                   2300: .Ed
1.63      kristaps 2301: .Ss \&Op
1.132     kristaps 2302: Command-line option.
                   2303: Used when listing options to command-line utilities.
                   2304: Prints the argument(s) in brackets.
                   2305: .Pp
                   2306: Examples:
1.173     kristaps 2307: .Dl \&.Op \&Fl a \&Ar b
                   2308: .Dl \&.Op \&Ar a | b
1.132     kristaps 2309: .Pp
                   2310: See also
                   2311: .Sx \&Oo .
1.63      kristaps 2312: .Ss \&Os
1.100     kristaps 2313: Document operating system version.
                   2314: This is the mandatory third macro of
1.66      kristaps 2315: any
                   2316: .Nm
1.120     kristaps 2317: file.
                   2318: Its syntax is as follows:
1.66      kristaps 2319: .Pp
1.185     kristaps 2320: .D1 Pf \. Sx \&Os Op Ar system Op Ar version
1.66      kristaps 2321: .Pp
                   2322: The optional
1.185     kristaps 2323: .Ar system
1.100     kristaps 2324: parameter specifies the relevant operating system or environment.
                   2325: Left unspecified, it defaults to the local operating system version.
                   2326: This is the suggested form.
1.66      kristaps 2327: .Pp
                   2328: Examples:
1.173     kristaps 2329: .Dl \&.Os
                   2330: .Dl \&.Os KTH/CSC/TCS
                   2331: .Dl \&.Os BSD 4.3
1.66      kristaps 2332: .Pp
                   2333: See also
                   2334: .Sx \&Dd
                   2335: and
                   2336: .Sx \&Dt .
1.63      kristaps 2337: .Ss \&Ot
1.66      kristaps 2338: Unknown usage.
                   2339: .Pp
                   2340: .Em Remarks :
                   2341: this macro has been deprecated.
1.63      kristaps 2342: .Ss \&Ox
1.144     schwarze 2343: Format the
                   2344: .Ox
                   2345: version provided as an argument, or a default value
1.65      kristaps 2346: if no argument is provided.
                   2347: .Pp
                   2348: Examples:
1.173     kristaps 2349: .Dl \&.Ox 4.5
                   2350: .Dl \&.Ox
1.65      kristaps 2351: .Pp
                   2352: See also
                   2353: .Sx \&At ,
                   2354: .Sx \&Bsx ,
                   2355: .Sx \&Bx ,
1.66      kristaps 2356: .Sx \&Dx ,
1.65      kristaps 2357: .Sx \&Fx ,
                   2358: .Sx \&Nx ,
                   2359: and
                   2360: .Sx \&Ux .
1.63      kristaps 2361: .Ss \&Pa
1.132     kristaps 2362: A file-system path.
1.165     kristaps 2363: If an argument is not provided, the string
                   2364: .Dq \(ti
                   2365: is used as a default.
1.132     kristaps 2366: .Pp
                   2367: Examples:
1.173     kristaps 2368: .Dl \&.Pa /usr/bin/mandoc
                   2369: .Dl \&.Pa /usr/share/man/man7/mdoc.7
1.132     kristaps 2370: .Pp
                   2371: See also
                   2372: .Sx \&Lk .
1.63      kristaps 2373: .Ss \&Pc
1.132     kristaps 2374: Close parenthesised context opened by
                   2375: .Sx \&Po .
1.63      kristaps 2376: .Ss \&Pf
1.132     kristaps 2377: Removes the space
1.138     kristaps 2378: .Pq Dq prefix
1.132     kristaps 2379: between its arguments.
                   2380: Its syntax is as follows:
                   2381: .Pp
1.185     kristaps 2382: .D1 Pf \. \&Pf Ar prefix suffix
1.132     kristaps 2383: .Pp
                   2384: The
1.185     kristaps 2385: .Ar suffix
1.132     kristaps 2386: argument may be a macro.
                   2387: .Pp
                   2388: Examples:
1.185     kristaps 2389: .Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix
1.63      kristaps 2390: .Ss \&Po
1.132     kristaps 2391: Multi-line version of
                   2392: .Sx \&Pq .
1.63      kristaps 2393: .Ss \&Pp
1.132     kristaps 2394: Break a paragraph.
                   2395: This will assert vertical space between prior and subsequent macros
                   2396: and/or text.
1.63      kristaps 2397: .Ss \&Pq
1.132     kristaps 2398: Parenthesised enclosure.
                   2399: .Pp
                   2400: See also
                   2401: .Sx \&Po .
1.63      kristaps 2402: .Ss \&Qc
1.138     kristaps 2403: Close quoted context opened by
                   2404: .Sx \&Qo .
1.63      kristaps 2405: .Ss \&Ql
1.138     kristaps 2406: Format a single-quoted literal.
                   2407: See also
                   2408: .Sx \&Qq
                   2409: and
                   2410: .Sx \&Sq .
1.63      kristaps 2411: .Ss \&Qo
1.138     kristaps 2412: Multi-line version of
                   2413: .Sx \&Qq .
1.63      kristaps 2414: .Ss \&Qq
1.138     kristaps 2415: Encloses its arguments in
                   2416: .Dq typewriter
                   2417: double-quotes.
                   2418: Consider using
                   2419: .Sx \&Dq .
                   2420: .Pp
                   2421: See also
                   2422: .Sx \&Dq ,
                   2423: .Sx \&Sq ,
                   2424: and
                   2425: .Sx \&Qo .
1.63      kristaps 2426: .Ss \&Re
1.141     kristaps 2427: Close an
1.63      kristaps 2428: .Sx \&Rs
1.100     kristaps 2429: block.
                   2430: Does not have any tail arguments.
1.63      kristaps 2431: .Ss \&Rs
1.141     kristaps 2432: Begin a bibliographic
1.63      kristaps 2433: .Pq Dq reference
1.100     kristaps 2434: block.
                   2435: Does not have any head arguments.
                   2436: The block macro may only contain
1.63      kristaps 2437: .Sx \&%A ,
                   2438: .Sx \&%B ,
                   2439: .Sx \&%C ,
                   2440: .Sx \&%D ,
                   2441: .Sx \&%I ,
                   2442: .Sx \&%J ,
                   2443: .Sx \&%N ,
                   2444: .Sx \&%O ,
                   2445: .Sx \&%P ,
                   2446: .Sx \&%Q ,
                   2447: .Sx \&%R ,
                   2448: .Sx \&%T ,
1.120     kristaps 2449: .Sx \&%U ,
1.63      kristaps 2450: and
                   2451: .Sx \&%V
                   2452: child macros (at least one must be specified).
                   2453: .Pp
1.64      kristaps 2454: Examples:
1.91      kristaps 2455: .Bd -literal -offset indent -compact
1.63      kristaps 2456: \&.Rs
                   2457: \&.%A J. E. Hopcroft
                   2458: \&.%A J. D. Ullman
                   2459: \&.%B Introduction to Automata Theory, Languages, and Computation
                   2460: \&.%I Addison-Wesley
                   2461: \&.%C Reading, Massachusettes
                   2462: \&.%D 1979
                   2463: \&.Re
                   2464: .Ed
                   2465: .Pp
                   2466: If an
                   2467: .Sx \&Rs
                   2468: block is used within a SEE ALSO section, a vertical space is asserted
                   2469: before the rendered output, else the block continues on the current
                   2470: line.
                   2471: .Ss \&Rv
1.193   ! schwarze 2472: Insert a standard sentence regarding a function call's return value of 0
1.191     kristaps 2473: on success and \-1 on error, with the
                   2474: .Va errno
                   2475: libc global variable set on error.
                   2476: Its syntax is as follows:
                   2477: .Pp
1.193   ! schwarze 2478: .D1 Pf \. Sx \&Rv Fl std Op Ar function ...
1.191     kristaps 2479: .Pp
1.139     kristaps 2480: If
                   2481: .Ar function
1.191     kristaps 2482: is not specified, the document's name set by
1.139     kristaps 2483: .Sx \&Nm
1.191     kristaps 2484: is used.
                   2485: Multiple
                   2486: .Ar function
                   2487: arguments are treated as separate functions.
1.139     kristaps 2488: .Pp
                   2489: See also
                   2490: .Sx \&Ex .
1.63      kristaps 2491: .Ss \&Sc
1.138     kristaps 2492: Close single-quoted context opened by
                   2493: .Sx \&So .
1.63      kristaps 2494: .Ss \&Sh
1.138     kristaps 2495: Begin a new section.
                   2496: For a list of conventional manual sections, see
                   2497: .Sx MANUAL STRUCTURE .
                   2498: These sections should be used unless it's absolutely necessary that
                   2499: custom sections be used.
                   2500: .Pp
                   2501: Section names should be unique so that they may be keyed by
                   2502: .Sx \&Sx .
                   2503: .Pp
                   2504: See also
                   2505: .Sx \&Pp ,
                   2506: .Sx \&Ss ,
                   2507: and
                   2508: .Sx \&Sx .
1.63      kristaps 2509: .Ss \&Sm
1.134     schwarze 2510: Switches the spacing mode for output generated from macros.
                   2511: Its syntax is as follows:
                   2512: .Pp
                   2513: .D1 Pf \. Sx \&Sm Cm on | off
                   2514: .Pp
                   2515: By default, spacing is
1.193   ! schwarze 2516: .Cm on .
1.134     schwarze 2517: When switched
1.193   ! schwarze 2518: .Cm off ,
1.134     schwarze 2519: no white space is inserted between macro arguments and between the
1.185     kristaps 2520: output generated from adjacent macros, but text lines
1.134     schwarze 2521: still get normal spacing between words and sentences.
1.63      kristaps 2522: .Ss \&So
1.138     kristaps 2523: Multi-line version of
                   2524: .Sx \&Sq .
1.63      kristaps 2525: .Ss \&Sq
1.138     kristaps 2526: Encloses its arguments in
                   2527: .Dq typewriter
                   2528: single-quotes.
                   2529: .Pp
                   2530: See also
                   2531: .Sx \&Dq ,
                   2532: .Sx \&Qq ,
                   2533: and
                   2534: .Sx \&So .
1.63      kristaps 2535: .Ss \&Ss
1.138     kristaps 2536: Begin a new sub-section.
                   2537: Unlike with
                   2538: .Sx \&Sh ,
                   2539: there's no convention for sub-sections.
                   2540: Conventional sections, as described in
                   2541: .Sx MANUAL STRUCTURE ,
                   2542: rarely have sub-sections.
                   2543: .Pp
                   2544: Sub-section names should be unique so that they may be keyed by
                   2545: .Sx \&Sx .
                   2546: .Pp
                   2547: See also
                   2548: .Sx \&Pp ,
                   2549: .Sx \&Sh ,
                   2550: and
                   2551: .Sx \&Sx .
1.63      kristaps 2552: .Ss \&St
1.139     kristaps 2553: Replace an abbreviation for a standard with the full form.
                   2554: The following standards are recognised:
                   2555: .Pp
                   2556: .Bl -tag -width "-p1003.1g-2000X" -compact
                   2557: .It \-p1003.1-88
                   2558: .St -p1003.1-88
                   2559: .It \-p1003.1-90
                   2560: .St -p1003.1-90
                   2561: .It \-p1003.1-96
                   2562: .St -p1003.1-96
                   2563: .It \-p1003.1-2001
                   2564: .St -p1003.1-2001
                   2565: .It \-p1003.1-2004
                   2566: .St -p1003.1-2004
                   2567: .It \-p1003.1-2008
                   2568: .St -p1003.1-2008
                   2569: .It \-p1003.1
                   2570: .St -p1003.1
                   2571: .It \-p1003.1b
                   2572: .St -p1003.1b
                   2573: .It \-p1003.1b-93
                   2574: .St -p1003.1b-93
                   2575: .It \-p1003.1c-95
                   2576: .St -p1003.1c-95
                   2577: .It \-p1003.1g-2000
                   2578: .St -p1003.1g-2000
                   2579: .It \-p1003.1i-95
                   2580: .St -p1003.1i-95
                   2581: .It \-p1003.2-92
                   2582: .St -p1003.2-92
                   2583: .It \-p1003.2a-92
                   2584: .St -p1003.2a-92
                   2585: .It \-p1387.2-95
                   2586: .St -p1387.2-95
                   2587: .It \-p1003.2
                   2588: .St -p1003.2
                   2589: .It \-p1387.2
                   2590: .St -p1387.2
                   2591: .It \-isoC
                   2592: .St -isoC
                   2593: .It \-isoC-90
                   2594: .St -isoC-90
                   2595: .It \-isoC-amd1
                   2596: .St -isoC-amd1
                   2597: .It \-isoC-tcor1
                   2598: .St -isoC-tcor1
                   2599: .It \-isoC-tcor2
                   2600: .St -isoC-tcor2
                   2601: .It \-isoC-99
                   2602: .St -isoC-99
                   2603: .It \-iso9945-1-90
                   2604: .St -iso9945-1-90
                   2605: .It \-iso9945-1-96
                   2606: .St -iso9945-1-96
                   2607: .It \-iso9945-2-93
                   2608: .St -iso9945-2-93
                   2609: .It \-ansiC
                   2610: .St -ansiC
                   2611: .It \-ansiC-89
                   2612: .St -ansiC-89
                   2613: .It \-ansiC-99
                   2614: .St -ansiC-99
                   2615: .It \-ieee754
                   2616: .St -ieee754
                   2617: .It \-iso8802-3
                   2618: .St -iso8802-3
                   2619: .It \-ieee1275-94
                   2620: .St -ieee1275-94
                   2621: .It \-xpg3
                   2622: .St -xpg3
                   2623: .It \-xpg4
                   2624: .St -xpg4
                   2625: .It \-xpg4.2
                   2626: .St -xpg4.2
                   2627: .St -xpg4.3
                   2628: .It \-xbd5
                   2629: .St -xbd5
                   2630: .It \-xcu5
                   2631: .St -xcu5
                   2632: .It \-xsh5
                   2633: .St -xsh5
                   2634: .It \-xns5
                   2635: .St -xns5
                   2636: .It \-xns5.2
                   2637: .St -xns5.2
                   2638: .It \-xns5.2d2.0
                   2639: .St -xns5.2d2.0
                   2640: .It \-xcurses4.2
                   2641: .St -xcurses4.2
                   2642: .It \-susv2
                   2643: .St -susv2
                   2644: .It \-susv3
                   2645: .St -susv3
                   2646: .It \-svid4
                   2647: .St -svid4
                   2648: .El
1.63      kristaps 2649: .Ss \&Sx
1.138     kristaps 2650: Reference a section or sub-section.
                   2651: The referenced section or sub-section name must be identical to the
                   2652: enclosed argument, including whitespace.
                   2653: .Pp
                   2654: Examples:
1.173     kristaps 2655: .Dl \&.Sx MANUAL STRUCTURE
1.172     kristaps 2656: .Pp
                   2657: See also
                   2658: .Sx \&Sh
                   2659: and
                   2660: .Sx \&Ss .
1.63      kristaps 2661: .Ss \&Sy
1.138     kristaps 2662: Format enclosed arguments in symbolic
                   2663: .Pq Dq boldface .
                   2664: Note that this is a presentation term and should not be used for
                   2665: stylistically decorating technical terms.
                   2666: .Pp
                   2667: See also
                   2668: .Sx \&Bf ,
                   2669: .Sx \&Li ,
                   2670: and
                   2671: .Sx \&Em .
1.190     schwarze 2672: .Ss \&Ta
                   2673: Table cell separator in
                   2674: .Sx \&Bl Fl column
                   2675: lists; can only be used below
                   2676: .Sx \&It .
1.63      kristaps 2677: .Ss \&Tn
1.138     kristaps 2678: Format a tradename.
                   2679: .Pp
                   2680: Examples:
1.173     kristaps 2681: .Dl \&.Tn IBM
1.63      kristaps 2682: .Ss \&Ud
1.110     kristaps 2683: Prints out
1.144     schwarze 2684: .Dq currently under development .
1.63      kristaps 2685: .Ss \&Ux
1.100     kristaps 2686: Format the UNIX name.
                   2687: Accepts no argument.
1.65      kristaps 2688: .Pp
                   2689: Examples:
1.173     kristaps 2690: .Dl \&.Ux
1.65      kristaps 2691: .Pp
                   2692: See also
                   2693: .Sx \&At ,
1.66      kristaps 2694: .Sx \&Bsx ,
1.65      kristaps 2695: .Sx \&Bx ,
1.66      kristaps 2696: .Sx \&Dx ,
1.65      kristaps 2697: .Sx \&Fx ,
                   2698: .Sx \&Nx ,
                   2699: and
                   2700: .Sx \&Ox .
1.63      kristaps 2701: .Ss \&Va
1.132     kristaps 2702: A variable name.
                   2703: .Pp
                   2704: Examples:
1.173     kristaps 2705: .Dl \&.Va foo
                   2706: .Dl \&.Va const char *bar ;
1.63      kristaps 2707: .Ss \&Vt
1.100     kristaps 2708: A variable type.
1.122     kristaps 2709: This is also used for indicating global variables in the
                   2710: .Em SYNOPSIS
1.100     kristaps 2711: section, in which case a variable name is also specified.
                   2712: Note that it accepts
1.83      kristaps 2713: .Sx Block partial-implicit
1.123     kristaps 2714: syntax when invoked as the first macro in the
1.122     kristaps 2715: .Em SYNOPSIS
                   2716: section, else it accepts ordinary
1.83      kristaps 2717: .Sx In-line
                   2718: syntax.
                   2719: .Pp
                   2720: Note that this should not be confused with
                   2721: .Sx \&Ft ,
                   2722: which is used for function return types.
                   2723: .Pp
                   2724: Examples:
1.173     kristaps 2725: .Dl \&.Vt unsigned char
                   2726: .Dl \&.Vt extern const char * const sys_signame[] \&;
1.83      kristaps 2727: .Pp
                   2728: See also
1.122     kristaps 2729: .Sx MANUAL STRUCTURE
1.83      kristaps 2730: and
                   2731: .Sx \&Va .
1.84      kristaps 2732: .Ss \&Xc
1.87      kristaps 2733: Close a scope opened by
                   2734: .Sx \&Xo .
1.84      kristaps 2735: .Ss \&Xo
1.170     schwarze 2736: Extend the header of an
                   2737: .Sx \&It
                   2738: macro or the body of a partial-implicit block macro
                   2739: beyond the end of the input line.
                   2740: This macro originally existed to work around the 9-argument limit
                   2741: of historic
                   2742: .Xr roff 7 .
1.84      kristaps 2743: .Ss \&Xr
                   2744: Link to another manual
                   2745: .Pq Qq cross-reference .
1.120     kristaps 2746: Its syntax is as follows:
1.84      kristaps 2747: .Pp
1.185     kristaps 2748: .D1 Pf \. Sx \&Xr Ar name section
1.84      kristaps 2749: .Pp
                   2750: The
1.185     kristaps 2751: .Ar name
1.84      kristaps 2752: and
1.185     kristaps 2753: .Ar section
1.100     kristaps 2754: are the name and section of the linked manual.
                   2755: If
1.185     kristaps 2756: .Ar section
1.84      kristaps 2757: is followed by non-punctuation, an
                   2758: .Sx \&Ns
1.100     kristaps 2759: is inserted into the token stream.
                   2760: This behaviour is for compatibility with
1.148     kristaps 2761: GNU troff.
1.84      kristaps 2762: .Pp
                   2763: Examples:
1.173     kristaps 2764: .Dl \&.Xr mandoc 1
                   2765: .Dl \&.Xr mandoc 1 \&;
                   2766: .Dl \&.Xr mandoc 1 \&Ns s behaviour
1.84      kristaps 2767: .Ss \&br
1.140     kristaps 2768: Emits a line-break.
                   2769: This macro should not be used; it is implemented for compatibility with
                   2770: historical manuals.
                   2771: .Pp
                   2772: Consider using
                   2773: .Sx \&Pp
                   2774: in the event of natural paragraph breaks.
1.84      kristaps 2775: .Ss \&sp
1.140     kristaps 2776: Emits vertical space.
                   2777: This macro should not be used; it is implemented for compatibility with
                   2778: historical manuals.
                   2779: Its syntax is as follows:
                   2780: .Pp
1.185     kristaps 2781: .D1 Pf \. Sx \&sp Op Ar height
1.140     kristaps 2782: .Pp
                   2783: The
1.185     kristaps 2784: .Ar height
1.140     kristaps 2785: argument must be formatted as described in
                   2786: .Sx Scaling Widths .
                   2787: If unspecified,
                   2788: .Sx \&sp
                   2789: asserts a single vertical space.
1.4       kristaps 2790: .Sh COMPATIBILITY
1.93      kristaps 2791: This section documents compatibility between mandoc and other other
                   2792: troff implementations, at this time limited to GNU troff
                   2793: .Pq Qq groff .
1.50      kristaps 2794: The term
1.57      kristaps 2795: .Qq historic groff
1.166     schwarze 2796: refers to groff versions before 1.17,
                   2797: which featured a significant update of the
1.57      kristaps 2798: .Pa doc.tmac
1.166     schwarze 2799: file.
1.57      kristaps 2800: .Pp
1.93      kristaps 2801: Heirloom troff, the other significant troff implementation accepting
                   2802: \-mdoc, is similar to historic groff.
                   2803: .Pp
1.150     kristaps 2804: The following problematic behaviour is found in groff:
                   2805: .ds hist (Historic groff only.)
                   2806: .Pp
1.57      kristaps 2807: .Bl -dash -compact
1.168     kristaps 2808: .It
                   2809: Display macros
1.171     schwarze 2810: .Po
                   2811: .Sx \&Bd ,
                   2812: .Sx \&Dl ,
                   2813: and
                   2814: .Sx \&D1
                   2815: .Pc
1.168     kristaps 2816: may not be nested.
                   2817: \*[hist]
1.147     kristaps 2818: .It
1.150     kristaps 2819: .Sx \&At
                   2820: with unknown arguments produces no output at all.
                   2821: \*[hist]
                   2822: Newer groff and mandoc print
                   2823: .Qq AT&T UNIX
                   2824: and the arguments.
1.149     kristaps 2825: .It
1.190     schwarze 2826: .Sx \&Bl Fl column
1.150     kristaps 2827: does not recognize trailing punctuation characters when they immediately
                   2828: precede tabulator characters, but treats them as normal text and
                   2829: outputs a space before them.
                   2830: .It
                   2831: .Sx \&Bd Fl ragged compact
                   2832: does not start a new line.
                   2833: \*[hist]
1.142     kristaps 2834: .It
1.150     kristaps 2835: .Sx \&Dd
1.181     schwarze 2836: with non-standard arguments behaves very strangely.
                   2837: When there are three arguments, they are printed verbatim.
                   2838: Any other number of arguments is replaced by the current date,
                   2839: but without any arguments the string
                   2840: .Dq Epoch
                   2841: is printed.
1.125     kristaps 2842: .It
1.150     kristaps 2843: .Sx \&Fl
                   2844: does not print a dash for an empty argument.
                   2845: \*[hist]
1.137     kristaps 2846: .It
1.150     kristaps 2847: .Sx \&Fn
                   2848: does not start a new line unless invoked as the line macro in the
                   2849: .Em SYNOPSIS
                   2850: section.
                   2851: \*[hist]
1.119     kristaps 2852: .It
1.150     kristaps 2853: .Sx \&Fo
                   2854: with
1.120     kristaps 2855: .Pf non- Sx \&Fa
1.150     kristaps 2856: children causes inconsistent spacing between arguments.
                   2857: In mandoc, a single space is always inserted between arguments.
1.120     kristaps 2858: .It
                   2859: .Sx \&Ft
                   2860: in the
1.150     kristaps 2861: .Em SYNOPSIS
                   2862: causes inconsistent vertical spacing, depending on whether a prior
1.120     kristaps 2863: .Sx \&Fn
                   2864: has been invoked.
                   2865: See
                   2866: .Sx \&Ft
                   2867: and
                   2868: .Sx \&Fn
1.150     kristaps 2869: for the normalised behaviour in mandoc.
1.120     kristaps 2870: .It
1.150     kristaps 2871: .Sx \&In
                   2872: ignores additional arguments and is not treated specially in the
                   2873: .Em SYNOPSIS .
                   2874: \*[hist]
1.118     kristaps 2875: .It
1.150     kristaps 2876: .Sx \&It
                   2877: sometimes requires a
                   2878: .Fl nested
                   2879: flag.
                   2880: \*[hist]
                   2881: In new groff and mandoc, any list may be nested by default and
                   2882: .Fl enum
                   2883: lists will restart the sequence only for the sub-list.
1.115     kristaps 2884: .It
1.150     kristaps 2885: .Sx \&Li
                   2886: followed by a reserved character is incorrectly used in some manuals
                   2887: instead of properly quoting that character, which sometimes works with
                   2888: historic groff.
1.57      kristaps 2889: .It
1.150     kristaps 2890: .Sx \&Lk
                   2891: only accepts a single link-name argument; the remainder is misformatted.
1.81      kristaps 2892: .It
1.80      kristaps 2893: .Sx \&Pa
1.150     kristaps 2894: does not format its arguments when used in the FILES section under
1.100     kristaps 2895: certain list types.
1.80      kristaps 2896: .It
1.150     kristaps 2897: .Sx \&Ta
                   2898: can only be called by other macros, but not at the beginning of a line.
                   2899: .It
                   2900: .Sx \&%C
                   2901: is not implemented.
1.166     schwarze 2902: .It
                   2903: Historic groff only allows up to eight or nine arguments per macro input
                   2904: line, depending on the exact situation.
                   2905: Providing more arguments causes garbled output.
                   2906: The number of arguments on one input line is not limited with mandoc.
1.150     kristaps 2907: .It
                   2908: Historic groff has many un-callable macros.
                   2909: Most of these (excluding some block-level macros) are callable
                   2910: in new groff and mandoc.
                   2911: .It
                   2912: .Sq \(ba
                   2913: (vertical bar) is not fully supported as a delimiter.
                   2914: \*[hist]
1.79      kristaps 2915: .It
1.77      kristaps 2916: .Sq \ef
1.150     kristaps 2917: .Pq font face
                   2918: and
                   2919: .Sq \ef
                   2920: .Pq font family face
1.93      kristaps 2921: .Sx Text Decoration
1.150     kristaps 2922: escapes behave irregularly when specified within line-macro scopes.
1.77      kristaps 2923: .It
1.150     kristaps 2924: Negative scaling units return to prior lines.
                   2925: Instead, mandoc truncates them to zero.
                   2926: .El
                   2927: .Pp
                   2928: The following features are unimplemented in mandoc:
                   2929: .Pp
                   2930: .Bl -dash -compact
1.61      kristaps 2931: .It
1.150     kristaps 2932: .Sx \&Bd
                   2933: .Fl file Ar file .
1.57      kristaps 2934: .It
1.78      kristaps 2935: .Sx \&Bd
1.126     kristaps 2936: .Fl offset Ar center
1.64      kristaps 2937: and
1.150     kristaps 2938: .Fl offset Ar right .
                   2939: Groff does not implement centered and flush-right rendering either,
                   2940: but produces large indentations.
                   2941: .It
                   2942: The
                   2943: .Sq \eh
                   2944: .Pq horizontal position ,
                   2945: .Sq \ev
                   2946: .Pq vertical position ,
                   2947: .Sq \em
                   2948: .Pq text colour ,
                   2949: .Sq \eM
                   2950: .Pq text filling colour ,
1.152     kristaps 2951: .Sq \ez
                   2952: .Pq zero-length character ,
1.153     kristaps 2953: .Sq \ew
                   2954: .Pq string length ,
1.154     kristaps 2955: .Sq \ek
                   2956: .Pq horizontal position marker ,
1.157     kristaps 2957: .Sq \eo
                   2958: .Pq text overstrike ,
1.64      kristaps 2959: and
1.150     kristaps 2960: .Sq \es
                   2961: .Pq text size
1.153     kristaps 2962: escape sequences are all discarded in mandoc.
1.57      kristaps 2963: .It
1.150     kristaps 2964: The
                   2965: .Sq \ef
                   2966: scaling unit is accepted by mandoc, but rendered as the default unit.
1.57      kristaps 2967: .It
1.150     kristaps 2968: In quoted literals, groff allows pairwise double-quotes to produce a
                   2969: standalone double-quote in formatted output.
                   2970: This is not supported by mandoc.
1.57      kristaps 2971: .El
1.2       kristaps 2972: .Sh SEE ALSO
1.159     schwarze 2973: .Xr man 1 ,
1.57      kristaps 2974: .Xr mandoc 1 ,
1.180     kristaps 2975: .Xr eqn 7 ,
1.174     kristaps 2976: .Xr man 7 ,
1.57      kristaps 2977: .Xr mandoc_char 7
1.174     kristaps 2978: .Xr roff 7 ,
                   2979: .Xr tbl 7
1.151     kristaps 2980: .Sh HISTORY
                   2981: The
                   2982: .Nm
                   2983: language first appeared as a troff macro package in
                   2984: .Bx 4.4 .
                   2985: It was later significantly updated by Werner Lemberg and Ruslan Ermilov
1.155     kristaps 2986: in groff-1.17.
1.151     kristaps 2987: The standalone implementation that is part of the
                   2988: .Xr mandoc 1
                   2989: utility written by Kristaps Dzonsons appeared in
                   2990: .Ox 4.6 .
1.2       kristaps 2991: .Sh AUTHORS
                   2992: The
1.57      kristaps 2993: .Nm
1.50      kristaps 2994: reference was written by
1.94      kristaps 2995: .An Kristaps Dzonsons Aq kristaps@bsd.lv .

CVSweb