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

Diff for /mandoc/mdoc.7 between version 1.126 and 1.139

version 1.126, 2010/06/12 11:41:50 version 1.139, 2010/07/19 15:43:10
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 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 465  section, particularly
Line 450  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 463  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 \&Sx ,
   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 672  has multiple heads.
Line 670  has multiple heads.
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable 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 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 921  block.
Line 935  block.
 .Ss \&Ac  .Ss \&Ac
 Closes an  Closes 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  Address construct: usually in the context of an computational address in
 memory, not a physical (post) address.  memory, not a physical (post) address.
Line 972  Examples:
Line 987  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  .Bd -literal -offset indent
Line 1036  and
Line 1051  and
 .Ss \&Bc  .Ss \&Bc
 Closes a  Closes 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.  Begins a display block.
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bd
   .Fl type
   .Op Fl offset Ar width
   .Op Fl compact
   .Ed
   .Pp
 A display is collection of macros or text which may be collectively  A display is collection of macros or text which may be collectively
 offset or justified in a manner different from that  offset or justified in a manner different from that
 of the enclosing context.  of the enclosing context.
Line 1063  Centre-justify each line.
Line 1087  Centre-justify each line.
 The type must be provided first.  The type must be provided first.
 Secondary arguments are as follows:  Secondary arguments are as follows:
 .Bl -tag -width 12n -offset indent  .Bl -tag -width 12n -offset indent
 .It Fl offset Ar width  .It Fl offset Ar val
 Offset by the value of  Offset by the value of
 .Ar width ,  .Ar val ,
 which is interpreted as one of the following, specified in order:  which is interpreted as one of the following, specified in order:
 .Bl -item  .Bl -item
 .It  .It
Line 1076  the width of standard indentation;
Line 1100  the width of standard indentation;
 twice  twice
 .Ar indent ;  .Ar indent ;
 .Ar left ,  .Ar left ,
 which has no effect ;  which has no effect;
 .Ar right ,  .Ar right ,
 which justifies to the right margin; and  which justifies to the right margin; and
 .Ar center ,  .Ar center ,
Line 1097  As the calculated string length of the opaque string.
Line 1121  As the calculated string length of the opaque string.
 If not provided an argument, it will be ignored.  If not provided an argument, it will be ignored.
 .It Fl compact  .It Fl compact
 Do not assert a vertical space before the block.  Do not assert a vertical space before the block.
 .It Fl file Ar file  
 Prepend the file  
 .Ar file  
 before any text or macros within the block.  
 .El  .El
 .Pp  .Pp
 Examples:  Examples:
Line 1115  See also
Line 1135  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 ,
   and
   .Sx \&Sy .
 .Ss \&Bk  .Ss \&Bk
   Begins a collection of macros or text not breaking the line.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Bk Fl words
   .Pp
   Subsequent arguments are ignored.
   The
   .Fl words
   argument is required.
   .Pp
   Each line within a keep block is kept intact, so the following example
   will not break within each
   .Sx \&Op
   macro line:
   .Bd -literal -offset indent
   \&.Bk \-words
   \&.Op Fl f Ar flags
   \&.Op Fl o Ar output
   \&.Ek
   .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.  Begins a list composed of one or more list entries.
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bl
   .Fl type
   .Op Fl width Ar val
   .Op Fl offset Ar val
   .Op Fl compact
   .Op HEAD ...
   .Ed
   .Pp
 A list is associated with a type, which is a required argument.  A list is associated with a type, which is a required argument.
 Other arguments are  Other arguments are
 .Fl width ,  .Fl width ,
Line 1215  The
Line 1301  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  A list offset by list entry heads.
 after the head as specified by the  List entry bodies are positioned after the head as specified by the
 .Fl width  .Fl width
 argument.  argument.
 .El  .El
Line 1254  See also
Line 1340  See also
 .Ss \&Brc  .Ss \&Brc
 Closes a  Closes 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.  Begins a block enclosed by curly braces.
 Does not have any head arguments.  Does not have any head arguments.
Line 1322  Examples:
Line 1409  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 1358  Its syntax is as follows:
Line 1445  Its syntax is as follows:
 .Ss \&Dc  .Ss \&Dc
 Closes a  Closes 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 1401  See also
Line 1489  See also
 and  and
 .Sx \&D1 .  .Sx \&D1 .
 .Ss \&Do  .Ss \&Do
 Begins a block enclosed by double quotes.  Does not have any head  Begins 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  .D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot
Line 1410  Examples:
Line 1498  Examples:
 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 1419  Examples:
Line 1509  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 1441  Its arguments are as follows:
Line 1534  Its arguments are as follows:
 .Bl -tag -width Ds -offset Ds  .Bl -tag -width Ds -offset Ds
 .It Cm title  .It Cm 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 Cm section
Line 1481  or
Line 1574  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 Cm volume
 This overrides the volume inferred from  This overrides the volume inferred from
Line 1586  See also
Line 1679  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 Cm TERM
   .Pp
   The
   .Cm 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
   Ends a font mode context started by
   .Sx \&Bf .
 .Ss \&Ek  .Ss \&Ek
   Ends a keep context started by
   .Sx \&Bk .
 .Ss \&El  .Ss \&El
 Ends a list context started by  Ends a list context started by
 .Sx \&Bl .  .Sx \&Bl .
Line 1605  stylistically decorating technical terms.
Line 1715  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.
 .Ss \&Eo  .Ss \&Eo
   An arbitrary enclosure.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Eo Op Cm TERM
   .Pp
   The
   .Cm 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 1617  Examples:
Line 1744  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 1625  Examples:
Line 1753  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.  Inserts text regarding a utility's exit value.
 This macro must have first the  This macro must consist of the
 .Fl std  .Fl std
 argument specified, then an optional  argument followed by an optional
 .Ar utility .  .Ar utility .
 If  If
 .Ar utility  .Ar utility
 is not provided, the document's name as stipulated in  is not provided, the document's name as stipulated in
 .Sx \&Nm  .Sx \&Nm
 is provided.  is provided.
   .Pp
   See also
   .Sx \&Rv .
 .Ss \&Fa  .Ss \&Fa
 Function argument.  Function argument.
 Its syntax is as follows:  Its syntax is as follows:
Line 1667  Examples:
Line 1798  Examples:
 See also  See also
 .Sx \&Fo .  .Sx \&Fo .
 .Ss \&Fc  .Ss \&Fc
   Ends 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 1752  See also
Line 1885  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 1788  See also
Line 1922  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 angled braces.
 .Pp  .Pp
 Examples:  Examples:
Line 1869  are interpreted within the scope of the last phrase.
Line 2020  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 1911  Examples:
Line 2062  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 1924  Examples:
Line 2084  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.
   .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 1936  Its syntax is as follows:
Line 2103  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 1957  See also
Line 2200  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Oc  .Ss \&Oc
   Closes 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 2007  See also
Line 2272  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  Closes a
 .Sx \&Rs  .Sx \&Rs
Line 2062  block is used within a SEE ALSO section, a vertical sp
Line 2379  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 2092  See also
Line 2593  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 2166  Heirloom troff, the other significant troff implementa
Line 2672  Heirloom troff, the other significant troff implementa
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .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 2213  pseudo-macro as a line macro.
Line 2722  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 2249  Display offsets
Line 2758  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 2305  The
Line 2814  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.126  
changed lines
  Added in v.1.139
CVSweb