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

Annotation of mandoc/mdoc.7, Revision 1.286

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

CVSweb