version 1.81, 2010/01/01 16:52:00 |
version 1.82, 2010/01/07 19:10:10 |
|
|
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(revert to previous mode): |
(revert to previous mode): |
.Pp |
.Pp |
.D1 \efBbold\efR \efIitalic\efP |
.D1 \efBbold\efR \efIitalic\efP |
.Pp |
.Pp |
Line 170 for arbitrary-digit numerals: |
|
Line 170 for arbitrary-digit numerals: |
|
.D1 \es+(10much bigger\es-(10 |
.D1 \es+(10much bigger\es-(10 |
.D1 \es+'100'much much bigger\es-'100' |
.D1 \es+'100'much much bigger\es-'100' |
.Pp |
.Pp |
Note these forms are |
Note these forms are |
.Em not |
.Em not |
recommended for |
recommended for |
.Nm , |
.Nm , |
which encourages semantic annotation. |
which encourages semantic annotation. |
. |
. |
. |
. |
.Ss Predefined Strings |
.Ss Predefined Strings |
Historically, |
Historically, |
.Xr groff 1 |
.Xr groff 1 |
also defined a set of package-specific |
also defined a set of package-specific |
.Dq predefined strings , |
.Dq predefined strings , |
which, like |
which, like |
.Sx Special Characters , |
.Sx Special Characters , |
demark special output characters and strings by way of input codes. |
demark special output characters and strings by way of input codes. |
Predefined strings are escaped with the slash-asterisk, |
Predefined strings are escaped with the slash-asterisk, |
|
|
.Sx \&Os |
.Sx \&Os |
macros, is required for every document. |
macros, is required for every document. |
.Pp |
.Pp |
The first section (sections are denoted by |
The first section (sections are denoted by |
.Sx \&Sh ) |
.Sx \&Sh ) |
must be the NAME section, consisting of at least one |
must be the NAME section, consisting of at least one |
.Sx \&Nm |
.Sx \&Nm |
Line 420 macro(s) must precede the |
|
Line 420 macro(s) must precede the |
|
.Sx \&Nd |
.Sx \&Nd |
macro. |
macro. |
.Pp |
.Pp |
See |
See |
.Sx \&Nm |
.Sx \&Nm |
and |
and |
.Sx \&Nd . |
.Sx \&Nd . |
|
|
. |
. |
.It Em SYNOPSIS |
.It Em SYNOPSIS |
Documents the utility invocation syntax, function call syntax, or device |
Documents the utility invocation syntax, function call syntax, or device |
configuration. |
configuration. |
.Pp |
.Pp |
For the first, utilities (sections 1, 6, and 8), this is |
For the first, utilities (sections 1, 6, and 8), this is |
generally structured as follows: |
generally structured as follows: |
Line 469 And for the third, configurations (section 4): |
|
Line 469 And for the third, configurations (section 4): |
|
\&.Cd \*qit* at isa? port 0x4e\*q |
\&.Cd \*qit* at isa? port 0x4e\*q |
.Ed |
.Ed |
.Pp |
.Pp |
Manuals not in these sections generally don't need a |
Manuals not in these sections generally don't need a |
.Em SYNOPSIS . |
.Em SYNOPSIS . |
.Pp |
.Pp |
See |
See |
.Sx \&Op , |
.Sx \&Op , |
.Sx \&Cd , |
.Sx \&Cd , |
.Sx \&Fn , |
.Sx \&Fn , |
|
|
.Sx \&Vt . |
.Sx \&Vt . |
. |
. |
.It Em DESCRIPTION |
.It Em DESCRIPTION |
This expands upon the brief, one-line description in |
This expands upon the brief, one-line description in |
.Em NAME . |
.Em NAME . |
It usually contains a break-down of the options (if documenting a |
It usually contains a break-down of the options (if documenting a |
command), such as: |
command), such as: |
Line 683 All macros have bodies; some |
|
Line 683 All macros have bodies; some |
|
don't have heads; only one |
don't have heads; only one |
.Po |
.Po |
.Sx \&It Fl column |
.Sx \&It Fl column |
.Pc |
.Pc |
has multiple heads. |
has multiple heads. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
Line 866 then the macro accepts an arbitrary number of argument |
|
Line 866 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
. |
. |
. |
. |
.Sh REFERENCE |
.Sh REFERENCE |
|
|
.Ed |
.Ed |
. |
. |
.Ss \&Aq |
.Ss \&Aq |
Encloses its arguments in angled brackets. |
Encloses its arguments in angled brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 1073 Note that these parameters do not begin with a hyphen. |
|
Line 1073 Note that these parameters do not begin with a hyphen. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.At |
\&.At |
\&.At V.1 |
\&.At V.1 |
.Ed |
.Ed |
.Pp |
.Pp |
|
|
.Sx \&Bq . |
.Sx \&Bq . |
. |
. |
.Ss \&Bq |
.Ss \&Bq |
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 1389 manual. Its calling syntax is as follows: |
|
Line 1389 manual. Its calling syntax is as follows: |
|
.Pp |
.Pp |
.D1 \. Ns Sx \&Dd Cm date |
.D1 \. Ns Sx \&Dd Cm date |
.Pp |
.Pp |
The |
The |
.Cm date |
.Cm date |
field may be either |
field may be either |
.Ar $\&Mdocdate$ , |
.Ar $\&Mdocdate$ , |
|
|
.Sx \&Dq . |
.Sx \&Dq . |
. |
. |
.Ss \&Dq |
.Ss \&Dq |
Encloses its arguments in double quotes. |
Encloses its arguments in double quotes. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
|
|
macro does not format its arguments when used in the FILES section under |
macro does not format its arguments when used in the FILES section under |
certain list types. This irregular behaviour has been discontinued. |
certain list types. This irregular behaviour has been discontinued. |
.It |
.It |
Historic |
Historic |
.Xr groff 1 |
.Xr groff 1 |
does not print a dash for empty |
does not print a dash for empty |
.Sx \&Fl |
.Sx \&Fl |
arguments. This behaviour has been discontinued. |
arguments. This behaviour has been discontinued. |
.It |
.It |