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

Annotation of mandoc/mdoc.7, Revision 1.181

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

CVSweb