version 1.32, 2009/08/20 12:08:40 |
version 1.37, 2009/09/05 10:37:09 |
Line 139 are generally structured as follows: |
|
Line 139 are generally structured as follows: |
|
\&. |
\&. |
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBfoo\efR \e(en a description goes here |
|
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .SH LIBRARY |
\&. |
\&. |
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\&. |
\&. |
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility does... |
The \efBfoo\efR utility processes files... |
\&. |
\&. |
|
\&.\e\*q .SH IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH FILES |
\&.\e\*q .SH FILES |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q .SH EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\*q .SH DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q \efBbar\efR(1) |
\&.\e\*q \efBbar\efR(1) |
Line 159 The \efBfoo\efR utility does... |
|
Line 168 The \efBfoo\efR utility does... |
|
\&.\e\*q .SH AUTHORS |
\&.\e\*q .SH AUTHORS |
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH BUGS |
\&.\e\*q .SH BUGS |
|
\&.\e\*q .SH SECURITY CONSIDERATIONS |
.Ed |
.Ed |
. |
. |
. |
. |
|
|
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.I foo . |
.Sq \&.I foo . |
.\" PARAGRAPH |
If next-line macros are invoked consecutively, only the last is used. |
Consecutive next-line scope invocations are disallowed. |
If a next-line macro is proceded by a block macro, it is ignored. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
.Ed |
.Ed |
. |
. |
.Pp |
.Pp |
It is considered an error when next-line scope is open at the end of |
|
file. |
|
. |
|
.Pp |
|
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.It Em Macro Ta Em Arguments Ta Em Scope |
.It Em Macro Ta Em Arguments Ta Em Scope |
.It B Ta n Ta next-line |
.It B Ta n Ta next-line |
|
|
.It SB Ta n Ta next-line |
.It SB Ta n Ta next-line |
.It SM Ta n Ta next-line |
.It SM Ta n Ta next-line |
.It TH Ta >1, <6 Ta current |
.It TH Ta >1, <6 Ta current |
|
.It UC Ta n Ta current |
.It br Ta 0 Ta current |
.It br Ta 0 Ta current |
.It fi Ta 0 Ta current |
.It fi Ta 0 Ta current |
.It i Ta n Ta current |
.It i Ta n Ta current |
|
|
The |
The |
.Sq RS , |
.Sq RS , |
.Sq RE , |
.Sq RE , |
|
.Sq UC , |
.Sq br , |
.Sq br , |
.Sq fi , |
.Sq fi , |
.Sq i , |
.Sq i , |
|
|
.Sq r , |
.Sq r , |
and |
and |
.Sq sp |
.Sq sp |
macros aren't historically part of |
macros should not be used. They're included for compatibility. |
.Nm |
|
and should not be used. They're included for compatibility. |
|
. |
. |
. |
. |
.Ss Block Macros |
.Ss Block Macros |
|
|
No closure refers to an explicit block closing macro. |
No closure refers to an explicit block closing macro. |
. |
. |
.Pp |
.Pp |
It is considered an error when part or next-line scope is open at the |
|
end of file. |
|
. |
|
.Pp |
|
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.It HP Ta <2 Ta current Ta paragraph |
.It HP Ta <2 Ta current Ta paragraph |
|
|
.It PP Ta 0 Ta current Ta paragraph |
.It PP Ta 0 Ta current Ta paragraph |
.It RE Ta 0 Ta current Ta none |
.It RE Ta 0 Ta current Ta none |
.It RS Ta 1 Ta current Ta part |
.It RS Ta 1 Ta current Ta part |
.It SH Ta >0 Ta current Ta section |
.It SH Ta >0 Ta next-line Ta section |
.It SS Ta >0 Ta current Ta sub-section |
.It SS Ta >0 Ta next-line Ta sub-section |
.It TP Ta n Ta next-line Ta paragraph |
.It TP Ta n Ta next-line Ta paragraph |
.El |
.El |
. |
. |
Line 301 If a block macro is next-line scoped, it may only be f |
|
Line 303 If a block macro is next-line scoped, it may only be f |
|
macros (excluding |
macros (excluding |
.Sq DT , |
.Sq DT , |
.Sq TH , |
.Sq TH , |
|
.Sq UC , |
.Sq br , |
.Sq br , |
.Sq na , |
.Sq na , |
.Sq sp , |
.Sq sp , |
Line 355 render in italics. Whitespace between arguments is om |
|
Line 358 render in italics. Whitespace between arguments is om |
|
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.It DT |
.It DT |
Re-set the tab spacing to 0.5 inches. |
Has no effect. Included for compatibility. |
.It HP |
.It HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented, with the following syntax: |
subsequent output lines are indented, with the following syntax: |
Line 473 must be a properly-formed numeric width. If |
|
Line 476 must be a properly-formed numeric width. If |
|
.Va width |
.Va width |
is specified, it's saved for later paragraph left-margins; if |
is specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
|
.It UC |
|
Has no effect. Included for compatibility. |
.It br |
.It br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
.It fi |
.It fi |
Line 482 End literal mode begun by |
|
Line 487 End literal mode begun by |
|
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. If no arguments are specified, all subsequent text |
is italicised. |
is italicised. |
.It na |
.It na |
Don't alignment the right margin. |
Don't align to the right margin. |
.It nf |
.It nf |
Begin literal mode: all subsequent free-form lines have their end of |
Begin literal mode: all subsequent free-form lines have their end of |
line boundaries preserved. May be ended by |
line boundaries preserved. May be ended by |