version 1.117, 2010/06/04 20:57:26 |
version 1.119, 2010/06/04 22:16:27 |
Line 33 section describes compatibility with other troff \-mdo |
|
Line 33 section describes compatibility with other troff \-mdo |
|
.Pp |
.Pp |
An |
An |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
.Sq \. |
.Sq \. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. Other lines are interpreted within the scope of |
Line 122 escape followed by an indicator: B (bold), I, (italic) |
|
Line 122 escape followed by an indicator: B (bold), I, (italic) |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
respectively) may be used instead. |
respectively) may be used instead. |
A text decoration is valid within |
A text decoration is valid within |
the current font scope only: if a macro opens a font scope alongside |
the current font scope only: if a macro opens a font scope alongside |
its own scope, such as |
its own scope, such as |
.Sx \&Bf |
.Sx \&Bf |
.Cm \&Sy , |
.Cm \&Sy , |
|
|
See also |
See also |
.Sx \&Cm . |
.Sx \&Cm . |
.Ss \&Fn |
.Ss \&Fn |
|
A function name. |
|
Its calling syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Ns Sx \&Fn |
|
.Op Cm functype |
|
.Cm funcname |
|
.Op Oo Cm argtype Oc Cm argname |
|
.Ed |
|
If invoked in the |
|
.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. |
|
If no arguments are specified, blank parenthesis are output. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fn "int funcname" "int arg0" "int arg1" |
|
.D1 \&.Fn funcname |
|
.D1 \&.Fn funcname "int arg0" |
|
.D1 \&.Fn funcname arg0 |
|
.Pp |
|
See also |
|
.Sx \&Fa , |
|
.Sx \&Fo , |
|
.Sx \&Fc , |
|
and |
|
.Sx \&Ft . |
.Ss \&Fo |
.Ss \&Fo |
.Ss \&Fr |
.Ss \&Fr |
.Ss \&Ft |
.Ss \&Ft |
|
|
.Ss \&Hf |
.Ss \&Hf |
.Ss \&Ic |
.Ss \&Ic |
.Ss \&In |
.Ss \&In |
|
An |
|
.Qq include |
|
file. |
|
In the |
|
.Em SYNOPSIS |
|
section (only if invoked as the line macro), the first argument is |
|
preceded by |
|
.Qq #include , |
|
the arguments is enclosed in angled braces, and a newline is asserted. |
|
In all other invocations, only angled braces will enclose the argument. |
|
.Pp |
|
Examples |
|
.D1 \&.In sys/types |
.Ss \&It |
.Ss \&It |
A list item. The syntax of this macro depends on the list type. |
A list item. The syntax of this macro depends on the list type. |
.Pp |
.Pp |
Line 2034 Heirloom troff, the other significant troff implementa |
|
Line 2074 Heirloom troff, the other significant troff implementa |
|
\-mdoc, is similar to historic groff. |
\-mdoc, is similar to historic groff. |
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
|
.It |
|
Historic groff does not break before an |
|
.Sx \&Fn |
|
when not invoked as the line macro in the |
|
.Em SYNOPSIS |
|
section. |
|
.It |
|
Historic groff formats the |
|
.Sx \&In |
|
badly: trailing arguments are trashed and |
|
.Em SYNOPSIS |
|
is not specially treated. |
.It |
.It |
groff does not accept the |
groff does not accept the |
.Sq \&Ta |
.Sq \&Ta |