version 1.19, 2010/12/29 15:21:34 |
version 1.20, 2011/01/03 16:04:41 |
Line 535 This request is intended to have one argument, |
|
Line 535 This request is intended to have one argument, |
|
consisting of an even number of characters. |
consisting of an even number of characters. |
Currently, it is ignored including its arguments, |
Currently, it is ignored including its arguments, |
and the number of arguments is not checked. |
and the number of arguments is not checked. |
.\" .Ss \&T& |
.Ss \&T& |
.\" Re-start a table layout, retaining the options of the prior table |
Re-start a table layout, retaining the options of the prior table |
.\" invocation. |
invocation. |
.\" See |
See |
.\" .Sx \&TS . |
.Sx \&TS . |
.\" .Ss \&TE |
.Ss \&TE |
.\" End a table context. |
End a table context. |
.\" See |
See |
.\" .Sx \&TS . |
.Sx \&TS . |
.\" .Ss \&TS |
.Ss \&TS |
.\" Begin a table, which formats input in aligned rows and columns. |
Begin a table, which formats input in aligned rows and columns. |
.\" A table consists of an optional single line of table options terminated |
A table consists of an optional single line of table options terminated |
.\" by a semicolon, followed by one or more lines of layout specification |
by a semicolon, followed by one or more lines of layout specification |
.\" terminated by a period, then table data. |
terminated by a period, then table data. |
.\" A table block may also include |
A table block may also include |
.\" .Nm , |
.Nm , |
.\" .Xr mdoc 7 , |
.Xr mdoc 7 , |
.\" or |
or |
.\" .Xr man 7 |
.Xr man 7 |
.\" macros. |
macros. |
.\" .Pp |
Example: |
.\" Table data is |
.Bd -literal -offset indent |
.\" .Em pre-processed , |
\&.TS |
.\" that is, data rows are parsed then inserted into the underlying stream |
box tab(:); \e" Table-wide options. |
.\" of input data. |
c | c \e" Layout for first line. |
.\" This allows data rows to be interspersed by arbitrary macros, such as |
| c | c. \e" Layout for all subsequent lines. |
.\" .Bd -literal -offset indent |
1:2 \e" Data... |
.\" \&.TS |
3:4 |
.\" c c c. |
\&.TE |
.\" 1 2 3 |
.Ed |
.\" \&.Ao |
.Pp |
.\" 3 2 1 |
Table data is |
.\" \&.Ac |
.Em pre-processed , |
.\" \&.TE |
that is, data rows are parsed then inserted into the underlying stream |
.\" .Ed |
of input data. |
.\" .Pp |
This allows data rows to be interspersed by arbitrary macros, such as |
.\" in the case of |
.Bd -literal -offset indent |
.\" .Xr mdoc 7 |
\&.TS |
.\" or |
tab(:); |
.\" .Bd -literal -offset indent |
c c c. |
.\" \&.TS |
1:2:3 |
.\" c c c. |
\&.Ao |
.\" \&.ds ab 2 |
3:2:1 |
.\" 1 \e*(ab 3 |
\&.Ac |
.\" \&.I |
\&.TE |
.\" 3 2 1 |
.Ed |
.\" \&.TE |
.Pp |
.\" .Ed |
in the case of |
.\" .Pp |
.Xr mdoc 7 |
.\" in the case of |
or |
.\" .Xr man 7 . |
.Bd -literal -offset indent |
.\" .Pp |
\&.TS |
.\" The first line of a table consists of its options, which consists of |
tab(:); |
.\" space-separated keys and modifiers terminated by a semicolon. |
c c c. |
.\" If the first line does not have a terminating semicolon, it is assumed |
\&.ds ab 2 |
.\" that no options are specified and instead a layout is processed. |
1:\e*(ab:3 |
.\" Some options accept arguments enclosed by paranthesis. |
\&.I |
.\" The following case-insensitive options are available: |
3:2:1 |
.\" .Bl -tag -width Ds |
\&.TE |
.\" .It Cm center |
.Ed |
.\" This may also be invoked with |
.Pp |
.\" .Cm centre . |
in the case of |
.\" .It Cm delim |
.Xr man 7 . |
.\" Accepts a two-character argument. |
.Pp |
.\" This option is ignored. |
The first line of a table consists of its options, which consists of |
.\" .It Cm expand |
space-separated keys and modifiers terminated by a semicolon. |
.\" .It Cm box |
If the first line does not have a terminating semicolon, it is assumed |
.\" This may also be invoked with |
that no options are specified and instead a layout is processed. |
.\" .Cm frame . |
Some options accept arguments enclosed by paranthesis. |
.\" .It Cm doublebox |
The following case-insensitive options are available: |
.\" This may also be invoked with |
.Bl -tag -width Ds |
.\" .Cm doubleframe . |
.It Cm center |
.\" .It Cm allbox |
This option is not supported by |
.\" .It Cm tab |
.Xr mandoc 1 . |
.\" Accepts a single character argument used as the delimiter for cells in |
This may also be invoked with |
.\" data rows. |
.Cm centre . |
.\" .It Cm linesize |
.It Cm delim |
.\" Accepts a natural number (all digits) used as the line width for drawing |
Accepts a two-character argument. |
.\" boxes. |
This option is not supported by |
.\" .It Cm nokeep |
.Xr mandoc 1 . |
.\" .It Cm decimalpoint |
.It Cm expand |
.\" .It Cm nospaces |
This option is not supported by |
.\" .El |
.Xr mandoc 1 . |
.\" .Pp |
.It Cm box |
.\" The table layout follows table options, except in the case of |
Draw a single-line box around the table. |
.\" .Sx \&T& , |
This may also be invoked with |
.\" where it immediately procedes invocation. |
.Cm frame . |
.\" Layout specifies how data rows are displayed on output. |
.It Cm doublebox |
.\" Each layout line corresponds to a line of data; the last layout line |
Draw a double-line box around the table. |
.\" applies to all remaining data lines. |
This may also be invoked with |
.\" Layout lines may also be separated by a comma. |
.Cm doubleframe . |
.\" Each layout cell consists of one of the following case-insensitive keys: |
.It Cm allbox |
.\" .Bl -tag -width Ds |
This option is not supported by |
.\" .It Cm c |
.Xr mandoc 1 . |
.\" .It Cm r |
.It Cm tab |
.\" .It Cm l |
Accepts a single-character argument. |
.\" .It Cm n |
This character is used a delimiter between data cells, which otherwise |
.\" .It Cm s |
defaults to the tab character. |
.\" .It Cm a |
.It Cm linesize |
.\" .It Cm ^ |
Accepts a natural number (all digits). |
.\" .It Cm \- |
This option is not supported by |
.\" This may also be invoked with |
.Xr mandoc 1 . |
.\" .Cm _ . |
.It Cm nokeep |
.\" .It Cm = |
This option is not supported by |
.\" .It Cm \(ba |
.Xr mandoc 1 . |
.\" .It Cm \(ba\(ba |
.It Cm decimalpoint |
.\" .El |
Accepts a single-character argument. |
.\" Keys may be followed by a set of modifiers. |
This character will be used as the decimal point with the |
.\" A modifier is either a modifier key or a natural number for specifying |
.Cm n |
.\" spacing. |
layout key. |
.\" The following case-insensitive modifier keys are available: |
This option is not supported by |
.\" .Bl -tag -width Ds |
.Xr mandoc 1 . |
.\" .It Cm z |
.It Cm nospaces |
.\" .It Cm u |
This option is not supported by |
.\" .It Cm e |
.Xr mandoc 1 . |
.\" .It Cm t |
.El |
.\" .It Cm d |
.Pp |
.\" .It Cm f |
The table layout follows table options, except in the case of |
.\" Must be followed by a case-insensitive font style: |
.Sx \&T& , |
.\" .Cm b |
where it immediately procedes invocation. |
.\" for bold or |
Layout specifies how data rows are displayed on output. |
.\" .Cm i |
Each layout line corresponds to a line of data; the last layout line |
.\" for italic. |
applies to all remaining data lines. |
.\" .It Cm b |
Layout lines may also be separated by a comma. |
.\" .It Cm i |
Each layout cell consists of one of the following case-insensitive keys: |
.\" .El |
.Bl -tag -width Ds |
|
.It Cm c |
|
Centre a literal string within its column. |
|
.It Cm r |
|
Right-justify a literal string within its column. |
|
.It Cm l |
|
Left-justify a literal string within its column. |
|
.It Cm n |
|
Justify a number around its decimal point. |
|
If the decimal point is not found on the number, it's assumed to trail |
|
the number. |
|
.It Cm s |
|
This option is not supported by |
|
.Xr mandoc 1 . |
|
.It Cm a |
|
This option is not supported by |
|
.Xr mandoc 1 . |
|
.It Cm ^ |
|
This option is not supported by |
|
.Xr mandoc 1 . |
|
.It Cm \- |
|
This may also be invoked with |
|
.Cm _ . |
|
.It Cm = |
|
.It Cm \(ba |
|
Emit a vertical bar instead of data. |
|
.It Cm \(ba\(ba |
|
Emit a double-vertical bar instead of data. |
|
.El |
|
.Pp |
|
Keys may be followed by a set of modifiers. |
|
A modifier is either a modifier key or a natural number for specifying |
|
spacing. |
|
The following case-insensitive modifier keys are available: |
|
.Bl -tag -width Ds |
|
.It Cm z |
|
.It Cm u |
|
.It Cm e |
|
.It Cm t |
|
.It Cm d |
|
.It Cm f |
|
Must be followed by a case-insensitive font style: |
|
.Cm b |
|
for bold or |
|
.Cm i |
|
for italic. |
|
.It Cm b |
|
.It Cm i |
|
.El |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other other |
This section documents compatibility between mandoc and other other |
.Nm |
.Nm |