version 1.189, 2011/07/11 08:45:02 |
version 1.191, 2011/07/18 10:23:02 |
|
|
.Em SYNOPSIS |
.Em SYNOPSIS |
section line, else it is |
section line, else it is |
.Sx In-line . |
.Sx In-line . |
|
.Ss Special block macro |
|
The |
|
.Sx \&Ta |
|
macro can only be used below |
|
.Sx \&It |
|
in |
|
.Sx \&Bl Fl column |
|
lists. |
|
It delimits blocks representing table cells; |
|
these blocks have bodies, but no heads. |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
|
.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It |
|
.El |
.Ss In-line |
.Ss In-line |
Closed by |
Closed by |
.Sx Reserved Terms , |
.Sx Reserved Terms , |
|
|
.Sx \&Dv |
.Sx \&Dv |
for general constants. |
for general constants. |
.Ss \&Ex |
.Ss \&Ex |
Insert a standard sentence regarding exit values. |
Insert a standard sentence regarding command exit values of 0 on success |
|
and >0 on failure. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Ex Fl std Op Ar utility |
.D1 Pf \. Sx \&Ex Fl std Op Ar utility... |
.Pp |
.Pp |
When |
If |
.Ar utility |
.Ar utility |
is not specified, the document's name set by |
is not specified, the document's name set by |
.Sx \&Nm |
.Sx \&Nm |
is used. |
is used. |
|
Multiple |
|
.Ar utility |
|
arguments are treated as separate utilities. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Rv . |
.Sx \&Rv . |
|
|
.Sx \&Fc , |
.Sx \&Fc , |
and |
and |
.Sx \&Ft . |
.Sx \&Ft . |
|
.Ss \&Fr |
|
This macro is obsolete and not implemented. |
.Ss \&Ft |
.Ss \&Ft |
A function type. |
A function type. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
list is the most complicated. |
list is the most complicated. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It Op Cm args |
.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ... |
|
.D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ... |
.Pp |
.Pp |
The |
The arguments consist of one or more lines of text and macros |
.Cm args |
representing a complete table line. |
are phrases, a mix of macros and text corresponding to a line column, |
Cells within the line are delimited by tabs or by the special |
delimited by tabs or the special |
.Sx \&Ta |
.Sq \&Ta |
block macro. |
pseudo-macro. |
The tab cell delimiter may only be used within the |
Lines subsequent the |
|
.Sx \&It |
.Sx \&It |
are interpreted within the scope of the last phrase. |
line itself; on following lines, only the |
Calling the pseudo-macro |
.Sx \&Ta |
.Sq \&Ta |
macro can be used to delimit cells, and |
will open a new phrase scope (this must occur on a macro line to be |
.Sx \&Ta |
interpreted as a macro). |
is only recognized as a macro when called by other macros, |
Note that the tab phrase delimiter may only be used within the |
not as the first macro on a line. |
|
.Pp |
|
Note that quoted strings may span tab-delimited cells on an |
.Sx \&It |
.Sx \&It |
line itself. |
line. |
Subsequent this, only the |
For example, |
.Sq \&Ta |
|
pseudo-macro may be used to delimit phrases. |
|
Furthermore, note that quoted sections propagate over tab-delimited |
|
phrases on an |
|
.Sx \&It , |
|
for example, |
|
.Pp |
.Pp |
.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
.Pp |
.Pp |
Line 2449 block is used within a SEE ALSO section, a vertical sp |
|
Line 2466 block is used within a SEE ALSO section, a vertical sp |
|
before the rendered output, else the block continues on the current |
before the rendered output, else the block continues on the current |
line. |
line. |
.Ss \&Rv |
.Ss \&Rv |
Inserts text regarding a function call's return value. |
Insert a standard sentence regarding a system call's return value of 0 |
This macro must consist of the |
on success and \-1 on error, with the |
.Fl std |
.Va errno |
argument followed by an optional |
libc global variable set on error. |
.Ar function . |
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Rv Fl std Op Ar function... |
|
.Pp |
If |
If |
.Ar function |
.Ar function |
is not provided, the document's name as stipulated by the first |
is not specified, the document's name set by |
.Sx \&Nm |
.Sx \&Nm |
is provided. |
is used. |
|
Multiple |
|
.Ar function |
|
arguments are treated as separate functions. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Ex . |
.Sx \&Ex . |
|
|
.Sx \&Li , |
.Sx \&Li , |
and |
and |
.Sx \&Em . |
.Sx \&Em . |
|
.Ss \&Ta |
|
Table cell separator in |
|
.Sx \&Bl Fl column |
|
lists; can only be used below |
|
.Sx \&It . |
.Ss \&Tn |
.Ss \&Tn |
Format a tradename. |
Format a tradename. |
.Pp |
.Pp |
Line 2792 Newer groff and mandoc print |
|
Line 2820 Newer groff and mandoc print |
|
.Qq AT&T UNIX |
.Qq AT&T UNIX |
and the arguments. |
and the arguments. |
.It |
.It |
.Sx \&Bd Fl column |
.Sx \&Bl Fl column |
does not recognize trailing punctuation characters when they immediately |
does not recognize trailing punctuation characters when they immediately |
precede tabulator characters, but treats them as normal text and |
precede tabulator characters, but treats them as normal text and |
outputs a space before them. |
outputs a space before them. |