version 1.116, 2010/06/03 15:54:27 |
version 1.118, 2010/06/04 21:49:39 |
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 , |
|
|
and |
and |
.Sx \&Dl . |
.Sx \&Dl . |
.Ss \&Db |
.Ss \&Db |
|
Start a debugging context. |
|
This macro is parsed, but generally ignored. |
|
Its calling syntax is as follows: |
|
.Pp |
|
.D1 \. Ns Sx \&Db Cm on | off |
.Ss \&Dc |
.Ss \&Dc |
Closes a |
Closes a |
.Sx \&Do |
.Sx \&Do |
|
|
.Ss \&Ef |
.Ss \&Ef |
.Ss \&Ek |
.Ss \&Ek |
.Ss \&El |
.Ss \&El |
|
Ends a list context started by |
|
.Sx \&Bl . |
|
.Pp |
|
See also |
|
.Sx \&Bl |
|
and |
|
.Sx \&It . |
.Ss \&Em |
.Ss \&Em |
Denotes text that should be emphasised. |
Denotes text that should be emphasised. |
Note that this is a presentation term and should not be used for |
Note that this is a presentation term and should not be used for |
Line 1598 is not provided, the document's name as stipulated in |
|
Line 1610 is not provided, the document's name as stipulated in |
|
.Sx \&Nm |
.Sx \&Nm |
is provided. |
is provided. |
.Ss \&Fa |
.Ss \&Fa |
|
Function argument. |
|
This may be invoked for names with or without the corresponding type. |
|
It is also used to specify the field name of a structure. |
|
Most often, the |
|
.Sx \&Fa |
|
macro is used in the |
|
.Em SYNOPSIS |
|
section when documenting multi-line function prototypes. |
|
If invoked with multiple arguments, the arguments are separated by a |
|
comma. |
|
Furthermore, if the following macro is another |
|
.Sx \&Fa , |
|
the last argument will also have a trailing comma. |
|
.Pp |
|
Examples: |
|
.D1 \&.Fa \(dqconst char *p\(dq |
|
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
|
.D1 \&.Fa foo |
.Ss \&Fc |
.Ss \&Fc |
.Ss \&Fd |
.Ss \&Fd |
|
Historically used to document include files. |
|
This usage has been deprecated in favour of |
|
.Sx \&In . |
|
Do not use this macro. |
|
.Pp |
|
See also |
|
.Sx \&In . |
.Ss \&Fl |
.Ss \&Fl |
Command-line flag. |
Command-line flag. |
Used when listing arguments to command-line utilities. |
Used when listing arguments to command-line utilities. |
|
|
.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 1997 Heirloom troff, the other significant troff implementa |
|
Line 2047 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 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 |