=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.119 retrieving revision 1.126 diff -u -p -r1.119 -r1.126 --- mandoc/man.7 2013/07/13 19:41:16 1.119 +++ mandoc/man.7 2014/03/31 01:05:32 1.126 @@ -1,7 +1,8 @@ -.\" $Id: man.7,v 1.119 2013/07/13 19:41:16 schwarze Exp $ +.\" $Id: man.7,v 1.126 2014/03/31 01:05:32 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons -.\" Copyright (c) 2011, 2012 Ingo Schwarze +.\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze +.\" Copyright (c) 2010 Joerg Sonnenberger .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -15,7 +16,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: July 13 2013 $ +.Dd $Mdocdate: March 31 2014 $ .Dt MAN 7 .Os .Sh NAME @@ -97,30 +98,32 @@ file for a utility .Bd -literal -offset indent \&.TH PROGNAME 1 2009-10-10 \&.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 For sections 2 & 3 only. +\&.\e\(dq For sections 2, 3, and 9 only. \&.\e\(dq Not used in OpenBSD. \&.SH SYNOPSIS -\efBprogname\efR [\efB\e-options\efR] arguments... +\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR \&.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 Not used in OpenBSD. \&.\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 For sections 1, 6, 7, & 8 only. +\&.\e\(dq For sections 1, 6, 7, and 8 only. \&.\e\(dq .SH FILES \&.\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 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 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 .BR foo ( 1 ) +\&.\e\(dq .BR foobar ( 1 ) \&.\e\(dq .SH STANDARDS \&.\e\(dq .SH HISTORY \&.\e\(dq .SH AUTHORS @@ -170,6 +173,9 @@ This expands upon the brief, one-line description in .Em NAME . It usually contains a break-down of the options (if documenting a 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 Implementation-specific notes should be kept here. This is useful when implementing standard functions that may have side @@ -196,13 +202,19 @@ well-tested invocations. Make sure that examples work properly! .It Em DIAGNOSTICS 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 .Em EXIT STATUS for manuals in sections 1, 6, and 8; however, this practise is discouraged. .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 References other manuals with related topics. This section should exist for most manuals. @@ -280,7 +292,7 @@ For the scoping of individual macros, see .Sx MACRO SYNTAX . .Ss \&AT Sets the volume for the footer for compatibility with man pages from -.Tn AT&T UNIX +.At releases. The optional arguments specify which release it is from. .Ss \&B @@ -653,8 +665,23 @@ and .Sx \&PP . .Ss \&UC 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. +.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 Breaks the current line. Consecutive invocations have no further effect. @@ -664,11 +691,6 @@ See also .Ss \&fi End literal mode begun by .Sx \&nf . -.Ss \&ft -Change the current font mode. -See -.Sx Text Decoration -for a listing of available font modes. .Ss \&in Indent relative to the current indentation: .Pp @@ -749,10 +771,13 @@ The syntax is as follows: .It Sx \&BI Ta n Ta current Ta \& .It Sx \&BR Ta n 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 \&IB 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 \&PD Ta 1 Ta current Ta \& .It Sx \&R Ta n Ta next-line Ta \& .It Sx \&RB Ta n Ta current Ta \& .It Sx \&RI Ta n Ta current Ta \& @@ -762,7 +787,6 @@ The syntax is as follows: .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 \&ft 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 @@ -822,6 +846,8 @@ implicitly closed, is syntactically incorrect. .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 \&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 .Pp Macros marked