version 1.99, 2011/03/07 01:35:51 |
version 1.102, 2011/07/08 09:35:06 |
Line 205 appears as the first macro. |
|
Line 205 appears as the first macro. |
|
Beyond |
Beyond |
.Sx \&TH , |
.Sx \&TH , |
at least one macro or text node must appear in the document. |
at least one macro or text node must appear in the document. |
Documents are generally structured as follows: |
.Pp |
|
The following is a well-formed skeleton |
|
.Nm |
|
file for a utility |
|
.Qq progname : |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 2009-10-10 |
\&.TH PROGNAME 1 2009-10-10 |
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBprogname\efR \e(en a description goes here |
\&.\e\*q .SH LIBRARY |
\&.\e\*q .SH LIBRARY |
\&.\e\*q For sections 2 & 3 only. |
\&.\e\*q For sections 2 & 3 only. |
\&.\e\*q Not used in OpenBSD. |
\&.\e\*q Not used in OpenBSD. |
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBprogname\efR [\efB\e-options\efR] arguments... |
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility processes files... |
The \efBfoo\efR utility processes files... |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q .SH IMPLEMENTATION NOTES |
|
|
.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 |
|
.Sx \&RS |
|
invocation. |
.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. |
|
|
and |
and |
.Sx \&IR . |
.Sx \&IR . |
.Ss \&RS |
.Ss \&RS |
Begin a part setting the left margin. |
Temporarily reset the default left margin. |
The left margin controls the offset, following an initial indentation, |
|
to un-indented text such as that of |
|
.Sx \&PP . |
|
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 Cm width |
.Ed |
.Ed |
.Pp |
.Pp |
|
|
argument must conform to |
argument must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&RE . |
.Ss \&SB |
.Ss \&SB |
Text is rendered in small size (one point smaller than the default font) |
Text is rendered in small size (one point smaller than the default font) |
bold face. |
bold face. |
Line 841 Begin literal mode: all subsequent free-form lines hav |
|
Line 848 Begin literal mode: all subsequent free-form lines hav |
|
line boundaries preserved. |
line boundaries preserved. |
May be ended by |
May be ended by |
.Sx \&fi . |
.Sx \&fi . |
|
Literal mode is implicitly ended by |
|
.Sx \&SH |
|
or |
|
.Sx \&SS . |
.Ss \&sp |
.Ss \&sp |
Insert vertical spaces into output with the following syntax: |
Insert vertical spaces into output with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |