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

Diff for /mandoc/man.7 between version 1.83 and 1.95

version 1.83, 2010/08/24 12:18:48 version 1.95, 2011/01/12 10:43:22
Line 59  line termination.
Line 59  line termination.
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will assert a  Blank lines are acceptable; where found, the output will assert a
 vertical space.  vertical space.
   .Pp
   If the first character of a line is a space, that line is printed
   with a leading newline.
 .Ss Comments  .Ss Comments
 Text following a  Text following a
 .Sq \e\*q ,  .Sq \e\*q ,
Line 219  Documents are generally structured as follows:
Line 222  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 251  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 411  The syntax is as follows:
Line 417  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 421  The syntax is as follows:
Line 426  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 509  The optional arguments specify which release it is fro
Line 510  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 532  Whitespace between arguments is omitted in output.
Line 530  Whitespace between arguments is omitted in output.
 .Pp  .Pp
 Examples:  Examples:
 .Pp  .Pp
 .D1 \&.BI bold italic bold italic  .Dl \&.BI bold italic bold italic
 .Pp  .Pp
 The output of this example will be emboldened  The output of this example will be emboldened
 .Dq bold  .Dq bold
Line 591  and
Line 589  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 692  and
Line 687  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 792  manual section.
Line 784  manual section.
 .Pp  .Pp
 Examples:  Examples:
 .Pp  .Pp
 .D1 \&.TH CVS 5 "1992-02-12" GNU  .Dl \&.TH CVS 5 "1992-02-12" GNU
 .Ss \&TP  .Ss \&TP
 Begin a paragraph where the head, if exceeding the indentation width, is  Begin a paragraph where the head, if exceeding the indentation width, is
 followed by a newline; if not, the body follows on the same line after a  followed by a newline; if not, the body follows on the same line after a
Line 818  See also
Line 810  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 837  See also
Line 823  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 866  Begin literal mode: all subsequent free-form lines hav
Line 845  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 894  Defaults to 1, if unspecified.
Line 863  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 938  The
Line 892  The
 .Pq text filling colour ,  .Pq text filling colour ,
 .Sq \ez  .Sq \ez
 .Pq zero-length character ,  .Pq zero-length character ,
   .Sq \ew
   .Pq string length ,
   .Sq \ek
   .Pq horizontal position marker ,
   .Sq \eo
   .Pq text overstrike ,
 and  and
 .Sq \es  .Sq \es
 .Pq text size  .Pq text size
 .Sx Text Decoration  escape sequences are all discarded in mandoc.
 escapes are all discarded in mandoc.  
 .It  .It
 The  The
 .Sq \ef  .Sq \ef
Line 954  macro does not accept negative values in mandoc.
Line 913  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.
 .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 ,
   .Xr roff 7 ,
   .Xr tbl 7
 .Sh HISTORY  .Sh HISTORY
 The  The
 .Nm  .Nm
Legend:
Removed from v.1.83  
changed lines
  Added in v.1.95
CVSweb