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

Diff for /mandoc/man.7 between version 1.111 and 1.119

version 1.111, 2011/09/26 23:07:31 version 1.119, 2013/07/13 19:41:16
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2011, 2012 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 253  in the alphabetical reference below.
Line 253  in the alphabetical reference below.
 .It Sx IP Ta indented paragraph: Op Ar head Op Ar width  .It Sx IP Ta indented paragraph: Op Ar head Op Ar width
 .It Sx TP Ta tagged paragraph: Op Ar width  .It Sx TP Ta tagged paragraph: Op Ar width
 .It Sx HP Ta hanged paragraph: Op Ar width  .It Sx HP Ta hanged paragraph: Op Ar width
   .It Sx PD Ta set vertical paragraph distance: Op Ar height
 .It Sx \&br Ta force output line break in text mode (no arguments)  .It Sx \&br Ta force output line break in text mode (no arguments)
 .It Sx \&sp Ta force vertical space: Op Ar height  .It Sx \&sp Ta force vertical space: Op Ar height
 .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)  .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
Line 339  and
Line 340  and
 .Ss \&DT  .Ss \&DT
 Has no effect.  Has no effect.
 Included for compatibility.  Included for compatibility.
   .Ss \&EE
   This is a non-standard GNU extension, included only for compatibility.
   In
   .Xr mandoc 1 ,
   it does the same as
   .Sx \&fi .
   .Ss \&EX
   This is a non-standard GNU extension, included only for compatibility.
   In
   .Xr mandoc 1 ,
   it does the same as
   .Sx \&nf .
 .Ss \&HP  .Ss \&HP
 Begin a paragraph whose initial output line is left-justified, but  Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:  subsequent output lines are indented, with the following syntax:
Line 349  subsequent output lines are indented, with the followi
Line 362  subsequent output lines are indented, with the followi
 .Pp  .Pp
 The  The
 .Cm width  .Cm width
 argument must conform to  argument is a
 .Sx Scaling Widths .  .Xr roff 7
   scaling width.
 If specified, it's saved for later paragraph left-margins; if unspecified, the  If specified, it's saved for later paragraph left-margins; if unspecified, the
 saved or default width is used.  saved or default width is used.
 .Pp  .Pp
Line 392  Begin an indented paragraph with the following syntax:
Line 406  Begin an indented paragraph with the following syntax:
 .Pp  .Pp
 The  The
 .Cm width  .Cm width
 argument defines the width of the left margin and is defined by  argument is a
 .Sx Scaling Widths .  .Xr roff 7
   scaling width defining the left margin.
 It's saved for later paragraph left-margins; if unspecified, the saved or  It's saved for later paragraph left-margins; if unspecified, the saved or
 default width is used.  default width is used.
 .Pp  .Pp
Line 437  See also
Line 452  See also
 .Sx \&PP ,  .Sx \&PP ,
 and  and
 .Sx \&TP .  .Sx \&TP .
   .Ss \&OP
   Optional command-line argument.
   This is a non-standard GNU extension, included only for compatibility.
   It has the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&OP
   .Cm key Op Cm value
   .Ed
   .Pp
   The
   .Cm key
   is usually a command-line flag and
   .Cm value
   its argument.
 .Ss \&P  .Ss \&P
 Synonym for  Synonym for
 .Sx \&LP .  .Sx \&LP .
Line 448  See also
Line 477  See also
 .Sx \&PP ,  .Sx \&PP ,
 and  and
 .Sx \&TP .  .Sx \&TP .
   .Ss \&PD
   Specify the vertical space to be inserted before each new paragraph.
   .br
   The syntax is as follows:
   .Bd -filled -offset indent
   .Pf \. Sx \&PD
   .Op Cm height
   .Ed
   .Pp
   The
   .Cm height
   argument is a
   .Xr roff 7
   scaling width.
   It defaults to
   .Cm 1v .
   If the unit is omitted,
   .Cm v
   is assumed.
   .Pp
   This macro affects the spacing before any subsequent instances of
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&P ,
   .Sx \&PP ,
   .Sx \&SH ,
   .Sx \&SS ,
   and
   .Sx \&TP .
 .Ss \&PP  .Ss \&PP
 Synonym for  Synonym for
 .Sx \&LP .  .Sx \&LP .
Line 512  This has the following syntax:
Line 571  This has the following syntax:
 .Pp  .Pp
 The  The
 .Cm width  .Cm width
 argument must conform to  argument is a
 .Sx Scaling Widths .  .Xr roff 7
   scaling width.
 If not specified, the saved or default width is used.  If not specified, the saved or default width is used.
 .Pp  .Pp
 See also  See also
Line 578  The syntax is as follows:
Line 638  The syntax is as follows:
 .Pp  .Pp
 The  The
 .Cm width  .Cm width
 argument must conform to  argument is a
 .Sx Scaling Widths .  .Xr roff 7
   scaling width.
 If specified, it's saved for later paragraph left-margins; if  If specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.  unspecified, the saved or default width is used.
 .Pp  .Pp
Line 636  Insert vertical spaces into output with the following 
Line 697  Insert vertical spaces into output with the following 
 .Op Cm height  .Op Cm height
 .Ed  .Ed
 .Pp  .Pp
 Insert  The
 .Cm height  .Cm height
 spaces, which must conform to  argument is a scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 If 0, this is equivalent to the  If 0, this is equivalent to the
 .Sx \&br  .Sx \&br
 macro.  macro.
Line 691  The syntax is as follows:
Line 752  The syntax is as follows:
 .It Sx \&I   Ta    n         Ta    next-line Ta    \&  .It Sx \&I   Ta    n         Ta    next-line Ta    \&
 .It Sx \&IB  Ta    n         Ta    current   Ta    \&  .It Sx \&IB  Ta    n         Ta    current   Ta    \&
 .It Sx \&IR  Ta    n         Ta    current   Ta    \&  .It Sx \&IR  Ta    n         Ta    current   Ta    \&
   .It Sx \&OP  Ta    0, 1      Ta    current   Ta    compat
 .It Sx \&R   Ta    n         Ta    next-line Ta    \&  .It Sx \&R   Ta    n         Ta    next-line Ta    \&
 .It Sx \&RB  Ta    n         Ta    current   Ta    \&  .It Sx \&RB  Ta    n         Ta    current   Ta    \&
 .It Sx \&RI  Ta    n         Ta    current   Ta    \&  .It Sx \&RI  Ta    n         Ta    current   Ta    \&
Line 840  The
Line 902  The
 .Sx \&sp  .Sx \&sp
 macro does not accept negative values in mandoc.  macro does not accept negative values in mandoc.
 In GNU troff, this would result in strange behaviour.  In GNU troff, this would result in strange behaviour.
   .It
   In page header lines, GNU troff versions up to and including 1.21
   only print
   .Ar volume
   names explicitly specified in the
   .Sx \&TH
   macro; mandoc and newer groff print the default volume name
   corresponding to the
   .Ar section
   number when no
   .Ar volume
   is given, like in
   .Xr mdoc 7 .
 .El  .El
   .Pp
   The
   .Sx OP
   macro is part of the extended
   .Nm
   macro set, and may not be portable to non-GNU troff implementations.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
Line 856  language first appeared as a macro package for the rof
Line 937  language first appeared as a macro package for the rof
 system in  system in
 .At v7 .  .At v7 .
 It was later rewritten by James Clark as a macro package for groff.  It was later rewritten by James Clark as a macro package for groff.
   Eric S. Raymond wrote the extended
   .Nm
   macros for groff in 2007.
 The stand-alone implementation that is part of the  The stand-alone implementation that is part of the
 .Xr mandoc 1  .Xr mandoc 1
 utility written by Kristaps Dzonsons appeared in  utility written by Kristaps Dzonsons appeared in
Line 864  utility written by Kristaps Dzonsons appeared in
Line 948  utility written by Kristaps Dzonsons appeared in
 This  This
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
 .Sh CAVEATS  .Sh CAVEATS
 Do not use this language.  Do not use this language.
 Use  Use
Legend:
Removed from v.1.111  
changed lines
  Added in v.1.119
CVSweb