version 1.226, 2014/01/24 22:54:33 |
version 1.227, 2014/02/16 14:26:55 |
Line 125 file for a utility |
|
Line 125 file for a utility |
|
\&.Nm progname |
\&.Nm progname |
\&.Nd one line about what it does |
\&.Nd one line about what it does |
\&.\e\(dq .Sh LIBRARY |
\&.\e\(dq .Sh LIBRARY |
\&.\e\(dq For sections 2, 3, & 9 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 |
\&.Nm progname |
\&.Nm progname |
Line 138 utility processes files ... |
|
Line 138 utility processes files ... |
|
\&.\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 .Xr foobar 1 |
\&.\e\(dq .Xr foobar 1 |
\&.\e\(dq .Sh STANDARDS |
\&.\e\(dq .Sh STANDARDS |
|
|
This often contains snippets of well-formed, well-tested invocations. |
This often contains snippets of well-formed, 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 messages. |
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 |
|
|
.Sx \&Bl |
.Sx \&Bl |
.Fl diag . |
.Fl diag . |
.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. |
.Pp |
.Pp |
See |
See |
.Sx \&Er . |
.Sx \&Er . |