version 1.117, 2010/06/04 20:57:26 |
version 1.125, 2010/06/12 10:09:19 |
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 |
|
|
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e" , |
is also ignored. Macro lines with only a control charater and optionally |
is also ignored. Macro lines with only a control character and optionally |
whitespace are stripped from input. |
whitespace are stripped from input. |
.Ss Reserved Characters |
.Ss Reserved Characters |
Within a macro line, the following characters are reserved: |
Within a macro line, the following characters are reserved: |
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 , |
Line 167 also defined a set of package-specific |
|
Line 167 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. |
mark 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, |
.Sq \e* : |
.Sq \e* : |
single-character |
single-character |
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 . |
|
|
.Sx \&Aq . |
.Sx \&Aq . |
.Ss \&Ap |
.Ss \&Ap |
Inserts an apostrophe without any surrounding white-space. |
Inserts an apostrophe without any surrounding white-space. |
This is generally used as a grammatic device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
form of a function: |
form of a function: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Fn execve Ap d |
\&.Fn execve Ap d |
|
|
.Ss \&Db |
.Ss \&Db |
Start a debugging context. |
Start a debugging context. |
This macro is parsed, but generally ignored. |
This macro is parsed, but generally ignored. |
Its calling syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Db Cm on | off |
.D1 Pf \. Sx \&Db Cm on | off |
.Ss \&Dc |
.Ss \&Dc |
Closes a |
Closes a |
.Sx \&Do |
.Sx \&Do |
|
|
This is the mandatory first macro of any |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
Its calling syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Dd Cm date |
.D1 Pf \. Sx \&Dd Cm date |
.Pp |
.Pp |
The |
The |
.Cm date |
.Cm date |
Line 1407 Document title. |
|
Line 1428 Document title. |
|
This is the mandatory second macro of any |
This is the mandatory second macro of any |
.Nm |
.Nm |
file. |
file. |
Its calling syntax is as follows: |
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Dt |
|
.Oo |
|
.Cm title |
|
.Oo |
|
.Cm section |
|
.Op Cm volume | arch |
|
.Oc |
|
.Oc |
|
.Ed |
.Pp |
.Pp |
.D1 \. Ns Sx \&Dt Op Cm title Op Cm section Op Cm volume | arch |
|
.Pp |
|
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds -offset Ds |
.Bl -tag -width Ds -offset Ds |
.It Cm title |
.It Cm title |
Line 1611 is not provided, the document's name as stipulated in |
|
Line 1640 is not provided, the document's name as stipulated in |
|
is provided. |
is provided. |
.Ss \&Fa |
.Ss \&Fa |
Function argument. |
Function argument. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Fa |
|
.Op Cm argtype |
|
.Cm argname |
|
.Ed |
|
.Pp |
This may be invoked for names with or without the corresponding type. |
This may be invoked for names with or without the corresponding type. |
It is also used to specify the field name of a structure. |
It is also used to specify the field name of a structure. |
Most often, the |
Most often, the |
.Sx \&Fa |
.Sx \&Fa |
macro is used in the |
macro is used in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
|
within |
|
.Sx \&Fo |
section when documenting multi-line function prototypes. |
section when documenting multi-line function prototypes. |
If invoked with multiple arguments, the arguments are separated by a |
If invoked with multiple arguments, the arguments are separated by a |
comma. |
comma. |
|
|
.D1 \&.Fa \(dqconst char *p\(dq |
.D1 \&.Fa \(dqconst char *p\(dq |
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.D1 \&.Fa foo |
.D1 \&.Fa foo |
|
.Pp |
|
See also |
|
.Sx \&Fo . |
.Ss \&Fc |
.Ss \&Fc |
.Ss \&Fd |
.Ss \&Fd |
Historically used to document include files. |
Historically used to document include files. |
Line 1636 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. |
|
|
See also |
See also |
.Sx \&Cm . |
.Sx \&Cm . |
.Ss \&Fn |
.Ss \&Fn |
|
A function name. |
|
Its 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 |
|
.Pp |
|
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 "int arg0" |
|
.D1 \&.Fn funcname arg0 |
|
.Bd -literal -offset indent -compact |
|
\&.Ft functype |
|
\&.Fn funcname |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE |
|
and |
|
.Sx \&Ft . |
.Ss \&Fo |
.Ss \&Fo |
.Ss \&Fr |
Begin a function block. |
|
This is a multi-line version of |
|
.Sx \&Fn . |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Fo Cm funcname |
|
.Pp |
|
Invocations usually occur in the following context: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Ft Cm functype |
|
.br |
|
.Pf \. Sx \&Fo Cm funcname |
|
.br |
|
.Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname |
|
.br |
|
\.\.\. |
|
.br |
|
.Pf \. Sx \&Fc |
|
.Ed |
|
.Pp |
|
A |
|
.Sx \&Fo |
|
scope is closed by |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE , |
|
.Sx \&Fa , |
|
.Sx \&Fc , |
|
and |
.Ss \&Ft |
.Ss \&Ft |
|
A function type. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Ft Cm functype |
|
.Pp |
|
Examples: |
|
.D1 \&.Ft int |
|
.Bd -literal -offset indent -compact |
|
\&.Ft functype |
|
\&.Fn funcname |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE , |
|
.Sx \&Fn , |
|
and |
|
.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. |
|
|
.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. |
|
.Pp |
|
Examples: |
|
.D1 \&.In sys/types |
|
.Pp |
|
See also |
|
.Sx MANUAL STRUCTURE . |
.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 |
Lists |
Lists |
of type |
of type |
|
|
.Fl inset , |
.Fl inset , |
and |
and |
.Fl diag |
.Fl diag |
have the following calling syntax: |
have the following syntax: |
.Pp |
.Pp |
.D1 \. Ns Sx \&It Cm args |
.D1 Pf \. Sx \&It Cm args |
.Pp |
.Pp |
Lists of type |
Lists of type |
.Fl bullet , |
.Fl bullet , |
|
|
.Fl hyphen |
.Fl hyphen |
and |
and |
.Fl item |
.Fl item |
have the following calling syntax: |
have the following syntax: |
.Pp |
.Pp |
.D1 \. Ns Sx \&It |
.D1 Pf \. Sx \&It |
.Pp |
.Pp |
with subsequent lines interpreted within the scope of the |
with subsequent lines interpreted within the scope of the |
.Sx \&It |
.Sx \&It |
|
|
.Pp |
.Pp |
The |
The |
.Fl tag |
.Fl tag |
list has syntax |
list has the following syntax: |
.Pp |
.Pp |
.D1 \. Ns Sx \&It Op Cm args |
.D1 Pf \. Sx \&It Op Cm args |
.Pp |
.Pp |
with subsequent lines interpreted as with |
Subsequent lines are interpreted as with |
.Fl bullet |
.Fl bullet |
and family. |
and family. |
The line arguments correspond to the list's left-hand side; body |
The line arguments correspond to the list's left-hand side; body |
Line 1726 arguments correspond to the list's contents. |
|
Line 1856 arguments correspond to the list's contents. |
|
The |
The |
.Fl column |
.Fl column |
list is the most complicated. |
list is the most complicated. |
Its syntax is |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&It Op Cm args |
.D1 Pf \. Sx \&It Op Cm args |
.Pp |
.Pp |
where |
The |
.Cm args |
.Cm args |
are phrases, a mix of macros and text corresponding to a line column, |
are phrases, a mix of macros and text corresponding to a line column, |
delimited by tabs or the special |
delimited by tabs or the special |
|
|
Subsequent this, only the |
Subsequent this, only the |
.Sq \&Ta |
.Sq \&Ta |
pseudo-macro may be used to delimit phrases. |
pseudo-macro may be used to delimit phrases. |
Furthermore, note that quoted sections propogate over tab-delimited |
Furthermore, note that quoted sections propagate over tab-delimited |
phrases on an |
phrases on an |
.Sx \&It , |
.Sx \&It , |
for example, |
for example, |
.Pp |
.Pp |
.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq ; |
.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
.Pp |
.Pp |
will preserve the semicolon whitespace except for the last. |
will preserve the semicolon whitespace except for the last. |
.Pp |
.Pp |
|
|
.Sx \&Bl . |
.Sx \&Bl . |
.Ss \&Lb |
.Ss \&Lb |
Specify a library. |
Specify a library. |
The calling syntax is as follows: |
The syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Lb Cm library |
.D1 Pf \. Sx \&Lb Cm library |
.Pp |
.Pp |
The |
The |
.Cm library |
.Cm library |
|
|
.Ss \&Li |
.Ss \&Li |
.Ss \&Lk |
.Ss \&Lk |
Format a hyperlink. |
Format a hyperlink. |
The calling syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Lk Cm uri Op Cm name |
.D1 Pf \. Sx \&Lk Cm uri Op Cm name |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
|
|
Format a |
Format a |
.Qq mailto: |
.Qq mailto: |
hyperlink. |
hyperlink. |
The calling syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Mt Cm address |
.D1 Pf \. Sx \&Mt Cm address |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Mt discuss@manpages.bsd.lv |
.D1 \&.Mt discuss@manpages.bsd.lv |
Line 1837 Document operating system version. |
|
Line 1967 Document operating system version. |
|
This is the mandatory third macro of |
This is the mandatory third macro of |
any |
any |
.Nm |
.Nm |
file. Its calling syntax is as follows: |
file. |
|
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Os Op Cm system |
.D1 Pf \. Sx \&Os Op Cm system |
.Pp |
.Pp |
The optional |
The optional |
.Cm system |
.Cm system |
Line 1911 The block macro may only contain |
|
Line 2042 The block macro may only contain |
|
.Sx \&%Q , |
.Sx \&%Q , |
.Sx \&%R , |
.Sx \&%R , |
.Sx \&%T , |
.Sx \&%T , |
|
.Sx \&%U , |
and |
and |
.Sx \&%V |
.Sx \&%V |
child macros (at least one must be specified). |
child macros (at least one must be specified). |
|
|
.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 |
Line 1980 which is used for function return types. |
|
Line 2114 which is used for function return types. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Vt unsigned char |
.D1 \&.Vt unsigned char |
.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 |
Line 1996 since this limit has been lifted, the macro has been d |
|
Line 2130 since this limit has been lifted, the macro has been d |
|
.Ss \&Xr |
.Ss \&Xr |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Its calling syntax is |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 \. Ns Sx \&Xr Cm name section |
.D1 Pf \. Sx \&Xr Cm name section |
.Pp |
.Pp |
The |
The |
.Cm name |
.Cm name |
Line 2015 This behaviour is for compatibility with |
|
Line 2149 This behaviour is for compatibility with |
|
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 ; |
.D1 \&.Xr mandoc 1 \&; |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.Ss \&br |
.Ss \&br |
.Ss \&sp |
.Ss \&sp |
Line 2035 Heirloom troff, the other significant troff implementa |
|
Line 2169 Heirloom troff, the other significant troff implementa |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
groff supports a |
|
.Fl file Ar filename |
|
argument to |
|
.Sx \&Bd . |
|
mandoc does not. |
|
.It |
|
groff behaves inconsistently when encountering |
|
.Pf non- Sx \&Fa |
|
children of |
|
.Sx \&Fo |
|
regarding spacing between arguments. |
|
In mandoc, this is not the case: each argument is consistently followed |
|
by a single space and the trailing |
|
.Sq \&) |
|
suppresses prior spacing. |
|
.It |
|
groff behaves inconsistently when encountering |
|
.Sx \&Ft |
|
and |
|
.Sx \&Fn |
|
in the |
|
.Em SYNOPSIS : |
|
at times newline(s) are suppressed depending on whether a prior |
|
.Sx \&Fn |
|
has been invoked. |
|
In mandoc, this is not the case. |
|
See |
|
.Sx \&Ft |
|
and |
|
.Sx \&Fn |
|
for the normalised behaviour. |
|
.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 |
groff does not accept the |
groff does not accept the |
.Sq \&Ta |
.Sq \&Ta |
pseudo-macro as a line macro. |
pseudo-macro as a line macro. |
|
|
.Fl right |
.Fl right |
are aliases for |
are aliases for |
.Fl left |
.Fl left |
in manodc. Furthermore, the |
in mandoc. Furthermore, the |
.Fl file Ar file |
.Fl file Ar file |
argument is ignored. |
argument is ignored. |
Lastly, since text is not right-justified in mandoc (or even groff), |
Lastly, since text is not right-justified in mandoc (or even groff), |
Line 2110 Some manuals use |
|
Line 2288 Some manuals use |
|
incorrectly by following it with a reserved character and expecting the |
incorrectly by following it with a reserved character and expecting the |
delimiter to render. |
delimiter to render. |
This is not supported in mandoc. |
This is not supported in mandoc. |
.It |
|
In groff, the |
|
.Sx \&Fo |
|
macro only produces the first parameter. |
|
This is not the case in mandoc. |
|
.It |
.It |
In groff, the |
In groff, the |
.Sx \&Cd , |
.Sx \&Cd , |