===================================================================
RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/mandoc/Attic/mdoc.7,v
retrieving revision 1.41
retrieving revision 1.42
diff -c -r1.41 -r1.42
*** src/usr.bin/mandoc/Attic/mdoc.7	2010/07/25 18:05:54	1.41
--- src/usr.bin/mandoc/Attic/mdoc.7	2010/07/31 22:07:11	1.42
***************
*** 1,4 ****
! .\"	$Id: mdoc.7,v 1.41 2010/07/25 18:05:54 schwarze Exp $
  .\"
  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
--- 1,4 ----
! .\"	$Id: mdoc.7,v 1.42 2010/07/31 22:07:11 schwarze Exp $
  .\"
  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
***************
*** 15,21 ****
  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  .\"
! .Dd $Mdocdate: July 25 2010 $
  .Dt MDOC 7
  .Os
  .Sh NAME
--- 15,21 ----
  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  .\"
! .Dd $Mdocdate: July 31 2010 $
  .Dt MDOC 7
  .Os
  .Sh NAME
***************
*** 93,102 ****
  .Pp
  Use of reserved characters is described in
  .Sx MACRO SYNTAX .
! For general use in macro lines, these characters must either be escaped
  with a non-breaking space
  .Pq Sq \e&
! or, if applicable, an appropriate escape sequence used.
  .Ss Special Characters
  Special characters may occur in both macro and free-form lines.
  Sequences begin with the escape character
--- 93,102 ----
  .Pp
  Use of reserved characters is described in
  .Sx MACRO SYNTAX .
! For general use in macro lines, these characters can either be escaped
  with a non-breaking space
  .Pq Sq \e&
! or, if applicable, an appropriate escape sequence can be used.
  .Ss Special Characters
  Special characters may occur in both macro and free-form lines.
  Sequences begin with the escape character
***************
*** 201,224 ****
  In macro lines, whitespace delimits arguments and is discarded.
  If arguments are quoted, whitespace within the quotes is retained.
  .Ss Quotation
! Macro arguments may be quoted with a double-quote to group
  space-delimited terms or to retain blocks of whitespace.
  A quoted argument begins with a double-quote preceded by whitespace.
  The next double-quote not pair-wise adjacent to another double-quote
  terminates the literal, regardless of surrounding whitespace.
  .Pp
! This produces tokens
! .Sq a" ,
! .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
! .Sq \&Em a :
  .Bd -literal -offset indent
! \&.Em "Em a"
  .Ed
  .Pp
  In free-form mode, quotes are regarded as opaque text.
--- 201,218 ----
  In macro lines, whitespace delimits arguments and is discarded.
  If arguments are quoted, whitespace within the quotes is retained.
  .Ss Quotation
! Macro arguments may be quoted with double-quotes to group
  space-delimited terms or to retain blocks of whitespace.
  A quoted argument begins with a double-quote preceded by whitespace.
  The next double-quote not pair-wise adjacent to another double-quote
  terminates the literal, regardless of surrounding whitespace.
  .Pp
! Note that any quoted text, even if it would cause a macro invocation
! when unquoted, is considered literal text.
  Thus, the following produces
! .Sq Op "Fl a" :
  .Bd -literal -offset indent
! \&.Op "Fl a"
  .Ed
  .Pp
  In free-form mode, quotes are regarded as opaque text.
***************
*** 325,336 ****
  document consists of a document prologue followed by one or more
  sections.
  .Pp
! The prologue, which consists of (in order) the
  .Sx \&Dd ,
  .Sx \&Dt ,
  and
  .Sx \&Os
! macros, is required for every document.
  .Pp
  The first section (sections are denoted by
  .Sx \&Sh )
--- 319,330 ----
  document consists of a document prologue followed by one or more
  sections.
  .Pp
! The prologue, which consists of the
  .Sx \&Dd ,
  .Sx \&Dt ,
  and
  .Sx \&Os
! macros in that order, is required for every document.
  .Pp
  The first section (sections are denoted by
  .Sx \&Sh )
***************
*** 394,406 ****
  Sections should be composed as follows:
  .Bl -ohang -offset Ds
  .It Em NAME
! The name(s) and a short description of the documented material.
  The syntax for this as follows:
  .Bd -literal -offset indent
  \&.Nm name0
  \&.Nm name1
  \&.Nm name2
! \&.Nd a short description
  .Ed
  .Pp
  The
--- 388,400 ----
  Sections should be composed as follows:
  .Bl -ohang -offset Ds
  .It Em NAME
! The name(s) and a one-line description of the documented material.
  The syntax for this as follows:
  .Bd -literal -offset indent
  \&.Nm name0
  \&.Nm name1
  \&.Nm name2
! \&.Nd a one-line description
  .Ed
  .Pp
  The
***************
*** 493,499 ****
  .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.
--- 487,493 ----
  .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.
***************
*** 524,537 ****
  See
  .Sx \&Rv .
  .It Em ENVIRONMENT
! Documents any usages of environment variables, e.g.,
! .Xr environ 7 .
  .Pp
  See
  .Sx \&Ev .
  .It Em FILES
  Documents files used.
! It's helpful to document both the file and a short description of how
  the file is used (created, modified, etc.).
  .Pp
  See
--- 518,534 ----
  See
  .Sx \&Rv .
  .It Em ENVIRONMENT
! Lists the environment variables used by the utility,
! and explains the syntax and semantics of their values.
! The
! .Xr environ 7
! manual provides examples of typical content and formatting.
  .Pp
  See
  .Sx \&Ev .
  .It Em FILES
  Documents files used.
! It's helpful to document both the file name and a short description of how
  the file is used (created, modified, etc.).
  .Pp
  See
***************
*** 589,609 ****
  section should be described in this section.
  .It Em AUTHORS
  Credits to authors, if applicable, should appear in this section.
! Authors should generally be noted by both name and an e-mail address.
  .Pp
  See
  .Sx \&An .
  .It Em CAVEATS
! Explanations of common misuses and misunderstandings should be explained
  in this section.
  .It Em BUGS
! Extant bugs should be described in this section.
  .It Em SECURITY CONSIDERATIONS
  Documents any security precautions that operators should consider.
  .El
  .Sh MACRO SYNTAX
  Macros are one to three three characters in length and begin with a
! control character ,
  .Sq \&. ,
  at the beginning of the line.
  An arbitrary amount of whitespace may sit between the control character
--- 586,607 ----
  section should be described in this section.
  .It Em AUTHORS
  Credits to authors, if applicable, should appear in this section.
! Authors should generally be noted by both name and email address.
  .Pp
  See
  .Sx \&An .
  .It Em CAVEATS
! Common misuses and misunderstandings should be explained
  in this section.
  .It Em BUGS
! Known bugs, limitations and work-arounds should be described
! in this section.
  .It Em SECURITY CONSIDERATIONS
  Documents any security precautions that operators should consider.
  .El
  .Sh MACRO SYNTAX
  Macros are one to three three characters in length and begin with a
! control character,
  .Sq \&. ,
  at the beginning of the line.
  An arbitrary amount of whitespace may sit between the control character
***************
*** 636,645 ****
  .Sq Fl \&Sh .
  .Pp
  The
! .Em Parsable
  column indicates whether the macro may be followed by further
  (ostensibly callable) macros.
! If a macro is not parsable, subsequent macro invocations on the line
  will be interpreted as opaque text.
  .Pp
  The
--- 634,643 ----
  .Sq Fl \&Sh .
  .Pp
  The
! .Em Parsed
  column indicates whether the macro may be followed by further
  (ostensibly callable) macros.
! If a macro is not parsed, subsequent macro invocations on the line
  will be interpreted as opaque text.
  .Pp
  The
***************
*** 656,663 ****
  \&.Yc
  .Ed
  .Pp
! .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX"
! .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
  .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
  .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
--- 654,661 ----
  \&.Yc
  .Ed
  .Pp
! .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"
! .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
  .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
  .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
  .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
***************
*** 679,685 ****
  .Pc
  don't have heads; only one
  .Po
! .Sx \&It Fl column
  .Pc
  has multiple heads.
  .Bd -literal -offset indent
--- 677,685 ----
  .Pc
  don't have heads; only one
  .Po
! .Sx \&It
! in
! .Sx \&Bl Fl column
  .Pc
  has multiple heads.
  .Bd -literal -offset indent
***************
*** 687,694 ****
  \(lBbody...\(rB
  .Ed
  .Pp
! .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX"
! .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 \&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
--- 687,694 ----
  \(lBbody...\(rB
  .Ed
  .Pp
! .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
! .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
  .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
  .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
  .It Sx \&Nm  Ta    \&No     Ta  Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
***************
*** 723,730 ****
  \(lBbody...\(rB \&Yc \(lBtail...\(rB
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
  .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
--- 723,730 ----
  \(lBbody...\(rB \&Yc \(lBtail...\(rB
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
  .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
  .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
  .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
***************
*** 758,765 ****
  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsable
  .It Sx \&Aq  Ta    Yes      Ta    Yes
  .It Sx \&Bq  Ta    Yes      Ta    Yes
  .It Sx \&Brq Ta    Yes      Ta    Yes
--- 758,765 ----
  \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsed
  .It Sx \&Aq  Ta    Yes      Ta    Yes
  .It Sx \&Bq  Ta    Yes      Ta    Yes
  .It Sx \&Brq Ta    Yes      Ta    Yes
***************
*** 799,806 ****
  \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments
  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
  .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
  .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
--- 799,806 ----
  \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
  .Ed
  .Pp
! .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent
! .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
  .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
  .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
  .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
***************
*** 826,832 ****
  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
  .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
  .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
! .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    >0
  .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
  .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
  .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
--- 826,832 ----
  .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
  .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    n
  .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
! .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n
  .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
  .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    n
  .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
***************
*** 954,1013 ****
  .Sx \&Rs
  block.
  .Ss \&Ac
! Closes an
  .Sx \&Ao
  block.
  Does not have any tail arguments.
  .Ss \&Ad
! Address construct: usually in the context of an computational address in
! memory, not a physical (post) address.
  .Pp
  Examples:
  .D1 \&.Ad [0,$]
  .D1 \&.Ad 0x00000000
  .Ss \&An
  Author name.
! This macro may alternatively accepts the following arguments, although
! these may not be specified along with a parameter:
  .Pp
  .Bl -tag -width "-nosplitX" -offset indent -compact
  .It Fl split
! Renders a line break before each author listing.
  .It Fl nosplit
  The opposite of
  .Fl split .
  .El
  .Pp
  In the
  .Em AUTHORS
! section, the default is not to split the first author
! listing, but all subsequent author listings, whether or not they're
! interspersed by other macros or text, are split.
! Thus, specifying
  .Fl split
! will cause the first listing also to be split.
! If not in the
! .Em AUTHORS
! section, the default is not to split.
  .Pp
  Examples:
  .D1 \&.An -nosplit
! .D1 \&.An J. D. Ullman .
! .Pp
! .Em Remarks :
! the effects of
! .Fl split
! or
! .Fl nosplit
! are re-set when entering the
! .Em AUTHORS
! section, so if one specifies
! .Sx \&An Fl nosplit
! in the general document body, it must be re-specified in the
! .Em AUTHORS
! section.
  .Ss \&Ao
! Begins a block enclosed by angled brackets.
  Does not have any head arguments.
  .Pp
  Examples:
--- 954,1003 ----
  .Sx \&Rs
  block.
  .Ss \&Ac
! Close an
  .Sx \&Ao
  block.
  Does not have any tail arguments.
  .Ss \&Ad
! Memory address.
! Do not use this for postal addresses.
  .Pp
  Examples:
  .D1 \&.Ad [0,$]
  .D1 \&.Ad 0x00000000
  .Ss \&An
  Author name.
! Requires either the name of an author or one of the following arguments:
  .Pp
  .Bl -tag -width "-nosplitX" -offset indent -compact
  .It Fl split
! Start a new output line before each subsequent invocation of
! .Sx \&An .
  .It Fl nosplit
  The opposite of
  .Fl split .
  .El
  .Pp
+ The default is
+ .Fl nosplit .
+ The effect of selecting either of the
+ .Fl split
+ modes ends at the beginning of the
+ .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
  Examples:
  .D1 \&.An -nosplit
! .D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv
  .Ss \&Ao
! Begin a block enclosed by angle brackets.
  Does not have any head arguments.
  .Pp
  Examples:
***************
*** 1023,1029 ****
  Examples:
  .D1 \&.Fn execve \&Ap d
  .Ss \&Aq
! Encloses its arguments in angled brackets.
  .Pp
  Examples:
  .D1 \&.Fl -key= \&Ns \&Aq \&Ar val
--- 1013,1019 ----
  Examples:
  .D1 \&.Fn execve \&Ap d
  .Ss \&Aq
! Encloses its arguments in angle brackets.
  .Pp
  Examples:
  .D1 \&.Fl -key= \&Ns \&Aq \&Ar val
***************
*** 1043,1049 ****
  .Ss \&Ar
  Command arguments.
  If an argument is not provided, the string
! .Dq file ...
  is used as a default.
  .Pp
  Examples:
--- 1033,1039 ----
  .Ss \&Ar
  Command arguments.
  If an argument is not provided, the string
! .Dq file ...\&
  is used as a default.
  .Pp
  Examples:
***************
*** 1052,1069 ****
  .D1 \&.Ar arg1 , arg2 .
  .Ss \&At
  Formats an AT&T version.
! Accepts at most one parameter:
  .Pp
  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
  .It Cm v[1-7] | 32v
  A version of
  .At .
  .It Cm V[.[1-4]]?
! A system version of
! .At .
  .El
  .Pp
! Note that these parameters do not begin with a hyphen.
  .Pp
  Examples:
  .D1 \&.At
--- 1042,1059 ----
  .D1 \&.Ar arg1 , arg2 .
  .Ss \&At
  Formats an AT&T version.
! Accepts one optional argument:
  .Pp
  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
  .It Cm v[1-7] | 32v
  A version of
  .At .
  .It Cm V[.[1-4]]?
! A version of
! .At V .
  .El
  .Pp
! Note that these arguments do not begin with a hyphen.
  .Pp
  Examples:
  .D1 \&.At
***************
*** 1079,1161 ****
  and
  .Sx \&Ux .
  .Ss \&Bc
! Closes a
  .Sx \&Bo
  block.
  Does not have any tail arguments.
  .Ss \&Bd
! 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
! offset or justified in a manner different from that
! of the enclosing context.
! By default, the block is preceded by a vertical space.
  .Pp
! Each display is associated with a type, which must be one of the
! following arguments:
! .Bl -tag -width 12n -offset indent
! .It Fl ragged
! Only left-justify the block.
! .It Fl unfilled
! Do not justify the block at all.
  .It Fl filled
  Left- and right-justify the block.
  .It Fl literal
! Alias for
! .Fl unfilled .
! .It Fl centered
! Centre-justify each line.
  .El
  .Pp
! The type must be provided first.
! Secondary arguments are as follows:
! .Bl -tag -width 12n -offset indent
! .It Fl offset Ar val
! Offset by the value of
! .Ar val ,
! which is interpreted as one of the following, specified in order:
  .Bl -item
  .It
! As one of the pre-defined strings
! .Ar indent ,
  the width of standard indentation;
! .Ar indent-two ,
  twice
! .Ar indent ;
! .Ar left ,
  which has no effect;
! .Ar right ,
! which justifies to the right margin; and
! .Ar center ,
  which aligns around an imagined centre axis.
  .It
! As a precalculated width for a named macro.
  The most popular is the imaginary macro
  .Ar \&Ds ,
  which resolves to
! .Ar 6n .
  .It
! As a scaling unit following the syntax described in
  .Sx Scaling Widths .
  .It
! As the calculated string length of the opaque string.
  .El
  .Pp
! If not provided an argument, it will be ignored.
  .It Fl compact
! Do not assert a vertical space before the block.
  .El
  .Pp
  Examples:
  .Bd -literal -offset indent
! \&.Bd \-unfilled \-offset two-indent \-compact
     Hello       world.
  \&.Ed
  .Ed
--- 1069,1161 ----
  and
  .Sx \&Ux .
  .Ss \&Bc
! Close a
  .Sx \&Bo
  block.
  Does not have any tail arguments.
  .Ss \&Bd
! Begin a display block.
  Its syntax is as follows:
  .Bd -ragged -offset indent
  .Pf \. Sx \&Bd
! .Fl Ns Ar type
  .Op Fl offset Ar width
  .Op Fl compact
  .Ed
  .Pp
! Display blocks are used to select a different indentation and
! justification than the one used by the surrounding text.
! They may contain both macro lines and free-form text lines.
! By default, a display block is preceded by a vertical space.
  .Pp
! The
! .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
  Left- and right-justify the block.
  .It Fl literal
! Do not justify the block at all.
! Preserve white space as it appears in the input.
! .It Fl ragged
! Only left-justify the block.
! .It Fl unfilled
! An alias for
! .Fl literal .
  .El
  .Pp
! The
! .Ar type
! must be provided first.
! Additional arguments may follow:
! .Bl -tag -width 13n -offset indent
! .It Fl offset Ar width
! Indent the display by the
! .Ar width ,
! which may be one of the following:
  .Bl -item
  .It
! One of the pre-defined strings
! .Cm indent ,
  the width of standard indentation;
! .Cm indent-two ,
  twice
! .Cm indent ;
! .Cm left ,
  which has no effect;
! .Cm right ,
! which justifies to the right margin; or
! .Cm center ,
  which aligns around an imagined centre axis.
  .It
! A macro invocation, which selects a predefined width
! associated with that macro.
  The most popular is the imaginary macro
  .Ar \&Ds ,
  which resolves to
! .Sy 6n .
  .It
! A width using the syntax described in
  .Sx Scaling Widths .
  .It
! An arbitrary string, which indents by the length of this string.
  .El
  .Pp
! When the argument is missing,
! .Fl offset
! is ignored.
  .It Fl compact
! Do not assert vertical space before the display.
  .El
  .Pp
  Examples:
  .Bd -literal -offset indent
! \&.Bd \-literal \-offset indent \-compact
     Hello       world.
  \&.Ed
  .Ed
***************
*** 1196,1216 ****
  See also
  .Sx \&Li ,
  .Sx \&Ef ,
  and
  .Sx \&Sy .
  .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
--- 1196,1217 ----
  See also
  .Sx \&Li ,
  .Sx \&Ef ,
+ .Sx \&Em ,
  and
  .Sx \&Sy .
  .Ss \&Bk
! Keep the output generated from each macro input line together
! on one single output line.
! Line breaks in free-form text lines are unaffected.
! The syntax is as follows:
  .Pp
  .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
***************
*** 1223,1346 ****
  Be careful in using over-long lines within a keep block!
  Doing so will clobber the right margin.
  .Ss \&Bl
! 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.
! 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
! macro, which consists of a head and optional body (depending on the list
! type).
  A list must specify one of the following list types:
  .Bl -tag -width 12n -offset indent
  .It Fl bullet
! A list offset by a bullet.
! The head of list entries must be empty.
! List entry bodies are positioned after the bullet.
! The
  .Fl width
! argument varies the width of list bodies' left-margins.
  .It Fl column
  A columnated list.
  The
  .Fl width
! argument has no effect.
! The number of columns is specified as parameters to the
! .Sx \&Bl
! macro.
! These dictate the width of columns either as
  .Sx Scaling Widths
! or literal text.
! If the initial macro of a
  .Fl column
  list is not an
- .Sx \&It ,
- an
  .Sx \&It
! context spanning each line is implied until an
  .Sx \&It
! line macro is encountered, at which point list bodies are interpreted as
  described in the
  .Sx \&It
  documentation.
  .It Fl dash
! A list offset by a dash (hyphen).
! The head of list entries must be empty.
! List entry bodies are positioned past the dash.
! The
! .Fl width
! argument varies the width of list bodies' left-margins.
  .It Fl diag
  Like
  .Fl inset ,
! but with additional formatting to the head.
! The
! .Fl width
! argument varies the width of list bodies' left-margins.
  .It Fl enum
! An enumerated list offset by the enumeration from 1.
! The head of list entries must be empty.
! List entry bodies are positioned after the enumeration.
! The
! .Fl width
! argument varies the width of list bodies' left-margins.
  .It Fl hang
  Like
  .Fl tag ,
! but instead of list bodies positioned after the head, they trail the
! head text.
! The
! .Fl width
! argument varies the width of list bodies' left-margins.
  .It Fl hyphen
  Synonym for
  .Fl dash .
  .It Fl inset
! List bodies follow the list head.
! The
  .Fl width
  argument is ignored.
  .It Fl item
! This produces blocks of text.
! The head of list entries must be empty.
! The
  .Fl width
  argument is ignored.
  .It Fl ohang
! List bodies are positioned on the line following the head.
  The
  .Fl width
  argument is ignored.
  .It Fl tag
! A list offset by list entry heads.
! List entry bodies are positioned after the head as specified by the
  .Fl width
  argument.
  .El
  .Pp
  See also
  .Sx \&It .
  .Ss \&Bo
! Begins a block enclosed by square brackets.
  Does not have any head arguments.
  .Pp
  Examples:
--- 1224,1351 ----
  Be careful in using over-long lines within a keep block!
  Doing so will clobber the right margin.
  .Ss \&Bl
! Begin a list.
! Lists consist of items started by the
! .Sx \&It
! macro, containing a head or a body or both.
! The list syntax is as follows:
  .Bd -ragged -offset indent
  .Pf \. Sx \&Bl
! .Fl Ns Ar type
  .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:
  .Bl -tag -width 12n -offset indent
  .It Fl bullet
! No item heads can be specified, but a bullet will be printed at the head
! of each item.
! Item bodies start on the same output line as the bullet
! and are indented according to the
  .Fl width
! argument.
  .It Fl column
  A columnated list.
  The
  .Fl width
! argument has no effect; instead, each argument specifies the width
! of one column, using either the
  .Sx Scaling Widths
! syntax or the string length of the argument.
! If the first line of the body of a
  .Fl column
  list is not an
  .Sx \&It
! macro line,
  .Sx \&It
! 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
  .Sx \&It
  documentation.
  .It Fl dash
! Like
! .Fl bullet ,
! except that dashes are used in place of bullets.
  .It Fl diag
  Like
  .Fl inset ,
! except that item heads are not parsed for macro invocations.
! .\" but with additional formatting to the head.
  .It Fl enum
! A numbered list.
! Formatted like
! .Fl bullet ,
! except that cardinal numbers are used in place of bullets,
! starting at 1.
  .It Fl hang
  Like
  .Fl tag ,
! except that the first lines of item bodies are not indented, but follow
! the item heads like in
! .Fl inset
! lists.
  .It Fl hyphen
  Synonym for
  .Fl dash .
  .It Fl inset
! Item bodies follow items heads on the same line, using normal inter-word
! spacing.
! Bodies are not indented, and the
  .Fl width
  argument is ignored.
  .It Fl item
! No item heads can be specified, and none are printed.
! Bodies are not indented, and the
  .Fl width
  argument is ignored.
  .It Fl ohang
! Item bodies start on the line following item heads and are not indented.
  The
  .Fl width
  argument is ignored.
  .It Fl tag
! Item bodies are indented according to the
  .Fl width
  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
  .Pp
  See also
+ .Sx \&El
+ and
  .Sx \&It .
  .Ss \&Bo
! Begin a block enclosed by square brackets.
  Does not have any head arguments.
  .Pp
  Examples:
***************
*** 1368,1379 ****
  See also
  .Sx \&Bo .
  .Ss \&Brc
! Closes a
  .Sx \&Bro
  block.
  Does not have any tail arguments.
  .Ss \&Bro
! Begins a block enclosed by curly braces.
  Does not have any head arguments.
  .Pp
  Examples:
--- 1373,1384 ----
  See also
  .Sx \&Bo .
  .Ss \&Brc
! Close a
  .Sx \&Bro
  block.
  Does not have any tail arguments.
  .Ss \&Bro
! Begin a block enclosed by curly braces.
  Does not have any head arguments.
  .Pp
  Examples:
***************
*** 1430,1436 ****
  and
  .Sx \&Ux .
  .Ss \&Cd
! Configuration declaration.
  This denotes strings accepted by
  .Xr config 8 .
  .Pp
--- 1435,1441 ----
  and
  .Sx \&Ux .
  .Ss \&Cd
! Kernel configuration declaration.
  This denotes strings accepted by
  .Xr config 8 .
  .Pp
***************
*** 1467,1479 ****
  and
  .Sx \&Dl .
  .Ss \&Db
! Start a debugging context.
! This macro is parsed, but generally ignored.
  Its syntax is as follows:
  .Pp
  .D1 Pf \. Sx \&Db Cm on | off
  .Ss \&Dc
! Closes a
  .Sx \&Do
  block.
  Does not have any tail arguments.
--- 1472,1486 ----
  and
  .Sx \&Dl .
  .Ss \&Db
! Switch debugging mode.
  Its syntax is as follows:
  .Pp
  .D1 Pf \. Sx \&Db Cm on | off
+ .Pp
+ This macro is ignored by
+ .Xr mandoc 1 .
  .Ss \&Dc
! Close a
  .Sx \&Do
  block.
  Does not have any tail arguments.
***************
*** 1484,1500 ****
  manual.
  Its syntax is as follows:
  .Pp
! .D1 Pf \. Sx \&Dd Cm date
  .Pp
  The
! .Cm date
! field may be either
  .Ar $\&Mdocdate$ ,
  which signifies the current manual revision date dictated by
  .Xr cvs 1 ,
  or instead a valid canonical date as specified by
  .Sx Dates .
! If a date does not conform, the current date is used instead.
  .Pp
  Examples:
  .D1 \&.Dd $\&Mdocdate$
--- 1491,1507 ----
  manual.
  Its syntax is as follows:
  .Pp
! .D1 Pf \. Sx \&Dd Op Ar date
  .Pp
  The
! .Ar date
! may be either
  .Ar $\&Mdocdate$ ,
  which signifies the current manual revision date dictated by
  .Xr cvs 1 ,
  or instead a valid canonical date as specified by
  .Sx Dates .
! If a date does not conform or is empty, the current date is used.
  .Pp
  Examples:
  .D1 \&.Dd $\&Mdocdate$
***************
*** 1519,1525 ****
  and
  .Sx \&D1 .
  .Ss \&Do
! Begins a block enclosed by double quotes.
  Does not have any head arguments.
  .Pp
  Examples:
--- 1526,1532 ----
  and
  .Sx \&D1 .
  .Ss \&Do
! Begin a block enclosed by double quotes.
  Does not have any head arguments.
  .Pp
  Examples:
***************
*** 1557,1578 ****
  .Bd -ragged -offset indent
  .Pf \. Sx \&Dt
  .Oo
! .Cm title
  .Oo
! .Cm section
! .Op Cm volume | arch
  .Oc
  .Oc
  .Ed
  .Pp
  Its arguments are as follows:
  .Bl -tag -width Ds -offset Ds
! .It Cm title
  The document's title (name), defaulting to
  .Dq UNKNOWN
  if unspecified.
  It should be capitalised.
! .It Cm section
  The manual section.
  This may be one of
  .Ar 1
--- 1564,1585 ----
  .Bd -ragged -offset indent
  .Pf \. Sx \&Dt
  .Oo
! .Ar title
  .Oo
! .Ar section
! .Op Ar volume | arch
  .Oc
  .Oc
  .Ed
  .Pp
  Its arguments are as follows:
  .Bl -tag -width Ds -offset Ds
! .It Ar title
  The document's title (name), defaulting to
  .Dq UNKNOWN
  if unspecified.
  It should be capitalised.
! .It Ar section
  The manual section.
  This may be one of
  .Ar 1
***************
*** 1611,1617 ****
  It should correspond to the manual's filename suffix and defaults to
  .Dq 1
  if unspecified.
! .It Cm volume
  This overrides the volume inferred from
  .Ar section .
  This field is optional, and if specified, must be one of
--- 1618,1624 ----
  It should correspond to the manual's filename suffix and defaults to
  .Dq 1
  if unspecified.
! .It Ar volume
  This overrides the volume inferred from
  .Ar section .
  This field is optional, and if specified, must be one of
***************
*** 1640,1649 ****
  or
  .Ar CON
  .Pq contributed manuals .
! .It Cm arch
  This specifies a specific relevant architecture.
  If
! .Cm volume
  is not provided, it may be used in its place, else it may be used
  subsequent that.
  It, too, is optional.
--- 1647,1656 ----
  or
  .Ar CON
  .Pq contributed manuals .
! .It Ar arch
  This specifies a specific relevant architecture.
  If
! .Ar volume
  is not provided, it may be used in its place, else it may be used
  subsequent that.
  It, too, is optional.
***************
*** 1718,1727 ****
  .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 .
--- 1725,1734 ----
  .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 .
***************
*** 1729,1741 ****
  End a display context started by
  .Sx \&Bd .
  .Ss \&Ef
! Ends a font mode context started by
  .Sx \&Bf .
  .Ss \&Ek
! Ends a keep context started by
  .Sx \&Bk .
  .Ss \&El
! Ends a list context started by
  .Sx \&Bl .
  .Pp
  See also
--- 1736,1748 ----
  End a display context started by
  .Sx \&Bd .
  .Ss \&Ef
! End a font mode context started by
  .Sx \&Bf .
  .Ss \&Ek
! End a keep context started by
  .Sx \&Bk .
  .Ss \&El
! End a list context started by
  .Sx \&Bl .
  .Pp
  See also
***************
*** 1757,1771 ****
  and
  .Sx \&Li .
  .Ss \&En
! This macro is obsolete and not implemented.
  .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 .
--- 1764,1779 ----
  and
  .Sx \&Li .
  .Ss \&En
! This macro is obsolete and not implemented in
! .Xr mandoc 1 .
  .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 .
***************
*** 1788,1803 ****
  .D1 \&.Ev DISPLAY
  .D1 \&.Ev PATH
  .Ss \&Ex
! Inserts text regarding a utility's exit value.
! This macro must consist of the
! .Fl std
! argument followed by an optional
! .Ar utility .
! If
  .Ar utility
! is not provided, the document's name as stipulated in
  .Sx \&Nm
! is provided.
  .Pp
  See also
  .Sx \&Rv .
--- 1796,1811 ----
  .D1 \&.Ev DISPLAY
  .D1 \&.Ev PATH
  .Ss \&Ex
! Insert a standard sentence regarding exit values.
! Its syntax is as follows:
! .Pp
! .D1 Pf \. Sx \&Ex Fl std Op Ar utility
! .Pp
! When
  .Ar utility
! is not specified, the document's name set by
  .Sx \&Nm
! is used.
  .Pp
  See also
  .Sx \&Rv .
***************
*** 1833,1839 ****
  See also
  .Sx \&Fo .
  .Ss \&Fc
! Ends a function context started by
  .Sx \&Fo .
  .Ss \&Fd
  Historically used to document include files.
--- 1841,1847 ----
  See also
  .Sx \&Fo .
  .Ss \&Fc
! End a function context started by
  .Sx \&Fo .
  .Ss \&Fd
  Historically used to document include files.
***************
*** 1984,1990 ****
  section (only if invoked as the line macro), the first argument is
  preceded by
  .Dq #include ,
! the arguments is enclosed in angled braces.
  .Pp
  Examples:
  .D1 \&.In sys/types
--- 1992,1998 ----
  section (only if invoked as the line macro), the first argument is
  preceded by
  .Dq #include ,
! the arguments is enclosed in angle brackets.
  .Pp
  Examples:
  .D1 \&.In sys/types
***************
*** 2238,2244 ****
  and
  .Sx \&Ux .
  .Ss \&Oc
! Closes multi-line
  .Sx \&Oo
  context.
  .Ss \&Oo
--- 2246,2252 ----
  and
  .Sx \&Ux .
  .Ss \&Oc
! Close multi-line
  .Sx \&Oo
  context.
  .Ss \&Oo
***************
*** 2372,2383 ****
  and
  .Sx \&Qo .
  .Ss \&Re
! Closes a
  .Sx \&Rs
  block.
  Does not have any tail arguments.
  .Ss \&Rs
! Begins a bibliographic
  .Pq Dq reference
  block.
  Does not have any head arguments.
--- 2380,2391 ----
  and
  .Sx \&Qo .
  .Ss \&Re
! Close an
  .Sx \&Rs
  block.
  Does not have any tail arguments.
  .Ss \&Rs
! Begin a bibliographic
  .Pq Dq reference
  block.
  Does not have any head arguments.
***************
*** 2730,2735 ****
--- 2738,2749 ----
  \-mdoc, is similar to historic groff.
  .Pp
  .Bl -dash -compact
+ .It
+ An empty
+ .Sq \&Dd
+ macro in groff prints
+ .Dq Epoch .
+ In mandoc, it resolves to the current date.
  .It
  Old groff fails to assert a newline before
  .Sx \&Bd Fl ragged compact .