version 1.123, 2014/02/14 17:35:05 |
version 1.125, 2014/03/17 06:57:48 |
Line 98 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 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 197 well-tested invocations. |
|
Line 197 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. |
|
|
.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 781 The syntax is as follows: |
|
Line 782 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 |