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

Diff for /mandoc/mdoc.7 between version 1.207 and 1.274

version 1.207, 2011/08/30 13:14:01 version 1.274, 2018/12/23 22:03:32
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 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 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mdoc  .Nm mdoc
 .Nd mdoc language reference  .Nd semantic markup language for formatting manual pages
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mdoc  .Nm mdoc
 language is used to format  language supports authoring of manual pages for the
 .Bx  .Xr man 1
 .Ux  utility by allowing semantic annotations of words, phrases,
 manuals.  page sections and complete manual pages.
 This reference document describes its syntax, structure, and  Such annotations are used by formatting tools to achieve a uniform
 usage.  presentation across all manuals written in
 The reference implementation for  .Nm ,
   and to support hyperlinking if supported by the output medium.
   .Pp
   This reference document describes the structure of manual pages
   and the syntax and usage of the
 .Nm  .Nm
 formatting is  language.
   The reference implementation of a parsing and formatting tool is
 .Xr mandoc 1 ;  .Xr mandoc 1 ;
 the  the
 .Sx COMPATIBILITY  .Sx COMPATIBILITY
 section describes compatibility with other implementations.  section describes compatibility with other implementations.
 .Pp  .Pp
 An  In an
 .Nm  .Nm
 document follows simple rules: lines beginning with the control  document, lines beginning with the control character
 character  
 .Sq \&.  .Sq \&.
 are parsed for macros.  are called
 Lines not beginning with the control character are  .Dq macro lines .
 interpreted within the scope of prior macros:  The first word is the macro name.
   It consists of two or three letters.
   Most macro names begin with a capital letter.
   For a list of available macros, see
   .Sx MACRO OVERVIEW .
   The words following the macro name are arguments to the macro, optionally
   including the names of other, callable macros; see
   .Sx MACRO SYNTAX
   for details.
   .Pp
   Lines not beginning with the control character are called
   .Dq text lines .
   They provide free-form text to be printed; the formatting of the text
   depends on the respective processing context:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Sh Macro lines change control state.  \&.Sh Macro lines change control state.
 Text lines are interpreted within the current state.  Text lines are interpreted within the current state.
 .Ed  .Ed
 .Sh LANGUAGE SYNTAX  
 .Nm  
 documents may contain only graphable 7-bit ASCII characters, the space  
 character, and, in certain circumstances, the tab character.  
 The back-space character  
 .Sq \e  
 indicates the start of an escape sequence for  
 .Sx Comments ,  
 .Sx Predefined Strings ,  
 and  
 .Sx Special Characters .  
 .Ss Comments  
 Text following an escaped double-quote  
 .Sq \e\(dq ,  
 whether in a macro or text line, is ignored to the end of  
 line.  
 A macro line beginning with a control character and comment escape  
 .Sq \&.\e\(dq  
 is also ignored.  
 Furthermore,  
 macro lines with only a control character and optional trailing  
 whitespace are  
 stripped from input.  
 .Pp  .Pp
 Examples:  Many aspects of the basic syntax of the
 .Bd -literal -offset indent -compact  
 \&.\e\(dq This is a comment line.  
 \&.\e\(dq The next line is ignored:  
 \&.  
 \&.Em Emphasis \e\(dq This is also a comment.  
 .Ed  
 .Ss Special Characters  
 Special characters are used to encode special glyphs and are rendered  
 differently across output media.  
 They may occur in both macro and text lines.  
 Sequences begin with the escape character  
 .Sq \e  
 followed by either an open-parenthesis  
 .Sq \&(  
 for two-character sequences; an open-bracket  
 .Sq \&[  
 for n-character sequences (terminated at a close-bracket  
 .Sq \&] ) ;  
 or a single one character sequence.  
 .Pp  
 Examples:  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li \e(em  
 Two-letter em dash escape.  
 .It Li \ee  
 One-letter backslash escape.  
 .El  
 .Pp  
 See  
 .Xr mandoc_char 7  
 for a complete list.  
 .Ss Text Decoration  
 Terms may be text-decorated using the  
 .Sq \ef  
 escape followed by an indicator: B (bold), I (italic), R (regular), or P  
 (revert to previous mode).  
 A numerical representation 3, 2, or 1 (bold, italic, and regular,  
 respectively) may be used instead.  
 If a macro opens a font scope after calling  
 .Sq \ef ,  
 such as with  
 .Sx \&Bf ,  
 the  
 .Sq \ef  
 mode will be restored upon exiting the  
 .Sx \&Bf  
 scope.  
 .Pp  
 Examples:  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li \efBbold\efR  
 Write in bold, then switch to regular font mode.  
 .It Li \efIitalic\efP  
 Write in italic, then return to previous font mode.  
 .El  
 .Pp  
 Text decoration is  
 .Em not  
 recommended for  
 .Nm ,  
 which encourages semantic annotation.  
 .Ss Predefined Strings  
 Predefined strings, like  
 .Sx Special Characters ,  
 mark special output glyphs.  
 Predefined strings are escaped with the slash-asterisk,  
 .Sq \e* :  
 single-character  
 .Sq \e*X ,  
 two-character  
 .Sq \e*(XX ,  
 and N-character  
 .Sq \e*[N] .  
 .Pp  
 Examples:  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li \e*(Am  
 Two-letter ampersand predefined string.  
 .It Li \e*q  
 One-letter double-quote predefined string.  
 .El  
 .Pp  
 These strings are set using  
 .Xr roff 7 ,  
 although  
 .Nm  .Nm
 consists of several pre-set escapes listed in  language are based on the
 .Xr mandoc_char 7 .  .Xr roff 7
 .Ss Whitespace  language; see the
 Whitespace consists of the space character.  .Em LANGUAGE SYNTAX
 In text lines, whitespace is preserved within a line.  
 In macro lines, whitespace delimits arguments and is discarded.  
 .Pp  
 Unescaped trailing spaces are stripped from text line input unless in a  
 literal context.  
 In general, trailing whitespace on any input line is discouraged for  
 reasons of portability.  
 In the rare case that a blank character is needed at the end of an  
 input line, it may be forced by  
 .Sq \e\ \e& .  
 .Pp  
 In general, space characters can be rendered as literal  
 characters by using non-breaking space escapes or  
 .Sx Quotation .  
 .Pp  
 Blank text lines, which may include whitespace, are only permitted  
 within literal contexts.  
 If the first character of a text line is a space, that line is printed  
 with a leading newline.  
 .Ss Quotation  
 Macro arguments may be quoted with double-quotes to so that the  
 enclosed text is one literal term.  
 Quoted text, even if whitespace or if it would cause a macro invocation  
 when unquoted, is considered literal text.  
 .Pp  
 A quoted argument begins with a double-quote preceded by whitespace.  
 The next double-quote not pairwise adjacent to another double-quote  
 terminates the literal, regardless of surrounding whitespace.  
 .Pp  
 Examples:  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li .Fn strlen \(dqconst char *s\(dq  
 Group arguments  
 .Qq const char *s  
 into one function argument.  
 If unspecified,  
 .Qq const ,  
 .Qq char ,  
 and  and
 .Qq *s  .Em MACRO SYNTAX
 would be considered separate arguments.  sections in the
 .Pq See Sx \&Fn .  .Xr roff 7
 .It Li .Op \(dqFl a\(dq  manual for details, in particular regarding
 Consider  comments, escape sequences, whitespace, and quoting.
 .Qq \&Fl a  However, using
 as literal text instead of a flag macro.  .Xr roff 7
 .Pq Aee Sx \&Op , \&Fl .  requests in
 .El  .Nm
 .Ss Scaling Widths  documents is discouraged;
 Many macros support scaled widths for their arguments.  .Xr mandoc 1
 The syntax for a scaled width is  supports some of them merely for backward compatibility.
 .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,  
 where a decimal must be preceded or proceeded by at least one digit.  
 Negative numbers, while accepted, are truncated to zero.  
 .Pp  
 The following scaling units are accepted:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It c  
 centimetre  
 .It i  
 inch  
 .It P  
 pica (~1/6 inch)  
 .It p  
 point (~1/72 inch)  
 .It f  
 synonym for  
 .Sq u  
 .It v  
 default vertical span  
 .It m  
 width of rendered  
 .Sq m  
 .Pq em  
 character  
 .It n  
 width of rendered  
 .Sq n  
 .Pq en  
 character  
 .It u  
 default horizontal span  
 .It M  
 mini-em (~1/100 em)  
 .El  
 .Pp  
 Using anything other than  
 .Sq m ,  
 .Sq n ,  
 .Sq u ,  
 or  
 .Sq v  
 is necessarily non-portable across output media.  
 See  
 .Sx COMPATIBILITY .  
 .Pp  
 Examples:  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li \&.Bl -tag -width 2i  
 two-inch tagged list indentation  
 .Pq see Sx \&Bl  
 .It Li \&.sp 2v  
 two vertical spaces  
 .Pq see Sx \&sp  
 .El  
 .Ss Sentence Spacing  
 Sentences should terminate at the end of an input line.  
 By doing this, a formatter will be able to apply the proper amount of  
 spacing after the end of sentence (unescaped) period, exclamation mark,  
 or question mark followed by zero or more non-sentence closing  
 delimiters  
 .Po  
 .Sq \&) ,  
 .Sq \&] ,  
 .Sq \&' ,  
 .Sq \&"  
 .Pc .  
 .Pp  
 The proper spacing is also intelligently preserved if a sentence ends at  
 the boundary of a macro line.  
 .Pp  
 Examples:  
 .Bd -literal -offset indent -compact  
 Do not end sentences mid-line like this.  Instead,  
 end a sentence like this.  
 A macro would end like this:  
 \&.Xr mandoc 1 \&.  
 .Ed  
 .Sh MANUAL STRUCTURE  .Sh MANUAL STRUCTURE
 A well-formed  A well-formed
 .Nm  .Nm
Line 301  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 332  file for a utility
Line 125  file for a utility
 \&.Nm progname  \&.Nm progname
 \&.Nd one line about what it does  \&.Nd one line about what it does
 \&.\e\(dq .Sh LIBRARY  \&.\e\(dq .Sh LIBRARY
 \&.\e\(dq For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, and 9 only.
 \&.\e\(dq Not used in OpenBSD.  \&.\e\(dq Not used in OpenBSD.
 \&.Sh SYNOPSIS  \&.Sh SYNOPSIS
 \&.Nm progname  \&.Nm progname
Line 342  file for a utility
Line 135  file for a utility
 The  The
 \&.Nm  \&.Nm
 utility processes files ...  utility processes files ...
   \&.\e\(dq .Sh CONTEXT
   \&.\e\(dq For section 9 functions only.
 \&.\e\(dq .Sh IMPLEMENTATION NOTES  \&.\e\(dq .Sh IMPLEMENTATION NOTES
 \&.\e\(dq Not used in OpenBSD.  \&.\e\(dq Not used in OpenBSD.
 \&.\e\(dq .Sh RETURN VALUES  \&.\e\(dq .Sh RETURN VALUES
 \&.\e\(dq For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, and 9 function return values only.
 \&.\e\(dq .Sh ENVIRONMENT  \&.\e\(dq .Sh ENVIRONMENT
 \&.\e\(dq For sections 1, 6, 7, & 8 only.  \&.\e\(dq For sections 1, 6, 7, and 8 only.
 \&.\e\(dq .Sh FILES  \&.\e\(dq .Sh FILES
 \&.\e\(dq .Sh EXIT STATUS  \&.\e\(dq .Sh EXIT STATUS
 \&.\e\(dq For sections 1, 6, & 8 only.  \&.\e\(dq For sections 1, 6, and 8 only.
 \&.\e\(dq .Sh EXAMPLES  \&.\e\(dq .Sh EXAMPLES
 \&.\e\(dq .Sh DIAGNOSTICS  \&.\e\(dq .Sh DIAGNOSTICS
 \&.\e\(dq For sections 1, 4, 6, 7, & 8 only.  \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
 \&.\e\(dq .Sh ERRORS  \&.\e\(dq .Sh ERRORS
 \&.\e\(dq For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
 \&.\e\(dq .Sh SEE ALSO  \&.\e\(dq .Sh SEE ALSO
 \&.\e\(dq .Xr foobar 1  \&.\e\(dq .Xr foobar 1
 \&.\e\(dq .Sh STANDARDS  \&.\e\(dq .Sh STANDARDS
Line 387  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 405  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 436  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 455  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 509  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
 manual.  manual.
   .It Em CONTEXT
   This section lists the contexts in which functions can be called in section 9.
   The contexts are autoconf, process, or interrupt.
 .It Em IMPLEMENTATION NOTES  .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.  Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side  This is useful when implementing standard functions that may have side
Line 534  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 543  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 559  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.
 Make sure that examples work properly!  Make sure that examples work properly!
 .It Em DIAGNOSTICS  .It Em DIAGNOSTICS
 Documents error conditions.  Documents error messages.
 This is most useful in section 4 manuals.  In section 4 and 9 manuals, these are usually messages printed by the
   kernel to the console and to the kernel log.
   In section 1, 6, 7, and 8, these are usually messages printed by
   userland programs to the standard error output.
   .Pp
 Historically, this section was used in place of  Historically, this section was used in place of
 .Em EXIT STATUS  .Em EXIT STATUS
 for manuals in sections 1, 6, and 8; however, this practise is  for manuals in sections 1, 6, and 8; however, this practise is
 discouraged.  discouraged.
 .Pp  .Pp
 See  See
 .Sx \&Bl  .Ic \&Bl
 .Fl diag .  .Fl diag .
 .It Em ERRORS  .It Em ERRORS
 Documents error handling in sections 2, 3, and 9.  Documents
   .Xr errno 2
   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.
 Cross-references should conventionally be ordered first by section, then  Cross-references should conventionally be ordered first by section, then
 alphabetically.  alphabetically (ignoring case).
 .Pp  .Pp
 References to other documentation concerning the topic of the manual page,  References to other documentation concerning the topic of the manual page,
 for example authoritative books or journal articles, may also be  for example authoritative books or journal articles, may also be
 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 601  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 610  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 620  in this section.
Line 429  in this section.
 .It Em SECURITY CONSIDERATIONS  .It Em SECURITY CONSIDERATIONS
 Documents any security precautions that operators should consider.  Documents any security precautions that operators should consider.
 .El  .El
 .Sh MACRO SYNTAX  .Sh MACRO OVERVIEW
 Macros are one to three three characters in length and begin with a  This overview is sorted such that macros of similar purpose are listed
 control character,  together, to help find the best macro for any given purpose.
 .Sq \&. ,  Deprecated macros are not included in the overview, but can be found below
 at the beginning of the line.  in the alphabetical
 An arbitrary amount of whitespace may sit between the control character  .Sx MACRO REFERENCE .
 and the macro name.  .Ss Document preamble and NAME section macros
 Thus, the following are equivalent:  .Bl -column "Brq, Bro, Brc" description
 .Bd -literal -offset indent  .It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
 \&.Pp  .It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch
 \&.\ \ \ \&Pp  .It Ic \&Os Ta operating system version: Op Ar system Op Ar version
 .Ed  .It Ic \&Nm Ta document name (one argument)
 .Pp  .It Ic \&Nd Ta document description (one line)
 The syntax of a macro depends on its classification.  
 In this section,  
 .Sq \-arg  
 refers to macro arguments, which may be followed by zero or more  
 .Sq parm  
 parameters;  
 .Sq \&Yo  
 opens the scope of a macro; and if specified,  
 .Sq \&Yc  
 closes it out.  
 .Pp  
 The  
 .Em Callable  
 column indicates that the macro may also be called by passing its name  
 as an argument to another macro.  
 For example,  
 .Sq \&.Op \&Fl O \&Ar file  
 produces  
 .Sq Op Fl O Ar file .  
 To prevent a macro call and render the macro name literally,  
 escape it by prepending a zero-width space,  
 .Sq \e& .  
 For example,  
 .Sq \&Op \e&Fl O  
 produces  
 .Sq Op \&Fl O .  
 If a macro is not callable but its name appears as an argument  
 to another macro, it is interpreted as opaque text.  
 For example,  
 .Sq \&.Fl \&Sh  
 produces  
 .Sq Fl \&Sh .  
 .Pp  
 The  
 .Em Parsed  
 column indicates whether the macro may call other macros by receiving  
 their names as arguments.  
 If a macro is not parsed but the name of another macro appears  
 as an argument, it is interpreted as opaque text.  
 .Pp  
 The  
 .Em Scope  
 column, if applicable, describes closure rules.  
 .Ss Block full-explicit  
 Multi-line scope closed by an explicit closing macro.  
 All macros contains bodies; only  
 .Sx \&Bf  
 and  
 .Pq optionally  
 .Sx \&Bl  
 contain a head.  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  
 \&.Yc  
 .Ed  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent  
 .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 Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef  
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek  
 .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El  
 .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd  
 .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf  
 .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk  
 .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl  
 .El  .El
 .Ss Block full-implicit  .Ss Sections and cross references
 Multi-line scope closed by end-of-file or implicitly by another macro.  .Bl -column "Brq, Bro, Brc" description
 All macros have bodies; some  .It Ic \&Sh Ta section header (one line)
 .Po  .It Ic \&Ss Ta subsection header (one line)
 .Sx \&It Fl bullet ,  .It Ic \&Sx Ta internal cross reference to a section or subsection
 .Fl hyphen ,  .It Ic \&Xr Ta cross reference to another manual page: Ar name section
 .Fl dash ,  .It Ic \&Pp Ta start a text paragraph (no arguments)
 .Fl enum ,  
 .Fl item  
 .Pc  
 don't have heads; only one  
 .Po  
 .Sx \&It  
 in  
 .Sx \&Bl Fl column  
 .Pc  
 has multiple heads.  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  
 \(lBbody...\(rB  
 .Ed  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent  
 .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 Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh  
 .It Sx \&Nm Ta \&No Ta Yes  Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss  
 .It Sx \&Sh Ta \&No Ta Yes  Ta closed by Sx \&Sh  
 .It Sx \&Ss Ta \&No Ta Yes  Ta closed by Sx \&Sh , Sx \&Ss  
 .El  .El
 .Pp  .Ss Displays and lists
 Note that the  .Bl -column "Brq, Bro, Brc" description
 .Sx \&Nm  .It Ic \&Bd , \&Ed Ta display block:
 macro is a  .Fl Ar type
 .Sx Block full-implicit  .Op Fl offset Ar width
 macro only when invoked as the first macro  .Op Fl compact
 in a  .It Ic \&D1 Ta indented display (one line)
 .Em SYNOPSIS  .It Ic \&Dl Ta indented literal display (one line)
 section line, else it is  .It Ic \&Ql Ta in-line literal display: Ql text
 .Sx In-line .  .It Ic \&Bl , \&El Ta list block:
 .Ss Block partial-explicit  .Fl Ar type
 Like block full-explicit, but also with single-line scope.  .Op Fl width Ar val
 Each has at least a body and, in limited circumstances, a head  .Op Fl offset Ar val
 .Po  .Op Fl compact
 .Sx \&Fo ,  .It Ic \&It Ta list item (syntax depends on Fl Ar type )
 .Sx \&Eo  .It Ic \&Ta Ta table cell separator in Ic \&Bl Fl column No lists
 .Pc  .It Ic \&Rs , \&%* , \&Re Ta bibliographic block (references)
 and/or tail  
 .Pq Sx \&Ec .  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  
 \&.Yc \(lBtail...\(rB  
   
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \  
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  
 .Ed  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent  
 .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 Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac  
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo  
 .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc  
 .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro  
 .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc  
 .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do  
 .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc  
 .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo  
 .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec  
 .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo  
 .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc  
 .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo  
 .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc  
 .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po  
 .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc  
 .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo  
 .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc  
 .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs  
 .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re  
 .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So  
 .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc  
 .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo  
 .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc  
 .El  .El
 .Ss Block partial-implicit  .Ss Spacing control
 Like block full-implicit, but with single-line scope closed by the  .Bl -column "Brq, Bro, Brc" description
 end of the line.  .It Ic \&Pf Ta prefix, no following horizontal space (one argument)
 .Bd -literal -offset indent  .It Ic \&Ns Ta roman font, no preceding horizontal space (no arguments)
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB  .It Ic \&Ap Ta apostrophe without surrounding whitespace (no arguments)
 .Ed  .It Ic \&Sm Ta switch horizontal spacing mode: Op Cm on | off
 .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent  .It Ic \&Bk , \&Ek Ta keep block: Fl words
 .It Em Macro Ta Em Callable Ta Em Parsed  
 .It Sx \&Aq  Ta    Yes      Ta    Yes  
 .It Sx \&Bq  Ta    Yes      Ta    Yes  
 .It Sx \&Brq Ta    Yes      Ta    Yes  
 .It Sx \&D1  Ta    \&No     Ta    \&Yes  
 .It Sx \&Dl  Ta    \&No     Ta    Yes  
 .It Sx \&Dq  Ta    Yes      Ta    Yes  
 .It Sx \&Op  Ta    Yes      Ta    Yes  
 .It Sx \&Pq  Ta    Yes      Ta    Yes  
 .It Sx \&Ql  Ta    Yes      Ta    Yes  
 .It Sx \&Qq  Ta    Yes      Ta    Yes  
 .It Sx \&Sq  Ta    Yes      Ta    Yes  
 .It Sx \&Vt  Ta    Yes      Ta    Yes  
 .El  .El
 .Pp  .Ss Semantic markup for command line utilities
 Note that the  .Bl -column "Brq, Bro, Brc" description
 .Sx \&Vt  .It Ic \&Nm Ta start a SYNOPSIS block with the name of a utility
 macro is a  .It Ic \&Fl Ta command line options (flags) (>=0 arguments)
 .Sx Block partial-implicit  .It Ic \&Cm Ta command modifier (>0 arguments)
 only when invoked as the first macro  .It Ic \&Ar Ta command arguments (>=0 arguments)
 in a  .It Ic \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)
 .Em SYNOPSIS  .It Ic \&Ic Ta internal or interactive command (>0 arguments)
 section line, else it is  .It Ic \&Ev Ta environmental variable (>0 arguments)
 .Sx In-line .  .It Ic \&Pa Ta file system path (>=0 arguments)
 .Ss Special block macro  
 The  
 .Sx \&Ta  
 macro can only be used below  
 .Sx \&It  
 in  
 .Sx \&Bl Fl column  
 lists.  
 It delimits blocks representing table cells;  
 these blocks have bodies, but no heads.  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent  
 .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  
 .El  .El
 .Ss In-line  .Ss Semantic markup for function libraries
 Closed by the end of the line, fixed argument lengths,  .Bl -column "Brq, Bro, Brc" description
 and/or subsequent macros.  .It Ic \&Lb Ta function library (one argument)
 In-line macros have only text children.  .It Ic \&In Ta include file (one argument)
 If a number (or inequality) of arguments is  .It Ic \&Fd Ta other preprocessor directive (>0 arguments)
 .Pq n ,  .It Ic \&Ft Ta function type (>0 arguments)
 then the macro accepts an arbitrary number of arguments.  .It Ic \&Fo , \&Fc Ta function block: Ar funcname
 .Bd -literal -offset indent  .It Ic \&Fn Ta function name: Ar funcname Op Ar argument ...
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB  .It Ic \&Fa Ta function argument (>0 arguments)
   .It Ic \&Vt Ta variable type (>0 arguments)
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...  .It Ic \&Va Ta variable name (>0 arguments)
   .It Ic \&Dv Ta defined variable or preprocessor constant (>0 arguments)
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  .It Ic \&Er Ta error constant (>0 arguments)
 .Ed  .It Ic \&Ev Ta environmental variable (>0 arguments)
 .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent  
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments  
 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1  
 .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&In  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ot  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1  
 .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1  
 .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1  
 .El  .El
 .Ss Delimiters  .Ss Various semantic markup
 When a macro argument consists of one single input character  .Bl -column "Brq, Bro, Brc" description
 considered as a delimiter, the argument gets special handling.  .It Ic \&An Ta author name (>0 arguments)
 This does not apply when delimiters appear in arguments containing  .It Ic \&Lk Ta hyperlink: Ar uri Op Ar display_name
 more than one character.  .It Ic \&Mt Ta Do mailto Dc hyperlink: Ar localpart Ns @ Ns Ar domain
 Consequently, to prevent special handling and just handle it  .It Ic \&Cd Ta kernel configuration declaration (>0 arguments)
 like any other argument, a delimiter can be escaped by prepending  .It Ic \&Ad Ta memory address (>0 arguments)
 a zero-width space  .It Ic \&Ms Ta mathematical symbol (>0 arguments)
 .Pq Sq \e& .  
 In text lines, delimiters never need escaping, but may be used  
 as normal punctuation.  
 .Pp  
 For many macros, when the leading arguments are opening delimiters,  
 these delimiters are put before the macro scope,  
 and when the trailing arguments are closing delimiters,  
 these delimiters are put after the macro scope.  
 For example,  
 .Pp  
 .D1 Pf \. \&Aq "( [ word ] ) ."  
 .Pp  
 renders as:  
 .Pp  
 .D1 Aq ( [ word ] ) .  
 .Pp  
 Opening delimiters are:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It \&(  
 left parenthesis  
 .It \&[  
 left bracket  
 .El  .El
 .Pp  .Ss Physical markup
 Closing delimiters are:  .Bl -column "Brq, Bro, Brc" description
 .Pp  .It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments)
 .Bl -tag -width Ds -offset indent -compact  .It Ic \&Sy Ta boldface font (symbolic) (>0 arguments)
 .It \&.  .It Ic \&No Ta return to roman font (normal) (no arguments)
 period  .It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy
 .It \&,  
 comma  
 .It \&:  
 colon  
 .It \&;  
 semicolon  
 .It \&)  
 right parenthesis  
 .It \&]  
 right bracket  
 .It \&?  
 question mark  
 .It \&!  
 exclamation mark  
 .El  .El
 .Pp  .Ss Physical enclosures
 Note that even a period preceded by a backslash  .Bl -column "Brq, Bro, Brc" description
 .Pq Sq \e.\&  .It Ic \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
 gets this special handling; use  .It Ic \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
 .Sq \e&.  .It Ic \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
 to prevent that.  .It Ic \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
 .Pp  .It Ic \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
 Many in-line macros interrupt their scope when they encounter  .It Ic \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
 delimiters, and resume their scope when more arguments follow that  .It Ic \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
 are not delimiters.  .It Ic \&Eo , \&Ec Ta generic enclosure
 For example,  
 .Pp  
 .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"  
 .Pp  
 renders as:  
 .Pp  
 .D1 Fl a ( b | c \*(Ba d ) e  
 .Pp  
 This applies to both opening and closing delimiters,  
 and also to the middle delimiter:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It \&|  
 vertical bar  
 .El  .El
 .Pp  .Ss Text production
 As a special case, the predefined string \e*(Ba is handled and rendered  .Bl -column "Brq, Bro, Brc" description
 in the same way as a plain  .It Ic \&Ex Fl std Ta standard command exit values: Op Ar utility ...
 .Sq \&|  .It Ic \&Rv Fl std Ta standard function return values: Op Ar function ...
 character.  .It Ic \&St Ta reference to a standards document (one argument)
 Using this predefined string is not recommended in new manuals.  .It Ic \&At Ta At
 .Sh REFERENCE  .It Ic \&Bx Ta Bx
   .It Ic \&Bsx Ta Bsx
   .It Ic \&Nx Ta Nx
   .It Ic \&Fx Ta Fx
   .It Ic \&Ox Ta Ox
   .It Ic \&Dx Ta Dx
   .El
   .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 1099  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 1122  for all other author listings.
Line 663  for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.An -nosplit  .Dl \&.An -nosplit
 .Dl \&.An Kristaps Dzonsons \&Aq 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 1169  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 AT&T version.  Formats an
   .At
   version.
 Accepts one optional argument:  Accepts one optional argument:
 .Pp  .Pp
 .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
Line 1185  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 1198  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .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 1231  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 1276  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 1285  The most popular is the imaginary macro
Line 843  The most popular is the imaginary macro
 which resolves to  which resolves to
 .Sy 6n .  .Sy 6n .
 .It  .It
 A width using the syntax described in  A scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 .It  .It
 An arbitrary string, which indents by the length of this string.  An arbitrary string, which indents by the length of this string.
 .El  .El
Line 1306  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 1335  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 1369  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 1391  The
Line 935  The
 .Fl width  .Fl width
 and  and
 .Fl offset  .Fl offset
 arguments accept  arguments accept macro names as described for
 .Sx Scaling Widths  .Ic \&Bd
   .Fl offset ,
   scaling widths as described in
   .Xr roff 7 ,
 or use the length of the given string.  or use the length of the given string.
 The  The
 .Fl offset  .Fl offset
Line 1420  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  specifies the width of one column.
 .Sx Scaling Widths  
 syntax 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 1497  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 1511  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 1521  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 1544  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 BSD/OS version provided as an argument, or a default value if  Format the
   .Bsx
   version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1562  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Ic \&Ox .
 .Ss \&Bt  .It Ic \&Bt
   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 BSD version provided as an argument, or a default value if no  Format the
   .Bx
   version provided as an argument, or a default value if no
 argument is provided.  argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1583  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .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 1603  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 1619  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 1629  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
 Switch debugging mode.  This macro is obsolete.
 Its syntax is as follows:  No replacement is needed.
 .Pp  It is ignored by
 .D1 Pf \. Sx \&Db Cm on | off  .Xr mandoc 1
 .Pp  and groff including its arguments.
 This macro is ignored by  It was formerly used to toggle a debugging mode.
 .Xr mandoc 1 .  .It Ic \&Dc
 .Ss \&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.  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 1675  the special string
Line 1219  the special string
 .Dq $\&Mdocdate$  .Dq $\&Mdocdate$
 can be given as an argument.  can be given as an argument.
 .It  .It
 A few alternative date formats are accepted as well  The traditional, purely numeric
 and converted to the standard form.  .Xr man 7
   format
   .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
   is accepted, too.
 .It  .It
 If a date string cannot be parsed, it is used verbatim.  If a date string cannot be parsed, it is used verbatim.
 .It  .It
Line 1685  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 intended 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.
 It is followed by a newline.  It is followed by a newline.
Line 1702  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 1718  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 1731  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.  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  
 .Oo  
 .Ar title  
 .Oo  
 .Ar section  
 .Op Ar volume | arch  
 .Oc  
 .Oc  
 .Ed  
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width Ds -offset Ds  .Bl -tag -width section -offset 2n
 .It Ar title  .It Ar TITLE
 The document's title (name), defaulting to  The document's title (name), defaulting to
 .Dq UNKNOWN  .Dq UNTITLED
 if unspecified.  if unspecified.
 It should be capitalised.  To achieve a uniform appearance of page header lines,
   it should by convention be all caps.
 .It Ar section  .It Ar section
 The manual section.  The manual section.
 This may be one of  This may be one of
 .Ar 1  .Cm 1
 .Pq utilities ,  .Pq General Commands ,
 .Ar 2  .Cm 2
 .Pq system calls ,  .Pq System Calls ,
 .Ar 3  .Cm 3
 .Pq libraries ,  .Pq Library Functions ,
 .Ar 3p  .Cm 3p
 .Pq Perl libraries ,  .Pq Perl Library ,
 .Ar 4  .Cm 4
 .Pq devices ,  .Pq Device Drivers ,
 .Ar 5  .Cm 5
 .Pq file formats ,  .Pq File Formats ,
 .Ar 6  .Cm 6
 .Pq games ,  .Pq Games ,
 .Ar 7  .Cm 7
 .Pq miscellaneous ,  .Pq Miscellaneous Information ,
 .Ar 8  .Cm 8
 .Pq system utilities ,  .Pq System Manager's Manual ,
 .Ar 9  
 .Pq kernel functions ,  
 .Ar X11  
 .Pq X Window System ,  
 .Ar X11R6  
 .Pq X Window System ,  
 .Ar unass  
 .Pq unassociated ,  
 .Ar local  
 .Pq local system ,  
 .Ar draft  
 .Pq draft manual ,  
 or  or
 .Ar 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
 .Dq 1  the empty string if unspecified.
 if unspecified.  
 .It Ar volume  
 This overrides the volume inferred from  
 .Ar section .  
 This field is optional, and if specified, must be one of  
 .Ar USD  
 .Pq users' supplementary documents ,  
 .Ar PS1  
 .Pq programmers' supplementary documents ,  
 .Ar AMD  
 .Pq administrators' supplementary documents ,  
 .Ar SMM  
 .Pq system managers' manuals ,  
 .Ar URM  
 .Pq users' reference manuals ,  
 .Ar PRM  
 .Pq programmers' reference manuals ,  
 .Ar KM  
 .Pq kernel manuals ,  
 .Ar IND  
 .Pq master index ,  
 .Ar MMI  
 .Pq master index ,  
 .Ar LOCAL  
 .Pq local manuals ,  
 .Ar LOC  
 .Pq local manuals ,  
 or  
 .Ar CON  
 .Pq contributed manuals .  
 .It Ar arch  .It Ar arch
 This specifies a specific relevant architecture.  This specifies the machine architecture a manual page applies to,
 If  where relevant, for example
 .Ar volume  .Cm alpha ,
 is not provided, it may be used in its place, else it may be used  .Cm amd64 ,
 subsequent that.  .Cm i386 ,
 It, too, is optional.  
 It must be one of  
 .Ar alpha ,  
 .Ar amd64 ,  
 .Ar amiga ,  
 .Ar arc ,  
 .Ar arm ,  
 .Ar armish ,  
 .Ar aviion ,  
 .Ar hp300 ,  
 .Ar hppa ,  
 .Ar hppa64 ,  
 .Ar i386 ,  
 .Ar landisk ,  
 .Ar loongson ,  
 .Ar luna88k ,  
 .Ar mac68k ,  
 .Ar macppc ,  
 .Ar mips64 ,  
 .Ar mvme68k ,  
 .Ar mvme88k ,  
 .Ar mvmeppc ,  
 .Ar pmax ,  
 .Ar sgi ,  
 .Ar socppc ,  
 .Ar sparc ,  
 .Ar sparc64 ,  
 .Ar sun3 ,  
 .Ar vax ,  
 or  or
 .Ar zaurus .  .Cm sparc64 .
   The list of valid architectures varies by operating system.
 .El  .El
 .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 1885  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 and  for special-purpose constants,
 .Sx \&Va  .Ic \&Va
 for variable symbols.  for variable symbols, and
 .Ss \&Dx  .Ic \&Fd
 Format the DragonFly BSD version provided as an argument, or a default  for listing preprocessor variable definitions in the
   .Em SYNOPSIS .
   .It Ic \&Dx Op Ar version
   Format the
   .Dx
   version provided as an argument, or a default
 value if no argument is provided.  value if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1900  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .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 .
   .It Ic \&Em Ar word ...
   Request an italic font.
   If the output device does not provide that, underline.
   .Pp
   This is most often used for stress emphasis (not to be confused with
   importance, see
   .Ic \&Sy ) .
   In the rare cases where none of the semantic markup macros fit,
   it can also be used for technical terms and placeholders, except
   that for syntax elements,
   .Ic \&Sy
 and  and
 .Sx \&It .  .Ic \&Ar
 .Ss \&Em  are preferred, respectively.
 Denotes text that should be  
 .Em emphasised .  
 Note that this is a presentation term and should not be used for  
 stylistically decorating technical terms.  
 Depending on the output device, this is usually represented  
 using an italic font or underlined characters.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Em Warnings!  .Bd -literal -compact -offset indent
 .Dl \&.Em Remarks :  Selected lines are those
   \&.Em not
   matching any of the specified patterns.
   Some of the functions use a
   \&.Em hold space
   to save the pattern space for subsequent retrieval.
   .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 and not implemented in  This macro is obsolete.
 .Xr mandoc 1 .  Use
 .Ss \&Eo  .Ic \&Eo
 An arbitrary enclosure.  or any of the other enclosure macros.
 Its syntax is as follows:  
 .Pp  .Pp
 .D1 Pf \. Sx \&Eo Op Ar TERM  It encloses its argument in the delimiters specified by the last
 .Pp  .Ic \&Es
   macro.
   .It Ic \&Eo Op Ar opening_delimiter
   An arbitrary enclosure.
 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 1980  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 and not implemented.  This macro is obsolete.
 .Ss \&Ev  Use
   .Ic \&Eo
   or any of the other enclosure macros.
   .Pp
   It takes two arguments, defining the delimiters to be used by subsequent
   .Ic \&En
   macros.
   .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 1993  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.  Function argument or parameter.
 Its syntax is as follows:  Each argument may be a name and a type (recommended for the
 .Bd -ragged -offset indent  .Em SYNOPSIS
 .Pf \. Sx \&Fa  section), a name alone (for function invocations),
 .Op Cm argtype  or a type alone (for function prototypes).
 .Cm argname  If both a type and a name are given or if the type consists of multiple
 .Ed  words, all words belonging to the same function argument have to be
   given in a single argument to the
   .Ic \&Fa
   macro.
 .Pp  .Pp
 This may be invoked for names with or without the corresponding type.  This macro is also used to specify the field name of a structure.
 It is also used to specify the field name of a structure.  .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
 section 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:
 .Dl \&.Fa \(dqconst char *p\(dq  .Dl \&.Fa \(dqconst char *p\(dq
 .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq  .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
 .Dl \&.Fa foo  .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 ...
 Historically used to document include files.  Preprocessor directive, in particular for listing it in the
 This usage has been deprecated in favour of  .Em SYNOPSIS .
 .Sx \&In .  Historically, it was also used to document include files.
 Do not use this macro.  The latter usage has been deprecated in favour of
   .Ic \&In .
 .Pp  .Pp
   Examples:
   .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
   .Dl \&.Fd #define SIO_MAXNFDS
   .Dl \&.Fd #ifdef FS_DEBUG
   .Dl \&.Ft void
   .Dl \&.Fn dbg_open \(dqconst char *\(dq
   .Dl \&.Fd #endif
   .Pp
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE ,
   .Ic \&In ,
 and  and
 .Sx \&In .  .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 2076  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 2106  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 Oo Ar argtype Oc 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 and not implemented in  This macro is obsolete.
 .Xr mandoc 1 .  No replacement markup is needed.
 .Pp  .Pp
 It was used to show function return values.  It was used to show numerical function return values in an italic font.
 The syntax was:  .It Ic \&Ft Ar functype
 .Pp  
 .Dl Pf . Sx \&Fr Ar value  
 .Ss \&Ft  
 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 2172  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 2186  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .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 2214  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 2251  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 2262  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 2288  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 recognized 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 2338  section as described in
Line 1824  section as described in
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Lb libz  .Dl \&.Lb libz
 .Dl \&.Lb mdoc  .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
 .Ss \&Nd  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
   .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 2412  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 2426  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 2446  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 2471  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 2491  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 2505  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 ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .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 2527  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 2539  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
 Document operating system version.  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 2562  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 and not implemented in  This macro is obsolete.
 .Xr mandoc 1 .  Use
   .Ic \&Ft
   instead; with
   .Xr mandoc 1 ,
   both have the same effect.
 .Pp  .Pp
 Historical  Historical
 .Xr mdoc 7  .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 2584  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 ,
 .Sx \&Nx ,  
 and  and
 .Sx \&Ux .  .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 2603  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 2710  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 2751  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 Cm on | off  
 .Pp  
 By default, spacing is  By default, spacing is
 .Cm on .  .Cm on .
 When switched  When switched
Line 2774  When switched
Line 2249  When switched
 no white space is inserted between macro arguments and between the  no white space is inserted between macro arguments and between the
 output generated from adjacent macros, but text lines  output generated from adjacent macros, but text lines
 still get normal spacing between words and sentences.  still get normal spacing between words and sentences.
 .Ss \&So  .Pp
   When called without an argument, the
   .Ic \&Sm
   macro toggles the spacing mode.
   Using this is not recommended because it makes the code harder to read.
   .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 2799  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,
   they all refer to the same standard, and using the first form
   is recommended.
   .Bl -tag -width 1n
   .It C language standards
 .Pp  .Pp
 .Bl -tag -width "-p1003.1g-2000X" -compact  .Bl -tag -width "-p1003.1g-2000" -compact
 .It \-p1003.1-88  .It \-ansiC
 .St -p1003.1-88  .St -ansiC
 .It \-p1003.1-90  .It \-ansiC-89
 .St -p1003.1-90  .St -ansiC-89
 .It \-p1003.1-96  
 .St -p1003.1-96  
 .It \-p1003.1-2001  
 .St -p1003.1-2001  
 .It \-p1003.1-2004  
 .St -p1003.1-2004  
 .It \-p1003.1-2008  
 .St -p1003.1-2008  
 .It \-p1003.1  
 .St -p1003.1  
 .It \-p1003.1b  
 .St -p1003.1b  
 .It \-p1003.1b-93  
 .St -p1003.1b-93  
 .It \-p1003.1c-95  
 .St -p1003.1c-95  
 .It \-p1003.1g-2000  
 .St -p1003.1g-2000  
 .It \-p1003.1i-95  
 .St -p1003.1i-95  
 .It \-p1003.2-92  
 .St -p1003.2-92  
 .It \-p1003.2a-92  
 .St -p1003.2a-92  
 .It \-p1387.2-95  
 .St -p1387.2-95  
 .It \-p1003.2  
 .St -p1003.2  
 .It \-p1387.2  
 .St -p1387.2  
 .It \-isoC  .It \-isoC
 .St -isoC  .St -isoC
 .It \-isoC-90  .It \-isoC-90
 .St -isoC-90  .St -isoC-90
   .br
   The original C standard.
   .Pp
 .It \-isoC-amd1  .It \-isoC-amd1
 .St -isoC-amd1  .St -isoC-amd1
   .Pp
 .It \-isoC-tcor1  .It \-isoC-tcor1
 .St -isoC-tcor1  .St -isoC-tcor1
   .Pp
 .It \-isoC-tcor2  .It \-isoC-tcor2
 .St -isoC-tcor2  .St -isoC-tcor2
   .Pp
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
   .br
   The second major version of the C language standard.
   .Pp
   .It \-isoC-2011
   .St -isoC-2011
   .br
   The third major version of the C language standard.
   .El
   .It POSIX.1 before the Single UNIX Specification
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-p1003.1-88
   .St -p1003.1-88
   .It \-p1003.1
   .St -p1003.1
   .br
   The original POSIX standard, based on ANSI C.
   .Pp
   .It \-p1003.1-90
   .St -p1003.1-90
 .It \-iso9945-1-90  .It \-iso9945-1-90
 .St -iso9945-1-90  .St -iso9945-1-90
   .br
   The first update of POSIX.1.
   .Pp
   .It \-p1003.1b-93
   .St -p1003.1b-93
   .It \-p1003.1b
   .St -p1003.1b
   .br
   Real-time extensions.
   .Pp
   .It \-p1003.1c-95
   .St -p1003.1c-95
   .br
   POSIX thread interfaces.
   .Pp
   .It \-p1003.1i-95
   .St -p1003.1i-95
   .br
   Technical Corrigendum.
   .Pp
   .It \-p1003.1-96
   .St -p1003.1-96
 .It \-iso9945-1-96  .It \-iso9945-1-96
 .St -iso9945-1-96  .St -iso9945-1-96
 .It \-iso9945-2-93  .br
 .St -iso9945-2-93  Includes POSIX.1-1990, 1b, 1c, and 1i.
 .It \-ansiC  .El
 .St -ansiC  .It X/Open Portability Guide version 4 and related standards
 .It \-ansiC-89  .Pp
 .St -ansiC-89  .Bl -tag -width "-p1003.1g-2000" -compact
 .It \-ansiC-99  
 .St -ansiC-99  
 .It \-ieee754  
 .St -ieee754  
 .It \-iso8802-3  
 .St -iso8802-3  
 .It \-ieee1275-94  
 .St -ieee1275-94  
 .It \-xpg3  .It \-xpg3
 .St -xpg3  .St -xpg3
   .br
   An XPG4 precursor, published in 1989.
   .Pp
   .It \-p1003.2
   .St -p1003.2
   .It \-p1003.2-92
   .St -p1003.2-92
   .It \-iso9945-2-93
   .St -iso9945-2-93
   .br
   An XCU4 precursor.
   .Pp
   .It \-p1003.2a-92
   .St -p1003.2a-92
   .br
   Updates to POSIX.2.
   .Pp
 .It \-xpg4  .It \-xpg4
 .St -xpg4  .St -xpg4
   .br
   Based on POSIX.1 and POSIX.2, published in 1992.
   .El
   .It Single UNIX Specification version 1 and related standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-susv1
   .St -susv1
 .It \-xpg4.2  .It \-xpg4.2
 .St -xpg4.2  .St -xpg4.2
 .It \-xpg4.3  .br
 .St -xpg4.3  This standard was published in 1994.
   It was used as the basis for UNIX 95 certification.
   The following three refer to parts of it.
   .Pp
   .It \-xsh4.2
   .St -xsh4.2
   .Pp
   .It \-xcurses4.2
   .St -xcurses4.2
   .Pp
   .It \-p1003.1g-2000
   .St -p1003.1g-2000
   .br
   Networking APIs, including sockets.
   .Pp
   .It \-svid4
   .St -svid4 ,
   .br
   Published in 1995.
   .El
   .It Single UNIX Specification version 2 and related standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-susv2
   .St -susv2
   This Standard was published in 1997
   and is also called X/Open Portability Guide version 5.
   It was used as the basis for UNIX 98 certification.
   The following refer to parts of it.
   .Pp
 .It \-xbd5  .It \-xbd5
 .St -xbd5  .St -xbd5
 .It \-xcu5  .Pp
 .St -xcu5  
 .It \-xsh5  .It \-xsh5
 .St -xsh5  .St -xsh5
   .Pp
   .It \-xcu5
   .St -xcu5
   .Pp
 .It \-xns5  .It \-xns5
 .St -xns5  .St -xns5
 .It \-xns5.2  .It \-xns5.2
 .St -xns5.2  .St -xns5.2
 .It \-xns5.2d2.0  .El
 .St -xns5.2d2.0  .It Single UNIX Specification version 3
 .It \-xcurses4.2  .Pp
 .St -xcurses4.2  .Bl -tag -width "-p1003.1-2001" -compact
 .It \-susv2  .It \-p1003.1-2001
 .St -susv2  .St -p1003.1-2001
 .It \-susv3  .It \-susv3
 .St -susv3  .St -susv3
 .It \-svid4  .br
 .St -svid4  This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.
   It is also called X/Open Portability Guide version 6.
   It is used as the basis for UNIX 03 certification.
   .Pp
   .It \-p1003.1-2004
   .St -p1003.1-2004
   .br
   The second and last Technical Corrigendum.
 .El  .El
 .Ss \&Sx  .It Single UNIX Specification version 4
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-p1003.1-2008
   .St -p1003.1-2008
   .It \-susv4
   .St -susv4
   .br
   This standard is also called
   X/Open Portability Guide version 7.
   .El
   .It Other standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-ieee754
   .St -ieee754
   .br
   Floating-point arithmetic.
   .Pp
   .It \-iso8601
   .St -iso8601
   .br
   Representation of dates and times, published in 1988.
   .Pp
   .It \-iso8802-3
   .St -iso8802-3
   .br
   Ethernet local area networks.
   .Pp
   .It \-ieee1275-94
   .St -ieee1275-94
   .El
   .El
   .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 2916  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 ...
 Format enclosed arguments in symbolic  Request a boldface font.
 .Pq Dq boldface .  
 Note that this is a presentation term and should not be used for  
 stylistically decorating technical terms.  
 .Pp  .Pp
   This is most often used to indicate importance or seriousness (not to be
   confused with stress emphasis, see
   .Ic \&Em ) .
   When none of the semantic macros fit, it is also adequate for syntax
   elements that have to be given or that appear verbatim.
   .Pp
   Examples:
   .Bd -literal -compact -offset indent
   \&.Sy Warning :
   If
   \&.Sy s
   appears in the owner permissions, set-user-ID mode is set.
   This utility replaces the former
   \&.Sy dumpdir
   program.
   .Ed
   .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 ...
 Format a tradename.  Supported only for compatibility, do not use this in new manuals.
 .Pp  Even though the macro name
 Since this macro is often implemented to use a small caps font,  .Pq Dq tradename
 it has historically been used for acronyms (like ASCII) as well.  suggests a semantic function, historic usage is inconsistent, mostly
 Such usage is not recommended because it would use the same macro  using it as a presentation-level macro to request a small caps font.
 sometimes for semantical annotation, sometimes for physical formatting.  .It Ic \&Ud
 .Pp  Supported only for compatibility, do not use this in new manuals.
 Examples:  
 .Dl \&.Tn IBM  
 .Ss \&Ud  
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
 .Ss \&Ux  .It Ic \&Ux
 Format the UNIX name.  Supported only for compatibility, do not use this in new manuals.
 Accepts no argument.  Prints out
 .Pp  .Dq Ux .
 Examples:  .It Ic \&Va Oo Ar type Oc Ar identifier ...
 .Dl \&.Ux  
 .Pp  
 See also  
 .Sx \&At ,  
 .Sx \&Bsx ,  
 .Sx \&Bx ,  
 .Sx \&Dx ,  
 .Sx \&Fx ,  
 .Sx \&Nx ,  
 and  
 .Sx \&Ox .  
 .Ss \&Va  
 A variable name.  A variable name.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Va foo  .Dl \&.Va foo
 .Dl \&.Va const char *bar ;  .Dl \&.Va const char *bar ;
 .Ss \&Vt  .Pp
   For function arguments and parameters, use
   .Ic \&Fa
   instead.
   For declarations of global variables in the
   .Em SYNOPSIS
   section, use
   .Ic \&Vt .
   .It Ic \&Vt Ar type Op Ar identifier
 A variable type.  A variable type.
   .Pp
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, in which case a variable name is also specified.  section, in which case a variable name is also specified.
Line 2987  In the former case, this macro starts a new output lin
Line 2586  In the former case, this macro starts a new output lin
 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 definition or include directive.  function definition or include directive.
 .Pp  .Pp
 Note that this should not be confused with  
 .Sx \&Ft ,  
 which is used for function return types.  
 .Pp  
 Examples:  Examples:
 .Dl \&.Vt unsigned char  .Dl \&.Vt unsigned char
 .Dl \&.Vt extern const char * const sys_signame[] \&;  .Dl \&.Vt extern const char * const sys_signame[] \&;
 .Pp  .Pp
   For parameters in function prototypes, use
   .Ic \&Fa
   instead, for function return types
   .Ic \&Ft ,
   and for variable names outside the
   .Em SYNOPSIS
   section
   .Ic \&Va ,
   even when including a type with the name.
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE .
 and  .It Ic \&Xc
 .Sx \&Va .  
 .Ss \&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 section  Cross reference the
 .Pp  
 The  
 .Ar name  .Ar name
 and  and
 .Ar section  .Ar section
 are the name and section of the linked manual.  number of another man page.
 If  
 .Ar section  
 is followed by non-punctuation, an  
 .Sx \&Ns  
 is inserted into the token stream.  
 This behaviour is for compatibility with  
 GNU troff.  
 .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.  .Sh MACRO SYNTAX
 This macro should not be used; it is implemented for compatibility with  The syntax of a macro depends on its classification.
 historical manuals.  In this section,
   .Sq \-arg
   refers to macro arguments, which may be followed by zero or more
   .Sq parm
   parameters;
   .Sq \&Yo
   opens the scope of a macro; and if specified,
   .Sq \&Yc
   closes it out.
 .Pp  .Pp
 Consider using  The
 .Sx \&Pp  .Em Callable
 in the event of natural paragraph breaks.  column indicates that the macro may also be called by passing its name
 .Ss \&sp  as an argument to another macro.
 Emits vertical space.  For example,
 This macro should not be used; it is implemented for compatibility with  .Sq \&.Op \&Fl O \&Ar file
 historical manuals.  produces
 Its syntax is as follows:  .Sq Op Fl O Ar file .
   To prevent a macro call and render the macro name literally,
   escape it by prepending a zero-width space,
   .Sq \e& .
   For example,
   .Sq \&Op \e&Fl O
   produces
   .Sq Op \&Fl O .
   If a macro is not callable but its name appears as an argument
   to another macro, it is interpreted as opaque text.
   For example,
   .Sq \&.Fl \&Sh
   produces
   .Sq Fl \&Sh .
 .Pp  .Pp
 .D1 Pf \. Sx \&sp Op Ar height  The
   .Em Parsed
   column indicates whether the macro may call other macros by receiving
   their names as arguments.
   If a macro is not parsed but the name of another macro appears
   as an argument, it is interpreted as opaque text.
 .Pp  .Pp
 The  The
 .Ar height  .Em Scope
 argument must be formatted as described in  column, if applicable, describes closure rules.
 .Sx Scaling Widths .  .Ss Block full-explicit
 If unspecified,  Multi-line scope closed by an explicit closing macro.
 .Sx \&sp  All macros contains bodies; only
 asserts a single vertical space.  .Ic \s&Bf
   and
   .Pq optionally
   .Ic \&Bl
   contain a head.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Ic \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ed
   .It Ic \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ef
   .It Ic \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Ek
   .It Ic \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Ic \&El
   .It Ic \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bd
   .It Ic \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bf
   .It Ic \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bk
   .It Ic \&El  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Bl
   .El
   .Ss Block full-implicit
   Multi-line scope closed by end-of-file or implicitly by another macro.
   All macros have bodies; some
   .Po
   .Ic \&It Fl bullet ,
   .Fl hyphen ,
   .Fl dash ,
   .Fl enum ,
   .Fl item
   .Pc
   don't have heads; only one
   .Po
   .Ic \&It
   in
   .Ic \&Bl Fl column
   .Pc
   has multiple heads.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
   \(lBbody...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Ic \&It Ta \&No Ta Yes  Ta closed by Ic \&It , Ic \&El
   .It Ic \&Nd Ta \&No Ta \&No Ta closed by Ic \&Sh
   .It Ic \&Nm Ta \&No Ta Yes  Ta closed by Ic \&Nm , Ic \&Sh , Ic \&Ss
   .It Ic \&Sh Ta \&No Ta Yes  Ta closed by Ic \&Sh
   .It Ic \&Ss Ta \&No Ta Yes  Ta closed by Ic \&Sh , Ic \&Ss
   .El
   .Pp
   Note that the
   .Ic \&Nm
   macro is a
   .Sx Block full-implicit
   macro only when invoked as the first macro
   in a
   .Em SYNOPSIS
   section line, else it is
   .Sx In-line .
   .Ss Block partial-explicit
   Like block full-explicit, but also with single-line scope.
   Each has at least a body and, in limited circumstances, a head
   .Po
   .Ic \&Fo ,
   .Ic \&Eo
   .Pc
   and/or tail
   .Pq Ic \&Ec .
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
   \(lBbody...\(rB \&Yc \(lBtail...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Ic \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Ao
   .It Ic \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Ac
   .It Ic \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Bo
   .It Ic \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Bc
   .It Ic \&Brc Ta    Yes      Ta    Yes      Ta    opened by Ic \&Bro
   .It Ic \&Bro Ta    Yes      Ta    Yes      Ta    closed by Ic \&Brc
   .It Ic \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Do
   .It Ic \&Do  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Dc
   .It Ic \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Eo
   .It Ic \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Ec
   .It Ic \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Fo
   .It Ic \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Fc
   .It Ic \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Oo
   .It Ic \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Oc
   .It Ic \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Po
   .It Ic \&Po  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Pc
   .It Ic \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Oo
   .It Ic \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Oc
   .It Ic \&Re  Ta    \&No     Ta    \&No     Ta    opened by Ic \&Rs
   .It Ic \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Ic \&Re
   .It Ic \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&So
   .It Ic \&So  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Sc
   .It Ic \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Ic \&Xo
   .It Ic \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Ic \&Xc
   .El
   .Ss Block partial-implicit
   Like block full-implicit, but with single-line scope closed by the
   end of the line.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed
   .It Ic \&Aq  Ta    Yes      Ta    Yes
   .It Ic \&Bq  Ta    Yes      Ta    Yes
   .It Ic \&Brq Ta    Yes      Ta    Yes
   .It Ic \&D1  Ta    \&No     Ta    \&Yes
   .It Ic \&Dl  Ta    \&No     Ta    Yes
   .It Ic \&Dq  Ta    Yes      Ta    Yes
   .It Ic \&En  Ta    Yes      Ta    Yes
   .It Ic \&Op  Ta    Yes      Ta    Yes
   .It Ic \&Pq  Ta    Yes      Ta    Yes
   .It Ic \&Ql  Ta    Yes      Ta    Yes
   .It Ic \&Qq  Ta    Yes      Ta    Yes
   .It Ic \&Sq  Ta    Yes      Ta    Yes
   .It Ic \&Vt  Ta    Yes      Ta    Yes
   .El
   .Pp
   Note that the
   .Ic \&Vt
   macro is a
   .Sx Block partial-implicit
   only when invoked as the first macro
   in a
   .Em SYNOPSIS
   section line, else it is
   .Sx In-line .
   .Ss Special block macro
   The
   .Ic \&Ta
   macro can only be used below
   .Ic \&It
   in
   .Ic \&Bl Fl column
   lists.
   It delimits blocks representing table cells;
   these blocks have bodies, but no heads.
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Ic \&Ta  Ta    Yes      Ta    Yes    Ta closed by Ic \&Ta , Ic \&It
   .El
   .Ss In-line
   Closed by the end of the line, fixed argument lengths,
   and/or subsequent macros.
   In-line macros have only text children.
   If a number (or inequality) of arguments is
   .Pq n ,
   then the macro accepts an arbitrary number of arguments.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
   .It Ic \&%A  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%B  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%C  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%D  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%I  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%J  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%N  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%O  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%P  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%Q  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%R  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%T  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%U  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&%V  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&Ad  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&An  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Ap  Ta    Yes      Ta    Yes      Ta    0
   .It Ic \&Ar  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&At  Ta    Yes      Ta    Yes      Ta    1
   .It Ic \&Bsx Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Bt  Ta    \&No     Ta    \&No     Ta    0
   .It Ic \&Bx  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Cd  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Cm  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Db  Ta    \&No     Ta    \&No     Ta    1
   .It Ic \&Dd  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Dt  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Dv  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Dx  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Em  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Er  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Es  Ta    Yes      Ta    Yes      Ta    2
   .It Ic \&Ev  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Ex  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Fa  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Fd  Ta    \&No     Ta    \&No     Ta    >0
   .It Ic \&Fl  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Fn  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Fr  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Ft  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Fx  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Hf  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Ic  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&In  Ta    \&No     Ta    \&No     Ta    1
   .It Ic \&Lb  Ta    \&No     Ta    \&No     Ta    1
   .It Ic \&Li  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Lk  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Lp  Ta    \&No     Ta    \&No     Ta    0
   .It Ic \&Ms  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Mt  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Nm  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&No  Ta    Yes      Ta    Yes      Ta    0
   .It Ic \&Ns  Ta    Yes      Ta    Yes      Ta    0
   .It Ic \&Nx  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Os  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Ot  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Ox  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Pa  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Pf  Ta    Yes      Ta    Yes      Ta    1
   .It Ic \&Pp  Ta    \&No     Ta    \&No     Ta    0
   .It Ic \&Rv  Ta    \&No     Ta    \&No     Ta    n
   .It Ic \&Sm  Ta    \&No     Ta    \&No     Ta    <2
   .It Ic \&St  Ta    \&No     Ta    Yes      Ta    1
   .It Ic \&Sx  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Sy  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Tn  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Ud  Ta    \&No     Ta    \&No     Ta    0
   .It Ic \&Ux  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Va  Ta    Yes      Ta    Yes      Ta    n
   .It Ic \&Vt  Ta    Yes      Ta    Yes      Ta    >0
   .It Ic \&Xr  Ta    Yes      Ta    Yes      Ta    2
   .El
   .Ss Delimiters
   When a macro argument consists of one single input character
   considered as a delimiter, the argument gets special handling.
   This does not apply when delimiters appear in arguments containing
   more than one character.
   Consequently, to prevent special handling and just handle it
   like any other argument, a delimiter can be escaped by prepending
   a zero-width space
   .Pq Sq \e& .
   In text lines, delimiters never need escaping, but may be used
   as normal punctuation.
   .Pp
   For many macros, when the leading arguments are opening delimiters,
   these delimiters are put before the macro scope,
   and when the trailing arguments are closing delimiters,
   these delimiters are put after the macro scope.
   Spacing is suppressed after opening delimiters
   and before closing delimiters.
   For example,
   .Pp
   .D1 Pf \. \&Aq "( [ word ] ) ."
   .Pp
   renders as:
   .Pp
   .D1 Aq ( [ word ] ) .
   .Pp
   Opening delimiters are:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&(
   left parenthesis
   .It \&[
   left bracket
   .El
   .Pp
   Closing delimiters are:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&.
   period
   .It \&,
   comma
   .It \&:
   colon
   .It \&;
   semicolon
   .It \&)
   right parenthesis
   .It \&]
   right bracket
   .It \&?
   question mark
   .It \&!
   exclamation mark
   .El
   .Pp
   Note that even a period preceded by a backslash
   .Pq Sq \e.\&
   gets this special handling; use
   .Sq \e&.
   to prevent that.
   .Pp
   Many in-line macros interrupt their scope when they encounter
   delimiters, and resume their scope when more arguments follow that
   are not delimiters.
   For example,
   .Pp
   .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"
   .Pp
   renders as:
   .Pp
   .D1 Fl a ( b | c \*(Ba d ) e
   .Pp
   This applies to both opening and closing delimiters,
   and also to the middle delimiter, which does not suppress spacing:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&|
   vertical bar
   .El
   .Pp
   As a special case, the predefined string \e*(Ba is handled and rendered
   in the same way as a plain
   .Sq \&|
   character.
   Using this predefined string is not recommended in new manuals.
   .Ss Font handling
   In
   .Nm
   documents, usage of semantic markup is recommended in order to have
   proper fonts automatically selected; only when no fitting semantic markup
   is available, consider falling back to
   .Sx Physical markup
   macros.
   Whenever any
   .Nm
   macro switches the
   .Xr roff 7
   font mode, it will automatically restore the previous font when exiting
   its scope.
   Manually switching the font using the
   .Xr roff 7
   .Ql \ef
   font escape sequences is never required.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other other  This section provides an incomplete list of compatibility issues
 troff implementations, at this time limited to GNU troff  between mandoc and 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 recognize 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 3110  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.  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
 .Sq \ef  .Sq \eF
 .Pq font family face  .Pq font family face
 .Sx Text Decoration  .Sx Text Decoration
 escapes behave irregularly when specified within line-macro scopes.  escapes behave irregularly when specified within line-macro scopes.
Line 3199  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 offset Ar center  .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
 and  and
 .Fl offset Ar right .  .Fl offset Cm right
   don't work.
 Groff does not implement centered and flush-right rendering either,  Groff does not implement centered and flush-right rendering either,
 but produces large indentations.  but produces large indentations.
 .It  
 The  
 .Sq \eh  
 .Pq horizontal position ,  
 .Sq \ev  
 .Pq vertical position ,  
 .Sq \em  
 .Pq text colour ,  
 .Sq \eM  
 .Pq text filling colour ,  
 .Sq \ez  
 .Pq zero-length character ,  
 .Sq \ew  
 .Pq string length ,  
 .Sq \ek  
 .Pq horizontal position marker ,  
 .Sq \eo  
 .Pq text overstrike ,  
 and  
 .Sq \es  
 .Pq text size  
 escape sequences are all discarded in mandoc.  
 .It  
 The  
 .Sq \ef  
 scaling unit is accepted by mandoc, but rendered as the default unit.  
 .It  
 In quoted literals, groff allows pairwise double-quotes to produce a  
 standalone double-quote in formatted output.  
 This is not supported by mandoc.  
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
Line 3247  This is not supported by mandoc.
Line 3093  This is not supported by mandoc.
 .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
Line 3262  utility written by Kristaps Dzonsons appeared in
Line 3114  utility written by Kristaps Dzonsons appeared in
 The  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
Legend:
Removed from v.1.207  
changed lines
  Added in v.1.274
CVSweb