version 1.121, 2010/06/06 22:25:56 |
version 1.122, 2010/06/07 11:01:15 |
Line 333 must be the NAME section, consisting of at least one |
|
Line 333 must be the NAME section, consisting of at least one |
|
followed by |
followed by |
.Sx \&Nd . |
.Sx \&Nd . |
.Pp |
.Pp |
Following that, convention dictates specifying at least the SYNOPSIS and |
Following that, convention dictates specifying at least the |
DESCRIPTION sections, although this varies between manual sections. |
.Em SYNOPSIS |
|
and |
|
.Em DESCRIPTION |
|
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 |
Line 450 And for the third, configurations (section 4): |
|
Line 453 And for the third, configurations (section 4): |
|
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 |
Some macros are displayed differently in the |
.Sx \&Op , |
.Em SYNOPSIS |
|
section, particularly |
|
.Sx \&Nm , |
.Sx \&Cd , |
.Sx \&Cd , |
|
.Sx \&Fd , |
.Sx \&Fn , |
.Sx \&Fn , |
.Sx \&Ft , |
.Sx \&Fo , |
|
.Sx \&In , |
|
.Sx \&Vt , |
and |
and |
.Sx \&Vt . |
.Sx \&Ft . |
|
All of these macros are output on their own line. If two such |
|
dissimilar macros are pair-wise invoked (except for |
|
.Sx \&Ft |
|
before |
|
.Sx \&Fo |
|
or |
|
.Sx \&Fn ) , |
|
they are separated by a vertical space, unless in the case of |
|
.Sx \&Fo , |
|
.Sx \&Fn , |
|
and |
|
.Sx \&Ft , |
|
which are always separated by vertical space. |
.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 . |
Line 1656 This usage has been deprecated in favour of |
|
Line 1677 This usage has been deprecated in favour of |
|
Do not use this macro. |
Do not use this macro. |
.Pp |
.Pp |
See also |
See also |
|
.Sx MANUAL STRUCTURE |
|
and |
.Sx \&In . |
.Sx \&In . |
.Ss \&Fl |
.Ss \&Fl |
Command-line flag. |
Command-line flag. |
Line 1685 Its syntax is as follows: |
|
Line 1708 Its syntax is as follows: |
|
.Op Oo Cm argtype Oc Cm argname |
.Op Oo Cm argtype Oc Cm argname |
.Ed |
.Ed |
.Pp |
.Pp |
If invoked in the |
Function arguments are surrounded in parenthesis and |
.Em SYNOPSIS |
|
section, vertical space is asserted before and after the macro. |
|
In all cases, the function arguments are surrounded in parenthesis and |
|
are delimited by commas. |
are delimited by commas. |
If no arguments are specified, blank parenthesis are output. |
If no arguments are specified, blank parenthesis are output. |
.Pp |
.Pp |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fa , |
.Sx MANUAL STRUCTURE |
.Sx \&Fo , |
|
.Sx \&Fc , |
|
and |
and |
.Sx \&Ft . |
.Sx \&Ft . |
.Ss \&Fo |
.Ss \&Fo |
Line 1728 Invocations usually occur in the following context: |
|
Line 1746 Invocations usually occur in the following context: |
|
.Pf \. Sx \&Fc |
.Pf \. Sx \&Fc |
.Ed |
.Ed |
.Pp |
.Pp |
In the |
|
.Em SYNOPSIS |
|
section, a |
|
.Sx \&Fo |
|
block is surrounded by vertical space unless |
|
.Sx \&Ft |
|
is the prior macro, in which case it is preceded by only a newline. |
|
.Pp |
|
A |
A |
.Sx \&Fo |
.Sx \&Fo |
scope is closed by |
scope is closed by |
.Pp |
.Pp |
See also |
See also |
|
.Sx MANUAL STRUCTURE , |
.Sx \&Fa , |
.Sx \&Fa , |
.Sx \&Fc , |
.Sx \&Fc , |
and |
and |
.Sx \&Fn . |
|
.Sx \&Fc . |
|
.Ss \&Fr |
|
.Ss \&Ft |
.Ss \&Ft |
A function type. |
A function type. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Ft Cm functype |
.D1 Pf \. Sx \&Ft Cm functype |
.Pp |
.Pp |
If invoked before a |
|
.Sx \&Fo |
|
or |
|
.Sx \&Fn |
|
in the |
|
.Em SYNOPSIS |
|
section, a line-break will follow. |
|
Furthermore, if invoked in the |
|
.Em SYNOPSIS |
|
section, it will assert vertical space prior to its arguments. |
|
.Pp |
|
Examples: |
Examples: |
.D1 \&.Ft int |
.D1 \&.Ft int |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fo , |
.Sx MANUAL STRUCTURE , |
.Sx \&Fc , |
.Sx \&Fn , |
and |
and |
.Sx \&Fn . |
.Sx \&Fo . |
.Ss \&Fx |
.Ss \&Fx |
Format the FreeBSD version provided as an argument, or a default value |
Format the FreeBSD version provided as an argument, or a default value |
if no argument is provided. |
if no argument is provided. |
|
|
section (only if invoked as the line macro), the first argument is |
section (only if invoked as the line macro), the first argument is |
preceded by |
preceded by |
.Qq #include , |
.Qq #include , |
the arguments is enclosed in angled braces, and a newline is asserted. |
the arguments is enclosed in angled braces. |
In all other invocations, only angled braces will enclose the argument. |
|
.Pp |
.Pp |
Examples |
Examples: |
.D1 \&.In sys/types |
.D1 \&.In sys/types |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE . |
.Ss \&It |
.Ss \&It |
A list item. |
A list item. |
The syntax of this macro depends on the list type. |
The syntax of this macro depends on the list type. |
|
|
.Ss \&Va |
.Ss \&Va |
.Ss \&Vt |
.Ss \&Vt |
A variable type. |
A variable type. |
This is also used for indicating global variables in the SYNOPSIS |
This is also used for indicating global variables in the |
|
.Em SYNOPSIS |
section, in which case a variable name is also specified. |
section, in which case a variable name is also specified. |
Note that it accepts |
Note that it accepts |
.Sx Block partial-implicit |
.Sx Block partial-implicit |
syntax when invoked as the first macro in the SYNOPSIS section, else it |
syntax when invoked as the first macro in the |
accepts ordinary |
.Em SYNOPSIS |
|
section, else it accepts ordinary |
.Sx In-line |
.Sx In-line |
syntax. |
syntax. |
.Pp |
.Pp |
|
|
.D1 \&.Vt extern const char * const sys_signame[] \&; |
.D1 \&.Vt extern const char * const sys_signame[] \&; |
.Pp |
.Pp |
See also |
See also |
.Sx \&Ft |
.Sx MANUAL STRUCTURE |
and |
and |
.Sx \&Va . |
.Sx \&Va . |
.Ss \&Xc |
.Ss \&Xc |