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

Annotation of mandoc/mdoc.7, Revision 1.212

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

CVSweb