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

Diff for /mandoc/man.7 between version 1.57 and 1.61

version 1.57, 2010/03/23 11:30:48 version 1.61, 2010/04/05 07:25:23
Line 403  Documents any security precautions that operators shou
Line 403  Documents any security precautions that operators shou
 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.  An arbitrary amount of whitespace may  at the beginning of the line.  The
 sit between the control character and the macro name.  Thus, the  .Sq \(aq
 following are equivalent:  macro control character is also accepted.  An arbitrary amount of
   whitespace (spaces or tabs) may sit between the control character and
   the macro name.  Thus, the following are equivalent:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.PP  \&.PP
 \&.\ \ \ PP  \&.\ \ \ PP
Line 438  If a next-line macro is followed by a non-next-line ma
Line 440  If a next-line macro is followed by a non-next-line ma
 raised (unless in the case of  raised (unless in the case of
 .Sx \&br ,  .Sx \&br ,
 .Sx \&sp ,  .Sx \&sp ,
 .Sx \&Sp ,  
 or  or
 .Sx \&na ) .  .Sx \&na ) .
 .Pp  .Pp
Line 458  The syntax is as follows:
Line 459  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 \&PD  Ta    n         Ta    current   Ta    compat  .\" .It Sx \&PD  Ta    n         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    \&
 .It Sx \&SB  Ta    n         Ta    next-line Ta    \&  .It Sx \&SB  Ta    n         Ta    next-line Ta    \&
 .It Sx \&SM  Ta    n         Ta    next-line Ta    \&  .It Sx \&SM  Ta    n         Ta    next-line Ta    \&
 .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&  .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&
 .It Sx \&UC  Ta    n         Ta    current   Ta    compat  .\" .It Sx \&UC  Ta    n         Ta    current   Ta    compat
 .It Sx \&br  Ta    0         Ta    current   Ta    compat  .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat  .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It Sx \&i   Ta    n         Ta    current   Ta    compat  .It Sx \&i   Ta    n         Ta    current   Ta    compat
Line 473  The syntax is as follows:
Line 474  The syntax is as follows:
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat  .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&r   Ta    0         Ta    current   Ta    compat  .It Sx \&r   Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat  .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .It Sx \&Sp  Ta    0         Ta    current   Ta    compat  .\" .It Sx \&Sp  Ta    0         Ta    current   Ta    compat
 .It Sx \&Vb  Ta    <1        Ta    current   Ta    compat  .\" .It Sx \&Vb  Ta    <1        Ta    current   Ta    compat
 .It Sx \&Ve  Ta    0         Ta    current   Ta    compat  .\" .It Sx \&Ve  Ta    0         Ta    current   Ta    compat
 .El  .El
 .  .
 .Pp  .Pp
Line 483  Macros marked as
Line 484  Macros marked as
 .Qq compat  .Qq compat
 are included for compatibility with the significant corpus of existing  are included for compatibility with the significant corpus of existing
 manuals that mix dialects of roff.  These macros should not be used for  manuals that mix dialects of roff.  These macros should not be used for
 portable manuals.  portable
   .Nm
   manuals.
 .  .
 .  .
 .Ss Block Macros  .Ss Block Macros
Line 519  or
Line 522  or
 No closure refers to an explicit block closing macro.  No closure refers to an explicit block closing macro.
 .  .
 .Pp  .Pp
   As a rule, block macros may not be nested; thus, calling a block macro
   while another block macro scope is open, and the open scope is not
   implicitly closed, is syntactically incorrect.
   .
   .Pp
 .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX"  .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX"
 .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes  .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes
 .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&  .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&
Line 896  See also
Line 904  See also
 .Sx \&P ,  .Sx \&P ,
 and  and
 .Sx \&PP .  .Sx \&PP .
   .\" .
   .\" .
   .\" .Ss \&PD
   .\" Has no effect.  Included for compatibility.
   .\" .
   .\" .
   .\" .Ss \&UC
   .\" Has no effect.  Included for compatibility.
 .  .
 .  .
 .Ss \&PD  
 Has no effect.  Included for compatibility.  
 .  
 .  
 .Ss \&UC  
 Has no effect.  Included for compatibility.  
 .  
 .  
 .Ss \&br  .Ss \&br
 Breaks the current line.  Consecutive invocations have no further effect.  Breaks the current line.  Consecutive invocations have no further effect.
 .Pp  .Pp
Line 971  macro.  Defaults to 1, if unspecified.
Line 979  macro.  Defaults to 1, if unspecified.
 See also  See also
 .Sx \&br .  .Sx \&br .
 .  .
 .Ss \&Sp  .\" .Ss \&Sp
 A synonym for  .\" A synonym for
 .Sx \&sp  .\" .Sx \&sp
 .Cm 0.5v .  .\" .Cm 0.5v .
   .\" .
   .\" .Ss \&Vb
   .\" A synonym for
   .\" .Sx \&nf .
   .\" Accepts an argument (the height of the formatted space) which is
   .\" disregarded.
   .\" .
   .\" .Ss \&Ve
   .\" A synonym for
   .\" .Sx \&fi .
   .\" .
 .  .
 .Ss \&Vb  
 A synonym for  
 .Sx \&nf .  
 Accepts an argument (the height of the formatted space) which is  
 disregarded.  
 .  
 .Ss \&Ve  
 A synonym for  
 .Sx \&fi .  
 .  
 .  
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility with other roff implementations, at  This section documents areas of questionable portability between
 this time limited to  implementations of the
 .Xr groff 1 .  .Nm
   language.
   .
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
 The  In quoted literals, GNU troff allowed pair-wise double-quotes to produce
 .Xr groff 1  a standalone double-quote in formatted output.  It is not known whether
 .Sx \&i  this behaviour is exhibited by other formatters.
 macro will italicise all subsequent text if a line argument is not  .
 provided.  This behaviour is not implemented.  
 .It  .It
 In quoted literals, groff allowed pair-wise double-quotes to produce a  Blocks of whitespace are stripped from macro and free-form text lines
 standalone double-quote in formatted output.  This idiosyncratic  (except when in literal mode) in mandoc.  This is not the case for GNU
 behaviour is no longer applicable.  troff: for maximum portability, whitespace sensitive blocks should be
   enclosed in literal contexts.
   .
 .It  .It
 The  The
 .Sx \&sp  .Sx \&sp
 macro does not accept negative numbers.  macro does not accept negative values in mandoc.  In GNU troff, this
   would result in strange behaviour.
   .
 .It  .It
 Blocks of whitespace are stripped from both macro and free-form text  The
 lines (except when in literal mode), while groff would retain whitespace  .Sq \(aq
 in free-form text lines.  macro control character, in GNU troff (and prior troffs) suppresses a
   newline before macro output; in mandoc, it is an alias for the standard
   .Sq \&.
   control character.
 .El  .El
 .  .
 .  .
Legend:
Removed from v.1.57  
changed lines
  Added in v.1.61
CVSweb