version 1.86, 2010/03/26 07:07:58 |
version 1.91, 2010/04/07 08:17:16 |
Line 860 then the macro accepts an arbitrary number of argument |
|
Line 860 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ox Ta Yes Ta Yes Ta n |
.It Sx \&Ox Ta Yes Ta Yes Ta n |
.It Sx \&Pa Ta Yes Ta Yes Ta n |
.It Sx \&Pa Ta Yes Ta Yes Ta n |
.It Sx \&Pf Ta \&No Ta Yes Ta 1 |
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Rv Ta \&No Ta \&No Ta n |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
Line 974 Address construct: usually in the context of an comput |
|
Line 974 Address construct: usually in the context of an comput |
|
memory, not a physical (post) address. |
memory, not a physical (post) address. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Ad [0,$] |
\&.Ad [0,$] |
.D1 \&.Ad 0x00000000 |
\&.Ad 0x00000000 |
|
.Ed |
|
. |
. |
.Ss \&An |
.Ss \&An |
Author name. This macro may alternatively accepts the following |
Author name. This macro may alternatively accepts the following |
Line 998 will cause the first listing also to be split. If not |
|
Line 996 will cause the first listing also to be split. If not |
|
section, the default is not to split. |
section, the default is not to split. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.An -nosplit |
\&.An -nosplit |
.D1 \&.An J. D. Ullman . |
\&.An J. E. Hopcraft , |
|
\&.An J. D. Ullman . |
|
.Ed |
|
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
the effects of |
the effects of |
Line 1019 Begins a block enclosed by angled brackets. Does not |
|
Line 1014 Begins a block enclosed by angled brackets. Does not |
|
arguments. |
arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac |
\&.Fl -key= Ns Ao Ar val Ac |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Aq . |
.Sx \&Aq . |
|
|
Encloses its arguments in angled brackets. |
Encloses its arguments in angled brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Fl -key= \&Ns \&Aq \&Ar val |
\&.Fl -key= Ns Aq Ar val |
|
.Ed |
|
.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 1061 Command arguments. If an argument is not provided, th |
|
Line 1052 Command arguments. If an argument is not provided, th |
|
is used as a default. |
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Fl o \&Ns \&Ar file1 |
\&.Fl o Ns Ar file1 |
.D1 \&.Ar |
\&.Ar |
.D1 \&.Ar arg1 , arg2 . |
\&.Ar arg1 , arg2 . |
|
.Ed |
|
. |
. |
.Ss \&At |
.Ss \&At |
Formats an AT&T version. Accepts at most one parameter: |
Formats an AT&T version. Accepts at most one parameter: |
Line 1081 A system version of |
|
Line 1070 A system version of |
|
Note that these parameters do not begin with a hyphen. |
Note that these parameters do not begin with a hyphen. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.At |
\&.At |
.D1 \&.At V.1 |
\&.At V.1 |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bsx , |
.Sx \&Bsx , |
|
|
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Bo 1 , |
\&.Bo 1 , |
\&.Dv BUFSIZ Bc |
\&.Dv BUFSIZ \&Bc |
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
|
|
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Bq 1 , \&Dv BUFSIZ |
\&.Bq 1 , Dv BUFSIZ |
|
.Ed |
|
.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 |
|
|
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Bro 1 , ... , |
\&.Bro 1 , ... , |
\&.Va n Brc |
\&.Va n \&Brc |
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
|
|
Encloses its arguments in curly braces. |
Encloses its arguments in curly braces. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Brq 1 , ... , \&Va n |
\&.Brq 1 , ... , Va n |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bro . |
.Sx \&Bro . |
Line 1303 Format the BSD/OS version provided as an argument, or |
|
Line 1286 Format the BSD/OS version provided as an argument, or |
|
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Bsx 1.0 |
\&.Bsx 1.0 |
.D1 \&.Bsx |
\&.Bsx |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1327 Format the BSD version provided as an argument, or a d |
|
Line 1308 Format the BSD version provided as an argument, or a d |
|
argument is provided. |
argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Bx 4.4 |
\&.Bx 4.4 |
.D1 \&.Bx |
\&.Bx |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1348 manuals). This denotes strings accepted by |
|
Line 1327 manuals). This denotes strings accepted by |
|
.Xr config 8 . |
.Xr config 8 . |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Cd device le0 at scode? |
\&.Cd device le0 at scode? |
|
.Ed |
|
.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 1363 Command modifiers. Useful when specifying configurati |
|
Line 1340 Command modifiers. Useful when specifying configurati |
|
keys. |
keys. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Cm ControlPath |
\&.Cm ControlPath |
.D1 \&.Cm ControlMaster |
\&.Cm ControlMaster |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Fl . |
.Sx \&Fl . |
Line 1376 One-line indented display. This is formatted by the d |
|
Line 1351 One-line indented display. This is formatted by the d |
|
is useful for simple indented statements. It is followed by a newline. |
is useful for simple indented statements. It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.D1 \&Fl abcdefgh |
\&.D1 Fl abcdefgh |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Sx \&Bd |
Line 1409 or instead a valid canonical date as specified by |
|
Line 1382 or instead a valid canonical date as specified by |
|
If a date does not conform, the current date is used instead. |
If a date does not conform, the current date is used instead. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
.D1 \&.Dd $\&Mdocdate: July 21 2007$ |
\&.Dd $\&Mdocdate: July 21 2007$ |
.D1 \&.Dd July 21, 2007 |
\&.Dd July 21, 2007 |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dt |
.Sx \&Dt |
Line 1425 One-line intended display. This is formatted as liter |
|
Line 1396 One-line intended display. This is formatted as liter |
|
useful for commands and invocations. It is followed by a newline. |
useful for commands and invocations. It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Dl % mandoc mdoc.7 | less |
\&.Dl % mandoc mdoc.7 | less |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Sx \&Bd |
Line 1439 Begins a block enclosed by double quotes. Does not ha |
|
Line 1408 Begins a block enclosed by double quotes. Does not ha |
|
arguments. |
arguments. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot |
\&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dq . |
.Sx \&Dq . |
|
|
Encloses its arguments in double quotes. |
Encloses its arguments in double quotes. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
\&.Dq April is the cruellest month |
\&.Dq April is the cruellest month |
\e(em T.S. Eliot |
\e(em T.S. Eliot |
.Ed |
.Ed |
|
|
.El |
.El |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Dt FOO 1 |
\&.Dt FOO 1 |
.D1 \&.Dt FOO 4 KM |
\&.Dt FOO 4 KM |
.D1 \&.Dt FOO 9 i386 |
\&.Dt FOO 9 i386 |
.D1 \&.Dt FOO 9 KM i386 |
\&.Dt FOO 9 KM i386 |
|
.Ed |
|
.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: |
.Bd -literal -offset indent |
.D1 \&.Dv BUFSIZ |
\&.Dv BUFSIZ |
.D1 \&.Dv STDOUT_FILENO |
\&.Dv STDOUT_FILENO |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Er . |
.Sx \&Er . |
Line 1601 Format the DragonFly BSD version provided as an argume |
|
Line 1564 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: |
.Bd -literal -offset indent |
.D1 \&.Dx 2.4.1 |
\&.Dx 2.4.1 |
.D1 \&.Dx |
\&.Dx |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
|
|
.Ss \&Ef |
.Ss \&Ef |
.Ss \&Ek |
.Ss \&Ek |
.Ss \&El |
.Ss \&El |
|
. |
.Ss \&Em |
.Ss \&Em |
Denotes text that should be emphasised. Note that this is a |
Denotes text that should be emphasised. Note that this is a |
presentation term and should not be used for stylistically decorating |
presentation term and should not be used for stylistically decorating |
technical terms. |
technical terms. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Em Warnings! |
\&.Ed Warnings! |
.D1 \&.Em Remarks : |
\&.Ed Remarks : |
|
.Ed |
|
. |
. |
.Ss \&En |
.Ss \&En |
.Ss \&Eo |
.Ss \&Eo |
.Ss \&Er |
.Ss \&Er |
Error constants (suggested for use only in section two manuals). |
Display error constants. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Er EPERM |
\&.Er EPERM |
.D1 \&.Er ENOENT |
\&.Er ENOENT |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dv . |
.Sx \&Dv . |
Line 1653 Environmental variables such as those specified in |
|
Line 1611 Environmental variables such as those specified in |
|
.Xr environ 7 . |
.Xr environ 7 . |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Ev DISPLAY |
\&.Ev DISPLAY |
.D1 \&.Ev PATH |
\&.Ev PATH |
|
.Ed |
|
. |
. |
.Ss \&Ex |
.Ss \&Ex |
Inserts text regarding a utility's exit values. This macro must have |
Inserts text regarding a utility's exit values. This macro must have |
|
|
Command-line flag. Used when listing arguments to command-line |
Command-line flag. Used when listing arguments to command-line |
utilities. Prints a fixed-width hyphen |
utilities. Prints a fixed-width hyphen |
.Sq \- |
.Sq \- |
before each delimited argument. If no arguments are provided, a hyphen |
directly followed by each argument. If no arguments are provided, a hyphen is |
is still printed. |
printed followed by a space. If the argument is a macro, a hyphen is |
|
prefixed to the subsequent macro output. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Fl a b c |
\&.Fl a b c |
.D1 \&.Fl \&Pf a b |
\&.Fl |
.D1 \&.Fl |
\&.Op Fl o Ns Ar file |
.D1 \&.Op \&Fl o \&Ns \&Ar file |
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Cm . |
.Sx \&Cm . |
Line 1698 Format the FreeBSD version provided as an argument, or |
|
Line 1654 Format the FreeBSD version provided as an argument, or |
|
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Fx 7.1 |
\&.Fx 7.1 |
.D1 \&.Fx |
\&.Fx |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1725 Format a hyperlink. The calling syntax is as follows: |
|
Line 1679 Format a hyperlink. The calling syntax is as follows: |
|
.D1 \. Ns Sx \&Lk Cm uri Op Cm name |
.D1 \. Ns Sx \&Lk Cm uri Op Cm name |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
\&.Lk http://bsd.lv "The BSD.lv Project" |
.D1 \&.Lk http://bsd.lv |
\&.Lk http://bsd.lv |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Mt . |
.Sx \&Mt . |
Line 1745 Format the NetBSD version provided as an argument, or |
|
Line 1697 Format the NetBSD version provided as an argument, or |
|
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Nx 5.01 |
\&.Nx 5.01 |
.D1 \&.Nx |
\&.Nx |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1778 unspecified, it defaults to the local operating system |
|
Line 1728 unspecified, it defaults to the local operating system |
|
the suggested form. |
the suggested form. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Os |
\&.Os |
.D1 \&.Os KTH/CSC/TCS |
\&.Os KTH/CSC/TCS |
.D1 \&.Os BSD 4.3 |
\&.Os BSD 4.3 |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dd |
.Sx \&Dd |
Line 1800 Format the OpenBSD version provided as an argument, or |
|
Line 1748 Format the OpenBSD version provided as an argument, or |
|
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Ox 4.5 |
\&.Ox 4.5 |
.D1 \&.Ox |
\&.Ox |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
|
|
child macros (at least one must be specified). |
child macros (at least one must be specified). |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
\&.Rs |
\&.Rs |
\&.%A J. E. Hopcroft |
\&.%A J. E. Hopcroft |
\&.%A J. D. Ullman |
\&.%A J. D. Ullman |
|
|
Format the UNIX name. Accepts no argument. |
Format the UNIX name. Accepts no argument. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Ux |
\&.Ux |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Sx \&At , |
Line 1916 Note that this should not be confused with |
|
Line 1860 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: |
.Bd -literal -offset indent |
.D1 \&.Vt unsigned char |
\&.Vt unsigned char |
.D1 \&.Vt extern const char * const sys_signame[] ; |
\&.Vt extern const char * const sys_signame[] ; |
|
.Ed |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Ft |
.Sx \&Ft |
|
|
.Sx \&Va . |
.Sx \&Va . |
. |
. |
.Ss \&Xc |
.Ss \&Xc |
|
Close a scope opened by |
|
.Sx \&Xo . |
|
. |
.Ss \&Xo |
.Ss \&Xo |
|
Open an extension scope. This macro originally existed to extend the |
|
9-argument limit of troff; since this limit has been lifted, the macro |
|
has been deprecated. |
|
. |
.Ss \&Xr |
.Ss \&Xr |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
|
|
.Xr groff 1 . |
.Xr groff 1 . |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.D1 \&.Xr mandoc 1 |
\&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 ; |
\&.Xr mandoc 1 ; |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
\&.Xr mandoc 1 s behaviour |
|
.Ed |
|
. |
. |
.Ss \&br |
.Ss \&br |
.Ss \&sp |
.Ss \&sp |