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

Diff for /mandoc/mdoc.7 between version 1.127 and 1.142

version 1.127, 2010/06/27 13:30:51 version 1.142, 2010/07/26 13:45:49
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2010 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 26  The
Line 27  The
 language is used to format  language is used to format
 .Bx  .Bx
 .Ux  .Ux
 manuals.  In this reference document, we describe its syntax, structure,  manuals.
 and usage.  Our reference implementation is mandoc; the  In this reference document, we describe its syntax, structure, and
   usage.
   Our reference implementation is mandoc; the
 .Sx COMPATIBILITY  .Sx COMPATIBILITY
 section describes compatibility with other troff \-mdoc implementations.  section describes compatibility with other troff \-mdoc implementations.
 .Pp  .Pp
Line 36  An
Line 39  An
 document follows simple rules: lines beginning with the control  document follows simple rules: lines beginning with the control
 character  character
 .Sq \.  .Sq \.
 are parsed for macros.  Other lines are interpreted within the scope of  are parsed for macros.
   Other lines are interpreted within the scope of
 prior macros:  prior macros:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Sh Macro lines change control state.  \&.Sh Macro lines change control state.
Line 45  Other lines are interpreted within the current state.
Line 49  Other lines are interpreted within the current state.
 .Sh LANGUAGE SYNTAX  .Sh LANGUAGE SYNTAX
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.  All  character, and, in certain circumstances, the tab character.
 manuals must have  All manuals must have
 .Ux  .Ux
 line terminators.  line terminators.
 .Ss Comments  .Ss Comments
 Text following a  Text following a
 .Sq \e" ,  .Sq \e\*q ,
 whether in a macro or free-form text line, is ignored to the end of  whether in a macro or free-form text line, is ignored to the end of
 line.  A macro line with only a control character and comment escape,  line.
 .Sq \&.\e" ,  A macro line with only a control character and comment escape,
 is also ignored.  Macro lines with only a control character and optionally  .Sq \&.\e\*q ,
 whitespace are stripped from input.  is also ignored.
   Macro lines with only a control character and optionally whitespace are
   stripped from input.
 .Ss Reserved Characters  .Ss Reserved Characters
 Within a macro line, the following characters are reserved:  Within a macro line, the following characters are reserved:
 .Pp  .Pp
Line 87  Within a macro line, the following characters are rese
Line 93  Within a macro line, the following characters are rese
 .Pp  .Pp
 Use of reserved characters is described in  Use of reserved characters is described in
 .Sx MACRO SYNTAX .  .Sx MACRO SYNTAX .
 For general use in macro lines, these characters must either be escaped  For general use in macro lines, these characters can either be escaped
 with a non-breaking space  with a non-breaking space
 .Pq Sq \e&  .Pq Sq \e&
 or, if applicable, an appropriate escape sequence used.  or, if applicable, an appropriate escape sequence can be used.
 .Ss Special Characters  .Ss Special Characters
 Special characters may occur in both macro and free-form lines.  Special characters may occur in both macro and free-form lines.
 Sequences begin with the escape character  Sequences begin with the escape character
Line 134  If
Line 140  If
 is specified outside of any font scope, such as in unenclosed, free-form  is specified outside of any font scope, such as in unenclosed, free-form
 text, it will affect the remainder of the document.  text, it will affect the remainder of the document.
 .Pp  .Pp
 Text may also be sized with the  Note this form is
 .Sq \es  
 escape, whose syntax is one of  
 .Sq \es+-n  
 for one-digit numerals;  
 .Sq \es(+-nn  
 or  
 .Sq \es+-(nn  
 for two-digit numerals; and  
 .Sq \es[+-N] ,  
 .Sq \es+-[N] ,  
 .Sq \es'+-N' ,  
 or  
 .Sq \es+-'N'  
 for arbitrary-digit numerals:  
 .Pp  
 .D1 \es+1bigger\es-1  
 .D1 \es[+10]much bigger\es[-10]  
 .D1 \es+(10much bigger\es-(10  
 .D1 \es+'100'much much bigger\es-'100'  
 .Pp  
 Note these forms are  
 .Em not  .Em not
 recommended for  recommended for
 .Nm ,  .Nm ,
Line 195  within literal contexts.
Line 180  within literal contexts.
 In macro lines, whitespace delimits arguments and is discarded.  In macro lines, whitespace delimits arguments and is discarded.
 If arguments are quoted, whitespace within the quotes is retained.  If arguments are quoted, whitespace within the quotes is retained.
 .Ss Quotation  .Ss Quotation
 Macro arguments may be quoted with a double-quote to group  Macro arguments may be quoted with double-quotes to group
 space-delimited terms or to retain blocks of whitespace.  space-delimited terms or to retain blocks of whitespace.
 A quoted argument begins with a double-quote preceded by whitespace.  A quoted argument begins with a double-quote preceded by whitespace.
 The next double-quote not pair-wise adjacent to another double-quote  The next double-quote not pair-wise adjacent to another double-quote
 terminates the literal, regardless of surrounding whitespace.  terminates the literal, regardless of surrounding whitespace.
 .Pp  .Pp
 This produces tokens  Note that any quoted text, even if it would cause a macro invocation
 .Sq a" ,  when unquoted, is considered literal text.
 .Sq b c ,  
 .Sq de ,  
 and  
 .Sq fg" .  
 Note that any quoted term, be it argument or macro, is indiscriminately  
 considered literal text.  
 Thus, the following produces  Thus, the following produces
 .Sq \&Em a :  .Sq Op "Fl a" :
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Em "Em a"  \&.Op "Fl a"
 .Ed  .Ed
 .Pp  .Pp
 In free-form mode, quotes are regarded as opaque text.  In free-form mode, quotes are regarded as opaque text.
Line 319  A well-formed
Line 298  A well-formed
 document consists of a document prologue followed by one or more  document consists of a document prologue followed by one or more
 sections.  sections.
 .Pp  .Pp
 The prologue, which consists of (in order) the  The prologue, which consists of the
 .Sx \&Dd ,  .Sx \&Dd ,
 .Sx \&Dt ,  .Sx \&Dt ,
 and  and
 .Sx \&Os  .Sx \&Os
 macros, 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 )  .Sx \&Sh )
Line 388  document are conventionally ordered as they appear abo
Line 367  document are conventionally ordered as they appear abo
 Sections should be composed as follows:  Sections should be composed as follows:
 .Bl -ohang -offset Ds  .Bl -ohang -offset Ds
 .It Em NAME  .It Em NAME
 The name(s) and a short description of the documented material.  The name(s) and a one-line description of the documented material.
 The syntax for this as follows:  The syntax for this as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Nm name0  \&.Nm name0
 \&.Nm name1  \&.Nm name1
 \&.Nm name2  \&.Nm name2
 \&.Nd a short description  \&.Nd a one-line description
 .Ed  .Ed
 .Pp  .Pp
 The  The
Line 465  section, particularly
Line 444  section, particularly
 .Sx \&Vt ,  .Sx \&Vt ,
 and  and
 .Sx \&Ft .  .Sx \&Ft .
 All of these macros are output on their own line.  If two such  All of these macros are output on their own line.
 dissimilar macros are pair-wise invoked (except for  If two such dissimilar macros are pair-wise invoked (except for
 .Sx \&Ft  .Sx \&Ft
 before  before
 .Sx \&Fo  .Sx \&Fo
Line 478  they are separated by a vertical space, unless in the 
Line 457  they are separated by a vertical space, unless in the 
 and  and
 .Sx \&Ft ,  .Sx \&Ft ,
 which are always separated by vertical space.  which are always separated by vertical space.
   .Pp
   When text and macros following an
   .Sx \&Nm
   macro starting an input line span multiple output lines,
   all output lines but the first will be indented to align
   with the text immediately following the
   .Sx \&Nm
   macro, up to the next
   .Sx \&Nm ,
   .Sx \&Sh ,
   or
   .Sx \&Ss
   macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION  .It Em DESCRIPTION
 This expands upon the brief, one-line description in  This expands upon the brief, one-line description in
 .Em NAME .  .Em NAME .
Line 505  It documents the return values of functions in section
Line 497  It documents the return values of functions in section
 See  See
 .Sx \&Rv .  .Sx \&Rv .
 .It Em ENVIRONMENT  .It Em ENVIRONMENT
 Documents any usages of environment variables, e.g.,  Lists the environment variables used by the utility,
 .Xr environ 7 .  and explains the syntax and semantics of their values.
   The
   .Xr environ 7
   manual provides examples of typical content and formatting.
 .Pp  .Pp
 See  See
 .Sx \&Ev .  .Sx \&Ev .
 .It Em FILES  .It Em FILES
 Documents files used.  Documents files used.
 It's helpful to document both the file 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
Line 570  The history of any manual without a
Line 565  The history of any manual without a
 section should be described in this section.  section should be described in this section.
 .It Em AUTHORS  .It Em AUTHORS
 Credits to authors, if applicable, should appear in this section.  Credits to authors, if applicable, should appear in this section.
 Authors should generally be noted by both name and an e-mail address.  Authors should generally be noted by both name and email address.
 .Pp  .Pp
 See  See
 .Sx \&An .  .Sx \&An .
 .It Em CAVEATS  .It Em CAVEATS
 Explanations of common misuses and misunderstandings should be explained  Common misuses and misunderstandings should be explained
 in this section.  in this section.
 .It Em BUGS  .It Em BUGS
 Extant bugs should be described in this section.  Known bugs, limitations and work-arounds should be described
   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 SYNTAX
 Macros are one to three three characters in length and begin with a  Macros are one to three three characters in length and begin with a
 control character ,  control character,
 .Sq \&. ,  .Sq \&. ,
 at the beginning of the line.  at the beginning of the line.
 An arbitrary amount of whitespace may sit between the control character  An arbitrary amount of whitespace may sit between the control character
Line 617  produces
Line 613  produces
 .Sq Fl \&Sh .  .Sq Fl \&Sh .
 .Pp  .Pp
 The  The
 .Em Parsable  .Em Parsed
 column indicates whether the macro may be followed by further  column indicates whether the macro may be followed by further
 (ostensibly callable) macros.  (ostensibly callable) macros.
 If a macro is not parsable, subsequent macro invocations on the line  If a macro is not parsed, subsequent macro invocations on the line
 will be interpreted as opaque text.  will be interpreted as opaque text.
 .Pp  .Pp
 The  The
Line 637  contains a head.
Line 633  contains a head.
 \&.Yc  \&.Yc
 .Ed  .Ed
 .Pp  .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed  .It 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 \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
Line 660  All macros have bodies; some
Line 656  All macros have bodies; some
 .Pc  .Pc
 don't have heads; only one  don't have heads; only one
 .Po  .Po
 .Sx \&It Fl column  .Sx \&It
   in
   .Sx \&Bl Fl column
 .Pc  .Pc
 has multiple heads.  has multiple heads.
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 668  has multiple heads.
Line 666  has multiple heads.
 \(lBbody...\(rB  \(lBbody...\(rB
 .Ed  .Ed
 .Pp  .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"  .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El  .It 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 \&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    \&No     Ta    closed by Sx \&Sh  .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss  .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
 .El  .El
   .Pp
   Note that the
   .Sx \&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  .Ss Block partial-explicit
 Like block full-explicit, but also with single-line scope.  Like block full-explicit, but also with single-line scope.
 Each has at least a body and, in limited circumstances, a head  Each has at least a body and, in limited circumstances, a head
Line 693  and/or tail
Line 702  and/or tail
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  \(lBbody...\(rB \&Yc \(lBtail...\(rB
 .Ed  .Ed
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao  .It 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 \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
Line 728  or end of line.
Line 737  or end of line.
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
 .Ed  .Ed
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable  .It Em Macro Ta Em Callable Ta Em Parsed
 .It Sx \&Aq  Ta    Yes      Ta    Yes  .It Sx \&Aq  Ta    Yes      Ta    Yes
 .It Sx \&Bq  Ta    Yes      Ta    Yes  .It Sx \&Bq  Ta    Yes      Ta    Yes
 .It Sx \&Brq Ta    Yes      Ta    Yes  .It Sx \&Brq Ta    Yes      Ta    Yes
Line 769  then the macro accepts an arbitrary number of argument
Line 778  then the macro accepts an arbitrary number of argument
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
 .Ed  .Ed
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent  .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments  .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
 .It Sx \&%B  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 \&%C  Ta    \&No     Ta    \&No     Ta    >0
Line 796  then the macro accepts an arbitrary number of argument
Line 805  then the macro accepts an arbitrary number of argument
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1  .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
 .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n  .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
Line 854  For the scoping of individual macros, see
Line 863  For the scoping of individual macros, see
 .Ss \&%A  .Ss \&%A
 Author name of an  Author name of an
 .Sx \&Rs  .Sx \&Rs
 block.  Multiple authors should each be accorded their own  block.
   Multiple authors should each be accorded their own
 .Sx \%%A  .Sx \%%A
 line.  Author names should be ordered with full or abbreviated  line.
 forename(s) first, then full surname.  Author names should be ordered with full or abbreviated forename(s)
   first, then full surname.
 .Ss \&%B  .Ss \&%B
 Book title of an  Book title of an
 .Sx \&Rs  .Sx \&Rs
 block.  This macro may also be used in a non-bibliographic context when  block.
   This macro may also be used in a non-bibliographic context when
 referring to book titles.  referring to book titles.
 .Ss \&%C  .Ss \&%C
 Publication city or location of an  Publication city or location of an
Line 874  this macro is not implemented in
Line 886  this macro is not implemented in
 .Ss \&%D  .Ss \&%D
 Publication date of an  Publication date of an
 .Sx \&Rs  .Sx \&Rs
 block.  This should follow the reduced or canonical form syntax  block.
 described in  This should follow the reduced or canonical form syntax described in
 .Sx Dates .  .Sx Dates .
 .Ss \&%I  .Ss \&%I
 Publisher or issuer name of an  Publisher or issuer name of an
Line 900  block.
Line 912  block.
 .Ss \&%Q  .Ss \&%Q
 Institutional author (school, government, etc.) of an  Institutional author (school, government, etc.) of an
 .Sx \&Rs  .Sx \&Rs
 block.  Multiple institutional authors should each be accorded their own  block.
   Multiple institutional authors should each be accorded their own
 .Sx \&%Q  .Sx \&%Q
 line.  line.
 .Ss \&%R  .Ss \&%R
Line 910  block.
Line 923  block.
 .Ss \&%T  .Ss \&%T
 Article title of an  Article title of an
 .Sx \&Rs  .Sx \&Rs
 block.  This macro may also be used in a non-bibliographical context  block.
 when referring to article titles.  This macro may also be used in a non-bibliographical context when
   referring to article titles.
 .Ss \&%U  .Ss \&%U
 URI of reference document.  URI of reference document.
 .Ss \&%V  .Ss \&%V
Line 919  Volume number of an
Line 933  Volume number of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
 .Ss \&Ac  .Ss \&Ac
 Closes an  Close an
 .Sx \&Ao  .Sx \&Ao
 block.  Does not have any tail arguments.  block.
   Does not have any tail arguments.
 .Ss \&Ad  .Ss \&Ad
 Address construct: usually in the context of an computational address in  Memory address.
 memory, not a physical (post) address.  Do not use this for postal addresses.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ad [0,$]  .D1 \&.Ad [0,$]
 .D1 \&.Ad 0x00000000  .D1 \&.Ad 0x00000000
 .Ss \&An  .Ss \&An
 Author name.  Author name.
 This macro may alternatively accepts the following arguments, although  Requires either the name of an author or one of the following arguments:
 these may not be specified along with a parameter:  .Pp
 .Bl -tag -width 12n -offset indent  .Bl -tag -width "-nosplitX" -offset indent -compact
 .It Fl split  .It Fl split
 Renders a line break before each author listing.  Start a new output line before each subsequent invocation of
   .Sx \&An .
 .It Fl nosplit  .It Fl nosplit
 The opposite of  The opposite of
 .Fl split .  .Fl split .
 .El  .El
 .Pp  .Pp
 In the AUTHORS section, the default is not to split the first author  The default is
 listing, but all subsequent author listings, whether or not they're  .Fl nosplit .
 interspersed by other macros or text, are split.  The effect of selecting either of the
 Thus, specifying  
 .Fl split  .Fl split
 will cause the first listing also to be split.  modes ends at the beginning of the
 If not in the AUTHORS section, the default is not to split.  .Em AUTHORS
   section.
   In the
   .Em AUTHORS
   section, the default is
   .Fl nosplit
   for the first author listing and
   .Fl split
   for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.An -nosplit  .D1 \&.An -nosplit
 .D1 \&.An J. D. Ullman .  .D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
 .Pp  
 .Em Remarks :  
 the effects of  
 .Fl split  
 or  
 .Fl nosplit  
 are re-set when entering the AUTHORS section, so if one specifies  
 .Sx \&An Fl nosplit  
 in the general document body, it must be re-specified in the AUTHORS  
 section.  
 .Ss \&Ao  .Ss \&Ao
 Begins a block enclosed by angled brackets.  Begin a block enclosed by angle brackets.
 Does not have any head arguments.  Does not have any head arguments.
 .Pp  .Pp
 Examples:  Examples:
Line 972  Examples:
Line 985  Examples:
 See also  See also
 .Sx \&Aq .  .Sx \&Aq .
 .Ss \&Ap  .Ss \&Ap
 Inserts an apostrophe without any surrounding white-space.  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.
 .Bd -literal -offset indent  .Pp
 \&.Fn execve Ap d  Examples:
 .Ed  .D1 \&.Fn execve \&Ap d
 .Ss \&Aq  .Ss \&Aq
 Encloses its arguments in angled brackets.  Encloses its arguments in angle brackets.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fl -key= \&Ns \&Aq \&Ar val  .D1 \&.Fl -key= \&Ns \&Aq \&Ar val
Line 999  See also
Line 1012  See also
 .Ss \&Ar  .Ss \&Ar
 Command arguments.  Command arguments.
 If an argument is not provided, the string  If an argument is not provided, the string
 .Dq file ...  .Dq file ...\&
 is used as a default.  is used as a default.
 .Pp  .Pp
 Examples:  Examples:
Line 1008  Examples:
Line 1021  Examples:
 .D1 \&.Ar arg1 , arg2 .  .D1 \&.Ar arg1 , arg2 .
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an AT&T version.
 Accepts at most one parameter:  Accepts one optional argument:
 .Bl -tag -width 12n -offset indent  .Pp
   .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
 .It Cm v[1-7] | 32v  .It Cm v[1-7] | 32v
 A version of  A version of
 .At .  .At .
 .It Cm V[.[1-4]]?  .It Cm V[.[1-4]]?
 A system version of  A version of
 .At .  .At V .
 .El  .El
 .Pp  .Pp
 Note that these parameters do not begin with a hyphen.  Note that these arguments do not begin with a hyphen.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.At  .D1 \&.At
Line 1034  See also
Line 1048  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Bc  .Ss \&Bc
 Closes a  Close a
 .Sx \&Bo  .Sx \&Bo
 block.  Does not have any tail arguments.  block.
   Does not have any tail arguments.
 .Ss \&Bd  .Ss \&Bd
 Begins a display block.  Begin a display block.
 A display is collection of macros or text which may be collectively  Its syntax is as follows:
 offset or justified in a manner different from that  .Bd -ragged -offset indent
 of the enclosing context.  .Pf \. Sx \&Bd
 By default, the block is preceded by a vertical space.  .Fl Ns Ar type
   .Op Fl offset Ar width
   .Op Fl compact
   .Ed
 .Pp  .Pp
 Each display is associated with a type, which must be one of the  Display blocks are used to select a different indentation and
 following arguments:  justification than the one used by the surrounding text.
 .Bl -tag -width 12n -offset indent  They may contain both macro lines and free-form text lines.
 .It Fl ragged  By default, a display block is preceded by a vertical space.
 Only left-justify the block.  .Pp
 .It Fl unfilled  The
 Do not justify the block at all.  .Ar type
   must be one of the following:
   .Bl -tag -width 13n -offset indent
   .It Fl centered
   Centre-justify each line.
   Using this display type is not recommended; many
   .Nm
   implementations render it poorly.
 .It Fl filled  .It Fl filled
 Left- and right-justify the block.  Left- and right-justify the block.
 .It Fl literal  .It Fl literal
 Alias for  Do not justify the block at all.
 .Fl unfilled .  Preserve white space as it appears in the input.
 .It Fl centered  .It Fl ragged
 Centre-justify each line.  Only left-justify the block.
   .It Fl unfilled
   An alias for
   .Fl literal .
 .El  .El
 .Pp  .Pp
 The type must be provided first.  The
 Secondary arguments are as follows:  .Ar type
 .Bl -tag -width 12n -offset indent  must be provided first.
   Additional arguments may follow:
   .Bl -tag -width 13n -offset indent
 .It Fl offset Ar width  .It Fl offset Ar width
 Offset by the value of  Indent the display by the
 .Ar width ,  .Ar width ,
 which is interpreted as one of the following, specified in order:  which may be one of the following:
 .Bl -item  .Bl -item
 .It  .It
 As one of the pre-defined strings  One of the pre-defined strings
 .Ar indent ,  .Cm indent ,
 the width of standard indentation;  the width of standard indentation;
 .Ar indent-two ,  .Cm indent-two ,
 twice  twice
 .Ar indent ;  .Cm indent ;
 .Ar left ,  .Cm left ,
 which has no effect ;  which has no effect;
 .Ar right ,  .Cm right ,
 which justifies to the right margin; and  which justifies to the right margin; or
 .Ar center ,  .Cm center ,
 which aligns around an imagined centre axis.  which aligns around an imagined centre axis.
 .It  .It
 As a precalculated width for a named macro.  A macro invocation, which selects a predefined width
   associated with that macro.
 The most popular is the imaginary macro  The most popular is the imaginary macro
 .Ar \&Ds ,  .Ar \&Ds ,
 which resolves to  which resolves to
 .Ar 6n .  .Sy 6n .
 .It  .It
 As a scaling unit following the syntax described in  A width using the syntax described in
 .Sx Scaling Widths .  .Sx Scaling Widths .
 .It  .It
 As the calculated string length of the opaque string.  An arbitrary string, which indents by the length of this string.
 .El  .El
 .Pp  .Pp
 If not provided an argument, it will be ignored.  When the argument is missing,
   .Fl offset
   is ignored.
 .It Fl compact  .It Fl compact
 Do not assert a vertical space before the block.  Do not assert vertical space before the display.
 .It Fl file Ar file  
 Prepend the file  
 .Ar file  
 before any text or macros within the block.  
 .El  .El
 .Pp  .Pp
 Examples:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Bd \-unfilled \-offset two-indent \-compact  \&.Bd \-literal \-offset indent \-compact
    Hello       world.     Hello       world.
 \&.Ed  \&.Ed
 .Ed  .Ed
Line 1115  See also
Line 1144  See also
 and  and
 .Sx \&Dl .  .Sx \&Dl .
 .Ss \&Bf  .Ss \&Bf
   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
   .Fl emphasis
   and
   .Cm \&Em
   argument are equivalent, as are
   .Fl symbolic
   and
   .Cm \&Sy,
   and
   .Fl literal
   and
   .Cm \&Li .
   Without an argument, this macro does nothing.
   The font mode continues until broken by a new font mode in a nested
   scope or
   .Sx \&Ef
   is encountered.
   .Pp
   See also
   .Sx \&Li ,
   .Sx \&Ef ,
   .Sx \&Em ,
   and
   .Sx \&Sy .
 .Ss \&Bk  .Ss \&Bk
 Begins a keep block, containing a collection of macros or text  Keep the output generated from each macro input line together
 to be kept together in the output.  on one single output line.
 One argument is required; additional arguments are ignored.  Line breaks in free-form text lines are unaffected.
 Currently, the only argument implemented is  The syntax is as follows:
 .Fl words ,  
 requesting to keep together all words of the contained text  
 on the same output line.  
 A  
 .Fl lines  
 argument to keep together all lines of the contained text  
 on the same page has been desired for a long time,  
 but has never been implemented.  
 .Pp  .Pp
 Examples:  .D1 Pf \. Sx \&Bk Fl words
   .Pp
   The
   .Fl words
   argument is required; additional arguments are ignored.
   .Pp
   The following example will not break within each
   .Sx \&Op
   macro line:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Bk \-words  \&.Bk \-words
 \&.Op o Ar output_file  \&.Op Fl f Ar flags
   \&.Op Fl o Ar output
 \&.Ek  \&.Ek
 .Ed  .Ed
   .Pp
   Be careful in using over-long lines within a keep block!
   Doing so will clobber the right margin.
 .Ss \&Bl  .Ss \&Bl
 Begins a list composed of one or more list entries.  Begin a list.
 A list is associated with a type, which is a required argument.  Lists consist of items started by the
 Other arguments are  
 .Fl width ,  
 defined per-type as accepting a literal or  
 .Sx Scaling Widths  
 value;  
 .Fl offset ,  
 also accepting a literal or  
 .Sx Scaling Widths  
 value setting the list's global offset; and  
 .Fl compact ,  
 suppressing the default vertical space printed before each list entry.  
 A list entry is specified by the  
 .Sx \&It  .Sx \&It
 macro, which consists of a head and optional body (depending on the list  macro, containing a head or a body or both.
 type).  The list syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bl
   .Fl Ns Ar type
   .Op Fl width Ar val
   .Op Fl offset Ar val
   .Op Fl compact
   .Op HEAD ...
   .Ed
   .Pp
   The list
   .Ar type
   is mandatory and must be specified first.
   The
   .Fl width
   and
   .Fl offset
   arguments accept
   .Sx Scaling Widths
   or use the length of the given string.
   The
   .Fl offset
   is a global indentation for the whole list, affecting both item heads
   and bodies.
   For those list types supporting it, the
   .Fl width
   argument requests an additional indentation of item bodies,
   to be added to the
   .Fl offset .
   Unless the
   .Fl compact
   argument is specified, list entries are separated by vertical space.
   .Pp
 A list must specify one of the following list types:  A list must specify one of the following list types:
 .Bl -tag -width 12n -offset indent  .Bl -tag -width 12n -offset indent
 .It Fl bullet  .It Fl bullet
 A list offset by a bullet.  No item heads can be specified, but a bullet will be printed at the head
 The head of list entries must be empty.  of each item.
 List entry bodies are positioned after the bullet.  Item bodies start on the same output line as the bullet
 The  and are indented according to the
 .Fl width  .Fl width
 argument varies the width of list bodies' left-margins.  argument.
 .It Fl column  .It Fl column
 A columnated list.  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect.  argument has no effect; instead, each argument specifies the width
 The number of columns is specified as parameters to the  of one column, using either the
 .Sx \&Bl  
 macro.  
 These dictate the width of columns either as  
 .Sx Scaling Widths  .Sx Scaling Widths
 or literal text.  syntax or the string length of the argument.
 If the initial macro 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 ,  
 an  
 .Sx \&It  .Sx \&It
 context spanning each line is implied until an  macro line,
 .Sx \&It  .Sx \&It
 line macro is encountered, at which point list bodies are interpreted as  contexts spanning one input line each are implied until an
   .Sx \&It
   macro line is encountered, at which point items start being interpreted as
 described in the  described in the
 .Sx \&It  .Sx \&It
 documentation.  documentation.
 .It Fl dash  .It Fl dash
 A list offset by a dash (hyphen).  Like
 The head of list entries must be empty.  .Fl bullet ,
 List entry bodies are positioned past the dash.  except that dashes are used in place of bullets.
 The  
 .Fl width  
 argument varies the width of list bodies' left-margins.  
 .It Fl diag  .It Fl diag
 Like  Like
 .Fl inset ,  .Fl inset ,
 but with additional formatting to the head.  except that item heads are not parsed for macro invocations.
 The  .\" but with additional formatting to the head.
 .Fl width  
 argument varies the width of list bodies' left-margins.  
 .It Fl enum  .It Fl enum
 An enumerated list offset by the enumeration from 1.  A numbered list.
 The head of list entries must be empty.  Formatted like
 List entry bodies are positioned after the enumeration.  .Fl bullet ,
 The  except that cardinal numbers are used in place of bullets,
 .Fl width  starting at 1.
 argument varies the width of list bodies' left-margins.  
 .It Fl hang  .It Fl hang
 Like  Like
 .Fl tag ,  .Fl tag ,
 but instead of list bodies positioned after the head, they trail the  except that the first lines of item bodies are not indented, but follow
 head text.  the item heads like in
 The  .Fl inset
 .Fl width  lists.
 argument varies the width of list bodies' left-margins.  
 .It Fl hyphen  .It Fl hyphen
 Synonym for  Synonym for
 .Fl dash .  .Fl dash .
 .It Fl inset  .It Fl inset
 List bodies follow the list head.  Item bodies follow items heads on the same line, using normal inter-word
 The  spacing.
   Bodies are not indented, and the
 .Fl width  .Fl width
 argument is ignored.  argument is ignored.
 .It Fl item  .It Fl item
 This produces blocks of text.  No item heads can be specified, and none are printed.
 The head of list entries must be empty.  Bodies are not indented, and the
 The  
 .Fl width  .Fl width
 argument is ignored.  argument is ignored.
 .It Fl ohang  .It Fl ohang
 List bodies are positioned on the line following the head.  Item bodies start on the line following item heads and are not indented.
 The  The
 .Fl width  .Fl width
 argument is ignored.  argument is ignored.
 .It Fl tag  .It Fl tag
 A list offset by list entry heads.  List entry bodies are positioned  Item bodies are indented according to the
 after the head as specified by the  
 .Fl width  .Fl width
 argument.  argument.
   When an item head fits inside the indentation, the item body follows
   this head on the same output line.
   Otherwise, the body starts on the output line following the head.
 .El  .El
 .Pp  .Pp
 See also  See also
   .Sx \&El
   and
 .Sx \&It .  .Sx \&It .
 .Ss \&Bo  .Ss \&Bo
 Begins 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
 Examples:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent -compact
 \&.Bo 1 ,  \&.Bo 1 ,
 \&.Dv BUFSIZ \&Bc  \&.Dv BUFSIZ \&Bc
 .Ed  .Ed
Line 1271  and
Line 1352  and
 See also  See also
 .Sx \&Bo .  .Sx \&Bo .
 .Ss \&Brc  .Ss \&Brc
 Closes a  Close a
 .Sx \&Bro  .Sx \&Bro
 block.  Does not have any tail arguments.  block.
   Does not have any tail arguments.
 .Ss \&Bro  .Ss \&Bro
 Begins 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
 Examples:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent -compact
 \&.Bro 1 , ... ,  \&.Bro 1 , ... ,
 \&.Va n \&Brc  \&.Va n \&Brc
 .Ed  .Ed
Line 1332  See also
Line 1414  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Cd  .Ss \&Cd
 Configuration declaration.  Kernel configuration declaration.
 This denotes strings accepted by  This denotes strings accepted by
 .Xr config 8 .  .Xr config 8 .
 .Pp  .Pp
Line 1341  Examples:
Line 1423  Examples:
 .Pp  .Pp
 .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
 white-space and align consecutive  whitespace and align consecutive
 .Sx \&Cd  .Sx \&Cd
 declarations.  declarations.
 This practise is discouraged.  This practise is discouraged.
Line 1369  See also
Line 1451  See also
 and  and
 .Sx \&Dl .  .Sx \&Dl .
 .Ss \&Db  .Ss \&Db
 Start a debugging context.  Switch debugging mode.
 This macro is parsed, but generally ignored.  
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Db Cm on | off  .D1 Pf \. Sx \&Db Cm on | off
   .Pp
   This macro is ignored by
   .Xr mandoc 1 .
 .Ss \&Dc  .Ss \&Dc
 Closes a  Close a
 .Sx \&Do  .Sx \&Do
 block.  Does not have any tail arguments.  block.
   Does not have any tail arguments.
 .Ss \&Dd  .Ss \&Dd
 Document date.  Document date.
 This is the mandatory first macro of any  This is the mandatory first macro of any
Line 1385  This is the mandatory first macro of any
Line 1470  This is the mandatory first macro of any
 manual.  manual.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Dd Cm date  .D1 Pf \. Sx \&Dd Op Ar date
 .Pp  .Pp
 The  The
 .Cm date  .Ar date
 field may be either  may be either
 .Ar $\&Mdocdate$ ,  .Ar $\&Mdocdate$ ,
 which signifies the current manual revision date dictated by  which signifies the current manual revision date dictated by
 .Xr cvs 1 ,  .Xr cvs 1 ,
 or instead a valid canonical date as specified by  or instead a valid canonical date as specified by
 .Sx Dates .  .Sx Dates .
 If a date does not conform, the current date is used instead.  If a date does not conform or is empty, the current date is used.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Dd $\&Mdocdate$  .D1 \&.Dd $\&Mdocdate$
Line 1413  invocations.
Line 1498  invocations.
 It is followed by a newline.  It is followed by a newline.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Dl % mandoc mdoc.7 | less  .D1 \&.Dl % mandoc mdoc.7 \e(ba less
 .Pp  .Pp
 See also  See also
 .Sx \&Bd  .Sx \&Bd
 and  and
 .Sx \&D1 .  .Sx \&D1 .
 .Ss \&Do  .Ss \&Do
 Begins a block enclosed by double quotes.  Does not have any head  Begin a block enclosed by double quotes.
 arguments.  Does not have any head arguments.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot  .Bd -literal -offset indent -compact
   \&.Do
   April is the cruellest month
   \&.Dc
   \e(em T.S. Eliot
   .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Dq .  .Sx \&Dq .
 .Ss \&Dq  .Ss \&Dq
 Encloses its arguments in double quotes.  Encloses its arguments in
   .Dq typographic
   double-quotes.
 .Pp  .Pp
 Examples:  Examples:
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
Line 1438  Examples:
Line 1530  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
   .Sx \&Qq ,
   .Sx \&Sq ,
   and
 .Sx \&Do .  .Sx \&Do .
 .Ss \&Dt  .Ss \&Dt
 Document title.  Document title.
Line 1448  Its syntax is as follows:
Line 1543  Its syntax is as follows:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Dt  .Pf \. Sx \&Dt
 .Oo  .Oo
 .Cm title  .Ar title
 .Oo  .Oo
 .Cm section  .Ar section
 .Op Cm volume | arch  .Op Ar volume | arch
 .Oc  .Oc
 .Oc  .Oc
 .Ed  .Ed
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width Ds -offset Ds  .Bl -tag -width Ds -offset Ds
 .It Cm title  .It Ar title
 The document's title (name), defaulting to  The document's title (name), defaulting to
 .Qq UNKNOWN  .Dq UNKNOWN
 if unspecified.  if unspecified.
 It should be capitalised.  It should be capitalised.
 .It Cm section  .It Ar section
 The manual section.  The manual section.
 This may be one of  This may be one of
 .Ar 1  .Ar 1
Line 1500  or
Line 1595  or
 .Ar paper  .Ar paper
 .Pq paper .  .Pq paper .
 It should correspond to the manual's filename suffix and defaults to  It should correspond to the manual's filename suffix and defaults to
 .Qq 1  .Dq 1
 if unspecified.  if unspecified.
 .It Cm volume  .It Ar volume
 This overrides the volume inferred from  This overrides the volume inferred from
 .Ar section .  .Ar section .
 This field is optional, and if specified, must be one of  This field is optional, and if specified, must be one of
Line 1531  This field is optional, and if specified, must be one 
Line 1626  This field is optional, and if specified, must be one 
 or  or
 .Ar CON  .Ar CON
 .Pq contributed manuals .  .Pq contributed manuals .
 .It Cm arch  .It Ar arch
 This specifies a specific relevant architecture.  This specifies a specific relevant architecture.
 If  If
 .Cm volume  .Ar volume
 is not provided, it may be used in its place, else it may be used  is not provided, it may be used in its place, else it may be used
 subsequent that.  subsequent that.
 It, too, is optional.  It, too, is optional.
Line 1605  See also
Line 1700  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Ec  .Ss \&Ec
   Close a scope started by
   .Sx \&Eo .
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Ec Op Ar TERM
   .Pp
   The
   .Ar TERM
   argument is used as the enclosure tail, for example, specifying \e(rq
   will emulate
   .Sx \&Dc .
 .Ss \&Ed  .Ss \&Ed
   End a display context started by
   .Sx \&Bd .
 .Ss \&Ef  .Ss \&Ef
   End a font mode context started by
   .Sx \&Bf .
 .Ss \&Ek  .Ss \&Ek
 Ends a keep context started by  End a keep context started by
 .Sx \&Bk .  .Sx \&Bk .
 .Ss \&El  .Ss \&El
 Ends a list context started by  End a list context started by
 .Sx \&Bl .  .Sx \&Bl .
 .Pp  .Pp
 See also  See also
Line 1626  stylistically decorating technical terms.
Line 1736  stylistically decorating technical terms.
 Examples:  Examples:
 .D1 \&.Em Warnings!  .D1 \&.Em Warnings!
 .D1 \&.Em Remarks :  .D1 \&.Em Remarks :
   .Pp
   See also
   .Sx \&Bf ,
   .Sx \&Sy ,
   and
   .Sx \&Li .
 .Ss \&En  .Ss \&En
   This macro is obsolete and not implemented in
   .Xr mandoc 1 .
 .Ss \&Eo  .Ss \&Eo
   An arbitrary enclosure.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Eo Op Ar TERM
   .Pp
   The
   .Ar TERM
   argument is used as the enclosure head, for example, specifying \e(lq
   will emulate
   .Sx \&Do .
 .Ss \&Er  .Ss \&Er
 Display error constants.  Display error constants.
 .Pp  .Pp
Line 1638  Examples:
Line 1766  Examples:
 See also  See also
 .Sx \&Dv .  .Sx \&Dv .
 .Ss \&Es  .Ss \&Es
   This macro is obsolete and not implemented.
 .Ss \&Ev  .Ss \&Ev
 Environmental variables such as those specified in  Environmental variables such as those specified in
 .Xr environ 7 .  .Xr environ 7 .
Line 1646  Examples:
Line 1775  Examples:
 .D1 \&.Ev DISPLAY  .D1 \&.Ev DISPLAY
 .D1 \&.Ev PATH  .D1 \&.Ev PATH
 .Ss \&Ex  .Ss \&Ex
 Inserts text regarding a utility's exit values.  Insert a standard sentence regarding exit values.
 This macro must have first the  Its syntax is as follows:
 .Fl std  .Pp
 argument specified, then an optional  .D1 Pf \. Sx \&Ex Fl std Op Ar utility
 .Ar utility .  .Pp
 If  When
 .Ar utility  .Ar utility
 is not provided, the document's name as stipulated in  is not specified, the document's name set by
 .Sx \&Nm  .Sx \&Nm
 is provided.  is used.
   .Pp
   See also
   .Sx \&Rv .
 .Ss \&Fa  .Ss \&Fa
 Function argument.  Function argument.
 Its syntax is as follows:  Its syntax is as follows:
Line 1688  Examples:
Line 1820  Examples:
 See also  See also
 .Sx \&Fo .  .Sx \&Fo .
 .Ss \&Fc  .Ss \&Fc
   End a function context started by
   .Sx \&Fo .
 .Ss \&Fd  .Ss \&Fd
 Historically used to document include files.  Historically used to document include files.
 This usage has been deprecated in favour of  This usage has been deprecated in favour of
Line 1773  See also
Line 1907  See also
 .Sx \&Fa ,  .Sx \&Fa ,
 .Sx \&Fc ,  .Sx \&Fc ,
 and  and
   .Sx \&Ft .
 .Ss \&Ft  .Ss \&Ft
 A function type.  A function type.
 Its syntax is as follows:  Its syntax is as follows:
Line 1809  See also
Line 1944  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Hf  .Ss \&Hf
   This macro is obsolete and not implemented.
 .Ss \&Ic  .Ss \&Ic
   Designate an internal or interactive command.
   This is similar to
   .Sx \&Cm
   but used for instructions rather than values.
   .Pp
   Examples:
   .D1 \&.Ic hash
   .D1 \&.Ic alias
   .Pp
   Note that using
   .Sx \&Bd No Fl literal
   or
   .Sx \&D1
   is preferred for displaying code; the
   .Sx \&Ic
   macro is used when referring to specific instructions.
 .Ss \&In  .Ss \&In
 An  An
 .Qq include  .Dq include
 file.  file.
 In the  In the
 .Em SYNOPSIS  .Em SYNOPSIS
 section (only if invoked as the line macro), the first argument is  section (only if invoked as the line macro), the first argument is
 preceded by  preceded by
 .Qq #include ,  .Dq #include ,
 the arguments is enclosed in angled braces.  the arguments is enclosed in angle brackets.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.In sys/types  .D1 \&.In sys/types
Line 1890  are interpreted within the scope of the last phrase.
Line 2042  are interpreted within the scope of the last phrase.
 Calling the pseudo-macro  Calling the pseudo-macro
 .Sq \&Ta  .Sq \&Ta
 will open a new phrase scope (this must occur on a macro line to be  will open a new phrase scope (this must occur on a macro line to be
 interpreted as a macro).  Note that the tab phrase delimiter may only be  interpreted as a macro).
 used within the  Note that the tab phrase delimiter may only be used within the
 .Sx \&It  .Sx \&It
 line itself.  line itself.
 Subsequent this, only the  Subsequent this, only the
Line 1932  Examples:
Line 2084  Examples:
 .D1 \&.Lb libz  .D1 \&.Lb libz
 .D1 \&.Lb mdoc  .D1 \&.Lb mdoc
 .Ss \&Li  .Ss \&Li
   Denotes text that should be in a literal font mode.
   Note that this is a presentation term and should not be used for
   stylistically decorating technical terms.
   .Pp
   See also
   .Sx \&Bf ,
   .Sx \&Sy ,
   and
   .Sx \&Em .
 .Ss \&Lk  .Ss \&Lk
 Format a hyperlink.  Format a hyperlink.
 Its syntax is as follows:  Its syntax is as follows:
Line 1945  Examples:
Line 2106  Examples:
 See also  See also
 .Sx \&Mt .  .Sx \&Mt .
 .Ss \&Lp  .Ss \&Lp
   Synonym for
   .Sx \&Pp .
 .Ss \&Ms  .Ss \&Ms
   Display a mathematical symbol.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Ms Cm symbol
   .Pp
   Examples:
   .D1 \&.Ms sigma
   .D1 \&.Ms aleph
 .Ss \&Mt  .Ss \&Mt
 Format a  Format a
 .Qq mailto:  .Dq mailto:
 hyperlink.  hyperlink.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
Line 1957  Its syntax is as follows:
Line 2128  Its syntax is as follows:
 Examples:  Examples:
 .D1 \&.Mt discuss@manpages.bsd.lv  .D1 \&.Mt discuss@manpages.bsd.lv
 .Ss \&Nd  .Ss \&Nd
   A one-line description of the manual's content.
   This may only be invoked in the
   .Em SYNOPSIS
   section subsequent the
   .Sx \&Nm
   macro.
   .Pp
   Examples:
   .D1 \&.Sx \&Nd mdoc language reference
   .D1 \&.Sx \&Nd format and display UNIX manuals
   .Pp
   The
   .Sx \&Nd
   macro technically accepts child macros and terminates with a subsequent
   .Sx \&Sh
   invocation.
   Do not assume this behaviour: some
   .Xr whatis 1
   database generators are not smart enough to parse more than the line
   arguments and will display macros verbatim.
   .Pp
   See also
   .Sx \&Nm .
 .Ss \&Nm  .Ss \&Nm
   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
   the manual page.
   When first invoked, the
   .Sx \&Nm
   macro expects a single argument, the name of the manual page.
   Usually, the first invocation happens in the
   .Em NAME
   section of the page.
   The specified name will be remembered and used whenever the macro is
   called again without arguments later in the page.
   The
   .Sx \&Nm
   macro uses
   .Sx Block full-implicit
   semantics when invoked as the first macro on an input line in the
   .Em SYNOPSIS
   section; otherwise, it uses ordinary
   .Sx In-line
   semantics.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Sh SYNOPSIS
   \&.Nm cat
   \&.Op Fl benstuv
   \&.Op Ar
   .Ed
   .Pp
   In the
   .Em SYNOPSIS
   of section 2, 3 and 9 manual pages, use the
   .Sx \&Fn
   macro rather than
   .Sx \&Nm
   to mark up the name of the manual page.
 .Ss \&No  .Ss \&No
   A
   .Dq noop
   macro used to terminate prior macro contexts.
   .Pp
   Examples:
   .D1 \&.Sx \&Fl ab \&No cd \&Fl ef
 .Ss \&Ns  .Ss \&Ns
   Suppress a space.
   Following invocation, text is interpreted as free-form text until a
   macro is encountered.
   .Pp
   Examples:
   .D1 \&.Fl o \&Ns \&Ar output
   .Pp
   See also
   .Sx \&No
   and
   .Sx \&Sm .
 .Ss \&Nx  .Ss \&Nx
 Format the NetBSD version provided as an argument, or a default value if  Format the NetBSD version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
Line 1978  See also
Line 2225  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Oc  .Ss \&Oc
   Close multi-line
   .Sx \&Oo
   context.
 .Ss \&Oo  .Ss \&Oo
   Multi-line version of
   .Sx \&Op .
   .Pp
   Examples:
   .Bd -literal -offset indent -compact
   \&.Oo
   \&.Op Fl flag Ns Ar value
   \&.Oc
   .Ed
 .Ss \&Op  .Ss \&Op
   Command-line option.
   Used when listing options to command-line utilities.
   Prints the argument(s) in brackets.
   .Pp
   Examples:
   .D1 \&.Op \&Fl a \&Ar b
   .D1 \&.Op \&Ar a | b
   .Pp
   See also
   .Sx \&Oo .
 .Ss \&Os  .Ss \&Os
 Document operating system version.  Document operating system version.
 This is the mandatory third macro of  This is the mandatory third macro of
Line 2028  See also
Line 2297  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Pa  .Ss \&Pa
   A file-system path.
   .Pp
   Examples:
   .D1 \&.Pa /usr/bin/mandoc
   .D1 \&.Pa /usr/share/man/man7/mdoc.7
   .Pp
   See also
   .Sx \&Lk .
 .Ss \&Pc  .Ss \&Pc
   Close parenthesised context opened by
   .Sx \&Po .
 .Ss \&Pf  .Ss \&Pf
   Removes the space
   .Pq Dq prefix
   between its arguments.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. \&Pf Cm prefix suffix
   .Pp
   The
   .Cm suffix
   argument may be a macro.
   .Pp
   Examples:
   .D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix
 .Ss \&Po  .Ss \&Po
   Multi-line version of
   .Sx \&Pq .
 .Ss \&Pp  .Ss \&Pp
   Break a paragraph.
   This will assert vertical space between prior and subsequent macros
   and/or text.
 .Ss \&Pq  .Ss \&Pq
   Parenthesised enclosure.
   .Pp
   See also
   .Sx \&Po .
 .Ss \&Qc  .Ss \&Qc
   Close quoted context opened by
   .Sx \&Qo .
 .Ss \&Ql  .Ss \&Ql
   Format a single-quoted literal.
   See also
   .Sx \&Qq
   and
   .Sx \&Sq .
 .Ss \&Qo  .Ss \&Qo
   Multi-line version of
   .Sx \&Qq .
 .Ss \&Qq  .Ss \&Qq
   Encloses its arguments in
   .Dq typewriter
   double-quotes.
   Consider using
   .Sx \&Dq .
   .Pp
   See also
   .Sx \&Dq ,
   .Sx \&Sq ,
   and
   .Sx \&Qo .
 .Ss \&Re  .Ss \&Re
 Closes a  Close an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Rs  .Ss \&Rs
 Begins 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.
Line 2083  block is used within a SEE ALSO section, a vertical sp
Line 2404  block is used within a SEE ALSO section, a vertical sp
 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  .Ss \&Rv
   Inserts text regarding a function call's return value.
   This macro must consist of the
   .Fl std
   argument followed by an optional
   .Ar function .
   If
   .Ar function
   is not provided, the document's name as stipulated by the first
   .Sx \&Nm
   is provided.
   .Pp
   See also
   .Sx \&Ex .
 .Ss \&Sc  .Ss \&Sc
   Close single-quoted context opened by
   .Sx \&So .
 .Ss \&Sh  .Ss \&Sh
   Begin a new section.
   For a list of conventional manual sections, see
   .Sx MANUAL STRUCTURE .
   These sections should be used unless it's absolutely necessary that
   custom sections be used.
   .Pp
   Section names should be unique so that they may be keyed by
   .Sx \&Sx .
   .Pp
   See also
   .Sx \&Pp ,
   .Sx \&Ss ,
   and
   .Sx \&Sx .
 .Ss \&Sm  .Ss \&Sm
   Switches the spacing mode for output generated from macros.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Sm Cm on | off
   .Pp
   By default, spacing is
   .Cm on .
   When switched
   .Cm off ,
   no white space is inserted between macro arguments and between the
   output generated from adjacent macros, but free-form text lines
   still get normal spacing between words and sentences.
 .Ss \&So  .Ss \&So
   Multi-line version of
   .Sx \&Sq .
 .Ss \&Sq  .Ss \&Sq
   Encloses its arguments in
   .Dq typewriter
   single-quotes.
   .Pp
   See also
   .Sx \&Dq ,
   .Sx \&Qq ,
   and
   .Sx \&So .
 .Ss \&Ss  .Ss \&Ss
   Begin a new sub-section.
   Unlike with
   .Sx \&Sh ,
   there's no convention for sub-sections.
   Conventional sections, as described in
   .Sx MANUAL STRUCTURE ,
   rarely have sub-sections.
   .Pp
   Sub-section names should be unique so that they may be keyed by
   .Sx \&Sx .
   .Pp
   See also
   .Sx \&Pp ,
   .Sx \&Sh ,
   and
   .Sx \&Sx .
 .Ss \&St  .Ss \&St
   Replace an abbreviation for a standard with the full form.
   The following standards are recognised:
   .Pp
   .Bl -tag -width "-p1003.1g-2000X" -compact
   .It \-p1003.1-88
   .St -p1003.1-88
   .It \-p1003.1-90
   .St -p1003.1-90
   .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
   .St -isoC
   .It \-isoC-90
   .St -isoC-90
   .It \-isoC-amd1
   .St -isoC-amd1
   .It \-isoC-tcor1
   .St -isoC-tcor1
   .It \-isoC-tcor2
   .St -isoC-tcor2
   .It \-isoC-99
   .St -isoC-99
   .It \-iso9945-1-90
   .St -iso9945-1-90
   .It \-iso9945-1-96
   .St -iso9945-1-96
   .It \-iso9945-2-93
   .St -iso9945-2-93
   .It \-ansiC
   .St -ansiC
   .It \-ansiC-89
   .St -ansiC-89
   .It \-ansiC-99
   .St -ansiC-99
   .It \-ieee754
   .St -ieee754
   .It \-iso8802-3
   .St -iso8802-3
   .It \-ieee1275-94
   .St -ieee1275-94
   .It \-xpg3
   .St -xpg3
   .It \-xpg4
   .St -xpg4
   .It \-xpg4.2
   .St -xpg4.2
   .St -xpg4.3
   .It \-xbd5
   .St -xbd5
   .It \-xcu5
   .St -xcu5
   .It \-xsh5
   .St -xsh5
   .It \-xns5
   .St -xns5
   .It \-xns5.2
   .St -xns5.2
   .It \-xns5.2d2.0
   .St -xns5.2d2.0
   .It \-xcurses4.2
   .St -xcurses4.2
   .It \-susv2
   .St -susv2
   .It \-susv3
   .St -susv3
   .It \-svid4
   .St -svid4
   .El
 .Ss \&Sx  .Ss \&Sx
   Reference a section or sub-section.
   The referenced section or sub-section name must be identical to the
   enclosed argument, including whitespace.
   .Pp
   Examples:
   .D1 \&.Sx MANUAL STRUCTURE
 .Ss \&Sy  .Ss \&Sy
   Format enclosed arguments in symbolic
   .Pq Dq boldface .
   Note that this is a presentation term and should not be used for
   stylistically decorating technical terms.
   .Pp
   See also
   .Sx \&Bf ,
   .Sx \&Li ,
   and
   .Sx \&Em .
 .Ss \&Tn  .Ss \&Tn
   Format a tradename.
   .Pp
   Examples:
   .D1 \&.Tn IBM
 .Ss \&Ud  .Ss \&Ud
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
Line 2113  See also
Line 2618  See also
 and  and
 .Sx \&Ox .  .Sx \&Ox .
 .Ss \&Va  .Ss \&Va
   A variable name.
   .Pp
   Examples:
   .D1 \&.Va foo
   .D1 \&.Va const char *bar ;
 .Ss \&Vt  .Ss \&Vt
 A variable type.  A variable type.
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
Line 2170  Examples:
Line 2680  Examples:
 .D1 \&.Xr mandoc 1 \&;  .D1 \&.Xr mandoc 1 \&;
 .D1 \&.Xr mandoc 1 \&Ns s behaviour  .D1 \&.Xr mandoc 1 \&Ns s behaviour
 .Ss \&br  .Ss \&br
   Emits a line-break.
   This macro should not be used; it is implemented for compatibility with
   historical manuals.
   .Pp
   Consider using
   .Sx \&Pp
   in the event of natural paragraph breaks.
 .Ss \&sp  .Ss \&sp
   Emits vertical space.
   This macro should not be used; it is implemented for compatibility with
   historical manuals.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&sp Op Cm height
   .Pp
   The
   .Cm height
   argument must be formatted as described in
   .Sx Scaling Widths .
   If unspecified,
   .Sx \&sp
   asserts a single vertical space.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other other  This section documents compatibility between mandoc and other other
 troff implementations, at this time limited to GNU troff  troff implementations, at this time limited to GNU troff
Line 2187  Heirloom troff, the other significant troff implementa
Line 2718  Heirloom troff, the other significant troff implementa
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
   An empty
   .Sq \&Dd
   macro in groff prints
   .Dq Epoch .
   In mandoc, it resolves to the current date.
   .It
   The \es (font size), \em (font colour), and \eM (font filling colour)
   font decoration escapes are all discarded in mandoc.
   .It
 Old groff fails to assert a newline before  Old groff fails to assert a newline before
 .Sx \&Bd Fl ragged compact .  .Sx \&Bd Fl ragged compact .
 .It  .It
Line 2234  pseudo-macro as a line macro.
Line 2774  pseudo-macro as a line macro.
 mandoc does.  mandoc does.
 .It  .It
 The comment syntax  The comment syntax
 .Sq \e."  .Sq \e\."
 is no longer accepted.  is no longer accepted.
 .It  .It
 In groff, the  In groff, the
Line 2270  Display offsets
Line 2810  Display offsets
 and  and
 .Fl offset Ar right  .Fl offset Ar right
 are disregarded in mandoc.  are disregarded in mandoc.
 Furthermore, the  Furthermore, troff specifies a
 .Fl file Ar file  .Fl file Ar file
 argument is not supported in mandoc.  argument that is not supported in mandoc.
 Lastly, since text is not right-justified in mandoc (or even groff),  Lastly, since text is not right-justified in mandoc (or even groff),
 .Fl ragged  .Fl ragged
 and  and
Line 2326  The
Line 2866  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .\"  
 .\" XXX: this really isn't the place for these caveats.  
 .\" .  
 .\" .  
 .\" .Sh CAVEATS  
 .\" There are many ambiguous parts of mdoc.  
 .\" .  
 .\" .Pp  
 .\" .Bl -dash -compact  
 .\" .It  
 .\" .Sq \&Fa  
 .\" should be  
 .\" .Sq \&Va  
 .\" as function arguments are variables.  
 .\" .It  
 .\" .Sq \&Ft  
 .\" should be  
 .\" .Sq \&Vt  
 .\" as function return types are still types.  Furthermore, the  
 .\" .Sq \&Ft  
 .\" should be removed and  
 .\" .Sq \&Fo ,  
 .\" which ostensibly follows it, should follow the same convention as  
 .\" .Sq \&Va .  
 .\" .It  
 .\" .Sq \&Va  
 .\" should formalise that only one or two arguments are acceptable: a  
 .\" variable name and optional, preceding type.  
 .\" .It  
 .\" .Sq \&Fd  
 .\" is ambiguous.  It's commonly used to indicate an include file in the  
 .\" synopsis section.  
 .\" .Sq \&In  
 .\" should be used, instead.  
 .\" .It  
 .\" Only the  
 .\" .Sq \-literal  
 .\" argument to  
 .\" .Sq \&Bd  
 .\" makes sense.  The remaining ones should be removed.  
 .\" .It  
 .\" The  
 .\" .Sq \&Xo  
 .\" and  
 .\" .Sq \&Xc  
 .\" macros should be deprecated.  
 .\" .It  
 .\" The  
 .\" .Sq \&Dt  
 .\" macro lacks clarity.  It should be absolutely clear which title will  
 .\" render when formatting the manual page.  
 .\" .It  
 .\" A  
 .\" .Sq \&Lx  
 .\" should be provided for Linux (\(`a la  
 .\" .Sq \&Ox ,  
 .\" .Sq \&Nx  
 .\" etc.).  
 .\" .It  
 .\" There's no way to refer to references in  
 .\" .Sq \&Rs/Re  
 .\" blocks.  
 .\" .It  
 .\" The \-split and \-nosplit dictates via  
 .\" .Sq \&An  
 .\" are re-set when entering and leaving the AUTHORS section.  
 .\" .El  
 .\" .  

Legend:
Removed from v.1.127  
changed lines
  Added in v.1.142

CVSweb