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

Diff for /mandoc/mdoc.7 between version 1.138 and 1.140

version 1.138, 2010/07/19 15:28:11 version 1.140, 2010/07/19 21:59:48
Line 948  Examples:
Line 948  Examples:
 Author name.  Author name.
 This macro may alternatively accepts the following arguments, although  This macro may alternatively accepts the following arguments, although
 these may not be specified along with a parameter:  these may not be specified along with a parameter:
 .Bl -tag -width 12n -offset indent  .Pp
   .Bl -tag -width "-nosplitX" -offset indent -compact
 .It Fl split  .It Fl split
 Renders a line break before each author listing.  Renders a line break before each author listing.
 .It Fl nosplit  .It Fl nosplit
Line 956  The opposite of
Line 957  The opposite of
 .Fl split .  .Fl split .
 .El  .El
 .Pp  .Pp
 In the AUTHORS section, the default is not to split the first author  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  listing, but all subsequent author listings, whether or not they're
 interspersed by other macros or text, are split.  interspersed by other macros or text, are split.
 Thus, specifying  Thus, specifying
 .Fl split  .Fl split
 will cause the first listing also to be split.  will cause the first listing also to be split.
 If not in the AUTHORS section, the default is not to split.  If not in the
   .Em AUTHORS
   section, the default is not to split.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.An -nosplit  .D1 \&.An -nosplit
Line 973  the effects of
Line 978  the effects of
 .Fl split  .Fl split
 or  or
 .Fl nosplit  .Fl nosplit
 are re-set when entering the AUTHORS section, so if one specifies  are re-set when entering the
   .Em AUTHORS
   section, so if one specifies
 .Sx \&An Fl nosplit  .Sx \&An Fl nosplit
 in the general document body, it must be re-specified in the AUTHORS  in the general document body, it must be re-specified in the
   .Em AUTHORS
 section.  section.
 .Ss \&Ao  .Ss \&Ao
 Begins a block enclosed by angled brackets.  Begins a block enclosed by angled brackets.
Line 989  See also
Line 997  See also
 .Ss \&Ap  .Ss \&Ap
 Inserts an apostrophe without any surrounding whitespace.  Inserts an apostrophe without any surrounding whitespace.
 This is generally used as a grammatical device when referring to the verb  This is generally used as a grammatical device when referring to the verb
 form of a function:  form of a function.
 .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 angled brackets.
 .Pp  .Pp
Line 1024  Examples:
Line 1032  Examples:
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an AT&T version.
 Accepts at most one parameter:  Accepts at most one parameter:
 .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 .
Line 1314  Begins a block enclosed by square brackets.
Line 1323  Begins 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 1347  Begins a block enclosed by curly braces.
Line 1356  Begins 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 1482  invocations.
Line 1491  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
Line 1493  Begins a block enclosed by double quotes.
Line 1502  Begins a block enclosed by double quotes.
 Does not have any head 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 .
Line 1509  Examples:
Line 1523  Examples:
 .Ed  .Ed
 .Pp  .Pp
 See also  See also
 .Ss \&Qq ,  .Sx \&Qq ,
 .Ss \&Sq ,  .Sx \&Sq ,
 and  and
 .Sx \&Do .  .Sx \&Do .
   .Ss \&Dt
 Document title.  Document title.
 This is the mandatory second macro of any  This is the mandatory second macro of any
 .Nm  .Nm
Line 1752  Examples:
Line 1767  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 1881  See also
Line 1899  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 2083  Synonym for
Line 2102  Synonym for
 .Sx \&Pp .  .Sx \&Pp .
 .Ss \&Ms  .Ss \&Ms
 Display a mathematical symbol.  Display a mathematical symbol.
   Its syntax is as follows:
 .Pp  .Pp
   .D1 Pf \. Sx \&Ms Cm symbol
   .Pp
 Examples:  Examples:
 .D1 \&.Ms sigma  .D1 \&.Ms sigma
 .D1 \&.Ms aleph  .D1 \&.Ms aleph
Line 2374  block is used within a SEE ALSO section, a vertical sp
Line 2396  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  Close single-quoted context opened by
 .Sx \&So .  .Sx \&So .
Line 2436  See also
Line 2471  See also
 and  and
 .Sx \&Sx .  .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.  Reference a section or sub-section.
 The referenced section or sub-section name must be identical to the  The referenced section or sub-section name must be identical to the
Line 2458  and
Line 2589  and
 Format a tradename.  Format a tradename.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Tn IBM .  .D1 \&.Tn IBM
 .Ss \&Ud  .Ss \&Ud
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
Line 2541  Examples:
Line 2672  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
Legend:
Removed from v.1.138  
changed lines
  Added in v.1.140
CVSweb