version 1.228, 2014/03/31 01:05:32 |
version 1.232, 2014/07/13 10:24:40 |
Line 513 in the alphabetical |
|
Line 513 in the alphabetical |
|
.It Sx \&Cd Ta kernel configuration declaration (>0 arguments) |
.It Sx \&Cd Ta kernel configuration declaration (>0 arguments) |
.It Sx \&Ad Ta memory address (>0 arguments) |
.It Sx \&Ad Ta memory address (>0 arguments) |
.It Sx \&Ms Ta mathematical symbol (>0 arguments) |
.It Sx \&Ms Ta mathematical symbol (>0 arguments) |
.It Sx \&Tn Ta tradename (>0 arguments) |
|
.El |
.El |
.Ss Physical markup |
.Ss Physical markup |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
Line 541 in the alphabetical |
|
Line 540 in the alphabetical |
|
.It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ... |
.It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ... |
.It Sx \&Rv Fl std Ta standard function return values: Op Ar function ... |
.It Sx \&Rv Fl std Ta standard function return values: Op Ar function ... |
.It Sx \&St Ta reference to a standards document (one argument) |
.It Sx \&St Ta reference to a standards document (one argument) |
.It Sx \&Ux Ta Ux |
|
.It Sx \&At Ta At |
.It Sx \&At Ta At |
.It Sx \&Bx Ta Bx |
.It Sx \&Bx Ta Bx |
.It Sx \&Bsx Ta Bsx |
.It Sx \&Bsx Ta Bsx |
|
|
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Nx , |
.Sx \&Nx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Bc |
.Ss \&Bc |
Close a |
Close a |
.Sx \&Bo |
.Sx \&Bo |
|
|
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Nx , |
.Sx \&Nx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Bt |
.Ss \&Bt |
|
Supported only for compatibility, do not use this in new manuals. |
Prints |
Prints |
.Dq is currently in beta test. |
.Dq is currently in beta test. |
.Ss \&Bx |
.Ss \&Bx |
|
|
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Nx , |
.Sx \&Nx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Cd |
.Ss \&Cd |
Kernel configuration declaration. |
Kernel configuration declaration. |
This denotes strings accepted by |
This denotes strings accepted by |
|
|
.Sx \&Bx , |
.Sx \&Bx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Nx , |
.Sx \&Nx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Ec |
.Ss \&Ec |
Close a scope started by |
Close a scope started by |
.Sx \&Eo . |
.Sx \&Eo . |
|
|
and |
and |
.Sx \&Sy . |
.Sx \&Sy . |
.Ss \&En |
.Ss \&En |
This macro is obsolete and not implemented in |
This macro is obsolete. |
.Xr mandoc 1 . |
Use |
|
.Sx \&Eo |
|
or any of the other enclosure macros. |
|
.Pp |
|
It encloses its argument in the delimiters specified by the last |
|
.Sx \&Es |
|
macro. |
.Ss \&Eo |
.Ss \&Eo |
An arbitrary enclosure. |
An arbitrary enclosure. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
.Sx \&Dv |
.Sx \&Dv |
for general constants. |
for general constants. |
.Ss \&Es |
.Ss \&Es |
This macro is obsolete and not implemented. |
This macro is obsolete. |
|
Use |
|
.Sx \&Eo |
|
or any of the other enclosure macros. |
|
.Pp |
|
It takes two arguments, defining the delimiters to be used by subsequent |
|
.Sx \&En |
|
macros. |
.Ss \&Ev |
.Ss \&Ev |
Environmental variables such as those specified in |
Environmental variables such as those specified in |
.Xr environ 7 . |
.Xr environ 7 . |
Line 1555 Function argument. |
|
Line 1563 Function argument. |
|
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Fa |
.Pf \. Sx \&Fa |
.Op Cm argtype |
.Qo |
.Cm argname |
.Op Ar argtype |
|
.Op Ar argname |
|
.Qc Ar \&... |
.Ed |
.Ed |
.Pp |
.Pp |
This may be invoked for names with or without the corresponding type. |
Each argument may be a name and a type (recommended for the |
It is also used to specify the field name of a structure. |
.Em SYNOPSIS |
|
section), a name alone (for function invocations), |
|
or a type alone (for function prototypes). |
|
If both a type and a name are given or if the type consists of multiple |
|
words, all words belonging to the same function argument have to be |
|
given in a single argument to the |
|
.Sx \&Fa |
|
macro. |
|
.Pp |
|
This macro is also used to specify the field name of a structure. |
|
.Pp |
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 |
within |
.Sx \&Fo |
.Sx \&Fo |
section when documenting multi-line function prototypes. |
blocks 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. |
Furthermore, if the following macro is another |
Furthermore, if the following macro is another |
Line 1577 the last argument will also have a trailing comma. |
|
Line 1597 the last argument will also have a trailing comma. |
|
Examples: |
Examples: |
.Dl \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa foo |
.Dl \&.Fa \(dqchar *\(dq size_t |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fo . |
.Sx \&Fo . |
Line 1680 Invocations usually occur in the following context: |
|
Line 1700 Invocations usually occur in the following context: |
|
.br |
.br |
.Pf \. Sx \&Fo Ar funcname |
.Pf \. Sx \&Fo Ar funcname |
.br |
.br |
.Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname |
.Pf \. Sx \&Fa Qq Ar argtype Ar argname |
.br |
.br |
\&.\.\. |
\&.\.\. |
.br |
.br |
|
|
and |
and |
.Sx \&Ft . |
.Sx \&Ft . |
.Ss \&Fr |
.Ss \&Fr |
This macro is obsolete and not implemented in |
This macro is obsolete. |
.Xr mandoc 1 . |
No replacement markup is needed. |
.Pp |
.Pp |
It was used to show function return values. |
It was used to show numerical function return values in an italic font. |
The syntax was: |
|
.Pp |
|
.Dl Pf . Sx \&Fr Ar value |
|
.Ss \&Ft |
.Ss \&Ft |
A function type. |
A function type. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
.Sx \&Bx , |
.Sx \&Bx , |
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Nx , |
.Sx \&Nx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Hf |
.Ss \&Hf |
This macro is not implemented in |
This macro is not implemented in |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
|
|
.Sx \&Bx , |
.Sx \&Bx , |
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Ox , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Ox . |
.Ss \&Oc |
.Ss \&Oc |
Close multi-line |
Close multi-line |
.Sx \&Oo |
.Sx \&Oo |
|
|
and |
and |
.Sx \&Dt . |
.Sx \&Dt . |
.Ss \&Ot |
.Ss \&Ot |
This macro is obsolete and not implemented in |
This macro is obsolete. |
.Xr mandoc 1 . |
Use |
|
.Sx \&Ft |
|
instead; with |
|
.Xr mandoc 1 , |
|
both have the same effect. |
.Pp |
.Pp |
Historical |
Historical |
.Nm |
.Nm |
|
|
.Sx \&Bx , |
.Sx \&Bx , |
.Sx \&Dx , |
.Sx \&Dx , |
.Sx \&Fx , |
.Sx \&Fx , |
.Sx \&Nx , |
|
and |
and |
.Sx \&Ux . |
.Sx \&Nx . |
.Ss \&Pa |
.Ss \&Pa |
An absolute or relative file system path, or a file or directory name. |
An absolute or relative file system path, or a file or directory name. |
If an argument is not provided, the character |
If an argument is not provided, the character |
Line 2633 Table cell separator in |
|
Line 2651 Table cell separator in |
|
lists; can only be used below |
lists; can only be used below |
.Sx \&It . |
.Sx \&It . |
.Ss \&Tn |
.Ss \&Tn |
Format a tradename. |
Supported only for compatibility, do not use this in new manuals. |
.Pp |
Even though the macro name |
Since this macro is often implemented to use a small caps font, |
.Pq Dq tradename |
it has historically been used for acronyms (like ASCII) as well. |
suggests a semantic function, historic usage is inconsistent, mostly |
Such usage is not recommended because it would use the same macro |
using it as a presentation-level macro to request a small caps font. |
sometimes for semantical annotation, sometimes for physical formatting. |
|
.Pp |
|
Examples: |
|
.Dl \&.Tn IBM |
|
.Ss \&Ud |
.Ss \&Ud |
|
Supported only for compatibility, do not use this in new manuals. |
Prints out |
Prints out |
.Dq currently under development. |
.Dq currently under development. |
.Ss \&Ux |
.Ss \&Ux |
Format the |
Supported only for compatibility, do not use this in new manuals. |
.Ux |
Prints out |
name. |
.Dq Ux . |
Accepts no argument. |
|
.Pp |
|
Examples: |
|
.Dl \&.Ux |
|
.Pp |
|
See also |
|
.Sx \&At , |
|
.Sx \&Bsx , |
|
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
and |
|
.Sx \&Ox . |
|
.Ss \&Va |
.Ss \&Va |
A variable name. |
A variable name. |
.Pp |
.Pp |
Line 2914 end of the line. |
|
Line 2915 end of the line. |
|
.It Sx \&D1 Ta \&No Ta \&Yes |
.It Sx \&D1 Ta \&No Ta \&Yes |
.It Sx \&Dl Ta \&No Ta Yes |
.It Sx \&Dl Ta \&No Ta Yes |
.It Sx \&Dq Ta Yes Ta Yes |
.It Sx \&Dq Ta Yes Ta Yes |
|
.It Sx \&En Ta Yes Ta Yes |
.It Sx \&Op Ta Yes Ta Yes |
.It Sx \&Op Ta Yes Ta Yes |
.It Sx \&Pq Ta Yes Ta Yes |
.It Sx \&Pq Ta Yes Ta Yes |
.It Sx \&Ql Ta Yes Ta Yes |
.It Sx \&Ql Ta Yes Ta Yes |
Line 2991 then the macro accepts an arbitrary number of argument |
|
Line 2993 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Dv Ta Yes Ta Yes Ta >0 |
.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 \&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 Yes Ta Yes Ta 2 |
.It Sx \&Ev Ta Yes Ta Yes Ta >0 |
.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 >0 |
.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 Yes Ta Yes Ta >0 |
.It Sx \&Ft Ta Yes Ta Yes Ta >0 |
.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 |
Line 3017 then the macro accepts an arbitrary number of argument |
|
Line 3018 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Ns Ta Yes Ta Yes Ta 0 |
.It Sx \&Ns Ta Yes Ta Yes Ta 0 |
.It Sx \&Nx Ta Yes Ta Yes Ta n |
.It Sx \&Nx Ta Yes Ta Yes Ta n |
.It Sx \&Os Ta \&No Ta \&No Ta n |
.It Sx \&Os Ta \&No Ta \&No Ta n |
.It Sx \&Ot Ta \&No Ta \&No Ta n |
.It Sx \&Ot Ta Yes Ta Yes Ta >0 |
.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 Yes Ta Yes Ta 1 |
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
Line 3139 Manually switching the font using the |
|
Line 3140 Manually switching the font using the |
|
.Ql \ef |
.Ql \ef |
font escape sequences is never required. |
font escape sequences is never required. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other |
This section provides an incomplete list of compatibility issues |
troff implementations, at this time limited to GNU troff |
between mandoc and other troff implementations, at this time limited |
|
to GNU troff |
.Pq Qq groff . |
.Pq Qq groff . |
The term |
The term |
.Qq historic groff |
.Qq historic groff |
Line 3249 certain list types. |
|
Line 3251 certain list types. |
|
can only be called by other macros, but not at the beginning of a line. |
can only be called by other macros, but not at the beginning of a line. |
.It |
.It |
.Sx \&%C |
.Sx \&%C |
is not implemented. |
is not implemented (up to and including groff-1.22.2). |
.It |
.It |
Historic groff only allows up to eight or nine arguments per macro input |
Historic groff only allows up to eight or nine arguments per macro input |
line, depending on the exact situation. |
line, depending on the exact situation. |
Line 3267 in new groff and mandoc. |
|
Line 3269 in new groff and mandoc. |
|
.Sq \ef |
.Sq \ef |
.Pq font face |
.Pq font face |
and |
and |
.Sq \ef |
.Sq \eF |
.Pq font family face |
.Pq font family face |
.Sx Text Decoration |
.Sx Text Decoration |
escapes behave irregularly when specified within line-macro scopes. |
escapes behave irregularly when specified within line-macro scopes. |
|
|
.Fl offset Cm right . |
.Fl offset Cm right . |
Groff does not implement centred and flush-right rendering either, |
Groff does not implement centred and flush-right rendering either, |
but produces large indentations. |
but produces large indentations. |
.It |
|
The |
|
.Sq \eh |
|
.Pq horizontal position , |
|
.Sq \ev |
|
.Pq vertical position , |
|
.Sq \em |
|
.Pq text colour , |
|
.Sq \eM |
|
.Pq text filling colour , |
|
.Sq \ez |
|
.Pq zero-length character , |
|
.Sq \ew |
|
.Pq string length , |
|
.Sq \ek |
|
.Pq horizontal position marker , |
|
.Sq \eo |
|
.Pq text overstrike , |
|
and |
|
.Sq \es |
|
.Pq text size |
|
escape sequences are all discarded in mandoc. |
|
.It |
|
The |
|
.Sq \ef |
|
scaling unit is accepted by mandoc, but rendered as the default unit. |
|
.It |
|
In quoted literals, groff allows pairwise double-quotes to produce a |
|
standalone double-quote in formatted output. |
|
This is not supported by mandoc. |
|
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |