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

Diff for /mandoc/man.7 between version 1.80 and 1.92

version 1.80, 2010/07/26 10:00:03 version 1.92, 2010/12/08 10:58:22
Line 219  Documents are generally structured as follows:
Line 219  Documents are generally structured as follows:
 \&.TH FOO 1 2009-10-10  \&.TH FOO 1 2009-10-10
 \&.SH NAME  \&.SH NAME
 \efBfoo\efR \e(en a description goes here  \efBfoo\efR \e(en a description goes here
 \&.\e\*q The next is for sections 2 & 3 only.  
 \&.\e\*q .SH LIBRARY  \&.\e\*q .SH LIBRARY
   \&.\e\*q For sections 2 & 3 only.
   \&.\e\*q Not used in OpenBSD.
 \&.SH SYNOPSIS  \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...  \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION  \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...  The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES  \&.\e\*q .SH IMPLEMENTATION NOTES
 \&.\e\*q The next is for sections 2, 3, & 9 only.  \&.\e\*q Not used in OpenBSD.
 \&.\e\*q .SH RETURN VALUES  \&.\e\*q .SH RETURN VALUES
 \&.\e\*q The next is for sections 1, 6, 7, & 8 only.  \&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .SH ENVIRONMENT  \&.\e\*q .SH ENVIRONMENT
   \&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .SH FILES  \&.\e\*q .SH FILES
 \&.\e\*q The next is for sections 1 & 8 only.  
 \&.\e\*q .SH EXIT STATUS  \&.\e\*q .SH EXIT STATUS
   \&.\e\*q For sections 1, 6, & 8 only.
 \&.\e\*q .SH EXAMPLES  \&.\e\*q .SH EXAMPLES
 \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.  
 \&.\e\*q .SH DIAGNOSTICS  \&.\e\*q .SH DIAGNOSTICS
 \&.\e\*q The next is for sections 2, 3, & 9 only.  \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .SH ERRORS  \&.\e\*q .SH ERRORS
   \&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .SH SEE ALSO  \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )  \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS  \&.\e\*q .SH STANDARDS
Line 246  The \efBfoo\efR utility processes files...
Line 248  The \efBfoo\efR utility processes files...
 \&.\e\*q .SH CAVEATS  \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS  \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS  \&.\e\*q .SH SECURITY CONSIDERATIONS
   \&.\e\*q Not used in OpenBSD.
 .Ed  .Ed
 .Pp  .Pp
 The sections in a  The sections in a
Line 338  If not adhering to any standards, the
Line 341  If not adhering to any standards, the
 .Em HISTORY  .Em HISTORY
 section should be used.  section should be used.
 .It Em HISTORY  .It Em HISTORY
 The history of any manual without a  A brief history of the subject, including where support first appeared.
 .Em STANDARDS  
 section should be described in this section.  
 .It Em AUTHORS  .It Em AUTHORS
 Credits to authors, if applicable, should appear in this section.  Credits to the person or persons who wrote the code and/or documentation.
 Authors should generally be noted by both name and email address.  Authors should generally be noted by both name and email address.
 .It Em CAVEATS  .It Em CAVEATS
 Common misuses and misunderstandings should be explained  Common misuses and misunderstandings should be explained
Line 413  The syntax is as follows:
Line 414  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 \&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 423  The syntax is as follows:
Line 423  The syntax is as follows:
 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&  .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .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 \&ft  Ta    1         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat  .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It Sx \&na  Ta    0         Ta    current   Ta    compat  .It Sx \&na  Ta    0         Ta    current   Ta    compat
 .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 \&sp  Ta    1         Ta    current   Ta    compat  .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .\" .It Sx \&Sp  Ta    <1        Ta    current   Ta    compat  
 .\" .It Sx \&Vb  Ta    <1        Ta    current   Ta    compat  
 .\" .It Sx \&Ve  Ta    0         Ta    current   Ta    compat  
 .El  .El
 .Pp  .Pp
 Macros marked as  Macros marked as
Line 511  The optional arguments specify which release it is fro
Line 507  The optional arguments specify which release it is fro
 Text is rendered in bold face.  Text is rendered in bold face.
 .Pp  .Pp
 See also  See also
 .Sx \&I ,  .Sx \&I
 .Sx \&R ,  
 .Sx \&b ,  
 .Sx \&i ,  
 and  and
 .Sx \&r .  .Sx \&R .
 .Ss \&BI  .Ss \&BI
 Text is rendered alternately in bold face and italic.  Text is rendered alternately in bold face and italic.
 Thus,  Thus,
Line 593  and
Line 586  and
 Text is rendered in italics.  Text is rendered in italics.
 .Pp  .Pp
 See also  See also
 .Sx \&B ,  .Sx \&B
 .Sx \&R ,  
 .Sx \&b ,  
 .Sx \&i ,  
 and  and
 .Sx \&r .  .Sx \&R .
 .Ss \&IB  .Ss \&IB
 Text is rendered alternately in italics and bold face.  Text is rendered alternately in italics and bold face.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
Line 694  and
Line 684  and
 Text is rendered in roman (the default font).  Text is rendered in roman (the default font).
 .Pp  .Pp
 See also  See also
 .Sx \&I ,  .Sx \&I
 .Sx \&B ,  
 .Sx \&b ,  
 .Sx \&i ,  
 and  and
 .Sx \&r .  .Sx \&B .
 .Ss \&RB  .Ss \&RB
 Text is rendered alternately in roman (the default font) and bold face.  Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
Line 820  See also
Line 807  See also
 .Sx \&P ,  .Sx \&P ,
 and  and
 .Sx \&PP .  .Sx \&PP .
 .\" .  
 .\" .  
 .\" .Ss \&PD  
 .\" Has no effect.  Included for compatibility.  
 .\" .  
 .\" .  
 .Ss \&UC  .Ss \&UC
 Sets the volume for the footer for compatibility with man pages from  Sets the volume for the footer for compatibility with man pages from
 BSD releases.  BSD releases.
Line 839  See also
Line 820  See also
 .Ss \&fi  .Ss \&fi
 End literal mode begun by  End literal mode begun by
 .Sx \&nf .  .Sx \&nf .
 .Ss \&i  .Ss \&ft
 Italicise arguments.  Change the current font mode.
 Synonym for  See
 .Sx \&I .  .Sx Text Decoration
 .Pp  for a listing of available font modes.
 See also  
 .Sx \&B ,  
 .Sx \&I ,  
 .Sx \&R .  
 .Sx \&b ,  
 and  
 .Sx \&r .  
 .Ss \&in  .Ss \&in
 Indent relative to the current indentation:  Indent relative to the current indentation:
 .Pp  .Pp
Line 868  Begin literal mode: all subsequent free-form lines hav
Line 842  Begin literal mode: all subsequent free-form lines hav
 line boundaries preserved.  line boundaries preserved.
 May be ended by  May be ended by
 .Sx \&fi .  .Sx \&fi .
 .Ss \&r  
 Fonts and styles (bold face, italics) reset to roman (default font).  
 .Pp  
 See also  
 .Sx \&B ,  
 .Sx \&I ,  
 .Sx \&R ,  
 .Sx \&b ,  
 and  
 .Sx \&i .  
 .Ss \&sp  .Ss \&sp
 Insert vertical spaces into output with the following syntax:  Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
Line 896  Defaults to 1, if unspecified.
Line 860  Defaults to 1, if unspecified.
 .Pp  .Pp
 See also  See also
 .Sx \&br .  .Sx \&br .
 .\" .Ss \&Sp  
 .\" A synonym for  
 .\" .Sx \&sp  
 .\" .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 .  
 .\" .  
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents areas of questionable portability between  This section documents areas of questionable portability between
 implementations of the  implementations of the
Line 919  language.
Line 868  language.
 .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  
 In quoted literals, GNU troff allowed pair-wise double-quotes to produce  In quoted literals, GNU troff allowed pair-wise double-quotes to produce
 a standalone double-quote in formatted output.  a standalone double-quote in formatted output.
 It is not known whether this behaviour is exhibited by other formatters.  It is not known whether this behaviour is exhibited by other formatters.
 .It  .It
   troff suppresses a newline before
   .Sq \(aq
   macro output; in mandoc, it is an alias for the standard
   .Sq \&.
   control character.
   .It
 The  The
   .Sq \eh
   .Pq horizontal position ,
   .Sq \ev
   .Pq vertical position ,
   .Sq \em
   .Pq text colour ,
   .Sq \eM
   .Pq text filling colour ,
   .Sq \ez
   .Pq zero-length character ,
   .Sq \ew
   .Pq string length ,
   .Sq \ek
   .Pq horizontal position marker ,
   .Sq \eo
   .Pq text overstrike ,
   and
   .Sq \es
   .Pq text size
   escape sequences are all discarded in mandoc.
   .It
   The
   .Sq \ef
   scaling unit is accepted by mandoc, but rendered as the default unit.
   .It
   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  
 The  
 .Sq \(aq  
 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
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mandoc_char 7  .Xr mandoc_char 7 ,
   .Xr mdoc 7
 .Sh HISTORY  .Sh HISTORY
 The  The
 .Nm  .Nm
Legend:
Removed from v.1.80  
changed lines
  Added in v.1.92
CVSweb