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

Annotation of mandoc/mdoc.7, Revision 1.249

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

CVSweb