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

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

version 1.119, 2013/07/13 19:41:16 version 1.136, 2017/06/25 11:42:02
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, 2012 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2011-2015 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 254  in the alphabetical reference below.
Line 266  in the alphabetical reference below.
 .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 PD Ta set vertical paragraph distance: Op Ar height
 .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 fi , nf Ta fill mode and no-fill mode (no arguments)  .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
 .It Sx in Ta additional indent: Op Ar width  .It Sx in Ta additional indent: Op Ar width
 .El  .El
Line 280  For the scoping of individual macros, see
Line 290  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 338  See also
Line 348  See also
 and  and
 .Sx \&IR .  .Sx \&IR .
 .Ss \&DT  .Ss \&DT
 Has no effect.  Restore the default tabulator positions.
 Included for compatibility.  They are at intervals of 0.5 inches.
   This has no effect unless the tabulator positions were changed with the
   .Xr roff 7
   .Ic \&ta
   request.
 .Ss \&EE  .Ss \&EE
 This is a non-standard GNU extension, included only for compatibility.  This is a non-standard GNU extension, included only for compatibility.
 In  In
Line 357  Begin a paragraph whose initial output line is left-ju
Line 371  Begin a paragraph whose initial output line is left-ju
 subsequent output lines are indented, with the following syntax:  subsequent output lines are indented, with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&HP  .Pf \. Sx \&HP
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 401  and
Line 415  and
 Begin an indented paragraph with the following syntax:  Begin an indented paragraph with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&IP  .Pf \. Sx \&IP
 .Op Cm head Op Cm width  .Op Ar head Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width defining the left margin.  scaling width defining the left margin.
Line 413  It's saved for later paragraph left-margins; if unspec
Line 427  It's saved for later paragraph left-margins; if unspec
 default width is used.  default width is used.
 .Pp  .Pp
 The  The
 .Cm head  .Ar head
 argument is used as a leading term, flushed to the left margin.  argument is used as a leading term, flushed to the left margin.
 This is useful for bulleted paragraphs and so on.  This is useful for bulleted paragraphs and so on.
 .Pp  .Pp
Line 452  See also
Line 466  See also
 .Sx \&PP ,  .Sx \&PP ,
 and  and
 .Sx \&TP .  .Sx \&TP .
   .Ss \&ME
   End a mailto block.
   This is a non-standard GNU extension, included only for compatibility.
   See
   .Sx \&MT .
   .Ss \&MT
   Begin a mailto block.
   This is a non-standard GNU extension, included only for compatibility.
   It has the following syntax:
   .Bd -literal -offset indent
   .Pf \. Sx \&MT Ar address
   link description to be shown
   .Pf \. Sx ME
   .Ed
 .Ss \&OP  .Ss \&OP
 Optional command-line argument.  Optional command-line argument.
 This is a non-standard GNU extension, included only for compatibility.  This is a non-standard GNU extension, included only for compatibility.
 It has the following syntax:  It has the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&OP  .Pf \. Sx \&OP
 .Cm key Op Cm value  .Ar key Op Ar value
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm key  .Ar key
 is usually a command-line flag and  is usually a command-line flag and
 .Cm value  .Ar value
 its argument.  its argument.
 .Ss \&P  .Ss \&P
 Synonym for  Synonym for
Line 483  Specify the vertical space to be inserted before each 
Line 511  Specify the vertical space to be inserted before each 
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&PD  .Pf \. Sx \&PD
 .Op Cm height  .Op Ar height
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm height  .Ar height
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 543  and
Line 571  and
 .Ss \&RE  .Ss \&RE
 Explicitly close out the scope of a prior  Explicitly close out the scope of a prior
 .Sx \&RS .  .Sx \&RS .
 The default left margin is restored to the state of the original  The default left margin is restored to the state before that
 .Sx \&RS  .Sx \&RS
 invocation.  invocation.
   .Pp
   The syntax is as follows:
   .Bd -filled -offset indent
   .Pf \. Sx \&RE
   .Op Ar level
   .Ed
   .Pp
   Without an argument, the most recent
   .Sx \&RS
   block is closed out.
   If
   .Ar level
   is 1, all open
   .Sx \&RS
   blocks are closed out.
   Otherwise,
   .Ar level No \(mi 1
   nested
   .Sx \&RS
   blocks remain open.
 .Ss \&RI  .Ss \&RI
 Text is rendered alternately in roman (the default font) and italics.  Text is rendered alternately in roman (the default font) and italics.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
Line 566  Temporarily reset the default left margin.
Line 614  Temporarily reset the default left margin.
 This has the following syntax:  This has the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&RS  .Pf \. Sx \&RS
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 595  The scope of a sub-section is closed by a subsequent s
Line 643  The scope of a sub-section is closed by a subsequent s
 section, or end of file.  section, or end of file.
 The paragraph left-margin width is reset to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&TH  .Ss \&TH
 Sets the title of the manual page with the following syntax:  Sets the title of the manual page for use in the page header
   and footer with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&TH  .Pf \. Sx \&TH
 .Ar title section date  .Ar title section date
Line 617  is empty or not specified, the current date is used.
Line 666  is empty or not specified, the current date is used.
 The optional  The optional
 .Ar source  .Ar source
 string specifies the organisation providing the utility.  string specifies the organisation providing the utility.
   When unspecified,
   .Xr mandoc 1
   uses its
   .Fl Ios
   argument.
 The  The
 .Ar volume  .Ar volume
 string replaces the default rendered volume, which is dictated by the  string replaces the default rendered volume, which is dictated by the
Line 633  Subsequent output lines are indented.
Line 687  Subsequent output lines are indented.
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&TP  .Pf \. Sx \&TP
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 653  and
Line 707  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 \&br  .Ss \&UE
 Breaks the current line.  End a uniform resource identifier block.
 Consecutive invocations have no further effect.  This is a non-standard GNU extension, included only for compatibility.
 .Pp  See
 See also  .Sx \&UE .
 .Sx \&sp .  .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 \&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
 .D1 Pf \. Sx \&in Op Cm width  .D1 Pf \. Sx \&in Op Ar width
 .Pp  .Pp
 If  If
 .Cm width  .Ar width
 is signed, the new offset is relative.  is signed, the new offset is relative.
 Otherwise, it is absolute.  Otherwise, it is absolute.
 This value is reset upon the next paragraph, section, or sub-section.  This value is reset upon the next paragraph, section, or sub-section.
 .Ss \&na  
 Don't align to the right margin.  
 .Ss \&nf  .Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of  Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.  line boundaries preserved.
Line 690  Literal mode is implicitly ended by
Line 746  Literal mode is implicitly ended by
 .Sx \&SH  .Sx \&SH
 or  or
 .Sx \&SS .  .Sx \&SS .
 .Ss \&sp  
 Insert vertical spaces into output with the following syntax:  
 .Bd -filled -offset indent  
 .Pf \. Sx \&sp  
 .Op Cm height  
 .Ed  
 .Pp  
 The  
 .Cm height  
 argument is a scaling width as described in  
 .Xr roff 7 .  
 If 0, this is equivalent to the  
 .Sx \&br  
 macro.  
 Defaults to 1, if unspecified.  
 .Pp  
 See also  
 .Sx \&br .  
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 The  The
 .Nm  .Nm
Line 731  is equivalent to
Line 769  is equivalent to
 .Sq \&.I foo .  .Sq \&.I foo .
 If next-line macros are invoked consecutively, only the last is used.  If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is  If a next-line macro is followed by a non-next-line macro, an error is
 raised, except for  raised.
 .Sx \&br ,  
 .Sx \&sp ,  
 and  
 .Sx \&na .  
 .Pp  .Pp
 The syntax is as follows:  The syntax is as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 749  The syntax is as follows:
Line 783  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 760  The syntax is as follows:
Line 797  The syntax is as follows:
 .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    <=1       Ta    current   Ta    \&  .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .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 \&nf  Ta    0         Ta    current   Ta    compat  .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat  
 .El  .El
 .Pp  .Pp
 Macros marked as  Macros marked as
Line 822  implicitly closed, is syntactically incorrect.
Line 855  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 846  until the end of the macro scope.
Line 881  until the end of the macro scope.
 Note that macros like  Note that macros like
 .Sx \&BR  .Sx \&BR
 open and close a font scope for each argument.  open and close a font scope for each argument.
 .Sh COMPATIBILITY  
 This section documents areas of questionable portability between  
 implementations of the  
 .Nm  
 language.  
 .Pp  
 .Bl -dash -compact  
 .It  
 Do not depend on  
 .Sx \&SH  
 or  
 .Sx \&SS  
 to close out a literal context opened with  
 .Sx \&nf .  
 This behaviour may not be portable.  
 .It  
 In quoted literals, GNU troff allowed pair-wise double-quotes to produce  
 a standalone double-quote in formatted output.  
 It is not known whether this behaviour is exhibited by other formatters.  
 .It  
 troff suppresses a newline before  
 .Sq \(aq  
 macro output; in mandoc, it is an alias for the standard  
 .Sq \&.  
 control character.  
 .It  
 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  
 macro does not accept negative values in mandoc.  
 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  
 .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 ,
Legend:
Removed from v.1.119  
changed lines
  Added in v.1.136
CVSweb