version 1.80, 2010/01/01 16:27:32 |
version 1.88, 2010/04/06 07:17:51 |
|
|
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 |
|
|
.It Sx \&Ql Ta Yes Ta Yes |
.It Sx \&Ql Ta Yes Ta Yes |
.It Sx \&Qq Ta Yes Ta Yes |
.It Sx \&Qq Ta Yes Ta Yes |
.It Sx \&Sq Ta Yes Ta Yes |
.It Sx \&Sq Ta Yes Ta Yes |
|
.It Sx \&Vt Ta Yes Ta Yes |
.El |
.El |
|
.Pp |
|
Note that the |
|
.Sx \&Vt |
|
macro is a |
|
.Sx Block partial-implicit |
|
only when invoked as the first macro |
|
in a SYNOPSIS section line, else it is |
|
.Sx In-line . |
. |
. |
. |
. |
.Ss In-line |
.Ss In-line |
Line 851 then the macro accepts an arbitrary number of argument |
|
Line 860 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ox Ta Yes Ta Yes Ta n |
.It Sx \&Ox Ta Yes Ta Yes Ta n |
.It Sx \&Pa Ta Yes Ta Yes Ta n |
.It Sx \&Pa Ta Yes Ta Yes Ta n |
.It Sx \&Pf Ta \&No Ta Yes Ta 1 |
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
Line 863 then the macro accepts an arbitrary number of argument |
|
Line 872 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Ux Ta Yes Ta Yes Ta n |
.It Sx \&Ux Ta Yes Ta Yes Ta n |
.It Sx \&Va Ta Yes Ta Yes Ta n |
.It Sx \&Va Ta Yes Ta Yes Ta n |
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&Xr Ta Yes Ta Yes Ta >0 |
.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 1082 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 1398 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 |
Line 1544 subsequent that. It, too, is optional. It must be on |
|
Line 1553 subsequent that. It, too, is optional. It must be on |
|
.Ar hppa64 , |
.Ar hppa64 , |
.Ar i386 , |
.Ar i386 , |
.Ar landisk , |
.Ar landisk , |
|
.Ar loongson , |
.Ar luna88k , |
.Ar luna88k , |
.Ar mac68k , |
.Ar mac68k , |
.Ar macppc , |
.Ar macppc , |
|
|
. |
. |
.Ss \&Va |
.Ss \&Va |
.Ss \&Vt |
.Ss \&Vt |
|
A variable type. This is also used for indicating global variables in the |
|
SYNOPSIS section, in which case a variable name is also specified. Note that |
|
it accepts |
|
.Sx Block partial-implicit |
|
syntax when invoked as the first macro in the SYNOPSIS section, else it |
|
accepts ordinary |
|
.Sx In-line |
|
syntax. |
|
.Pp |
|
Note that this should not be confused with |
|
.Sx \&Ft , |
|
which is used for function return types. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Vt unsigned char |
|
\&.Vt extern const char * const sys_signame[] ; |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Ft |
|
and |
|
.Sx \&Va . |
|
. |
.Ss \&Xc |
.Ss \&Xc |
|
Close a scope opened by |
|
.Sx \&Xo . |
|
. |
.Ss \&Xo |
.Ss \&Xo |
|
Open an extension scope. This macro originally existed to extend the |
|
9-argument limit of troff; since this limit has been lifted, the macro |
|
has been deprecated. |
|
. |
.Ss \&Xr |
.Ss \&Xr |
|
Link to another manual |
|
.Pq Qq cross-reference . |
|
Its calling syntax is |
|
.Pp |
|
.D1 \. Ns Sx \&Xr Cm name section |
|
.Pp |
|
The |
|
.Cm name |
|
and |
|
.Cm section |
|
are the name and section of the linked manual. If |
|
.Cm section |
|
is followed by non-punctuation, an |
|
.Sx \&Ns |
|
is inserted into the token stream. This behaviour is for compatibility |
|
with |
|
.Xr groff 1 . |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Xr mandoc 1 |
|
\&.Xr mandoc 1 ; |
|
\&.Xr mandoc 1 s behaviour |
|
.Ed |
|
. |
.Ss \&br |
.Ss \&br |
.Ss \&sp |
.Ss \&sp |
. |
. |
|
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
The comment syntax |
|
.Sq \e." |
|
is no longer accepted. |
|
.It |
In |
In |
.Xr groff 1 , |
.Xr groff 1 , |
the |
the |
|
|
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 |