[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.128

version 1.119, 2013/07/13 19:41:16 version 1.128, 2014/12/28 15:23:33
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, 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 280  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 595  The scope of a sub-section is closed by a subsequent s
Line 607  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 630  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 653  and
Line 671  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 664  See also
Line 697  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 749  The syntax is as follows:
Line 777  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 762  The syntax is as follows:
Line 793  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 822  implicitly closed, is syntactically incorrect.
Line 852  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 847  Note that macros like
Line 879  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  .Sh COMPATIBILITY
 This section documents areas of questionable portability between  This section mentions some areas of questionable portability between
 implementations of the  implementations of the
 .Nm  .Nm
 language.  language.
   More incompatibilities exist.
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
Line 862  to close out a literal context opened with
Line 895  to close out a literal context opened with
 .Sx \&nf .  .Sx \&nf .
 This behaviour may not be portable.  This behaviour may not be portable.
 .It  .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  troff suppresses a newline before
 .Sq \(aq  .Sq \(aq
 macro output; in mandoc, it is an alias for the standard  macro output; in mandoc, it is an alias for the standard
 .Sq \&.  .Sq \&.
 control character.  control character.
 .It  .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  In page header lines, GNU troff versions up to and including 1.21
 only print  only print
 .Ar volume  .Ar volume
Line 918  is given, like in
Line 916  is given, like in
 .El  .El
 .Pp  .Pp
 The  The
 .Sx OP  .Sx EE ,
 macro is part of the extended  .Sx EX ,
   .Sx OP ,
   .Sx UE ,
   and
   .Sx UR
   macros are part of the GNU extended
 .Nm  .Nm
 macro set, and may not be portable to non-GNU troff implementations.  macro set, and may not be portable to non-GNU troff implementations.
 .Sh SEE ALSO  .Sh SEE ALSO
Legend:
Removed from v.1.119  
changed lines
  Added in v.1.128
CVSweb