version 1.193, 2011/07/31 17:42:50 |
version 1.194, 2011/08/01 07:45:11 |
Line 178 trailing spaces are stripped from input (unless in a l |
|
Line 178 trailing spaces are stripped from input (unless in a l |
|
Blank text lines, which may include whitespace, are only permitted |
Blank text lines, which may include whitespace, are only permitted |
within literal contexts. |
within literal contexts. |
.Pp |
.Pp |
|
In general, trailing whitespace on input lines is discouraged |
|
for reasons of clarity and portability. |
|
In the rare case that a blank character is needed at the end of an |
|
input line, it may be forced by |
|
.Sq \e\ \e& . |
|
.Pp |
In macro lines, whitespace delimits arguments and is discarded. |
In macro lines, whitespace delimits arguments and is discarded. |
If arguments are quoted, whitespace within the quotes is retained. |
|
.Ss Quotation |
.Ss Quotation |
Macro arguments may be quoted with double-quotes to group |
Macro arguments may be quoted with double-quotes; in this case, |
space-delimited terms or to retain blocks of whitespace. |
whitespace within the quotes is retained as part of the argument. |
|
For example, |
|
.Pp |
|
.D1 Pf \. \&Fn strlen "\(dqconst char *s\(dq" |
|
.Pp |
|
renders as |
|
.Sq Fn strlen "const char *s" , |
|
while |
|
.Pp |
|
.D1 Pf \. \&Fn strlen "const char *s" |
|
.Pp |
|
would produce |
|
.Sq Fn strlen const char *s . |
|
.Pp |
A quoted argument begins with a double-quote preceded by whitespace. |
A quoted argument begins with a double-quote preceded by whitespace. |
The next double-quote not pairwise adjacent to another double-quote |
The next double-quote not pairwise adjacent to another double-quote |
terminates the literal, regardless of surrounding whitespace. |
terminates the literal, regardless of surrounding whitespace. |
.Pp |
.Pp |
|
In unquoted arguments, space characters can alternatively be included |
|
by preceding them with a backslash |
|
.Pq Sq \e\~ , |
|
but quoting is usually better for clarity. |
|
.Pp |
Note that any quoted text, even if it would cause a macro invocation |
Note that any quoted text, even if it would cause a macro invocation |
when unquoted, is considered literal text. |
when unquoted, is considered literal text. |
Thus, the following produces |
Thus, the following produces |
Line 304 file for a utility |
|
Line 327 file for a utility |
|
\&.Os |
\&.Os |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm progname |
\&.Nm progname |
\&.Nd a description goes here |
\&.Nd one line about what it does |
\&.\e\*q .Sh LIBRARY |
\&.\e\*q .Sh LIBRARY |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q Not used in OpenBSD. |
\&.\e\*q Not used in OpenBSD. |
|
|
.Em Callable |
.Em Callable |
column indicates that the macro may also be called by passing its name |
column indicates that the macro may also be called by passing its name |
as an argument to another macro. |
as an argument to another macro. |
|
For example, |
|
.Sq \&.Op \&Fl O \&Ar file |
|
produces |
|
.Sq Op Fl O Ar file . |
|
To prevent a macro call and render the macro name literally, |
|
escape it by prepending a non-breaking space, |
|
.Sq \e& . |
|
For example, |
|
.Sq \&Op \e&Fl O |
|
produces |
|
.Sq Op \&Fl O . |
If a macro is not callable but its name appears as an argument |
If a macro is not callable but its name appears as an argument |
to another macro, it is interpreted as opaque text. |
to another macro, it is interpreted as opaque text. |
For example, |
For example, |