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

Diff for /mandoc/mdoc.7 between version 1.243 and 1.275

version 1.243, 2014/11/28 18:09:01 version 1.275, 2019/02/06 22:18:59
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2010, 2011, 2013-2018 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 94  document consists of a document prologue followed by o
Line 94  document consists of a document prologue followed by o
 sections.  sections.
 .Pp  .Pp
 The prologue, which consists of the  The prologue, which consists of the
 .Sx \&Dd ,  .Ic \&Dd ,
 .Sx \&Dt ,  .Ic \&Dt ,
 and  and
 .Sx \&Os  .Ic \&Os
 macros in that order, is required for every document.  macros in that order, is required for every document.
 .Pp  .Pp
 The first section (sections are denoted by  The first section (sections are denoted by
 .Sx \&Sh )  .Ic \&Sh )
 must be the NAME section, consisting of at least one  must be the NAME section, consisting of at least one
 .Sx \&Nm  .Ic \&Nm
 followed by  followed by
 .Sx \&Nd .  .Ic \&Nd .
 .Pp  .Pp
 Following that, convention dictates specifying at least the  Following that, convention dictates specifying at least the
 .Em SYNOPSIS  .Em SYNOPSIS
Line 182  Multiple
Line 182  Multiple
 names should be separated by commas.  names should be separated by commas.
 .Pp  .Pp
 The  The
 .Sx \&Nm  .Ic \&Nm
 macro(s) must precede the  macro(s) must precede the
 .Sx \&Nd  .Ic \&Nd
 macro.  macro.
 .Pp  .Pp
 See  See
 .Sx \&Nm  .Ic \&Nm
 and  and
 .Sx \&Nd .  .Ic \&Nd .
 .It Em LIBRARY  .It Em LIBRARY
 The name of the library containing the documented material, which is  The name of the library containing the documented material, which is
 assumed to be a function in a section 2, 3, or 9 manual.  assumed to be a function in a section 2, 3, or 9 manual.
Line 200  The syntax for this is as follows:
Line 200  The syntax for this is as follows:
 .Ed  .Ed
 .Pp  .Pp
 See  See
 .Sx \&Lb .  .Ic \&Lb .
 .It Em SYNOPSIS  .It Em SYNOPSIS
 Documents the utility invocation syntax, function call syntax, or device  Documents the utility invocation syntax, function call syntax, or device
 configuration.  configuration.
Line 231  For the second, function calls (sections 2, 3, 9):
Line 231  For the second, function calls (sections 2, 3, 9):
 .Ed  .Ed
 .Pp  .Pp
 Ordering of  Ordering of
 .Sx \&In ,  .Ic \&In ,
 .Sx \&Vt ,  .Ic \&Vt ,
 .Sx \&Fn ,  .Ic \&Fn ,
 and  and
 .Sx \&Fo  .Ic \&Fo
 macros should follow C header-file conventions.  macros should follow C header-file conventions.
 .Pp  .Pp
 And for the third, configurations (section 4):  And for the third, configurations (section 4):
Line 250  Manuals not in these sections generally don't need a
Line 250  Manuals not in these sections generally don't need a
 Some macros are displayed differently in the  Some macros are displayed differently in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, particularly  section, particularly
 .Sx \&Nm ,  .Ic \&Nm ,
 .Sx \&Cd ,  .Ic \&Cd ,
 .Sx \&Fd ,  .Ic \&Fd ,
 .Sx \&Fn ,  .Ic \&Fn ,
 .Sx \&Fo ,  .Ic \&Fo ,
 .Sx \&In ,  .Ic \&In ,
 .Sx \&Vt ,  .Ic \&Vt ,
 and  and
 .Sx \&Ft .  .Ic \&Ft .
 All of these macros are output on their own line.  All of these macros are output on their own line.
 If two such dissimilar macros are pairwise invoked (except for  If two such dissimilar macros are pairwise invoked (except for
 .Sx \&Ft  .Ic \&Ft
 before  before
 .Sx \&Fo  .Ic \&Fo
 or  or
 .Sx \&Fn ) ,  .Ic \&Fn ) ,
 they are separated by a vertical space, unless in the case of  they are separated by a vertical space, unless in the case of
 .Sx \&Fo ,  .Ic \&Fo ,
 .Sx \&Fn ,  .Ic \&Fn ,
 and  and
 .Sx \&Ft ,  .Ic \&Ft ,
 which are always separated by vertical space.  which are always separated by vertical space.
 .Pp  .Pp
 When text and macros following an  When text and macros following an
 .Sx \&Nm  .Ic \&Nm
 macro starting an input line span multiple output lines,  macro starting an input line span multiple output lines,
 all output lines but the first will be indented to align  all output lines but the first will be indented to align
 with the text immediately following the  with the text immediately following the
 .Sx \&Nm  .Ic \&Nm
 macro, up to the next  macro, up to the next
 .Sx \&Nm ,  .Ic \&Nm ,
 .Sx \&Sh ,  .Ic \&Sh ,
 or  or
 .Sx \&Ss  .Ic \&Ss
 macro or the end of an enclosing block, whichever comes first.  macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION  .It Em DESCRIPTION
 This begins with an expansion of the brief, one line description in  This begins with an expansion of the brief, one line description in
Line 304  Print verbose information.
Line 304  Print verbose information.
 \&.El  \&.El
 .Ed  .Ed
 .Pp  .Pp
   List the options in alphabetical order,
   uppercase before lowercase for each letter and
   with no regard to whether an option takes an argument.
   Put digits in ascending order before all letter options.
   .Pp
 Manuals not documenting a command won't include the above fragment.  Manuals not documenting a command won't include the above fragment.
 .Pp  .Pp
 Since the  Since the
 .Em DESCRIPTION  .Em DESCRIPTION
 section usually contains most of the text of a manual, longer manuals  section usually contains most of the text of a manual, longer manuals
 often use the  often use the
 .Sx \&Ss  .Ic \&Ss
 macro to form subsections.  macro to form subsections.
 In very long manuals, the  In very long manuals, the
 .Em DESCRIPTION  .Em DESCRIPTION
 may be split into multiple sections, each started by an  may be split into multiple sections, each started by an
 .Sx \&Sh  .Ic \&Sh
 macro followed by a non-standard section name, and each having  macro followed by a non-standard section name, and each having
 several subsections, like in the present  several subsections, like in the present
 .Nm  .Nm
Line 332  This section documents the
Line 337  This section documents the
 return values of functions in sections 2, 3, and 9.  return values of functions in sections 2, 3, and 9.
 .Pp  .Pp
 See  See
 .Sx \&Rv .  .Ic \&Rv .
 .It Em ENVIRONMENT  .It Em ENVIRONMENT
 Lists the environment variables used by the utility,  Lists the environment variables used by the utility,
 and explains the syntax and semantics of their values.  and explains the syntax and semantics of their values.
Line 341  The
Line 346  The
 manual provides examples of typical content and formatting.  manual provides examples of typical content and formatting.
 .Pp  .Pp
 See  See
 .Sx \&Ev .  .Ic \&Ev .
 .It Em FILES  .It Em FILES
 Documents files used.  Documents files used.
 It's helpful to document both the file name and a short description of how  It's helpful to document both the file name and a short description of how
 the file is used (created, modified, etc.).  the file is used (created, modified, etc.).
 .Pp  .Pp
 See  See
 .Sx \&Pa .  .Ic \&Pa .
 .It Em EXIT STATUS  .It Em EXIT STATUS
 This section documents the  This section documents the
 command exit status for section 1, 6, and 8 utilities.  command exit status for section 1, 6, and 8 utilities.
Line 357  Historically, this information was described in
Line 362  Historically, this information was described in
 a practise that is now discouraged.  a practise that is now discouraged.
 .Pp  .Pp
 See  See
 .Sx \&Ex .  .Ic \&Ex .
 .It Em EXAMPLES  .It Em EXAMPLES
 Example usages.  Example usages.
 This often contains snippets of well-formed, well-tested invocations.  This often contains snippets of well-formed, well-tested invocations.
Line 375  for manuals in sections 1, 6, and 8; however, this pra
Line 380  for manuals in sections 1, 6, and 8; however, this pra
 discouraged.  discouraged.
 .Pp  .Pp
 See  See
 .Sx \&Bl  .Ic \&Bl
 .Fl diag .  .Fl diag .
 .It Em ERRORS  .It Em ERRORS
 Documents  Documents
Line 383  Documents
Line 388  Documents
 settings in sections 2, 3, 4, and 9.  settings in sections 2, 3, 4, and 9.
 .Pp  .Pp
 See  See
 .Sx \&Er .  .Ic \&Er .
 .It Em SEE ALSO  .It Em SEE ALSO
 References other manuals with related topics.  References other manuals with related topics.
 This section should exist for most manuals.  This section should exist for most manuals.
Line 395  for example authoritative books or journal articles, m
Line 400  for example authoritative books or journal articles, m
 provided in this section.  provided in this section.
 .Pp  .Pp
 See  See
 .Sx \&Rs  .Ic \&Rs
 and  and
 .Sx \&Xr .  .Ic \&Xr .
 .It Em STANDARDS  .It Em STANDARDS
 References any standards implemented or used.  References any standards implemented or used.
 If not adhering to any standards, the  If not adhering to any standards, the
Line 405  If not adhering to any standards, the
Line 410  If not adhering to any standards, the
 section should be used instead.  section should be used instead.
 .Pp  .Pp
 See  See
 .Sx \&St .  .Ic \&St .
 .It Em HISTORY  .It Em HISTORY
 A brief history of the subject, including where it was first implemented,  A brief history of the subject, including where it was first implemented,
 and when it was ported to or reimplemented for the operating system at hand.  and when it was ported to or reimplemented for the operating system at hand.
Line 414  Credits to the person or persons who wrote the code an
Line 419  Credits to the person or persons who wrote the code an
 Authors should generally be noted by both name and email address.  Authors should generally be noted by both name and email address.
 .Pp  .Pp
 See  See
 .Sx \&An .  .Ic \&An .
 .It Em CAVEATS  .It Em CAVEATS
 Common misuses and misunderstandings should be explained  Common misuses and misunderstandings should be explained
 in this section.  in this section.
Line 432  in the alphabetical
Line 437  in the alphabetical
 .Sx MACRO REFERENCE .  .Sx MACRO REFERENCE .
 .Ss Document preamble and NAME section macros  .Ss Document preamble and NAME section macros
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year  .It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
 .It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch  .It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch
 .It Sx \&Os Ta operating system version: Op Ar system Op Ar version  .It Ic \&Os Ta operating system version: Op Ar system Op Ar version
 .It Sx \&Nm Ta document name (one argument)  .It Ic \&Nm Ta document name (one argument)
 .It Sx \&Nd Ta document description (one line)  .It Ic \&Nd Ta document description (one line)
 .El  .El
 .Ss Sections and cross references  .Ss Sections and cross references
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Sh Ta section header (one line)  .It Ic \&Sh Ta section header (one line)
 .It Sx \&Ss Ta subsection header (one line)  .It Ic \&Ss Ta subsection header (one line)
 .It Sx \&Sx Ta internal cross reference to a section or subsection  .It Ic \&Sx Ta internal cross reference to a section or subsection
 .It Sx \&Xr Ta cross reference to another manual page: Ar name section  .It Ic \&Xr Ta cross reference to another manual page: Ar name section
 .It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)  .It Ic \&Pp Ta start a text paragraph (no arguments)
 .El  .El
 .Ss Displays and lists  .Ss Displays and lists
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Bd , \&Ed Ta display block:  .It Ic \&Bd , \&Ed Ta display block:
 .Fl Ar type  .Fl Ar type
 .Op Fl offset Ar width  .Op Fl offset Ar width
 .Op Fl compact  .Op Fl compact
 .It Sx \&D1 Ta indented display (one line)  .It Ic \&D1 Ta indented display (one line)
 .It Sx \&Dl Ta indented literal display (one line)  .It Ic \&Dl Ta indented literal display (one line)
 .It Sx \&Bl , \&El Ta list block:  .It Ic \&Ql Ta in-line literal display: Ql text
   .It Ic \&Bl , \&El Ta list block:
 .Fl Ar type  .Fl Ar type
 .Op Fl width Ar val  .Op Fl width Ar val
 .Op Fl offset Ar val  .Op Fl offset Ar val
 .Op Fl compact  .Op Fl compact
 .It Sx \&It Ta list item (syntax depends on Fl Ar type )  .It Ic \&It Ta list item (syntax depends on Fl Ar type )
 .It Sx \&Ta Ta table cell separator in Sx \&Bl Fl column No lists  .It Ic \&Ta Ta table cell separator in Ic \&Bl Fl column No lists
 .It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)  .It Ic \&Rs , \&%* , \&Re Ta bibliographic block (references)
 .El  .El
 .Ss Spacing control  .Ss Spacing control
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Pf Ta prefix, no following horizontal space (one argument)  .It Ic \&Pf Ta prefix, no following horizontal space (one argument)
 .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)  .It Ic \&Ns Ta roman font, no preceding horizontal space (no arguments)
 .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)  .It Ic \&Ap Ta apostrophe without surrounding whitespace (no arguments)
 .It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off  .It Ic \&Sm Ta switch horizontal spacing mode: Op Cm on | off
 .It Sx \&Bk , \&Ek Ta keep block: Fl words  .It Ic \&Bk , \&Ek Ta keep block: Fl words
 .It Sx \&br Ta force output line break in text mode (no arguments)  
 .It Sx \&sp Ta force vertical space: Op Ar height  
 .El  .El
 .Ss Semantic markup for command line utilities:  .Ss Semantic markup for command line utilities
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility  .It Ic \&Nm Ta start a SYNOPSIS block with the name of a utility
 .It Sx \&Fl Ta command line options (flags) (>=0 arguments)  .It Ic \&Fl Ta command line options (flags) (>=0 arguments)
 .It Sx \&Cm Ta command modifier (>0 arguments)  .It Ic \&Cm Ta command modifier (>0 arguments)
 .It Sx \&Ar Ta command arguments (>=0 arguments)  .It Ic \&Ar Ta command arguments (>=0 arguments)
 .It Sx \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)  .It Ic \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)
 .It Sx \&Ic Ta internal or interactive command (>0 arguments)  .It Ic \&Ic Ta internal or interactive command (>0 arguments)
 .It Sx \&Ev Ta environmental variable (>0 arguments)  .It Ic \&Ev Ta environmental variable (>0 arguments)
 .It Sx \&Pa Ta file system path (>=0 arguments)  .It Ic \&Pa Ta file system path (>=0 arguments)
 .El  .El
 .Ss Semantic markup for function libraries:  .Ss Semantic markup for function libraries
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Lb Ta function library (one argument)  .It Ic \&Lb Ta function library (one argument)
 .It Sx \&In Ta include file (one argument)  .It Ic \&In Ta include file (one argument)
 .It Sx \&Fd Ta other preprocessor directive (>0 arguments)  .It Ic \&Fd Ta other preprocessor directive (>0 arguments)
 .It Sx \&Ft Ta function type (>0 arguments)  .It Ic \&Ft Ta function type (>0 arguments)
 .It Sx \&Fo , \&Fc Ta function block: Ar funcname  .It Ic \&Fo , \&Fc Ta function block: Ar funcname
 .It Sx \&Fn Ta function name:  .It Ic \&Fn Ta function name: Ar funcname Op Ar argument ...
 .Op Ar functype  .It Ic \&Fa Ta function argument (>0 arguments)
 .Ar funcname  .It Ic \&Vt Ta variable type (>0 arguments)
 .Oo  .It Ic \&Va Ta variable name (>0 arguments)
 .Op Ar argtype  .It Ic \&Dv Ta defined variable or preprocessor constant (>0 arguments)
 .Ar argname  .It Ic \&Er Ta error constant (>0 arguments)
 .Oc  .It Ic \&Ev Ta environmental variable (>0 arguments)
 .It Sx \&Fa Ta function argument (>0 arguments)  
 .It Sx \&Vt Ta variable type (>0 arguments)  
 .It Sx \&Va Ta variable name (>0 arguments)  
 .It Sx \&Dv Ta defined variable or preprocessor constant (>0 arguments)  
 .It Sx \&Er Ta error constant (>0 arguments)  
 .It Sx \&Ev Ta environmental variable (>0 arguments)  
 .El  .El
 .Ss Various semantic markup:  .Ss Various semantic markup
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&An Ta author name (>0 arguments)  .It Ic \&An Ta author name (>0 arguments)
 .It Sx \&Lk Ta hyperlink: Ar uri Op Ar name  .It Ic \&Lk Ta hyperlink: Ar uri Op Ar display_name
 .It Sx \&Mt Ta Do mailto Dc hyperlink: Ar address  .It Ic \&Mt Ta Do mailto Dc hyperlink: Ar localpart Ns @ Ns Ar domain
 .It Sx \&Cd Ta kernel configuration declaration (>0 arguments)  .It Ic \&Cd Ta kernel configuration declaration (>0 arguments)
 .It Sx \&Ad Ta memory address (>0 arguments)  .It Ic \&Ad Ta memory address (>0 arguments)
 .It Sx \&Ms Ta mathematical symbol (>0 arguments)  .It Ic \&Ms Ta mathematical symbol (>0 arguments)
 .El  .El
 .Ss Physical markup  .Ss Physical markup
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)  .It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments)
 .It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)  .It Ic \&Sy Ta boldface font (symbolic) (>0 arguments)
 .It Sx \&Li Ta typewriter font (literal) (>0 arguments)  .It Ic \&No Ta return to roman font (normal) (>0 arguments)
 .It Sx \&No Ta return to roman font (normal) (no arguments)  .It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy
 .It Sx \&Bf , \&Ef Ta font block:  
 .Op Fl Ar type | Cm \&Em | \&Li | \&Sy  
 .El  .El
 .Ss Physical enclosures  .Ss Physical enclosures
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text  .It Ic \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
 .It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text  .It Ic \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
 .It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text  .It Ic \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
 .It Sx \&Ql Ta single-quoted literal text: Ql text  .It Ic \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
 .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text  .It Ic \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
 .It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text  .It Ic \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
 .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text  .It Ic \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
 .It Sx \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text  .It Ic \&Eo , \&Ec Ta generic enclosure
 .It Sx \&Eo , \&Ec Ta generic enclosure  
 .El  .El
 .Ss Text production  .Ss Text production
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ...  .It Ic \&Ex Fl std Ta standard command exit values: Op Ar utility ...
 .It Sx \&Rv Fl std Ta standard function return values: Op Ar function ...  .It Ic \&Rv Fl std Ta standard function return values: Op Ar function ...
 .It Sx \&St Ta reference to a standards document (one argument)  .It Ic \&St Ta reference to a standards document (one argument)
 .It Sx \&At Ta At  .It Ic \&At Ta At
 .It Sx \&Bx Ta Bx  .It Ic \&Bx Ta Bx
 .It Sx \&Bsx Ta Bsx  .It Ic \&Bsx Ta Bsx
 .It Sx \&Nx Ta Nx  .It Ic \&Nx Ta Nx
 .It Sx \&Fx Ta Fx  .It Ic \&Fx Ta Fx
 .It Sx \&Ox Ta Ox  .It Ic \&Ox Ta Ox
 .It Sx \&Dx Ta Dx  .It Ic \&Dx Ta Dx
 .El  .El
 .Sh MACRO REFERENCE  .Sh MACRO REFERENCE
 This section is a canonical reference of all macros, arranged  This section is a canonical reference of all macros, arranged
 alphabetically.  alphabetically.
 For the scoping of individual macros, see  For the scoping of individual macros, see
 .Sx MACRO SYNTAX .  .Sx MACRO SYNTAX .
 .Ss \&%A  .Bl -tag -width 3n
   .It Ic \&%A Ar first_name ... last_name
 Author name of an  Author name of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 Multiple authors should each be accorded their own  Multiple authors should each be accorded their own
 .Sx \%%A  .Ic \%%A
 line.  line.
 Author names should be ordered with full or abbreviated forename(s)  Author names should be ordered with full or abbreviated forename(s)
 first, then full surname.  first, then full surname.
 .Ss \&%B  .It Ic \&%B Ar title
 Book title of an  Book title of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 This macro may also be used in a non-bibliographic context when  This macro may also be used in a non-bibliographic context when
 referring to book titles.  referring to book titles.
 .Ss \&%C  .It Ic \&%C Ar location
 Publication city or location of an  Publication city or location of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%D  .It Ic \&%D Oo Ar month day , Oc Ar year
 Publication date of an  Publication date of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 Recommended formats of arguments are  Provide the full English name of the
 .Ar month day , year  .Ar month
 or just  and all four digits of the
 .Ar year .  .Ar year .
 .Ss \&%I  .It Ic \&%I Ar name
 Publisher or issuer name of an  Publisher or issuer name of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%J  .It Ic \&%J Ar name
 Journal name of an  Journal name of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%N  .It Ic \&%N Ar number
 Issue number (usually for journals) of an  Issue number (usually for journals) of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%O  .It Ic \&%O Ar line
 Optional information of an  Optional information of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%P  .It Ic \&%P Ar number
 Book or journal page number of an  Book or journal page number of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%Q  .It Ic \&%Q Ar name
 Institutional author (school, government, etc.) of an  Institutional author (school, government, etc.) of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 Multiple institutional authors should each be accorded their own  Multiple institutional authors should each be accorded their own
 .Sx \&%Q  .Ic \&%Q
 line.  line.
 .Ss \&%R  .It Ic \&%R Ar name
 Technical report name of an  Technical report name of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&%T  .It Ic \&%T Ar title
 Article title of an  Article title of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 This macro may also be used in a non-bibliographical context when  This macro may also be used in a non-bibliographical context when
 referring to article titles.  referring to article titles.
 .Ss \&%U  .It Ic \&%U Ar protocol Ns :// Ns Ar path
 URI of reference document.  URI of reference document.
 .Ss \&%V  .It Ic \&%V Ar number
 Volume number of an  Volume number of an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 .Ss \&Ac  .It Ic \&Ac
 Close an  Close an
 .Sx \&Ao  .Ic \&Ao
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Ad  .It Ic \&Ad Ar address
 Memory address.  Memory address.
 Do not use this for postal addresses.  Do not use this for postal addresses.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Ad [0,$]  .Dl \&.Ad [0,$]
 .Dl \&.Ad 0x00000000  .Dl \&.Ad 0x00000000
 .Ss \&An  .It Ic \&An Fl split | nosplit | Ar first_name ... last_name
 Author name.  Author name.
 Can be used both for the authors of the program, function, or driver  Can be used both for the authors of the program, function, or driver
 documented in the manual, or for the authors of the manual itself.  documented in the manual, or for the authors of the manual itself.
Line 644  Requires either the name of an author or one of the fo
Line 640  Requires either the name of an author or one of the fo
 .Bl -tag -width "-nosplitX" -offset indent -compact  .Bl -tag -width "-nosplitX" -offset indent -compact
 .It Fl split  .It Fl split
 Start a new output line before each subsequent invocation of  Start a new output line before each subsequent invocation of
 .Sx \&An .  .Ic \&An .
 .It Fl nosplit  .It Fl nosplit
 The opposite of  The opposite of
 .Fl split .  .Fl split .
Line 668  for all other author listings.
Line 664  for all other author listings.
 Examples:  Examples:
 .Dl \&.An -nosplit  .Dl \&.An -nosplit
 .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Ao  .It Ic \&Ao Ar block
 Begin a block enclosed by angle brackets.  Begin a block enclosed by angle brackets.
 Does not have any head arguments.  Does not have any head arguments.
 .Pp  This macro is almost never useful.
 Examples:  See
 .Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac  .Ic \&Aq
 .Pp  for more details.
 See also  .It Ic \&Ap
 .Sx \&Aq .  
 .Ss \&Ap  
 Inserts an apostrophe without any surrounding whitespace.  Inserts an apostrophe without any surrounding whitespace.
 This is generally used as a grammatical device when referring to the verb  This is generally used as a grammatical device when referring to the verb
 form of a function.  form of a function.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fn execve \&Ap d  .Dl \&.Fn execve \&Ap d
 .Ss \&Aq  .It Ic \&Aq Ar line
 Encloses its arguments in angle brackets.  Enclose the rest of the input line in angle brackets.
   The only important use case is for email addresses.
   See
   .Ic \&Mt
   for an example.
 .Pp  .Pp
 Examples:  Occasionally, it is used for names of characters and keys, for example:
 .Dl \&.Fl -key= \&Ns \&Aq \&Ar val  .Bd -literal -offset indent
   Press the
   \&.Aq escape
   key to ...
   .Ed
 .Pp  .Pp
 .Em Remarks :  For URIs, use
 this macro is often abused for rendering URIs, which should instead use  .Ic \&Lk
 .Sx \&Lk  instead, and
   .Ic \&In
   for
   .Dq #include
   directives.
   Never wrap
   .Ic \&Ar
   in
   .Ic \&Aq .
   .Pp
   Since
   .Ic \&Aq
   usually renders with non-ASCII characters in non-ASCII output modes,
   do not use it where the ASCII characters
   .Sq <
   and
   .Sq >
   are required as syntax elements.
   Instead, use these characters directly in such cases, combining them
   with the macros
   .Ic \&Pf ,
   .Ic \&Ns ,
 or  or
 .Sx \&Mt ,  .Ic \&Eo
 or to note pre-processor  as needed.
 .Dq Li #include  
 statements, which should use  
 .Sx \&In .  
 .Pp  .Pp
 See also  See also
 .Sx \&Ao .  .Ic \&Ao .
 .Ss \&Ar  .It Ic \&Ar Op Ar placeholder ...
 Command arguments.  Command arguments.
 If an argument is not provided, the string  If an argument is not provided, the string
 .Dq file ...\&  .Dq file ...\&
Line 714  Examples:
Line 734  Examples:
 .Dl ".Ar arg1 , arg2 ."  .Dl ".Ar arg1 , arg2 ."
 .Pp  .Pp
 The arguments to the  The arguments to the
 .Sx \&Ar  .Ic \&Ar
 macro are names and placeholders for command arguments;  macro are names and placeholders for command arguments;
 for fixed strings to be passed verbatim as arguments, use  for fixed strings to be passed verbatim as arguments, use
 .Sx \&Fl  .Ic \&Fl
 or  or
 .Sx \&Cm .  .Ic \&Cm .
 .Ss \&At  .It Ic \&At Op Ar version
 Formats an  Formats an
 .At  .At
 version.  version.
Line 732  A version of
Line 752  A version of
 .At .  .At .
 .It Cm III  .It Cm III
 .At III .  .At III .
 .It Cm V[.[1-4]]?  .It Cm V | V.[1-4]
 A version of  A version of
 .At V .  .At V .
 .El  .El
Line 745  Examples:
Line 765  Examples:
 .Dl \&.At V.1  .Dl \&.At V.1
 .Pp  .Pp
 See also  See also
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 .Sx \&Nx ,  .Ic \&Nx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Bc  .It Ic \&Bc
 Close a  Close a
 .Sx \&Bo  .Ic \&Bo
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Bd  .It Ic \&Bd Fl Ns Ar type Oo Fl offset Ar width Oc Op Fl compact
 Begin a display block.  Begin a display block.
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Bd  
 .Fl Ns Ar type  
 .Op Fl offset Ar width  
 .Op Fl compact  
 .Ed  
 .Pp  
 Display blocks are used to select a different indentation and  Display blocks are used to select a different indentation and
 justification than the one used by the surrounding text.  justification than the one used by the surrounding text.
 They may contain both macro lines and text lines.  They may contain both macro lines and text lines.
Line 777  The
Line 789  The
 must be one of the following:  must be one of the following:
 .Bl -tag -width 13n -offset indent  .Bl -tag -width 13n -offset indent
 .It Fl centered  .It Fl centered
 Produce one output line from each input line, and centre-justify each line.  Produce one output line from each input line, and center-justify each line.
 Using this display type is not recommended; many  Using this display type is not recommended; many
 .Nm  .Nm
 implementations render it poorly.  implementations render it poorly.
Line 822  which has no effect;
Line 834  which has no effect;
 .Cm right ,  .Cm right ,
 which justifies to the right margin; or  which justifies to the right margin; or
 .Cm center ,  .Cm center ,
 which aligns around an imagined centre axis.  which aligns around an imagined center axis.
 .It  .It
 A macro invocation, which selects a predefined width  A macro invocation, which selects a predefined width
 associated with that macro.  associated with that macro.
Line 852  Examples:
Line 864  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&D1  .Ic \&D1
 and  and
 .Sx \&Dl .  .Ic \&Dl .
 .Ss \&Bf  .It Ic \&Bf Fl emphasis | literal | symbolic | Cm \&Em | \&Li | \&Sy
 Change the font mode for a scoped block of text.  Change the font mode for a scoped block of text.
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Bf  
 .Oo  
 .Fl emphasis | literal | symbolic |  
 .Cm \&Em | \&Li | \&Sy  
 .Oc  
 .Ed  
 .Pp  
 The  The
 .Fl emphasis  .Fl emphasis
 and  and
Line 881  and
Line 884  and
 Without an argument, this macro does nothing.  Without an argument, this macro does nothing.
 The font mode continues until broken by a new font mode in a nested  The font mode continues until broken by a new font mode in a nested
 scope or  scope or
 .Sx \&Ef  .Ic \&Ef
 is encountered.  is encountered.
 .Pp  .Pp
 See also  See also
 .Sx \&Li ,  .Ic \&Li ,
 .Sx \&Ef ,  .Ic \&Ef ,
 .Sx \&Em ,  .Ic \&Em ,
 and  and
 .Sx \&Sy .  .Ic \&Sy .
 .Ss \&Bk  .It Ic \&Bk Fl words
 For each macro, keep its output together on the same output line,  For each macro, keep its output together on the same output line,
 until the end of the macro or the end of the input line is reached,  until the end of the macro or the end of the input line is reached,
 whichever comes first.  whichever comes first.
 Line breaks in text lines are unaffected.  Line breaks in text lines are unaffected.
 The syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Bk Fl words  
 .Pp  
 The  The
 .Fl words  .Fl words
 argument is required; additional arguments are ignored.  argument is required; additional arguments are ignored.
 .Pp  .Pp
 The following example will not break within each  The following example will not break within each
 .Sx \&Op  .Ic \&Op
 macro line:  macro line:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Bk \-words  \&.Bk \-words
Line 915  macro line:
Line 915  macro line:
 .Pp  .Pp
 Be careful in using over-long lines within a keep block!  Be careful in using over-long lines within a keep block!
 Doing so will clobber the right margin.  Doing so will clobber the right margin.
 .Ss \&Bl  .It Xo
 Begin a list.  .Ic \&Bl
 Lists consist of items specified using the  
 .Sx \&It  
 macro, containing a head or a body or both.  
 The list syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Bl  
 .Fl Ns Ar type  .Fl Ns Ar type
 .Op Fl width Ar val  .Op Fl width Ar val
 .Op Fl offset Ar val  .Op Fl offset Ar val
 .Op Fl compact  .Op Fl compact
 .Op HEAD ...  .Op Ar col ...
 .Ed  .Xc
   Begin a list.
   Lists consist of items specified using the
   .Ic \&It
   macro, containing a head or a body or both.
 .Pp  .Pp
 The list  The list
 .Ar type  .Ar type
Line 938  The
Line 936  The
 and  and
 .Fl offset  .Fl offset
 arguments accept macro names as described for  arguments accept macro names as described for
 .Sx \&Bd  .Ic \&Bd
 .Fl offset ,  .Fl offset ,
 scaling widths as described in  scaling widths as described in
 .Xr roff 7 ,  .Xr roff 7 ,
Line 969  argument.
Line 967  argument.
 A columnated list.  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect; instead, each argument specifies the width  argument has no effect; instead, the string length of each argument
 of one column, using either the scaling width syntax described in  specifies the width of one column.
 .Xr roff 7  
 or the string length of the argument.  
 If the first line of the body of a  If the first line of the body of a
 .Fl column  .Fl column
 list is not an  list is not an
 .Sx \&It  .Ic \&It
 macro line,  macro line,
 .Sx \&It  .Ic \&It
 contexts spanning one input line each are implied until an  contexts spanning one input line each are implied until an
 .Sx \&It  .Ic \&It
 macro line is encountered, at which point items start being interpreted as  macro line is encountered, at which point items start being interpreted as
 described in the  described in the
 .Sx \&It  .Ic \&It
 documentation.  documentation.
 .It Fl dash  .It Fl dash
 Like  Like
Line 1046  and
Line 1042  and
 lists may not be portable.  lists may not be portable.
 .Pp  .Pp
 See also  See also
 .Sx \&El  .Ic \&El
 and  and
 .Sx \&It .  .Ic \&It .
 .Ss \&Bo  .It Ic \&Bo Ar block
 Begin a block enclosed by square brackets.  Begin a block enclosed by square brackets.
 Does not have any head arguments.  Does not have any head arguments.
 .Pp  .Pp
Line 1060  Examples:
Line 1056  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Bq .  .Ic \&Bq .
 .Ss \&Bq  .It Ic \&Bq Ar line
 Encloses its arguments in square brackets.  Encloses its arguments in square brackets.
 .Pp  .Pp
 Examples:  Examples:
Line 1070  Examples:
Line 1066  Examples:
 .Em Remarks :  .Em Remarks :
 this macro is sometimes abused to emulate optional arguments for  this macro is sometimes abused to emulate optional arguments for
 commands; the correct macros to use for this purpose are  commands; the correct macros to use for this purpose are
 .Sx \&Op ,  .Ic \&Op ,
 .Sx \&Oo ,  .Ic \&Oo ,
 and  and
 .Sx \&Oc .  .Ic \&Oc .
 .Pp  .Pp
 See also  See also
 .Sx \&Bo .  .Ic \&Bo .
 .Ss \&Brc  .It Ic \&Brc
 Close a  Close a
 .Sx \&Bro  .Ic \&Bro
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Bro  .It Ic \&Bro Ar block
 Begin a block enclosed by curly braces.  Begin a block enclosed by curly braces.
 Does not have any head arguments.  Does not have any head arguments.
 .Pp  .Pp
Line 1093  Examples:
Line 1089  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Brq .  .Ic \&Brq .
 .Ss \&Brq  .It Ic \&Brq Ar line
 Encloses its arguments in curly braces.  Encloses its arguments in curly braces.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Brq 1 , ... , \&Va n  .Dl \&.Brq 1 , ... , \&Va n
 .Pp  .Pp
 See also  See also
 .Sx \&Bro .  .Ic \&Bro .
 .Ss \&Bsx  .It Ic \&Bsx Op Ar version
 Format the  Format the
 .Bsx  .Bsx
 version provided as an argument, or a default value if  version provided as an argument, or a default value if
Line 1113  Examples:
Line 1109  Examples:
 .Dl \&.Bsx  .Dl \&.Bsx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 .Sx \&Nx ,  .Ic \&Nx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Bt  .It Ic \&Bt
 Supported only for compatibility, do not use this in new manuals.  Supported only for compatibility, do not use this in new manuals.
 Prints  Prints
 .Dq is currently in beta test.  .Dq is currently in beta test.
 .Ss \&Bx  .It Ic \&Bx Op Ar version Op Ar variant
 Format the  Format the
 .Bx  .Bx
 version provided as an argument, or a default value if no  version provided as an argument, or a default value if no
Line 1136  Examples:
Line 1132  Examples:
 .Dl \&.Bx  .Dl \&.Bx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 .Sx \&Nx ,  .Ic \&Nx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Cd  .It Ic \&Cd Ar line
 Kernel configuration declaration.  Kernel configuration declaration.
 This denotes strings accepted by  This denotes strings accepted by
 .Xr config 8 .  .Xr config 8 .
Line 1155  Examples:
Line 1151  Examples:
 .Em Remarks :  .Em Remarks :
 this macro is commonly abused by using quoted literals to retain  this macro is commonly abused by using quoted literals to retain
 whitespace and align consecutive  whitespace and align consecutive
 .Sx \&Cd  .Ic \&Cd
 declarations.  declarations.
 This practise is discouraged.  This practise is discouraged.
 .Ss \&Cm  .It Ic \&Cm Ar keyword ...
 Command modifiers.  Command modifiers.
 Typically used for fixed strings passed as arguments, unless  Typically used for fixed strings passed as arguments, unless
 .Sx \&Fl  .Ic \&Fl
 is more appropriate.  is more appropriate.
 Also useful when specifying configuration options or keys.  Also useful when specifying configuration options or keys.
 .Pp  .Pp
Line 1171  Examples:
Line 1167  Examples:
 .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"  .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
 .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"  .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
 .Dl ".Cm LogLevel Dv DEBUG"  .Dl ".Cm LogLevel Dv DEBUG"
 .Ss \&D1  .It Ic \&D1 Ar line
 One-line indented display.  One-line indented display.
 This is formatted by the default rules and is useful for simple indented  This is formatted by the default rules and is useful for simple indented
 statements.  statements.
Line 1181  Examples:
Line 1177  Examples:
 .Dl \&.D1 \&Fl abcdefgh  .Dl \&.D1 \&Fl abcdefgh
 .Pp  .Pp
 See also  See also
 .Sx \&Bd  .Ic \&Bd
 and  and
 .Sx \&Dl .  .Ic \&Dl .
 .Ss \&Db  .It Ic \&Db
 This macro is obsolete.  This macro is obsolete.
 No replacement is needed.  No replacement is needed.
 It is ignored by  It is ignored by
 .Xr mandoc 1  .Xr mandoc 1
 and groff including its arguments.  and groff including its arguments.
 It was formerly used to toggle a debugging mode.  It was formerly used to toggle a debugging mode.
 .Ss \&Dc  .It Ic \&Dc
 Close a  Close a
 .Sx \&Do  .Ic \&Do
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Dd  .It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year
 Document date for display in the page footer.  Document date for display in the page footer.
 This is the mandatory first macro of any  This is the mandatory first macro of any
 .Nm  .Nm
 manual.  manual.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Dd Ar month day , year  
 .Pp  
 The  The
 .Ar month  .Ar month
 is the full English month name, the  is the full English month name, the
 .Ar day  .Ar day
 is an optionally zero-padded numeral, and the  is an integer number, and the
 .Ar year  .Ar year
 is the full four-digit year.  is the full four-digit year.
 .Pp  .Pp
Line 1239  If no date string is given, the current date is used.
Line 1232  If no date string is given, the current date is used.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Dd $\&Mdocdate$  .Dl \&.Dd $\&Mdocdate$
 .Dl \&.Dd $\&Mdocdate: July 21 2007$  .Dl \&.Dd $\&Mdocdate: July 2 2018$
 .Dl \&.Dd July 21, 2007  .Dl \&.Dd July 2, 2018
 .Pp  .Pp
 See also  See also
 .Sx \&Dt  .Ic \&Dt
 and  and
 .Sx \&Os .  .Ic \&Os .
 .Ss \&Dl  .It Ic \&Dl Ar line
 One-line indented display.  One-line indented display.
 This is formatted as literal text and is useful for commands and  This is formatted as literal text and is useful for commands and
 invocations.  invocations.
Line 1256  Examples:
Line 1249  Examples:
 .Dl \&.Dl % mandoc mdoc.7 \e(ba less  .Dl \&.Dl % mandoc mdoc.7 \e(ba less
 .Pp  .Pp
 See also  See also
 .Sx \&Bd  .Ic \&Ql ,
   .Ic \&Bd Fl literal ,
 and  and
 .Sx \&D1 .  .Ic \&D1 .
 .Ss \&Do  .It Ic \&Do Ar block
 Begin a block enclosed by double quotes.  Begin a block enclosed by double quotes.
 Does not have any head arguments.  Does not have any head arguments.
 .Pp  .Pp
Line 1272  April is the cruellest month
Line 1266  April is the cruellest month
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Dq .  .Ic \&Dq .
 .Ss \&Dq  .It Ic \&Dq Ar line
 Encloses its arguments in  Encloses its arguments in
 .Dq typographic  .Dq typographic
 double-quotes.  double-quotes.
Line 1285  Examples:
Line 1279  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Qq ,  .Ic \&Qq ,
 .Sx \&Sq ,  .Ic \&Sq ,
 and  and
 .Sx \&Do .  .Ic \&Do .
 .Ss \&Dt  .It Ic \&Dt Ar TITLE section Op Ar arch
 Document title for display in the page header.  Document title for display in the page header.
 This is the mandatory second macro of any  This is the mandatory second macro of any
 .Nm  .Nm
 file.  file.
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Dt  
 .Ar TITLE  
 .Ar section  
 .Op Ar volume | arch  
 .Ed  
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width section -offset 2n  .Bl -tag -width section -offset 2n
Line 1314  it should by convention be all caps.
Line 1301  it should by convention be all caps.
 The manual section.  The manual section.
 This may be one of  This may be one of
 .Cm 1  .Cm 1
 .Pq utilities ,  .Pq General Commands ,
 .Cm 2  .Cm 2
 .Pq system calls ,  .Pq System Calls ,
 .Cm 3  .Cm 3
 .Pq libraries ,  .Pq Library Functions ,
 .Cm 3p  .Cm 3p
 .Pq Perl libraries ,  .Pq Perl Library ,
 .Cm 4  .Cm 4
 .Pq devices ,  .Pq Device Drivers ,
 .Cm 5  .Cm 5
 .Pq file formats ,  .Pq File Formats ,
 .Cm 6  .Cm 6
 .Pq games ,  .Pq Games ,
 .Cm 7  .Cm 7
 .Pq miscellaneous ,  .Pq Miscellaneous Information ,
 .Cm 8  .Cm 8
 .Pq system utilities ,  .Pq System Manager's Manual ,
 .Cm 9  
 .Pq kernel functions ,  
 .Cm X11  
 .Pq X Window System ,  
 .Cm X11R6  
 .Pq X Window System ,  
 .Cm unass  
 .Pq unassociated ,  
 .Cm local  
 .Pq local system ,  
 .Cm draft  
 .Pq draft manual ,  
 or  or
 .Cm paper  .Cm 9
 .Pq paper .  .Pq Kernel Developer's Manual .
 It should correspond to the manual's filename suffix and defaults to  It should correspond to the manual's filename suffix and defaults to
 the empty string if unspecified.  the empty string if unspecified.
 .It Ar volume  
 This overrides the volume inferred from  
 .Ar section .  
 This field is optional, and if specified, must be one of  
 .Cm USD  
 .Pq users' supplementary documents ,  
 .Cm PS1  
 .Pq programmers' supplementary documents ,  
 .Cm AMD  
 .Pq administrators' supplementary documents ,  
 .Cm SMM  
 .Pq system managers' manuals ,  
 .Cm URM  
 .Pq users' reference manuals ,  
 .Cm PRM  
 .Pq programmers' reference manuals ,  
 .Cm KM  
 .Pq kernel manuals ,  
 .Cm IND  
 .Pq master index ,  
 .Cm MMI  
 .Pq master index ,  
 .Cm LOCAL  
 .Pq local manuals ,  
 .Cm LOC  
 .Pq local manuals ,  
 or  
 .Cm CON  
 .Pq contributed manuals .  
 .It Ar arch  .It Ar arch
 This specifies the machine architecture a manual page applies to,  This specifies the machine architecture a manual page applies to,
 where relevant, for example  where relevant, for example
Line 1390  The list of valid architectures varies by operating sy
Line 1336  The list of valid architectures varies by operating sy
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Dt FOO 1  .Dl \&.Dt FOO 1
 .Dl \&.Dt FOO 4 KM  
 .Dl \&.Dt FOO 9 i386  .Dl \&.Dt FOO 9 i386
 .Pp  .Pp
 See also  See also
 .Sx \&Dd  .Ic \&Dd
 and  and
 .Sx \&Os .  .Ic \&Os .
 .Ss \&Dv  .It Ic \&Dv Ar identifier ...
 Defined variables such as preprocessor constants, constant symbols,  Defined variables such as preprocessor constants, constant symbols,
 enumeration values, and so on.  enumeration values, and so on.
 .Pp  .Pp
Line 1407  Examples:
Line 1352  Examples:
 .Dl \&.Dv STDOUT_FILENO  .Dl \&.Dv STDOUT_FILENO
 .Pp  .Pp
 See also  See also
 .Sx \&Er  .Ic \&Er
 and  and
 .Sx \&Ev  .Ic \&Ev
 for special-purpose constants,  for special-purpose constants,
 .Sx \&Va  .Ic \&Va
 for variable symbols, and  for variable symbols, and
 .Sx \&Fd  .Ic \&Fd
 for listing preprocessor variable definitions in the  for listing preprocessor variable definitions in the
 .Em SYNOPSIS .  .Em SYNOPSIS .
 .Ss \&Dx  .It Ic \&Dx Op Ar version
 Format the  Format the
 .Dx  .Dx
 version provided as an argument, or a default  version provided as an argument, or a default
Line 1427  Examples:
Line 1372  Examples:
 .Dl \&.Dx  .Dl \&.Dx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 .Sx \&Nx ,  .Ic \&Nx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Ec  .It Ic \&Ec Op Ar closing_delimiter
 Close a scope started by  Close a scope started by
 .Sx \&Eo .  .Ic \&Eo .
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Ec Op Ar TERM  
 .Pp  
 The  The
 .Ar TERM  .Ar closing_delimiter
 argument is used as the enclosure tail, for example, specifying \e(rq  argument is used as the enclosure tail, for example, specifying \e(rq
 will emulate  will emulate
 .Sx \&Dc .  .Ic \&Dc .
 .Ss \&Ed  .It Ic \&Ed
 End a display context started by  End a display context started by
 .Sx \&Bd .  .Ic \&Bd .
 .Ss \&Ef  .It Ic \&Ef
 End a font mode context started by  End a font mode context started by
 .Sx \&Bf .  .Ic \&Bf .
 .Ss \&Ek  .It Ic \&Ek
 End a keep context started by  End a keep context started by
 .Sx \&Bk .  .Ic \&Bk .
 .Ss \&El  .It Ic \&El
 End a list context started by  End a list context started by
 .Sx \&Bl .  .Ic \&Bl .
 .Pp  
 See also  See also
 .Sx \&Bl  .Ic \&It .
 and  .It Ic \&Em Ar word ...
 .Sx \&It .  
 .Ss \&Em  
 Request an italic font.  Request an italic font.
 If the output device does not provide that, underline.  If the output device does not provide that, underline.
 .Pp  .Pp
 This is most often used for stress emphasis (not to be confused with  This is most often used for stress emphasis (not to be confused with
 importance, see  importance, see
 .Sx \&Sy ) .  .Ic \&Sy ) .
 In the rare cases where none of the semantic markup macros fit,  In the rare cases where none of the semantic markup macros fit,
 it can also be used for technical terms and placeholders, except  it can also be used for technical terms and placeholders, except
 that for syntax elements,  that for syntax elements,
 .Sx \&Sy  .Ic \&Sy
 and  and
 .Sx \&Ar  .Ic \&Ar
 are preferred, respectively.  are preferred, respectively.
 .Pp  .Pp
 Examples:  Examples:
Line 1489  to save the pattern space for subsequent retrieval.
Line 1428  to save the pattern space for subsequent retrieval.
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Bf ,  .Ic \&No ,
 .Sx \&Li ,  .Ic \&Ql ,
 .Sx \&No ,  
 and  and
 .Sx \&Sy .  .Ic \&Sy .
 .Ss \&En  .It Ic \&En Ar word ...
 This macro is obsolete.  This macro is obsolete.
 Use  Use
 .Sx \&Eo  .Ic \&Eo
 or any of the other enclosure macros.  or any of the other enclosure macros.
 .Pp  .Pp
 It encloses its argument in the delimiters specified by the last  It encloses its argument in the delimiters specified by the last
 .Sx \&Es  .Ic \&Es
 macro.  macro.
 .Ss \&Eo  .It Ic \&Eo Op Ar opening_delimiter
 An arbitrary enclosure.  An arbitrary enclosure.
 Its syntax is as follows:  
 .Pp  
 .D1 Pf \. Sx \&Eo Op Ar TERM  
 .Pp  
 The  The
 .Ar TERM  .Ar opening_delimiter
 argument is used as the enclosure head, for example, specifying \e(lq  argument is used as the enclosure head, for example, specifying \e(lq
 will emulate  will emulate
 .Sx \&Do .  .Ic \&Do .
 .Ss \&Er  .It Ic \&Er Ar identifier ...
 Error constants for definitions of the  Error constants for definitions of the
 .Va errno  .Va errno
 libc global variable.  libc global variable.
Line 1525  Examples:
Line 1459  Examples:
 .Dl \&.Er ENOENT  .Dl \&.Er ENOENT
 .Pp  .Pp
 See also  See also
 .Sx \&Dv  .Ic \&Dv
 for general constants.  for general constants.
 .Ss \&Es  .It Ic \&Es Ar opening_delimiter closing_delimiter
 This macro is obsolete.  This macro is obsolete.
 Use  Use
 .Sx \&Eo  .Ic \&Eo
 or any of the other enclosure macros.  or any of the other enclosure macros.
 .Pp  .Pp
 It takes two arguments, defining the delimiters to be used by subsequent  It takes two arguments, defining the delimiters to be used by subsequent
 .Sx \&En  .Ic \&En
 macros.  macros.
 .Ss \&Ev  .It Ic \&Ev Ar identifier ...
 Environmental variables such as those specified in  Environmental variables such as those specified in
 .Xr environ 7 .  .Xr environ 7 .
 .Pp  .Pp
Line 1545  Examples:
Line 1479  Examples:
 .Dl \&.Ev PATH  .Dl \&.Ev PATH
 .Pp  .Pp
 See also  See also
 .Sx \&Dv  .Ic \&Dv
 for general constants.  for general constants.
 .Ss \&Ex  .It Ic \&Ex Fl std Op Ar utility ...
 Insert a standard sentence regarding command exit values of 0 on success  Insert a standard sentence regarding command exit values of 0 on success
 and >0 on failure.  and >0 on failure.
 This is most often used in section 1, 6, and 8 manual pages.  This is most often used in section 1, 6, and 8 manual pages.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...  
 .Pp  
 If  If
 .Ar utility  .Ar utility
 is not specified, the document's name set by  is not specified, the document's name set by
 .Sx \&Nm  .Ic \&Nm
 is used.  is used.
 Multiple  Multiple
 .Ar utility  .Ar utility
 arguments are treated as separate utilities.  arguments are treated as separate utilities.
 .Pp  .Pp
 See also  See also
 .Sx \&Rv .  .Ic \&Rv .
 .Ss \&Fa  .It Ic \&Fa Ar argument ...
 Function argument or parameter.  Function argument or parameter.
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Fa  
 .Qo  
 .Op Ar argtype  
 .Op Ar argname  
 .Qc Ar \&...  
 .Ed  
 .Pp  
 Each argument may be a name and a type (recommended for the  Each argument may be a name and a type (recommended for the
 .Em SYNOPSIS  .Em SYNOPSIS
 section), a name alone (for function invocations),  section), a name alone (for function invocations),
Line 1584  or a type alone (for function prototypes).
Line 1506  or a type alone (for function prototypes).
 If both a type and a name are given or if the type consists of multiple  If both a type and a name are given or if the type consists of multiple
 words, all words belonging to the same function argument have to be  words, all words belonging to the same function argument have to be
 given in a single argument to the  given in a single argument to the
 .Sx \&Fa  .Ic \&Fa
 macro.  macro.
 .Pp  .Pp
 This macro is also used to specify the field name of a structure.  This macro is also used to specify the field name of a structure.
 .Pp  .Pp
 Most often, the  Most often, the
 .Sx \&Fa  .Ic \&Fa
 macro is used in the  macro is used in the
 .Em SYNOPSIS  .Em SYNOPSIS
 within  within
 .Sx \&Fo  .Ic \&Fo
 blocks when documenting multi-line function prototypes.  blocks when documenting multi-line function prototypes.
 If invoked with multiple arguments, the arguments are separated by a  If invoked with multiple arguments, the arguments are separated by a
 comma.  comma.
 Furthermore, if the following macro is another  Furthermore, if the following macro is another
 .Sx \&Fa ,  .Ic \&Fa ,
 the last argument will also have a trailing comma.  the last argument will also have a trailing comma.
 .Pp  .Pp
 Examples:  Examples:
Line 1608  Examples:
Line 1530  Examples:
 .Dl \&.Fa \(dqchar *\(dq size_t  .Dl \&.Fa \(dqchar *\(dq size_t
 .Pp  .Pp
 See also  See also
 .Sx \&Fo .  .Ic \&Fo .
 .Ss \&Fc  .It Ic \&Fc
 End a function context started by  End a function context started by
 .Sx \&Fo .  .Ic \&Fo .
 .Ss \&Fd  .It Ic \&Fd Pf # Ar directive Op Ar argument ...
 Preprocessor directive, in particular for listing it in the  Preprocessor directive, in particular for listing it in the
 .Em SYNOPSIS .  .Em SYNOPSIS .
 Historically, it was also used to document include files.  Historically, it was also used to document include files.
 The latter usage has been deprecated in favour of  The latter usage has been deprecated in favour of
 .Sx \&In .  .Ic \&In .
 .Pp  .Pp
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Sx \&Fd  
 .Li # Ns Ar directive  
 .Op Ar argument ...  
 .Ed  
 .Pp  
 Examples:  Examples:
 .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler  .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
 .Dl \&.Fd #define SIO_MAXNFDS  .Dl \&.Fd #define SIO_MAXNFDS
Line 1636  Examples:
Line 1551  Examples:
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
 .Sx \&In ,  .Ic \&In ,
 and  and
 .Sx \&Dv .  .Ic \&Dv .
 .Ss \&Fl  .It Ic \&Fl Op Ar word ...
 Command-line flag or option.  Command-line flag or option.
 Used when listing arguments to command-line utilities.  Used when listing arguments to command-line utilities.
 Prints a fixed-width hyphen  Prints a fixed-width hyphen
Line 1657  Examples:
Line 1572  Examples:
 .Dl ".Fl o Fl"  .Dl ".Fl o Fl"
 .Pp  .Pp
 See also  See also
 .Sx \&Cm .  .Ic \&Cm .
 .Ss \&Fn  .It Ic \&Fn Ar funcname Op Ar argument ...
 A function name.  A function name.
 Its syntax is as follows:  
 .Bd -ragged -offset indent  
 .Pf \. Ns Sx \&Fn  
 .Op Ar functype  
 .Ar funcname  
 .Op Oo Ar argtype Oc Ar argname  
 .Ed  
 .Pp  .Pp
 Function arguments are surrounded in parenthesis and  Function arguments are surrounded in parenthesis and
 are delimited by commas.  are delimited by commas.
Line 1687  Examples:
Line 1595  Examples:
 .Ed  .Ed
 .Pp  .Pp
 When referring to a function documented in another manual page, use  When referring to a function documented in another manual page, use
 .Sx \&Xr  .Ic \&Xr
 instead.  instead.
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
 .Sx \&Fo ,  .Ic \&Fo ,
 and  and
 .Sx \&Ft .  .Ic \&Ft .
 .Ss \&Fo  .It Ic \&Fo Ar funcname
 Begin a function block.  Begin a function block.
 This is a multi-line version of  This is a multi-line version of
 .Sx \&Fn .  .Ic \&Fn .
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Fo Ar funcname  
 .Pp  
 Invocations usually occur in the following context:  Invocations usually occur in the following context:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Ft Ar functype  .Pf \. Ic \&Ft Ar functype
 .br  .br
 .Pf \. Sx \&Fo Ar funcname  .Pf \. Ic \&Fo Ar funcname
 .br  .br
 .Pf \. Sx \&Fa Qq Ar argtype Ar argname  .Pf \. Ic \&Fa Qq Ar argtype Ar argname
 .br  .br
 \&.\.\.  \&.\.\.
 .br  .br
 .Pf \. Sx \&Fc  .Pf \. Ic \&Fc
 .Ed  .Ed
 .Pp  .Pp
 A  A
 .Sx \&Fo  .Ic \&Fo
 scope is closed by  scope is closed by
 .Sx \&Fc .  .Ic \&Fc .
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
 .Sx \&Fa ,  .Ic \&Fa ,
 .Sx \&Fc ,  .Ic \&Fc ,
 and  and
 .Sx \&Ft .  .Ic \&Ft .
 .Ss \&Fr  .It Ic \&Fr Ar number
 This macro is obsolete.  This macro is obsolete.
 No replacement markup is needed.  No replacement markup is needed.
 .Pp  .Pp
 It was used to show numerical function return values in an italic font.  It was used to show numerical function return values in an italic font.
 .Ss \&Ft  .It Ic \&Ft Ar functype
 A function type.  A function type.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Ft Ar functype  
 .Pp  
 In the  In the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, a new output line is started after this macro.  section, a new output line is started after this macro.
Line 1750  Examples:
Line 1652  Examples:
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
 .Sx \&Fn ,  .Ic \&Fn ,
 and  and
 .Sx \&Fo .  .Ic \&Fo .
 .Ss \&Fx  .It Ic \&Fx Op Ar version
 Format the  Format the
 .Fx  .Fx
 version provided as an argument, or a default value  version provided as an argument, or a default value
Line 1764  Examples:
Line 1666  Examples:
 .Dl \&.Fx  .Dl \&.Fx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Nx ,  .Ic \&Nx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Hf  .It Ic \&Hf Ar filename
 This macro is not implemented in  This macro is not implemented in
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Pp  
 It was used to include the contents of a (header) file literally.  It was used to include the contents of a (header) file literally.
 The syntax was:  .It Ic \&Ic Ar keyword ...
 .Pp  
 .Dl Pf . Sx \&Hf Ar filename  
 .Ss \&Ic  
 Designate an internal or interactive command.  Designate an internal or interactive command.
 This is similar to  This is similar to
 .Sx \&Cm  .Ic \&Cm
 but used for instructions rather than values.  but used for instructions rather than values.
 .Pp  .Pp
 Examples:  Examples:
Line 1791  Examples:
Line 1689  Examples:
 .Dl \&.Ic alias  .Dl \&.Ic alias
 .Pp  .Pp
 Note that using  Note that using
 .Sx \&Bd Fl literal  .Ic \&Ql ,
   .Ic \&Dl ,
 or  or
 .Sx \&D1  .Ic \&Bd Fl literal
 is preferred for displaying code; the  is preferred for displaying code samples; the
 .Sx \&Ic  .Ic \&Ic
 macro is used when referring to specific instructions.  macro is used when referring to an individual command name.
 .Ss \&In  .It Ic \&In Ar filename
 An  The name of an include file.
 .Dq include  This macro is most often used in section 2, 3, and 9 manual pages.
 file.  .Pp
 When invoked as the first macro on an input line in the  When invoked as the first macro on an input line in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, the argument is displayed in angle brackets  section, the argument is displayed in angle brackets
 and preceded by  and preceded by
 .Dq #include ,  .Qq #include ,
 and a blank line is inserted in front if there is a preceding  and a blank line is inserted in front if there is a preceding
 function declaration.  function declaration.
 This is most often used in section 2, 3, and 9 manual pages.  In other sections, it only encloses its argument in angle brackets
   and causes no line break.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.In sys/types.h  .Dl \&.In sys/types.h
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
 .Ss \&It  .It Ic \&It Op Ar head
 A list item.  A list item.
 The syntax of this macro depends on the list type.  The syntax of this macro depends on the list type.
 .Pp  .Pp
Line 1828  and
Line 1728  and
 .Fl diag  .Fl diag
 have the following syntax:  have the following syntax:
 .Pp  .Pp
 .D1 Pf \. Sx \&It Ar args  .D1 Pf \. Ic \&It Ar args
 .Pp  .Pp
 Lists of type  Lists of type
 .Fl bullet ,  .Fl bullet ,
Line 1839  and
Line 1739  and
 .Fl item  .Fl item
 have the following syntax:  have the following syntax:
 .Pp  .Pp
 .D1 Pf \. Sx \&It  .D1 Pf \. Ic \&It
 .Pp  .Pp
 with subsequent lines interpreted within the scope of the  with subsequent lines interpreted within the scope of the
 .Sx \&It  .Ic \&It
 until either a closing  until either a closing
 .Sx \&El  .Ic \&El
 or another  or another
 .Sx \&It .  .Ic \&It .
 .Pp  .Pp
 The  The
 .Fl tag  .Fl tag
 list has the following syntax:  list has the following syntax:
 .Pp  .Pp
 .D1 Pf \. Sx \&It Op Cm args  .D1 Pf \. Ic \&It Op Cm args
 .Pp  .Pp
 Subsequent lines are interpreted as with  Subsequent lines are interpreted as with
 .Fl bullet  .Fl bullet
Line 1865  The
Line 1765  The
 list is the most complicated.  list is the most complicated.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...  .D1 Pf \. Ic \&It Ar cell Op Ic \&Ta Ar cell ...
 .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...  .D1 Pf \. Ic \&It Ar cell Op <TAB> Ar cell ...
 .Pp  .Pp
 The arguments consist of one or more lines of text and macros  The arguments consist of one or more lines of text and macros
 representing a complete table line.  representing a complete table line.
 Cells within the line are delimited by tabs or by the special  Cells within the line are delimited by the special
 .Sx \&Ta  .Ic \&Ta
 block macro.  block macro or by literal tab characters.
   .Pp
   Using literal tabs is strongly discouraged because they are very
   hard to use correctly and
   .Nm
   code using them is very hard to read.
   In particular, a blank character is syntactically significant
   before and after the literal tab character.
   If a word precedes or follows the tab without an intervening blank,
   that word is never interpreted as a macro call, but always output
   literally.
   .Pp
 The tab cell delimiter may only be used within the  The tab cell delimiter may only be used within the
 .Sx \&It  .Ic \&It
 line itself; on following lines, only the  line itself; on following lines, only the
 .Sx \&Ta  .Ic \&Ta
 macro can be used to delimit cells, and  macro can be used to delimit cells, and portability requires that
 .Sx \&Ta  .Ic \&Ta
 is only recognised as a macro when called by other macros,  is called by other macros: some parsers do not recognize it when
 not as the first macro on a line.  it appears as the first macro on a line.
 .Pp  .Pp
 Note that quoted strings may span tab-delimited cells on an  Note that quoted strings may span tab-delimited cells on an
 .Sx \&It  .Ic \&It
 line.  line.
 For example,  For example,
 .Pp  .Pp
 .Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;  .Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&;
 .Pp  .Pp
 will preserve the semicolon whitespace except for the last.  will preserve the whitespace before both commas,
   but not the whitespace before the semicolon.
 .Pp  .Pp
 See also  See also
 .Sx \&Bl .  .Ic \&Bl .
 .Ss \&Lb  .It Ic \&Lb Cm lib Ns Ar name
 Specify a library.  Specify a library.
 The syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Lb Ar library  
 .Pp  
 The  The
 .Ar library  .Ar name
 parameter may be a system library, such as  parameter may be a system library, such as
 .Cm libz  .Cm z
 or  or
 .Cm libpam ,  .Cm pam ,
 in which case a small library description is printed next to the linker  in which case a small library description is printed next to the linker
 invocation; or a custom library, in which case the library name is  invocation; or a custom library, in which case the library name is
 printed in quotes.  printed in quotes.
Line 1916  section as described in
Line 1825  section as described in
 Examples:  Examples:
 .Dl \&.Lb libz  .Dl \&.Lb libz
 .Dl \&.Lb libmandoc  .Dl \&.Lb libmandoc
 .Ss \&Li  .It Ic \&Li Ar word ...
 Denotes text that should be in a  Request a typewriter (literal) font.
 .Li literal  Deprecated because on terminal output devices, this is usually
 font mode.  indistinguishable from normal text.
 Note that this is a presentation term and should not be used for  For literal displays, use
 stylistically decorating technical terms.  .Ic \&Ql Pq in-line ,
 .Pp  .Ic \&Dl Pq single line ,
 On terminal output devices, this is often indistinguishable from  or
 normal text.  .Ic \&Bd Fl literal Pq multi-line
 .Pp  instead.
 See also  .It Ic \&Lk Ar uri Op Ar display_name
 .Sx \&Bf ,  
 .Sx \&Em ,  
 .Sx \&No ,  
 and  
 .Sx \&Sy .  
 .Ss \&Lk  
 Format a hyperlink.  Format a hyperlink.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Lk Ar uri Op Ar name  
 .Pp  
 Examples:  Examples:
 .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq  .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq
 .Dl \&.Lk http://bsd.lv  .Dl \&.Lk http://bsd.lv
 .Pp  .Pp
 See also  See also
 .Sx \&Mt .  .Ic \&Mt .
 .Ss \&Lp  .It Ic \&Lp
 Synonym for  Deprecated synonym for
 .Sx \&Pp .  .Ic \&Pp .
 .Ss \&Ms  .It Ic \&Ms Ar name
 Display a mathematical symbol.  Display a mathematical symbol.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Ms Ar symbol  
 .Pp  
 Examples:  Examples:
 .Dl \&.Ms sigma  .Dl \&.Ms sigma
 .Dl \&.Ms aleph  .Dl \&.Ms aleph
 .Ss \&Mt  .It Ic \&Mt Ar localpart Ns @ Ns Ar domain
 Format a  Format a
 .Dq mailto:  .Dq mailto:
 hyperlink.  hyperlink.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Mt Ar address  
 .Pp  
 Examples:  Examples:
 .Dl \&.Mt discuss@manpages.bsd.lv  .Dl \&.Mt discuss@manpages.bsd.lv
 .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd  .It Ic \&Nd Ar line
 A one line description of the manual's content.  A one line description of the manual's content.
 This may only be invoked in the  This is the mandatory last macro of the
 .Em SYNOPSIS  .Em NAME
 section subsequent the  section and not appropriate for other sections.
 .Sx \&Nm  
 macro.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl Pf . Sx \&Nd mdoc language reference  .Dl Pf . Ic \&Nd mdoc language reference
 .Dl Pf . Sx \&Nd format and display UNIX manuals  .Dl Pf . Ic \&Nd format and display UNIX manuals
 .Pp  .Pp
 The  The
 .Sx \&Nd  .Ic \&Nd
 macro technically accepts child macros and terminates with a subsequent  macro technically accepts child macros and terminates with a subsequent
 .Sx \&Sh  .Ic \&Sh
 invocation.  invocation.
 Do not assume this behaviour: some  Do not assume this behaviour: some
 .Xr whatis 1  .Xr whatis 1
Line 1990  database generators are not smart enough to parse more
Line 1882  database generators are not smart enough to parse more
 arguments and will display macros verbatim.  arguments and will display macros verbatim.
 .Pp  .Pp
 See also  See also
 .Sx \&Nm .  .Ic \&Nm .
 .Ss \&Nm  .It Ic \&Nm Op Ar name
 The name of the manual page, or \(em in particular in section 1, 6,  The name of the manual page, or \(em in particular in section 1, 6,
 and 8 pages \(em of an additional command or feature documented in  and 8 pages \(em of an additional command or feature documented in
 the manual page.  the manual page.
 When first invoked, the  When first invoked, the
 .Sx \&Nm  .Ic \&Nm
 macro expects a single argument, the name of the manual page.  macro expects a single argument, the name of the manual page.
 Usually, the first invocation happens in the  Usually, the first invocation happens in the
 .Em NAME  .Em NAME
Line 2004  section of the page.
Line 1896  section of the page.
 The specified name will be remembered and used whenever the macro is  The specified name will be remembered and used whenever the macro is
 called again without arguments later in the page.  called again without arguments later in the page.
 The  The
 .Sx \&Nm  .Ic \&Nm
 macro uses  macro uses
 .Sx Block full-implicit  .Sx Block full-implicit
 semantics when invoked as the first macro on an input line in the  semantics when invoked as the first macro on an input line in the
Line 2024  Examples:
Line 1916  Examples:
 In the  In the
 .Em SYNOPSIS  .Em SYNOPSIS
 of section 2, 3 and 9 manual pages, use the  of section 2, 3 and 9 manual pages, use the
 .Sx \&Fn  .Ic \&Fn
 macro rather than  macro rather than
 .Sx \&Nm  .Ic \&Nm
 to mark up the name of the manual page.  to mark up the name of the manual page.
 .Ss \&No  .It Ic \&No Ar word ...
 Normal text.  Normal text.
 Closes the scope of any preceding in-line macro.  Closes the scope of any preceding in-line macro.
 When used after physical formatting macros like  When used after physical formatting macros like
 .Sx \&Em  .Ic \&Em
 or  or
 .Sx \&Sy ,  .Ic \&Sy ,
 switches back to the standard font face and weight.  switches back to the standard font face and weight.
 Can also be used to embed plain text strings in macro lines  Can also be used to embed plain text strings in macro lines
 using semantic annotation macros.  using semantic annotation macros.
Line 2049  Examples:
Line 1941  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Em ,  .Ic \&Em ,
 .Sx \&Li ,  .Ic \&Ql ,
 and  and
 .Sx \&Sy .  .Ic \&Sy .
 .Ss \&Ns  .It Ic \&Ns
 Suppress a space between the output of the preceding macro  Suppress a space between the output of the preceding macro
 and the following text or macro.  and the following text or macro.
 Following invocation, input is interpreted as normal text  Following invocation, input is interpreted as normal text
 just like after an  just like after an
 .Sx \&No  .Ic \&No
 macro.  macro.
 .Pp  .Pp
 This has no effect when invoked at the start of a macro line.  This has no effect when invoked at the start of a macro line.
Line 2069  Examples:
Line 1961  Examples:
 .Dl ".Fl o Ns Ar output"  .Dl ".Fl o Ns Ar output"
 .Pp  .Pp
 See also  See also
 .Sx \&No  .Ic \&No
 and  and
 .Sx \&Sm .  .Ic \&Sm .
 .Ss \&Nx  .It Ic \&Nx Op Ar version
 Format the  Format the
 .Nx  .Nx
 version provided as an argument, or a default value if  version provided as an argument, or a default value if
Line 2083  Examples:
Line 1975  Examples:
 .Dl \&.Nx  .Dl \&.Nx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 and  and
 .Sx \&Ox .  .Ic \&Ox .
 .Ss \&Oc  .It Ic \&Oc
 Close multi-line  Close multi-line
 .Sx \&Oo  .Ic \&Oo
 context.  context.
 .Ss \&Oo  .It Ic \&Oo Ar block
 Multi-line version of  Multi-line version of
 .Sx \&Op .  .Ic \&Op .
 .Pp  .Pp
 Examples:  Examples:
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
Line 2104  Examples:
Line 1996  Examples:
 \&.Op Fl flag Ns Ar value  \&.Op Fl flag Ns Ar value
 \&.Oc  \&.Oc
 .Ed  .Ed
 .Ss \&Op  .It Ic \&Op Ar line
 Optional part of a command line.  Optional part of a command line.
 Prints the argument(s) in brackets.  Prints the argument(s) in brackets.
 This is most often used in the  This is most often used in the
Line 2116  Examples:
Line 2008  Examples:
 .Dl \&.Op \&Ar a | b  .Dl \&.Op \&Ar a | b
 .Pp  .Pp
 See also  See also
 .Sx \&Oo .  .Ic \&Oo .
 .Ss \&Os  .It Ic \&Os Op Ar system Op Ar version
 Operating system version for display in the page footer.  Operating system version for display in the page footer.
 This is the mandatory third macro of  This is the mandatory third macro of
 any  any
 .Nm  .Nm
 file.  file.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Os Op Ar system Op Ar version  
 .Pp  
 The optional  The optional
 .Ar system  .Ar system
 parameter specifies the relevant operating system or environment.  parameter specifies the relevant operating system or environment.
 Left unspecified, it defaults to the local operating system version.  It is suggested to leave it unspecified, in which case
 This is the suggested form.  .Xr mandoc 1
   uses its
   .Fl Ios
   argument or, if that isn't specified either,
   .Fa sysname
   and
   .Fa release
   as returned by
   .Xr uname 3 .
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Os  .Dl \&.Os
Line 2139  Examples:
Line 2036  Examples:
 .Dl \&.Os BSD 4.3  .Dl \&.Os BSD 4.3
 .Pp  .Pp
 See also  See also
 .Sx \&Dd  .Ic \&Dd
 and  and
 .Sx \&Dt .  .Ic \&Dt .
 .Ss \&Ot  .It Ic \&Ot Ar functype
 This macro is obsolete.  This macro is obsolete.
 Use  Use
 .Sx \&Ft  .Ic \&Ft
 instead; with  instead; with
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 both have the same effect.  both have the same effect.
Line 2154  Historical
Line 2051  Historical
 .Nm  .Nm
 packages described it as  packages described it as
 .Dq "old function type (FORTRAN)" .  .Dq "old function type (FORTRAN)" .
 .Ss \&Ox  .It Ic \&Ox Op Ar version
 Format the  Format the
 .Ox  .Ox
 version provided as an argument, or a default value  version provided as an argument, or a default value
Line 2165  Examples:
Line 2062  Examples:
 .Dl \&.Ox  .Dl \&.Ox
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Ic \&At ,
 .Sx \&Bsx ,  .Ic \&Bsx ,
 .Sx \&Bx ,  .Ic \&Bx ,
 .Sx \&Dx ,  .Ic \&Dx ,
 .Sx \&Fx ,  .Ic \&Fx ,
 and  and
 .Sx \&Nx .  .Ic \&Nx .
 .Ss \&Pa  .It Ic \&Pa Ar name ...
 An absolute or relative file system path, or a file or directory name.  An absolute or relative file system path, or a file or directory name.
 If an argument is not provided, the character  If an argument is not provided, the character
 .Sq \(ti  .Sq \(ti
Line 2183  Examples:
Line 2080  Examples:
 .Dl \&.Pa /usr/share/man/man7/mdoc.7  .Dl \&.Pa /usr/share/man/man7/mdoc.7
 .Pp  .Pp
 See also  See also
 .Sx \&Lk .  .Ic \&Lk .
 .Ss \&Pc  .It Ic \&Pc
 Close parenthesised context opened by  Close parenthesised context opened by
 .Sx \&Po .  .Ic \&Po .
 .Ss \&Pf  .It Ic \&Pf Ar prefix macro Op Ar argument ...
 Removes the space between its argument  Removes the space between its argument and the following macro.
 .Pq Dq prefix  It is equivalent to:
 and the following macro.  
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 .Pf Ar prefix macro arguments ...  .D1 Ic \&No Pf \e& Ar prefix Ic \&Ns Ar macro Op Ar argument ...
 .Pp  .Pp
 This is equivalent to:  The
   .Ar prefix
   argument is not parsed for macro names or delimiters,
   but used verbatim as if it were escaped.
 .Pp  .Pp
 .D1 .No Ar prefix No \&Ns Ar macro arguments ...  
 .Pp  
 Examples:  Examples:
 .Dl ".Pf $ Ar variable_name"  .Dl ".Pf $ Ar variable_name"
   .Dl ".Pf . Ar macro_name"
 .Dl ".Pf 0x Ar hex_digits"  .Dl ".Pf 0x Ar hex_digits"
 .Pp  .Pp
 See also  See also
 .Sx \&Ns  .Ic \&Ns
 and  and
 .Sx \&Sm .  .Ic \&Sm .
 .Ss \&Po  .It Ic \&Po Ar block
 Multi-line version of  Multi-line version of
 .Sx \&Pq .  .Ic \&Pq .
 .Ss \&Pp  .It Ic \&Pp
 Break a paragraph.  Break a paragraph.
 This will assert vertical space between prior and subsequent macros  This will assert vertical space between prior and subsequent macros
 and/or text.  and/or text.
 .Pp  .Pp
 Paragraph breaks are not needed before or after  Paragraph breaks are not needed before or after
 .Sx \&Sh  .Ic \&Sh
 or  or
 .Sx \&Ss  .Ic \&Ss
 macros or before displays  macros or before displays
 .Pq Sx \&Bd  .Pq Ic \&Bd Ar line
 or lists  or lists
 .Pq Sx \&Bl  .Pq Ic \&Bl
 unless the  unless the
 .Fl compact  .Fl compact
 flag is given.  flag is given.
 .Ss \&Pq  .It Ic \&Pq Ar line
 Parenthesised enclosure.  Parenthesised enclosure.
 .Pp  .Pp
 See also  See also
 .Sx \&Po .  .Ic \&Po .
 .Ss \&Qc  .It Ic \&Qc
 Close quoted context opened by  Close quoted context opened by
 .Sx \&Qo .  .Ic \&Qo .
 .Ss \&Ql  .It Ic \&Ql Ar line
 Format a single-quoted literal.  In-line literal display.
   This can be used for complete command invocations and for multi-word
   code examples when an indented display is not desired.
   .Pp
 See also  See also
 .Sx \&Qq  .Ic \&Dl
 and  and
 .Sx \&Sq .  .Ic \&Bd
 .Ss \&Qo  .Fl literal .
   .It Ic \&Qo Ar block
 Multi-line version of  Multi-line version of
 .Sx \&Qq .  .Ic \&Qq .
 .Ss \&Qq  .It Ic \&Qq Ar line
 Encloses its arguments in  Encloses its arguments in
 .Qq typewriter  .Qq typewriter
 double-quotes.  double-quotes.
 Consider using  Consider using
 .Sx \&Dq .  .Ic \&Dq .
 .Pp  .Pp
 See also  See also
 .Sx \&Dq ,  .Ic \&Dq ,
 .Sx \&Sq ,  .Ic \&Sq ,
 and  and
 .Sx \&Qo .  .Ic \&Qo .
 .Ss \&Re  .It Ic \&Re
 Close an  Close an
 .Sx \&Rs  .Ic \&Rs
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Rs  .It Ic \&Rs
 Begin a bibliographic  Begin a bibliographic
 .Pq Dq reference  .Pq Dq reference
 block.  block.
 Does not have any head arguments.  Does not have any head arguments.
 The block macro may only contain  The block macro may only contain
 .Sx \&%A ,  .Ic \&%A ,
 .Sx \&%B ,  .Ic \&%B ,
 .Sx \&%C ,  .Ic \&%C ,
 .Sx \&%D ,  .Ic \&%D ,
 .Sx \&%I ,  .Ic \&%I ,
 .Sx \&%J ,  .Ic \&%J ,
 .Sx \&%N ,  .Ic \&%N ,
 .Sx \&%O ,  .Ic \&%O ,
 .Sx \&%P ,  .Ic \&%P ,
 .Sx \&%Q ,  .Ic \&%Q ,
 .Sx \&%R ,  .Ic \&%R ,
 .Sx \&%T ,  .Ic \&%T ,
 .Sx \&%U ,  .Ic \&%U ,
 and  and
 .Sx \&%V  .Ic \&%V
 child macros (at least one must be specified).  child macros (at least one must be specified).
 .Pp  .Pp
 Examples:  Examples:
Line 2290  Examples:
Line 2191  Examples:
 \&.%A J. D. Ullman  \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation  \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley  \&.%I Addison-Wesley
 \&.%C Reading, Massachusettes  \&.%C Reading, Massachusetts
 \&.%D 1979  \&.%D 1979
 \&.Re  \&.Re
 .Ed  .Ed
 .Pp  .Pp
 If an  If an
 .Sx \&Rs  .Ic \&Rs
 block is used within a SEE ALSO section, a vertical space is asserted  block is used within a SEE ALSO section, a vertical space is asserted
 before the rendered output, else the block continues on the current  before the rendered output, else the block continues on the current
 line.  line.
 .Ss \&Rv  .It Ic \&Rv Fl std Op Ar function ...
 Insert a standard sentence regarding a function call's return value of 0  Insert a standard sentence regarding a function call's return value of 0
 on success and \-1 on error, with the  on success and \-1 on error, with the
 .Va errno  .Va errno
 libc global variable set on error.  libc global variable set on error.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Rv Fl std Op Ar function ...  
 .Pp  
 If  If
 .Ar function  .Ar function
 is not specified, the document's name set by  is not specified, the document's name set by
 .Sx \&Nm  .Ic \&Nm
 is used.  is used.
 Multiple  Multiple
 .Ar function  .Ar function
 arguments are treated as separate functions.  arguments are treated as separate functions.
 .Pp  .Pp
 See also  See also
 .Sx \&Ex .  .Ic \&Ex .
 .Ss \&Sc  .It Ic \&Sc
 Close single-quoted context opened by  Close single-quoted context opened by
 .Sx \&So .  .Ic \&So .
 .Ss \&Sh  .It Ic \&Sh Ar TITLE LINE
 Begin a new section.  Begin a new section.
 For a list of conventional manual sections, see  For a list of conventional manual sections, see
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
Line 2331  These sections should be used unless it's absolutely n
Line 2229  These sections should be used unless it's absolutely n
 custom sections be used.  custom sections be used.
 .Pp  .Pp
 Section names should be unique so that they may be keyed by  Section names should be unique so that they may be keyed by
 .Sx \&Sx .  .Ic \&Sx .
 Although this macro is parsed, it should not consist of child node or it  Although this macro is parsed, it should not consist of child node or it
 may not be linked with  may not be linked with
 .Sx \&Sx .  .Ic \&Sx .
 .Pp  .Pp
 See also  See also
 .Sx \&Pp ,  .Ic \&Pp ,
 .Sx \&Ss ,  .Ic \&Ss ,
 and  and
 .Sx \&Sx .  .Ic \&Sx .
 .Ss \&Sm  .It Ic \&Sm Op Cm on | off
 Switches the spacing mode for output generated from macros.  Switches the spacing mode for output generated from macros.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Sm Op Cm on | off  
 .Pp  
 By default, spacing is  By default, spacing is
 .Cm on .  .Cm on .
 When switched  When switched
Line 2356  output generated from adjacent macros, but text lines
Line 2251  output generated from adjacent macros, but text lines
 still get normal spacing between words and sentences.  still get normal spacing between words and sentences.
 .Pp  .Pp
 When called without an argument, the  When called without an argument, the
 .Sx \&Sm  .Ic \&Sm
 macro toggles the spacing mode.  macro toggles the spacing mode.
 Using this is not recommended because it makes the code harder to read.  Using this is not recommended because it makes the code harder to read.
 .Ss \&So  .It Ic \&So Ar block
 Multi-line version of  Multi-line version of
 .Sx \&Sq .  .Ic \&Sq .
 .Ss \&Sq  .It Ic \&Sq Ar line
 Encloses its arguments in  Encloses its arguments in
 .Sq typewriter  .Sq typewriter
 single-quotes.  single-quotes.
 .Pp  .Pp
 See also  See also
 .Sx \&Dq ,  .Ic \&Dq ,
 .Sx \&Qq ,  .Ic \&Qq ,
 and  and
 .Sx \&So .  .Ic \&So .
 .Ss \&Ss  .It Ic \&Ss Ar Title line
 Begin a new subsection.  Begin a new subsection.
 Unlike with  Unlike with
 .Sx \&Sh ,  .Ic \&Sh ,
 there is no convention for the naming of subsections.  there is no convention for the naming of subsections.
 Except  Except
 .Em DESCRIPTION ,  .Em DESCRIPTION ,
Line 2384  the conventional sections described in
Line 2279  the conventional sections described in
 rarely have subsections.  rarely have subsections.
 .Pp  .Pp
 Sub-section names should be unique so that they may be keyed by  Sub-section names should be unique so that they may be keyed by
 .Sx \&Sx .  .Ic \&Sx .
 Although this macro is parsed, it should not consist of child node or it  Although this macro is parsed, it should not consist of child node or it
 may not be linked with  may not be linked with
 .Sx \&Sx .  .Ic \&Sx .
 .Pp  .Pp
 See also  See also
 .Sx \&Pp ,  .Ic \&Pp ,
 .Sx \&Sh ,  .Ic \&Sh ,
 and  and
 .Sx \&Sx .  .Ic \&Sx .
 .Ss \&St  .It Ic \&St Fl Ns Ar abbreviation
 Replace an abbreviation for a standard with the full form.  Replace an abbreviation for a standard with the full form.
 The following standards are recognised.  The following standards are recognised.
 Where multiple lines are given without a blank line in between,  Where multiple lines are given without a blank line in between,
Line 2426  The original C standard.
Line 2321  The original C standard.
 .Pp  .Pp
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
 .It \-ansiC-99  
 .St -ansiC-99  
 .br  .br
 The second major version of the C language standard.  The second major version of the C language standard.
 .Pp  .Pp
Line 2527  The following three refer to parts of it.
Line 2420  The following three refer to parts of it.
 .br  .br
 Networking APIs, including sockets.  Networking APIs, including sockets.
 .Pp  .Pp
 .It \-xpg4.3  
 .St -xpg4.3  
 .Pp  
 .It \-svid4  .It \-svid4
 .St -svid4 ,  .St -svid4 ,
 .br  .br
Line 2559  The following refer to parts of it.
Line 2449  The following refer to parts of it.
 .It \-xns5.2  .It \-xns5.2
 .St -xns5.2  .St -xns5.2
 .El  .El
 .It Single UNIX Specification version 3 and related standards  .It Single UNIX Specification version 3
 .Pp  .Pp
 .Bl -tag -width "-p1003.1g-2000X" -compact  .Bl -tag -width "-p1003.1-2001" -compact
 .It \-p1003.1d-99  
 .St -p1003.1d-99  
 .br  
 Additional real-time extensions.  
 .Pp  
 .It \-p1003.1-2001  .It \-p1003.1-2001
 .St -p1003.1-2001  .St -p1003.1-2001
 .It \-susv3  .It \-susv3
Line 2591  The second and last Technical Corrigendum.
Line 2476  The second and last Technical Corrigendum.
 .br  .br
 This standard is also called  This standard is also called
 X/Open Portability Guide version 7.  X/Open Portability Guide version 7.
 .Pp  
 .It \-p1003.1-2013  
 .St -p1003.1-2013  
 .br  
 This is the first Technical Corrigendum.  
 .El  .El
 .It Other standards  .It Other standards
 .Pp  .Pp
Line 2619  Ethernet local area networks.
Line 2499  Ethernet local area networks.
 .St -ieee1275-94  .St -ieee1275-94
 .El  .El
 .El  .El
 .Ss \&Sx  .It Ic \&Sx Ar Title line
 Reference a section or subsection in the same manual page.  Reference a section or subsection in the same manual page.
 The referenced section or subsection name must be identical to the  The referenced section or subsection name must be identical to the
 enclosed argument, including whitespace.  enclosed argument, including whitespace.
Line 2628  Examples:
Line 2508  Examples:
 .Dl \&.Sx MANUAL STRUCTURE  .Dl \&.Sx MANUAL STRUCTURE
 .Pp  .Pp
 See also  See also
 .Sx \&Sh  .Ic \&Sh
 and  and
 .Sx \&Ss .  .Ic \&Ss .
 .Ss \&Sy  .It Ic \&Sy Ar word ...
 Request a boldface font.  Request a boldface font.
 .Pp  .Pp
 This is most often used to indicate importance or seriousness (not to be  This is most often used to indicate importance or seriousness (not to be
 confused with stress emphasis, see  confused with stress emphasis, see
 .Sx \&Em ) .  .Ic \&Em ) .
 When none of the semantic macros fit, it is also adequate for syntax  When none of the semantic macros fit, it is also adequate for syntax
 elements that have to be given or that appear verbatim.  elements that have to be given or that appear verbatim.
 .Pp  .Pp
Line 2652  program.
Line 2532  program.
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Bf ,  .Ic \&Em ,
 .Sx \&Em ,  .Ic \&No ,
 .Sx \&Li ,  
 and  and
 .Sx \&No .  .Ic \&Ql .
 .Ss \&Ta  .It Ic \&Ta
 Table cell separator in  Table cell separator in
 .Sx \&Bl Fl column  .Ic \&Bl Fl column
 lists; can only be used below  lists; can only be used below
 .Sx \&It .  .Ic \&It .
 .Ss \&Tn  .It Ic \&Tn Ar word ...
 Supported only for compatibility, do not use this in new manuals.  Supported only for compatibility, do not use this in new manuals.
 Even though the macro name  Even though the macro name
 .Pq Dq tradename  .Pq Dq tradename
 suggests a semantic function, historic usage is inconsistent, mostly  suggests a semantic function, historic usage is inconsistent, mostly
 using it as a presentation-level macro to request a small caps font.  using it as a presentation-level macro to request a small caps font.
 .Ss \&Ud  .It Ic \&Ud
 Supported only for compatibility, do not use this in new manuals.  Supported only for compatibility, do not use this in new manuals.
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
 .Ss \&Ux  .It Ic \&Ux
 Supported only for compatibility, do not use this in new manuals.  Supported only for compatibility, do not use this in new manuals.
 Prints out  Prints out
 .Dq Ux .  .Dq Ux .
 .Ss \&Va  .It Ic \&Va Oo Ar type Oc Ar identifier ...
 A variable name.  A variable name.
 .Pp  .Pp
 Examples:  Examples:
Line 2684  Examples:
Line 2563  Examples:
 .Dl \&.Va const char *bar ;  .Dl \&.Va const char *bar ;
 .Pp  .Pp
 For function arguments and parameters, use  For function arguments and parameters, use
 .Sx \&Fa  .Ic \&Fa
 instead.  instead.
 For declarations of global variables in the  For declarations of global variables in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, use  section, use
 .Sx \&Vt .  .Ic \&Vt .
 .Ss \&Vt  .It Ic \&Vt Ar type Op Ar identifier
 A variable type.  A variable type.
 .Pp  .Pp
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
Line 2712  Examples:
Line 2591  Examples:
 .Dl \&.Vt extern const char * const sys_signame[] \&;  .Dl \&.Vt extern const char * const sys_signame[] \&;
 .Pp  .Pp
 For parameters in function prototypes, use  For parameters in function prototypes, use
 .Sx \&Fa  .Ic \&Fa
 instead, for function return types  instead, for function return types
 .Sx \&Ft ,  .Ic \&Ft ,
 and for variable names outside the  and for variable names outside the
 .Em SYNOPSIS  .Em SYNOPSIS
 section  section
 .Sx \&Va ,  .Ic \&Va ,
 even when including a type with the name.  even when including a type with the name.
 See also  See also
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
 .Ss \&Xc  .It Ic \&Xc
 Close a scope opened by  Close a scope opened by
 .Sx \&Xo .  .Ic \&Xo .
 .Ss \&Xo  .It Ic \&Xo Ar block
 Extend the header of an  Extend the header of an
 .Sx \&It  .Ic \&It
 macro or the body of a partial-implicit block macro  macro or the body of a partial-implicit block macro
 beyond the end of the input line.  beyond the end of the input line.
 This macro originally existed to work around the 9-argument limit  This macro originally existed to work around the 9-argument limit
 of historic  of historic
 .Xr roff 7 .  .Xr roff 7 .
 .Ss \&Xr  .It Ic \&Xr Ar name section
 Link to another manual  Link to another manual
 .Pq Qq cross-reference .  .Pq Qq cross-reference .
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Xr Ar name Op section  
 .Pp  
 Cross reference the  Cross reference the
 .Ar name  .Ar name
 and  and
 .Ar section  .Ar section
 number of another man page;  number of another man page.
 omitting the section number is rarely useful.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Xr mandoc 1  .Dl \&.Xr mandoc 1
 .Dl \&.Xr mandoc 1 \&;  .Dl \&.Xr mandoc 1 \&;
 .Dl \&.Xr mandoc 1 \&Ns s behaviour  .Dl \&.Xr mandoc 1 \&Ns s behaviour
 .Ss \&br  .El
 Emits a line-break.  
 This macro should not be used; it is implemented for compatibility with  
 historical manuals.  
 .Pp  
 Consider using  
 .Sx \&Pp  
 in the event of natural paragraph breaks.  
 .Ss \&sp  
 Emits vertical space.  
 This macro should not be used; it is implemented for compatibility with  
 historical manuals.  
 Its syntax is as follows:  
 .Pp  
 .D1 Pf \. Sx \&sp Op Ar height  
 .Pp  
 The  
 .Ar height  
 argument is a scaling width as described in  
 .Xr roff 7 .  
 If unspecified,  
 .Sx \&sp  
 asserts a single vertical space.  
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 The syntax of a macro depends on its classification.  The syntax of a macro depends on its classification.
 In this section,  In this section,
Line 2821  column, if applicable, describes closure rules.
Line 2674  column, if applicable, describes closure rules.
 .Ss Block full-explicit  .Ss Block full-explicit
 Multi-line scope closed by an explicit closing macro.  Multi-line scope closed by an explicit closing macro.
 All macros contains bodies; only  All macros contains bodies; only
 .Sx \&Bf  .Ic \s&Bf
 and  and
 .Pq optionally  .Pq optionally
 .Sx \&Bl  .Ic \&Bl
 contain a head.  contain a head.
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
Line 2833  contain a head.
Line 2686  contain a head.
 .Ed  .Ed
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed  .It Ic \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ed
 .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef  .It Ic \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ef
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek  .It Ic \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ek
 .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El  .It Ic \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Ic \&El
 .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd  .It Ic \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bd
 .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf  .It Ic \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bf
 .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk  .It Ic \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bk
 .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl  .It Ic \&El  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bl
 .El  .El
 .Ss Block full-implicit  .Ss Block full-implicit
 Multi-line scope closed by end-of-file or implicitly by another macro.  Multi-line scope closed by end-of-file or implicitly by another macro.
 All macros have bodies; some  All macros have bodies; some
 .Po  .Po
 .Sx \&It Fl bullet ,  .Ic \&It Fl bullet ,
 .Fl hyphen ,  .Fl hyphen ,
 .Fl dash ,  .Fl dash ,
 .Fl enum ,  .Fl enum ,
Line 2854  All macros have bodies; some
Line 2707  All macros have bodies; some
 .Pc  .Pc
 don't have heads; only one  don't have heads; only one
 .Po  .Po
 .Sx \&It  .Ic \&It
 in  in
 .Sx \&Bl Fl column  .Ic \&Bl Fl column
 .Pc  .Pc
 has multiple heads.  has multiple heads.
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 2865  has multiple heads.
Line 2718  has multiple heads.
 .Ed  .Ed
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&It Ta \&No Ta Yes  Ta closed by Sx \&It , Sx \&El  .It Ic \&It Ta \&No Ta Yes  Ta closed by Ic \&It , Ic \&El
 .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh  .It Ic \&Nd Ta \&No Ta \&No Ta closed by Ic \&Sh
 .It Sx \&Nm Ta \&No Ta Yes  Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss  .It Ic \&Nm Ta \&No Ta Yes  Ta closed by Ic \&Nm , Ic \&Sh , Ic \&Ss
 .It Sx \&Sh Ta \&No Ta Yes  Ta closed by Sx \&Sh  .It Ic \&Sh Ta \&No Ta Yes  Ta closed by Ic \&Sh
 .It Sx \&Ss Ta \&No Ta Yes  Ta closed by Sx \&Sh , Sx \&Ss  .It Ic \&Ss Ta \&No Ta Yes  Ta closed by Ic \&Sh , Ic \&Ss
 .El  .El
 .Pp  .Pp
 Note that the  Note that the
 .Sx \&Nm  .Ic \&Nm
 macro is a  macro is a
 .Sx Block full-implicit  .Sx Block full-implicit
 macro only when invoked as the first macro  macro only when invoked as the first macro
Line 2885  section line, else it is
Line 2738  section line, else it is
 Like block full-explicit, but also with single-line scope.  Like block full-explicit, but also with single-line scope.
 Each has at least a body and, in limited circumstances, a head  Each has at least a body and, in limited circumstances, a head
 .Po  .Po
 .Sx \&Fo ,  .Ic \&Fo ,
 .Sx \&Eo  .Ic \&Eo
 .Pc  .Pc
 and/or tail  and/or tail
 .Pq Sx \&Ec .  .Pq Ic \&Ec .
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
 \(lBbody...\(rB  \(lBbody...\(rB
Line 2900  and/or tail
Line 2753  and/or tail
 .Ed  .Ed
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao  .It Ic \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Ao
 .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac  .It Ic \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Ac
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo  .It Ic \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Bo
 .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc  .It Ic \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Bc
 .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro  .It Ic \&Brc Ta    Yes      Ta    Yes      Ta    opened by Ic \&Bro
 .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc  .It Ic \&Bro Ta    Yes      Ta    Yes      Ta    closed by Ic \&Brc
 .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do  .It Ic \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Do
 .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc  .It Ic \&Do  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Dc
 .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo  .It Ic \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Eo
 .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec  .It Ic \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Ec
 .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo  .It Ic \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Fo
 .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc  .It Ic \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Fc
 .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo  .It Ic \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Oo
 .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc  .It Ic \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Oc
 .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po  .It Ic \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Po
 .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc  .It Ic \&Po  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Pc
 .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo  .It Ic \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Oo
 .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc  .It Ic \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Oc
 .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs  .It Ic \&Re  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Rs
 .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re  .It Ic \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Re
 .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So  .It Ic \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&So
 .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc  .It Ic \&So  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Sc
 .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo  .It Ic \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Xo
 .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc  .It Ic \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Xc
 .El  .El
 .Ss Block partial-implicit  .Ss Block partial-implicit
 Like block full-implicit, but with single-line scope closed by the  Like block full-implicit, but with single-line scope closed by the
Line 2933  end of the line.
Line 2786  end of the line.
 .Ed  .Ed
 .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed  .It Em Macro Ta Em Callable Ta Em Parsed
 .It Sx \&Aq  Ta    Yes      Ta    Yes  .It Ic \&Aq  Ta    Yes      Ta    Yes
 .It Sx \&Bq  Ta    Yes      Ta    Yes  .It Ic \&Bq  Ta    Yes      Ta    Yes
 .It Sx \&Brq Ta    Yes      Ta    Yes  .It Ic \&Brq Ta    Yes      Ta    Yes
 .It Sx \&D1  Ta    \&No     Ta    \&Yes  .It Ic \&D1  Ta    \&No     Ta    \&Yes
 .It Sx \&Dl  Ta    \&No     Ta    Yes  .It Ic \&Dl  Ta    \&No     Ta    Yes
 .It Sx \&Dq  Ta    Yes      Ta    Yes  .It Ic \&Dq  Ta    Yes      Ta    Yes
 .It Sx \&En  Ta    Yes      Ta    Yes  .It Ic \&En  Ta    Yes      Ta    Yes
 .It Sx \&Op  Ta    Yes      Ta    Yes  .It Ic \&Op  Ta    Yes      Ta    Yes
 .It Sx \&Pq  Ta    Yes      Ta    Yes  .It Ic \&Pq  Ta    Yes      Ta    Yes
 .It Sx \&Ql  Ta    Yes      Ta    Yes  .It Ic \&Ql  Ta    Yes      Ta    Yes
 .It Sx \&Qq  Ta    Yes      Ta    Yes  .It Ic \&Qq  Ta    Yes      Ta    Yes
 .It Sx \&Sq  Ta    Yes      Ta    Yes  .It Ic \&Sq  Ta    Yes      Ta    Yes
 .It Sx \&Vt  Ta    Yes      Ta    Yes  .It Ic \&Vt  Ta    Yes      Ta    Yes
 .El  .El
 .Pp  .Pp
 Note that the  Note that the
 .Sx \&Vt  .Ic \&Vt
 macro is a  macro is a
 .Sx Block partial-implicit  .Sx Block partial-implicit
 only when invoked as the first macro  only when invoked as the first macro
Line 2959  section line, else it is
Line 2812  section line, else it is
 .Sx In-line .  .Sx In-line .
 .Ss Special block macro  .Ss Special block macro
 The  The
 .Sx \&Ta  .Ic \&Ta
 macro can only be used below  macro can only be used below
 .Sx \&It  .Ic \&It
 in  in
 .Sx \&Bl Fl column  .Ic \&Bl Fl column
 lists.  lists.
 It delimits blocks representing table cells;  It delimits blocks representing table cells;
 these blocks have bodies, but no heads.  these blocks have bodies, but no heads.
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&Ta  Ta    Yes      Ta    Yes    Ta closed by Sx \&Ta , Sx \&It  .It Ic \&Ta  Ta    Yes      Ta    Yes    Ta closed by Ic \&Ta , Ic \&It
 .El  .El
 .Ss In-line  .Ss In-line
 Closed by the end of the line, fixed argument lengths,  Closed by the end of the line, fixed argument lengths,
Line 2987  then the macro accepts an arbitrary number of argument
Line 2840  then the macro accepts an arbitrary number of argument
 .Ed  .Ed
 .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%B  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%C  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%D  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%I  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%J  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%N  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%O  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%P  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%Q  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%R  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%T  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%U  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&%V  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ad  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&An  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0  .It Ic \&Ap  Ta    Yes      Ta    Yes      Ta    0
 .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Ar  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1  .It Ic \&At  Ta    Yes      Ta    Yes      Ta    1
 .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Bsx Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0  .It Ic \&Bt  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Bx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Cm  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1  .It Ic \&Db  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Dd  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Dv  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Dx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Em  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Er  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Es  Ta    Yes      Ta    Yes      Ta    2  .It Ic \&Es  Ta    Yes      Ta    Yes      Ta    2
 .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ev  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Ex  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Fa  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0  .It Ic \&Fd  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Fl  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Fn  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Fr  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Fr  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ft  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Fx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Hf  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ic  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&In  Ta    \&No     Ta    \&No     Ta    1  .It Ic \&In  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1  .It Ic \&Lb  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Li  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Lk  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0  .It Ic \&Lp  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ms  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Mt  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Nm  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0  .It Ic \&No  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0  .It Ic \&Ns  Ta    Yes      Ta    Yes      Ta    0
 .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Nx  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Os  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Ot  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Ot  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Ox  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Pa  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1  .It Ic \&Pf  Ta    Yes      Ta    Yes      Ta    1
 .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0  .It Ic \&Pp  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n  .It Ic \&Rv  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    <2  .It Ic \&Sm  Ta    \&No     Ta    \&No     Ta    <2
 .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1  .It Ic \&St  Ta    \&No     Ta    Yes      Ta    1
 .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Sx  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Sy  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Tn  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0  .It Ic \&Ud  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Ux  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n  .It Ic \&Va  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Vt  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0  .It Ic \&Xr  Ta    Yes      Ta    Yes      Ta    2
 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1  
 .El  .El
 .Ss Delimiters  .Ss Delimiters
 When a macro argument consists of one single input character  When a macro argument consists of one single input character
Line 3077  For many macros, when the leading arguments are openin
Line 2928  For many macros, when the leading arguments are openin
 these delimiters are put before the macro scope,  these delimiters are put before the macro scope,
 and when the trailing arguments are closing delimiters,  and when the trailing arguments are closing delimiters,
 these delimiters are put after the macro scope.  these delimiters are put after the macro scope.
   Spacing is suppressed after opening delimiters
   and before closing delimiters.
 For example,  For example,
 .Pp  .Pp
 .D1 Pf \. \&Aq "( [ word ] ) ."  .D1 Pf \. \&Aq "( [ word ] ) ."
Line 3133  renders as:
Line 2986  renders as:
 .D1 Fl a ( b | c \*(Ba d ) e  .D1 Fl a ( b | c \*(Ba d ) e
 .Pp  .Pp
 This applies to both opening and closing delimiters,  This applies to both opening and closing delimiters,
 and also to the middle delimiter:  and also to the middle delimiter, which does not suppress spacing:
 .Pp  .Pp
 .Bl -tag -width Ds -offset indent -compact  .Bl -tag -width Ds -offset indent -compact
 .It \&|  .It \&|
Line 3165  Manually switching the font using the
Line 3018  Manually switching the font using the
 font escape sequences is never required.  font escape sequences is never required.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section provides an incomplete list of compatibility issues  This section provides an incomplete list of compatibility issues
 between mandoc and other troff implementations, at this time limited  between mandoc and GNU troff
 to GNU troff  
 .Pq Qq groff .  .Pq Qq groff .
 The term  
 .Qq historic groff  
 refers to groff versions before 1.17,  
 which featured a significant update of the  
 .Pa doc.tmac  
 file.  
 .Pp  .Pp
 Heirloom troff, the other significant troff implementation accepting  
 \-mdoc, is similar to historic groff.  
 .Pp  
 The following problematic behaviour is found in groff:  The following problematic behaviour is found in groff:
 .ds hist (Historic groff only.)  
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
 Display macros  .Ic \&Dd
 .Po  
 .Sx \&Bd ,  
 .Sx \&Dl ,  
 and  
 .Sx \&D1  
 .Pc  
 may not be nested.  
 \*[hist]  
 .It  
 .Sx \&At  
 with unknown arguments produces no output at all.  
 \*[hist]  
 Newer groff and mandoc print  
 .Qq AT&T UNIX  
 and the arguments.  
 .It  
 .Sx \&Bl Fl column  
 does not recognise trailing punctuation characters when they immediately  
 precede tabulator characters, but treats them as normal text and  
 outputs a space before them.  
 .It  
 .Sx \&Bd Fl ragged compact  
 does not start a new line.  
 \*[hist]  
 .It  
 .Sx \&Dd  
 with non-standard arguments behaves very strangely.  with non-standard arguments behaves very strangely.
 When there are three arguments, they are printed verbatim.  When there are three arguments, they are printed verbatim.
 Any other number of arguments is replaced by the current date,  Any other number of arguments is replaced by the current date,
Line 3217  but without any arguments the string
Line 3033  but without any arguments the string
 .Dq Epoch  .Dq Epoch
 is printed.  is printed.
 .It  .It
 .Sx \&Fl  .Ic \&Lk
 does not print a dash for an empty argument.  
 \*[hist]  
 .It  
 .Sx \&Fn  
 does not start a new line unless invoked as the line macro in the  
 .Em SYNOPSIS  
 section.  
 \*[hist]  
 .It  
 .Sx \&Fo  
 with  
 .Pf non- Sx \&Fa  
 children causes inconsistent spacing between arguments.  
 In mandoc, a single space is always inserted between arguments.  
 .It  
 .Sx \&Ft  
 in the  
 .Em SYNOPSIS  
 causes inconsistent vertical spacing, depending on whether a prior  
 .Sx \&Fn  
 has been invoked.  
 See  
 .Sx \&Ft  
 and  
 .Sx \&Fn  
 for the normalised behaviour in mandoc.  
 .It  
 .Sx \&In  
 ignores additional arguments and is not treated specially in the  
 .Em SYNOPSIS .  
 \*[hist]  
 .It  
 .Sx \&It  
 sometimes requires a  
 .Fl nested  
 flag.  
 \*[hist]  
 In new groff and mandoc, any list may be nested by default and  
 .Fl enum  
 lists will restart the sequence only for the sub-list.  
 .It  
 .Sx \&Li  
 followed by a delimiter is incorrectly used in some manuals  
 instead of properly quoting that character, which sometimes works with  
 historic groff.  
 .It  
 .Sx \&Lk  
 only accepts a single link-name argument; the remainder is misformatted.  only accepts a single link-name argument; the remainder is misformatted.
 .It  .It
 .Sx \&Pa  .Ic \&Pa
 does not format its arguments when used in the FILES section under  does not format its arguments when used in the FILES section under
 certain list types.  certain list types.
 .It  .It
 .Sx \&Ta  .Ic \&Ta
 can only be called by other macros, but not at the beginning of a line.  can only be called by other macros, but not at the beginning of a line.
 .It  .It
 .Sx \&%C  .Ic \&%C
 is not implemented (up to and including groff-1.22.2).  is not implemented (up to and including groff-1.22.2).
 .It  .It
 Historic groff only allows up to eight or nine arguments per macro input  
 line, depending on the exact situation.  
 Providing more arguments causes garbled output.  
 The number of arguments on one input line is not limited with mandoc.  
 .It  
 Historic groff has many un-callable macros.  
 Most of these (excluding some block-level macros) are callable  
 in new groff and mandoc.  
 .It  
 .Sq \(ba  
 (vertical bar) is not fully supported as a delimiter.  
 \*[hist]  
 .It  
 .Sq \ef  .Sq \ef
 .Pq font face  .Pq font face
 and  and
Line 3306  The following features are unimplemented in mandoc:
Line 3062  The following features are unimplemented in mandoc:
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
 .Sx \&Bd  .Ic \&Bd Fl file Ar file
 .Fl file Ar file .  is unsupported for security reasons.
 .It  .It
 .Sx \&Bd  .Ic \&Bd
   .Fl filled
   does not adjust the right margin, but is an alias for
   .Ic \&Bd
   .Fl ragged .
   .It
   .Ic \&Bd
   .Fl literal
   does not use a literal font, but is an alias for
   .Ic \&Bd
   .Fl unfilled .
   .It
   .Ic \&Bd
 .Fl offset Cm center  .Fl offset Cm center
 and  and
 .Fl offset Cm right .  .Fl offset Cm right
 Groff does not implement centred and flush-right rendering either,  don't work.
   Groff does not implement centered and flush-right rendering either,
 but produces large indentations.  but produces large indentations.
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
Line 3324  but produces large indentations.
Line 3093  but produces large indentations.
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr roff 7 ,  .Xr roff 7 ,
 .Xr tbl 7  .Xr tbl 7
   .Pp
   The web page
   .Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"
   provides a few tutorial-style pages for beginners, an extensive style
   guide for advanced authors, and an alphabetic index helping to choose
   the best macros for various kinds of content.
 .Sh HISTORY  .Sh HISTORY
 The  The
 .Nm  .Nm

Legend:
Removed from v.1.243  
changed lines
  Added in v.1.275

CVSweb