version 1.162, 2010/10/24 14:49:35 |
version 1.176, 2011/01/22 14:05:33 |
Line 55 character, and, in certain circumstances, the tab char |
|
Line 55 character, and, in certain circumstances, the tab char |
|
All manuals must have |
All manuals must have |
.Ux |
.Ux |
line terminators. |
line terminators. |
|
.Pp |
|
If the first character of a line is a space, that line is printed |
|
with a leading newline. |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e\*q , |
.Sq \e\*q , |
Line 125 Terms may be text-decorated using the |
|
Line 128 Terms may be text-decorated using the |
|
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 |
.Dl \efBbold\efR \efIitalic\efP |
.Pp |
.Pp |
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. |
Line 293 The proper spacing is also intelligently preserved if |
|
Line 296 The proper spacing is also intelligently preserved if |
|
the boundary of a macro line. |
the boundary of a macro line. |
For example: |
For example: |
.Pp |
.Pp |
.D1 \&Xr mandoc 1 \. |
.Dl \&Xr mandoc 1 \. |
.D1 \&Fl T \&Ns \&Cm ascii \. |
.Dl \&Fl T \&Ns \&Cm ascii \. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
A well-formed |
A well-formed |
.Nm |
.Nm |
|
|
.Pp |
.Pp |
The |
The |
.Em Callable |
.Em Callable |
column indicates that the macro may be called subsequent to the initial |
column indicates that the macro may also be called by passing its name |
line-macro. |
as an argument to another macro. |
If a macro is not callable, then its invocation after the initial line |
If a macro is not callable but its name appears as an argument |
macro is interpreted as opaque text, such that |
to another macro, it is interpreted as opaque text. |
|
For example, |
.Sq \&.Fl \&Sh |
.Sq \&.Fl \&Sh |
produces |
produces |
.Sq Fl \&Sh . |
.Sq Fl \&Sh . |
.Pp |
.Pp |
The |
The |
.Em Parsed |
.Em Parsed |
column indicates whether the macro may be followed by further |
column indicates whether the macro may call other macros by receiving |
(ostensibly callable) macros. |
their names as arguments. |
If a macro is not parsed, subsequent macro invocations on the line |
If a macro is not parsed but the name of another macro appears |
will be interpreted as opaque text. |
as an argument, it is interpreted as opaque text. |
.Pp |
.Pp |
The |
The |
.Em Scope |
.Em Scope |
Line 794 then the macro accepts an arbitrary number of argument |
|
Line 798 then the macro accepts an arbitrary number of argument |
|
.It Sx \&%T Ta \&No Ta \&No Ta >0 |
.It Sx \&%T Ta \&No Ta \&No Ta >0 |
.It Sx \&%U Ta \&No Ta \&No Ta >0 |
.It Sx \&%U Ta \&No Ta \&No Ta >0 |
.It Sx \&%V Ta \&No Ta \&No Ta >0 |
.It Sx \&%V Ta \&No Ta \&No Ta >0 |
.It Sx \&Ad Ta Yes Ta Yes Ta n |
.It Sx \&Ad Ta Yes Ta Yes Ta >0 |
.It Sx \&An Ta Yes Ta Yes Ta n |
.It Sx \&An Ta Yes Ta Yes Ta >0 |
.It Sx \&Ap Ta Yes Ta Yes Ta 0 |
.It Sx \&Ap Ta Yes Ta Yes Ta 0 |
.It Sx \&Ar Ta Yes Ta Yes Ta n |
.It Sx \&Ar Ta Yes Ta Yes Ta n |
.It Sx \&At Ta Yes Ta Yes Ta 1 |
.It Sx \&At Ta Yes Ta Yes Ta 1 |
Line 803 then the macro accepts an arbitrary number of argument |
|
Line 807 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Bt Ta \&No Ta \&No Ta 0 |
.It Sx \&Bt Ta \&No Ta \&No Ta 0 |
.It Sx \&Bx Ta Yes Ta Yes Ta n |
.It Sx \&Bx Ta Yes Ta Yes Ta n |
.It Sx \&Cd Ta Yes Ta Yes Ta >0 |
.It Sx \&Cd Ta Yes Ta Yes Ta >0 |
.It Sx \&Cm Ta Yes Ta Yes Ta n |
.It Sx \&Cm Ta Yes Ta Yes Ta >0 |
.It Sx \&Db Ta \&No Ta \&No Ta 1 |
.It Sx \&Db Ta \&No Ta \&No Ta 1 |
.It Sx \&Dd Ta \&No Ta \&No Ta n |
.It Sx \&Dd Ta \&No Ta \&No Ta n |
.It Sx \&Dt Ta \&No Ta \&No Ta n |
.It Sx \&Dt Ta \&No Ta \&No Ta n |
.It Sx \&Dv Ta Yes Ta Yes Ta n |
.It Sx \&Dv Ta Yes Ta Yes Ta >0 |
.It Sx \&Dx Ta Yes Ta Yes Ta n |
.It Sx \&Dx Ta Yes Ta Yes Ta n |
.It Sx \&Em Ta Yes Ta Yes Ta >0 |
.It Sx \&Em Ta Yes Ta Yes Ta >0 |
.It Sx \&En Ta \&No Ta \&No Ta 0 |
.It Sx \&En Ta \&No Ta \&No Ta 0 |
.It Sx \&Er Ta Yes Ta Yes Ta >0 |
.It Sx \&Er Ta Yes Ta Yes Ta >0 |
.It Sx \&Es Ta \&No Ta \&No Ta 0 |
.It Sx \&Es Ta \&No Ta \&No Ta 0 |
.It Sx \&Ev Ta Yes Ta Yes Ta n |
.It Sx \&Ev Ta Yes Ta Yes Ta >0 |
.It Sx \&Ex Ta \&No Ta \&No Ta n |
.It Sx \&Ex Ta \&No Ta \&No Ta n |
.It Sx \&Fa Ta Yes Ta Yes Ta n |
.It Sx \&Fa Ta Yes Ta Yes Ta >0 |
.It Sx \&Fd Ta \&No Ta \&No Ta >0 |
.It Sx \&Fd Ta \&No Ta \&No Ta >0 |
.It Sx \&Fl Ta Yes Ta Yes Ta n |
.It Sx \&Fl Ta Yes Ta Yes Ta n |
.It Sx \&Fn Ta Yes Ta Yes Ta >0 |
.It Sx \&Fn Ta Yes Ta Yes Ta >0 |
.It Sx \&Fr Ta \&No Ta \&No Ta n |
.It Sx \&Fr Ta \&No Ta \&No Ta n |
.It Sx \&Ft Ta Yes Ta Yes Ta n |
.It Sx \&Ft Ta Yes Ta Yes Ta >0 |
.It Sx \&Fx Ta Yes Ta Yes Ta n |
.It Sx \&Fx Ta Yes Ta Yes Ta n |
.It Sx \&Hf Ta \&No Ta \&No Ta n |
.It Sx \&Hf Ta \&No Ta \&No Ta n |
.It Sx \&Ic Ta Yes Ta Yes Ta >0 |
.It Sx \&Ic Ta Yes Ta Yes Ta >0 |
.It Sx \&In Ta \&No Ta \&No Ta n |
.It Sx \&In Ta \&No Ta \&No Ta n |
.It Sx \&Lb Ta \&No Ta \&No Ta 1 |
.It Sx \&Lb Ta \&No Ta \&No Ta 1 |
.It Sx \&Li Ta Yes Ta Yes Ta n |
.It Sx \&Li Ta Yes Ta Yes Ta >0 |
.It Sx \&Lk Ta Yes Ta Yes Ta n |
.It Sx \&Lk Ta Yes Ta Yes Ta >0 |
.It Sx \&Lp Ta \&No Ta \&No Ta 0 |
.It Sx \&Lp Ta \&No Ta \&No Ta 0 |
.It Sx \&Ms Ta Yes Ta Yes Ta >0 |
.It Sx \&Ms Ta Yes Ta Yes Ta >0 |
.It Sx \&Mt Ta Yes Ta Yes Ta >0 |
.It Sx \&Mt Ta Yes Ta Yes Ta >0 |
|
|
Do not use this for postal addresses. |
Do not use this for postal addresses. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ad [0,$] |
.Dl \&.Ad [0,$] |
.D1 \&.Ad 0x00000000 |
.Dl \&.Ad 0x00000000 |
.Ss \&An |
.Ss \&An |
Author name. |
Author name. |
Requires either the name of an author or one of the following arguments: |
Requires either the name of an author or one of the following arguments: |
Line 969 for the first author listing and |
|
Line 973 for the first author listing and |
|
for all other author listings. |
for all other author listings. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.An -nosplit |
.Dl \&.An -nosplit |
.D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv |
.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv |
.Ss \&Ao |
.Ss \&Ao |
Begin a block enclosed by angle brackets. |
Begin a block enclosed by angle brackets. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac |
.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac |
.Pp |
.Pp |
See also |
See also |
.Sx \&Aq . |
.Sx \&Aq . |
Line 986 This is generally used as a grammatical device when re |
|
Line 990 This is generally used as a grammatical device when re |
|
form of a function. |
form of a function. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fn execve \&Ap d |
.Dl \&.Fn execve \&Ap d |
.Ss \&Aq |
.Ss \&Aq |
Encloses its arguments in angle brackets. |
Encloses its arguments in angle brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl -key= \&Ns \&Aq \&Ar val |
.Dl \&.Fl -key= \&Ns \&Aq \&Ar val |
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
this macro is often abused for rendering URIs, which should instead use |
this macro is often abused for rendering URIs, which should instead use |
Line 1012 If an argument is not provided, the string |
|
Line 1016 If an argument is not provided, the string |
|
is used as a default. |
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl o \&Ns \&Ar file1 |
.Dl \&.Fl o \&Ns \&Ar file1 |
.D1 \&.Ar |
.Dl \&.Ar |
.D1 \&.Ar arg1 , arg2 . |
.Dl \&.Ar arg1 , arg2 . |
.Ss \&At |
.Ss \&At |
Formats an AT&T version. |
Formats an AT&T version. |
Accepts one optional argument: |
Accepts one optional argument: |
|
|
Note that these arguments do not begin with a hyphen. |
Note that these arguments do not begin with a hyphen. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.At |
.Dl \&.At |
.D1 \&.At V.1 |
.Dl \&.At V.1 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bsx , |
.Sx \&Bsx , |
Line 1076 implementations render it poorly. |
|
Line 1080 implementations render it poorly. |
|
Left- and right-justify the block. |
Left- and right-justify the block. |
.It Fl literal |
.It Fl literal |
Do not justify the block at all. |
Do not justify the block at all. |
Preserve white space and newlines as they appear in the input, including |
Preserve white space as it appears in the input. |
if it follows a macro. |
|
.It Fl ragged |
.It Fl ragged |
Only left-justify the block. |
Only left-justify the block. |
.It Fl unfilled |
.It Fl unfilled |
Line 1201 Be careful in using over-long lines within a keep bloc |
|
Line 1204 Be careful in using over-long lines within a keep bloc |
|
Doing so will clobber the right margin. |
Doing so will clobber the right margin. |
.Ss \&Bl |
.Ss \&Bl |
Begin a list. |
Begin a list. |
Lists consist of items started by the |
Lists consist of items specified using the |
.Sx \&It |
.Sx \&It |
macro, containing a head or a body or both. |
macro, containing a head or a body or both. |
The list syntax is as follows: |
The list syntax is as follows: |
|
|
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bq 1 , \&Dv BUFSIZ |
.Dl \&.Bq 1 , \&Dv BUFSIZ |
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
this macro is sometimes abused to emulate optional arguments for |
this macro is sometimes abused to emulate optional arguments for |
|
|
Encloses its arguments in curly braces. |
Encloses its arguments in curly braces. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Brq 1 , ... , \&Va n |
.Dl \&.Brq 1 , ... , \&Va n |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bro . |
.Sx \&Bro . |
Line 1378 Format the BSD/OS version provided as an argument, or |
|
Line 1381 Format the BSD/OS version provided as an argument, or |
|
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bsx 1.0 |
.Dl \&.Bsx 1.0 |
.D1 \&.Bsx |
.Dl \&.Bsx |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1398 Format the BSD version provided as an argument, or a d |
|
Line 1401 Format the BSD version provided as an argument, or a d |
|
argument is provided. |
argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bx 4.4 |
.Dl \&.Bx 4.4 |
.D1 \&.Bx |
.Dl \&.Bx |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1416 This denotes strings accepted by |
|
Line 1419 This denotes strings accepted by |
|
.Xr config 8 . |
.Xr config 8 . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Cd device le0 at scode? |
.Dl \&.Cd device le0 at scode? |
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
this macro is commonly abused by using quoted literals to retain |
this macro is commonly abused by using quoted literals to retain |
Line 1429 Command modifiers. |
|
Line 1432 Command modifiers. |
|
Useful when specifying configuration options or keys. |
Useful when specifying configuration options or keys. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Cm ControlPath |
.Dl \&.Cm ControlPath |
.D1 \&.Cm ControlMaster |
.Dl \&.Cm ControlMaster |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fl . |
.Sx \&Fl . |
|
|
It is followed by a newline. |
It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.D1 \&Fl abcdefgh |
.Dl \&.D1 \&Fl abcdefgh |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Sx \&Bd |
Line 1480 or instead a valid canonical date as specified by |
|
Line 1483 or instead a valid canonical date as specified by |
|
If a date does not conform or is empty, the current date is used. |
If a date does not conform or is empty, the current date is used. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dd $\&Mdocdate$ |
.Dl \&.Dd $\&Mdocdate$ |
.D1 \&.Dd $\&Mdocdate: July 21 2007$ |
.Dl \&.Dd $\&Mdocdate: July 21 2007$ |
.D1 \&.Dd July 21, 2007 |
.Dl \&.Dd July 21, 2007 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dt |
.Sx \&Dt |
|
|
It is followed by a newline. |
It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dl % mandoc mdoc.7 \e(ba less |
.Dl \&.Dl % mandoc mdoc.7 \e(ba less |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Sx \&Bd |
|
|
.El |
.El |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dt FOO 1 |
.Dl \&.Dt FOO 1 |
.D1 \&.Dt FOO 4 KM |
.Dl \&.Dt FOO 4 KM |
.D1 \&.Dt FOO 9 i386 |
.Dl \&.Dt FOO 9 i386 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dd |
.Sx \&Dd |
|
|
Defined variables such as preprocessor constants. |
Defined variables such as preprocessor constants. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dv BUFSIZ |
.Dl \&.Dv BUFSIZ |
.D1 \&.Dv STDOUT_FILENO |
.Dl \&.Dv STDOUT_FILENO |
.Pp |
.Pp |
See also |
See also |
.Sx \&Er . |
.Sx \&Er . |
Line 1685 Format the DragonFly BSD version provided as an argume |
|
Line 1688 Format the DragonFly BSD version provided as an argume |
|
value if no argument is provided. |
value if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dx 2.4.1 |
.Dl \&.Dx 2.4.1 |
.D1 \&.Dx |
.Dl \&.Dx |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1732 Note that this is a presentation term and should not b |
|
Line 1735 Note that this is a presentation term and should not b |
|
stylistically decorating technical terms. |
stylistically decorating technical terms. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Em Warnings! |
.Dl \&.Em Warnings! |
.D1 \&.Em Remarks : |
.Dl \&.Em Remarks : |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Sx \&Bf , |
|
|
Display error constants. |
Display error constants. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Er EPERM |
.Dl \&.Er EPERM |
.D1 \&.Er ENOENT |
.Dl \&.Er ENOENT |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dv . |
.Sx \&Dv . |
Line 1770 Environmental variables such as those specified in |
|
Line 1773 Environmental variables such as those specified in |
|
.Xr environ 7 . |
.Xr environ 7 . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ev DISPLAY |
.Dl \&.Ev DISPLAY |
.D1 \&.Ev PATH |
.Dl \&.Ev PATH |
.Ss \&Ex |
.Ss \&Ex |
Insert a standard sentence regarding exit values. |
Insert a standard sentence regarding exit values. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 1811 Furthermore, if the following macro is another |
|
Line 1814 Furthermore, if the following macro is another |
|
the last argument will also have a trailing comma. |
the last argument will also have a trailing comma. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqconst char *p\(dq |
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.D1 \&.Fa foo |
.Dl \&.Fa foo |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fo . |
.Sx \&Fo . |
Line 1841 If the argument is a macro, a hyphen is prefixed to th |
|
Line 1844 If the argument is a macro, a hyphen is prefixed to th |
|
output. |
output. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl a b c |
.Dl \&.Fl a b c |
.D1 \&.Fl \&Pf a b |
.Dl \&.Fl \&Pf a b |
.D1 \&.Fl |
.Dl \&.Fl |
.D1 \&.Op \&Fl o \&Ns \&Ar file |
.Dl \&.Op \&Fl o \&Ns \&Ar file |
.Pp |
.Pp |
See also |
See also |
.Sx \&Cm . |
.Sx \&Cm . |
Line 1863 are delimited by commas. |
|
Line 1866 are delimited by commas. |
|
If no arguments are specified, blank parenthesis are output. |
If no arguments are specified, blank parenthesis are output. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fn "int funcname" "int arg0" "int arg1" |
.Dl \&.Fn "int funcname" "int arg0" "int arg1" |
.D1 \&.Fn funcname "int arg0" |
.Dl \&.Fn funcname "int arg0" |
.D1 \&.Fn funcname arg0 |
.Dl \&.Fn funcname arg0 |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
.Ed |
.Ed |
.Pp |
.Pp |
When referring to a function documented in another manual page, |
When referring to a function documented in another manual page, use |
.Sx \&Xr |
.Sx \&Xr |
is usually preferable. |
instead. |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE |
and |
and |
Line 1916 Its syntax is as follows: |
|
Line 1919 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Ft Cm functype |
.D1 Pf \. Sx \&Ft Cm functype |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ft int |
.Dl \&.Ft int |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
Line 1934 version provided as an argument, or a default value |
|
Line 1937 version provided as an argument, or a default value |
|
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fx 7.1 |
.Dl \&.Fx 7.1 |
.D1 \&.Fx |
.Dl \&.Fx |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1955 This is similar to |
|
Line 1958 This is similar to |
|
but used for instructions rather than values. |
but used for instructions rather than values. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ic hash |
.Dl \&.Ic hash |
.D1 \&.Ic alias |
.Dl \&.Ic alias |
.Pp |
.Pp |
Note that using |
Note that using |
.Sx \&Bd Fl literal |
.Sx \&Bd Fl literal |
|
|
the arguments is enclosed in angle brackets. |
the arguments is enclosed in angle brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.In sys/types |
.Dl \&.In sys/types |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
|
|
.Sx \&It , |
.Sx \&It , |
for example, |
for example, |
.Pp |
.Pp |
.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
.Dl .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 |
Line 2084 section as described in |
|
Line 2087 section as described in |
|
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Lb libz |
.Dl \&.Lb libz |
.D1 \&.Lb mdoc |
.Dl \&.Lb mdoc |
.Ss \&Li |
.Ss \&Li |
Denotes text that should be in a literal font mode. |
Denotes text that should be in a literal font mode. |
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 2103 Its syntax is as follows: |
|
Line 2106 Its syntax is as follows: |
|
.D1 Pf \. 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 \*qThe BSD.lv Project\*q |
.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q |
.D1 \&.Lk http://bsd.lv |
.Dl \&.Lk http://bsd.lv |
.Pp |
.Pp |
See also |
See also |
.Sx \&Mt . |
.Sx \&Mt . |
Line 2118 Its syntax is as follows: |
|
Line 2121 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Ms Cm symbol |
.D1 Pf \. Sx \&Ms Cm symbol |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ms sigma |
.Dl \&.Ms sigma |
.D1 \&.Ms aleph |
.Dl \&.Ms aleph |
.Ss \&Mt |
.Ss \&Mt |
Format a |
Format a |
.Dq mailto: |
.Dq mailto: |
Line 2129 Its syntax is as follows: |
|
Line 2132 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Mt Cm address |
.D1 Pf \. Sx \&Mt Cm address |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Mt discuss@manpages.bsd.lv |
.Dl \&.Mt discuss@manpages.bsd.lv |
.Ss \&Nd |
.Ss \&Nd |
A one line description of the manual's content. |
A one line description of the manual's content. |
This may only be invoked in the |
This may only be invoked in the |
Line 2139 section subsequent the |
|
Line 2142 section subsequent the |
|
macro. |
macro. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx \&Nd mdoc language reference |
.Dl \&.Sx \&Nd mdoc language reference |
.D1 \&.Sx \&Nd format and display UNIX manuals |
.Dl \&.Sx \&Nd format and display UNIX manuals |
.Pp |
.Pp |
The |
The |
.Sx \&Nd |
.Sx \&Nd |
|
|
macro used to terminate prior macro contexts. |
macro used to terminate prior macro contexts. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx \&Fl ab \&No cd \&Fl ef |
.Dl \&.Sx \&Fl ab \&No cd \&Fl ef |
.Ss \&Ns |
.Ss \&Ns |
Suppress a space. |
Suppress a space. |
Following invocation, text is interpreted as free-form text until a |
Following invocation, text is interpreted as free-form text until a |
macro is encountered. |
macro is encountered. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl o \&Ns \&Ar output |
.Dl \&.Fl o \&Ns \&Ar output |
.Pp |
.Pp |
See also |
See also |
.Sx \&No |
.Sx \&No |
Line 2217 version provided as an argument, or a default value if |
|
Line 2220 version provided as an argument, or a default value if |
|
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Nx 5.01 |
.Dl \&.Nx 5.01 |
.D1 \&.Nx |
.Dl \&.Nx |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 2249 Used when listing options to command-line utilities. |
|
Line 2252 Used when listing options to command-line utilities. |
|
Prints the argument(s) in brackets. |
Prints the argument(s) in brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Op \&Fl a \&Ar b |
.Dl \&.Op \&Fl a \&Ar b |
.D1 \&.Op \&Ar a | b |
.Dl \&.Op \&Ar a | b |
.Pp |
.Pp |
See also |
See also |
.Sx \&Oo . |
.Sx \&Oo . |
Line 2271 Left unspecified, it defaults to the local operating s |
|
Line 2274 Left unspecified, it defaults to the local operating s |
|
This is the suggested form. |
This is the suggested form. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Os |
.Dl \&.Os |
.D1 \&.Os KTH/CSC/TCS |
.Dl \&.Os KTH/CSC/TCS |
.D1 \&.Os BSD 4.3 |
.Dl \&.Os BSD 4.3 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dd |
.Sx \&Dd |
Line 2291 version provided as an argument, or a default value |
|
Line 2294 version provided as an argument, or a default value |
|
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ox 4.5 |
.Dl \&.Ox 4.5 |
.D1 \&.Ox |
.Dl \&.Ox |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
|
|
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Pa |
.Ss \&Pa |
A file-system path. |
A file-system path. |
|
If an argument is not provided, the string |
|
.Dq \(ti |
|
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Pa /usr/bin/mandoc |
.Dl \&.Pa /usr/bin/mandoc |
.D1 \&.Pa /usr/share/man/man7/mdoc.7 |
.Dl \&.Pa /usr/share/man/man7/mdoc.7 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Lk . |
.Sx \&Lk . |
|
|
argument may be a macro. |
argument may be a macro. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix |
.Dl \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix |
.Ss \&Po |
.Ss \&Po |
Multi-line version of |
Multi-line version of |
.Sx \&Pq . |
.Sx \&Pq . |
Line 2588 The referenced section or sub-section name must be ide |
|
Line 2594 The referenced section or sub-section name must be ide |
|
enclosed argument, including whitespace. |
enclosed argument, including whitespace. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx MANUAL STRUCTURE |
.Dl \&.Sx MANUAL STRUCTURE |
|
.Pp |
|
See also |
|
.Sx \&Sh |
|
and |
|
.Sx \&Ss . |
.Ss \&Sy |
.Ss \&Sy |
Format enclosed arguments in symbolic |
Format enclosed arguments in symbolic |
.Pq Dq boldface . |
.Pq Dq boldface . |
|
|
Format a tradename. |
Format a tradename. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Tn IBM |
.Dl \&.Tn IBM |
.Ss \&Ud |
.Ss \&Ud |
Prints out |
Prints out |
.Dq currently under development . |
.Dq currently under development . |
Line 2613 Format the UNIX name. |
|
Line 2624 Format the UNIX name. |
|
Accepts no argument. |
Accepts no argument. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ux |
.Dl \&.Ux |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
|
|
A variable name. |
A variable name. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Va foo |
.Dl \&.Va foo |
.D1 \&.Va const char *bar ; |
.Dl \&.Va const char *bar ; |
.Ss \&Vt |
.Ss \&Vt |
A variable type. |
A variable type. |
This is also used for indicating global variables in the |
This is also used for indicating global variables in the |
Line 2648 Note that this should not be confused with |
|
Line 2659 Note that this should not be confused with |
|
which is used for function return types. |
which is used for function return types. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Vt unsigned char |
.Dl \&.Vt unsigned char |
.D1 \&.Vt extern const char * const sys_signame[] \&; |
.Dl \&.Vt extern const char * const sys_signame[] \&; |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE |
|
|
Close a scope opened by |
Close a scope opened by |
.Sx \&Xo . |
.Sx \&Xo . |
.Ss \&Xo |
.Ss \&Xo |
Open an extension scope. |
Extend the header of an |
This macro originally existed to extend the 9-argument limit of troff; |
.Sx \&It |
since this limit has been lifted, the macro has been deprecated. |
macro or the body of a partial-implicit block macro |
|
beyond the end of the input line. |
|
This macro originally existed to work around the 9-argument limit |
|
of historic |
|
.Xr roff 7 . |
.Ss \&Xr |
.Ss \&Xr |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Line 2683 This behaviour is for compatibility with |
|
Line 2698 This behaviour is for compatibility with |
|
GNU troff. |
GNU troff. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Xr mandoc 1 |
.Dl \&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 \&; |
.Dl \&.Xr mandoc 1 \&; |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.Dl \&.Xr mandoc 1 \&Ns s behaviour |
.Ss \&br |
.Ss \&br |
Emits a line-break. |
Emits a line-break. |
This macro should not be used; it is implemented for compatibility with |
This macro should not be used; it is implemented for compatibility with |
Line 2715 troff implementations, at this time limited to GNU tro |
|
Line 2730 troff implementations, at this time limited to GNU tro |
|
.Pq Qq groff . |
.Pq Qq groff . |
The term |
The term |
.Qq historic groff |
.Qq historic groff |
refers to groff versions before the |
refers to groff versions before 1.17, |
|
which featured a significant update of the |
.Pa doc.tmac |
.Pa doc.tmac |
file re-write |
file. |
.Pq somewhere between 1.15 and 1.19 . |
|
.Pp |
.Pp |
Heirloom troff, the other significant troff implementation accepting |
Heirloom troff, the other significant troff implementation accepting |
\-mdoc, is similar to historic groff. |
\-mdoc, is similar to historic groff. |
Line 2728 The following problematic behaviour is found in groff: |
|
Line 2743 The following problematic behaviour is found in groff: |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
Display macros |
|
.Po |
|
.Sx \&Bd , |
|
.Sx \&Dl , |
|
and |
|
.Sx \&D1 |
|
.Pc |
|
may not be nested. |
|
\*[hist] |
|
.It |
.Sx \&At |
.Sx \&At |
with unknown arguments produces no output at all. |
with unknown arguments produces no output at all. |
\*[hist] |
\*[hist] |
Line 2809 can only be called by other macros, but not at the beg |
|
Line 2834 can only be called by other macros, but not at the beg |
|
.Sx \&%C |
.Sx \&%C |
is not implemented. |
is not implemented. |
.It |
.It |
|
Historic groff only allows up to eight or nine arguments per macro input |
|
line, depending on the exact situation. |
|
Providing more arguments causes garbled output. |
|
The number of arguments on one input line is not limited with mandoc. |
|
.It |
Historic groff has many un-callable macros. |
Historic groff has many un-callable macros. |
Most of these (excluding some block-level macros) are callable |
Most of these (excluding some block-level macros) are callable |
in new groff and mandoc. |
in new groff and mandoc. |
Line 2876 This is not supported by mandoc. |
|
Line 2906 This is not supported by mandoc. |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
|
.Xr man 7 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
|
.Xr roff 7 , |
|
.Xr tbl 7 |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |