version 1.132, 2010/07/06 10:55:50 |
version 1.136, 2010/07/19 09:19:22 |
Line 52 manuals must have |
|
Line 52 manuals must have |
|
line terminators. |
line terminators. |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e" , |
.Sq \e\*q , |
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e\*q , |
is also ignored. Macro lines with only a control character and optionally |
is also ignored. Macro lines with only a control character and optionally |
whitespace are stripped from input. |
whitespace are stripped from input. |
.Ss Reserved Characters |
.Ss Reserved Characters |
|
|
is specified outside of any font scope, such as in unenclosed, free-form |
is specified outside of any font scope, such as in unenclosed, free-form |
text, it will affect the remainder of the document. |
text, it will affect the remainder of the document. |
.Pp |
.Pp |
Text may also be sized with the |
Note this form is |
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Note these forms are |
|
.Em not |
.Em not |
recommended for |
recommended for |
.Nm , |
.Nm , |
|
|
and |
and |
.Sx \&Sy . |
.Sx \&Sy . |
.Ss \&Bk |
.Ss \&Bk |
Begins a keep block, containing a collection of macros or text |
Begins a collection of macros or text not breaking the line. |
to be kept together in the output. |
|
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Bk Fl words |
.D1 Pf \. Sx \&Bk Fl words |
.Pp |
.Pp |
Currently, the only argument implemented is |
|
.Fl words , |
|
requesting to keep together all words of the contained text |
|
on the same output line. |
|
Subsequent arguments are ignored. |
Subsequent arguments are ignored. |
|
The |
|
.Fl words |
|
argument is required. |
.Pp |
.Pp |
Examples: |
Each line within a keep block is kept intact, so the following example |
|
will not break within each |
|
.Sx \&Op |
|
macro line: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Bk \-words |
\&.Bk \-words |
\&.Op o Ar output_file |
\&.Op Fl f Ar flags |
|
\&.Op Fl o Ar output |
\&.Ek |
\&.Ek |
.Ed |
.Ed |
.Pp |
.Pp |
See also |
Be careful in using over-long lines within a keep block! |
.Sx \&Ek . |
Doing so will clobber the right margin. |
.Ss \&Bl |
.Ss \&Bl |
Begins a list composed of one or more list entries. |
Begins a list composed of one or more list entries. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
.Ss \&Sc |
.Ss \&Sc |
.Ss \&Sh |
.Ss \&Sh |
.Ss \&Sm |
.Ss \&Sm |
|
Switches the spacing mode for output generated from macros. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Sm Cm on | off |
|
.Pp |
|
By default, spacing is |
|
.Cm on . |
|
When switched |
|
.Cm off , |
|
no white space is inserted between macro arguments and between the |
|
output generated from adjacent macros, but free-form text lines |
|
still get normal spacing between words and sentences. |
.Ss \&So |
.Ss \&So |
.Ss \&Sq |
.Ss \&Sq |
.Ss \&Ss |
.Ss \&Ss |