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

Diff for /mandoc/man.7 between version 1.116 and 1.126

version 1.116, 2012/06/02 20:16:23 version 1.126, 2014/03/31 01:05:32
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011, 2012 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, 2013 Ingo Schwarze <schwarze@openbsd.org>
   .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.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 97  file for a utility
Line 98  file for a utility
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.TH PROGNAME 1 2009-10-10  \&.TH PROGNAME 1 2009-10-10
 \&.SH NAME  \&.SH NAME
 \efBprogname\efR \e(en a description goes here  \efBprogname\efR \e(en one line about what it does
 \&.\e\(dq .SH LIBRARY  \&.\e\(dq .SH LIBRARY
 \&.\e\(dq For sections 2 & 3 only.  \&.\e\(dq For sections 2, 3, and 9 only.
 \&.\e\(dq Not used in OpenBSD.  \&.\e\(dq Not used in OpenBSD.
 \&.SH SYNOPSIS  \&.SH SYNOPSIS
 \efBprogname\efR [\efB\e-options\efR] arguments...  \efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR
 \&.SH DESCRIPTION  \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...  The \efBfoo\efR utility processes files ...
   \&.\e\(dq .Sh CONTEXT
   \&.\e\(dq For section 9 functions only.
 \&.\e\(dq .SH IMPLEMENTATION NOTES  \&.\e\(dq .SH IMPLEMENTATION NOTES
 \&.\e\(dq Not used in OpenBSD.  \&.\e\(dq Not used in OpenBSD.
 \&.\e\(dq .SH RETURN VALUES  \&.\e\(dq .SH RETURN VALUES
 \&.\e\(dq For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, and 9 function return values only.
 \&.\e\(dq .SH ENVIRONMENT  \&.\e\(dq .SH ENVIRONMENT
 \&.\e\(dq For sections 1, 6, 7, & 8 only.  \&.\e\(dq For sections 1, 6, 7, and 8 only.
 \&.\e\(dq .SH FILES  \&.\e\(dq .SH FILES
 \&.\e\(dq .SH EXIT STATUS  \&.\e\(dq .SH EXIT STATUS
 \&.\e\(dq For sections 1, 6, & 8 only.  \&.\e\(dq For sections 1, 6, and 8 only.
 \&.\e\(dq .SH EXAMPLES  \&.\e\(dq .SH EXAMPLES
 \&.\e\(dq .SH DIAGNOSTICS  \&.\e\(dq .SH DIAGNOSTICS
 \&.\e\(dq For sections 1, 4, 6, 7, & 8 only.  \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
 \&.\e\(dq .SH ERRORS  \&.\e\(dq .SH ERRORS
 \&.\e\(dq For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
 \&.\e\(dq .SH SEE ALSO  \&.\e\(dq .SH SEE ALSO
 \&.\e\(dq .BR foo ( 1 )  \&.\e\(dq .BR foobar ( 1 )
 \&.\e\(dq .SH STANDARDS  \&.\e\(dq .SH STANDARDS
 \&.\e\(dq .SH HISTORY  \&.\e\(dq .SH HISTORY
 \&.\e\(dq .SH AUTHORS  \&.\e\(dq .SH AUTHORS
Line 170  This expands upon the brief, one-line description in
Line 173  This expands upon the brief, one-line description in
 .Em NAME .  .Em NAME .
 It usually contains a break-down of the options (if documenting a  It usually contains a break-down of the options (if documenting a
 command).  command).
   .It Em CONTEXT
   This section lists the contexts in which functions can be called in section 9.
   The contexts are autoconf, process, or interrupt.
 .It Em IMPLEMENTATION NOTES  .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.  Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side  This is useful when implementing standard functions that may have side
Line 196  well-tested invocations.
Line 202  well-tested invocations.
 Make sure that examples work properly!  Make sure that examples work properly!
 .It Em DIAGNOSTICS  .It Em DIAGNOSTICS
 Documents error conditions.  Documents error conditions.
 This is most useful in section 4 manuals.  In section 4 and 9 manuals, these are usually messages
   printed by the kernel to the console and to the kernel log.
   In section 1, 6, 7, and 8, these are usually messages
   printed by userland programs to the standard error output.
   .Pp
 Historically, this section was used in place of  Historically, this section was used in place of
 .Em EXIT STATUS  .Em EXIT STATUS
 for manuals in sections 1, 6, and 8; however, this practise is  for manuals in sections 1, 6, and 8; however, this practise is
 discouraged.  discouraged.
 .It Em ERRORS  .It Em ERRORS
 Documents error handling in sections 2, 3, and 9.  Documents
   .Xr errno 2
   settings in sections 2, 3, 4, and 9.
 .It Em SEE ALSO  .It Em SEE ALSO
 References other manuals with related topics.  References other manuals with related topics.
 This section should exist for most manuals.  This section should exist for most manuals.
Line 253  in the alphabetical reference below.
Line 265  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 279  For the scoping of individual macros, see
Line 292  For the scoping of individual macros, see
 .Sx MACRO SYNTAX .  .Sx MACRO SYNTAX .
 .Ss \&AT  .Ss \&AT
 Sets the volume for the footer for compatibility with man pages from  Sets the volume for the footer for compatibility with man pages from
 .Tn AT&T UNIX  .At
 releases.  releases.
 The optional arguments specify which release it is from.  The optional arguments specify which release it is from.
 .Ss \&B  .Ss \&B
Line 361  subsequent output lines are indented, with the followi
Line 374  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 404  Begin an indented paragraph with the following syntax:
Line 418  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 474  See also
Line 489  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 538  This has the following syntax:
Line 583  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 604  The syntax is as follows:
Line 650  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 618  and
Line 665  and
 .Sx \&PP .  .Sx \&PP .
 .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.  .Bx
   releases.
 The optional first argument specifies which release it is from.  The optional first argument specifies which release it is from.
   .Ss \&UE
   End a uniform resource identifier block.
   This is a non-standard GNU extension, included only for compatibility.
   See
   .Sx \&UE .
   .Ss \&UR
   Begin a uniform resource identifier block.
   This is a non-standard GNU extension, included only for compatibility.
   It has the following syntax:
   .Bd -literal -offset indent
   .Pf \. Sx \&UR Ar uri
   link description to be shown
   .Pf \. Sx UE
   .Ed
 .Ss \&br  .Ss \&br
 Breaks the current line.  Breaks the current line.
 Consecutive invocations have no further effect.  Consecutive invocations have no further effect.
Line 629  See also
Line 691  See also
 .Ss \&fi  .Ss \&fi
 End literal mode begun by  End literal mode begun by
 .Sx \&nf .  .Sx \&nf .
 .Ss \&ft  
 Change the current font mode.  
 See  
 .Sx Text Decoration  
 for a listing of available font modes.  
 .Ss \&in  .Ss \&in
 Indent relative to the current indentation:  Indent relative to the current indentation:
 .Pp  .Pp
Line 662  Insert vertical spaces into output with the following 
Line 719  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 714  The syntax is as follows:
Line 771  The syntax is as follows:
 .It Sx \&BI  Ta    n         Ta    current   Ta    \&  .It Sx \&BI  Ta    n         Ta    current   Ta    \&
 .It Sx \&BR  Ta    n         Ta    current   Ta    \&  .It Sx \&BR  Ta    n         Ta    current   Ta    \&
 .It Sx \&DT  Ta    0         Ta    current   Ta    \&  .It Sx \&DT  Ta    0         Ta    current   Ta    \&
   .It Sx \&EE  Ta    0         Ta    current   Ta    compat
   .It Sx \&EX  Ta    0         Ta    current   Ta    compat
 .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 \&OP  Ta    0, 1      Ta    current   Ta    compat
   .It Sx \&PD  Ta    1         Ta    current   Ta    \&
 .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 727  The syntax is as follows:
Line 787  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 \&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
Line 787  implicitly closed, is syntactically incorrect.
Line 846  implicitly closed, is syntactically incorrect.
 .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&  .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
 .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&  .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
 .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&  .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&
   .It Sx \&UE  Ta    0         Ta    current    Ta    none        Ta    compat
   .It Sx \&UR  Ta    1         Ta    current    Ta    part        Ta    compat
 .El  .El
 .Pp  .Pp
 Macros marked  Macros marked
Line 913  utility written by Kristaps Dzonsons appeared in
Line 974  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.116  
changed lines
  Added in v.1.126
CVSweb