version 1.185, 2011/04/06 11:39:25 |
version 1.188, 2011/05/26 09:26:16 |
Line 97 Within a macro line, the following terms are reserved: |
|
Line 97 Within a macro line, the following terms are reserved: |
|
.Pq reserved-word vertical bar |
.Pq reserved-word vertical bar |
.El |
.El |
.Pp |
.Pp |
Use of reserved terms is described in |
|
.Sx MACRO SYNTAX . |
|
For general use in macro lines, these can be escaped with a non-breaking |
For general use in macro lines, these can be escaped with a non-breaking |
space |
space |
.Pq Sq \e& . |
.Pq Sq \e& . |
Line 298 sections, although this varies between manual sections |
|
Line 296 sections, although this varies between manual sections |
|
.Pp |
.Pp |
The following is a well-formed skeleton |
The following is a well-formed skeleton |
.Nm |
.Nm |
file: |
file for a utility |
|
.Qq progname : |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt PROGNAME section |
\&.Os |
\&.Os |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm foo |
\&.Nm progname |
\&.Nd a description goes here |
\&.Nd a description goes here |
\&.\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. |
\&.Sh SYNOPSIS |
\&.Sh SYNOPSIS |
\&.Nm foo |
\&.Nm progname |
\&.Op Fl options |
\&.Op Fl options |
\&.Ar |
\&.Ar |
\&.Sh DESCRIPTION |
\&.Sh DESCRIPTION |
|
|
and |
and |
.Sx \&Sy . |
.Sx \&Sy . |
.Ss \&Bk |
.Ss \&Bk |
Keep the output generated from each macro input line together |
For each macro, keep its output together on the same output line, |
on one single output line. |
until the end of the macro or the end of the input line is reached, |
|
whichever comes first. |
Line breaks in text lines are unaffected. |
Line breaks in text lines are unaffected. |
The syntax is as follows: |
The syntax is as follows: |
.Pp |
.Pp |