version 1.20, 2014/10/14 02:16:06 |
version 1.26, 2015/01/29 00:33:57 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 50 macro tags, whose precise syntax is documented in |
|
Line 50 macro tags, whose precise syntax is documented in |
|
Tables consist of a series of options on a single line, followed by the |
Tables consist of a series of options on a single line, followed by the |
table layout, followed by data. |
table layout, followed by data. |
.Pp |
.Pp |
For example, the following creates a boxed table with digits centred in |
For example, the following creates a boxed table with digits centered in |
the cells. |
the cells. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TS |
\&.TS |
|
|
in the case of |
in the case of |
.Xr man 7 . |
.Xr man 7 . |
.Ss Options |
.Ss Options |
The first line of a table consists of space-separated option keys and |
The first line of a table may contain options separated by spaces, tabs, |
modifiers terminated by a semicolon. |
or commas and terminated by a semicolon. |
If the first line does not have a terminating semicolon, it is assumed |
If the first line does not have a terminating semicolon, it is assumed |
that no options are specified and instead a |
that no options are specified and instead a |
.Sx Layout |
.Sx Layout |
is processed. |
is processed. |
Some options accept arguments enclosed by parenthesis. |
Some options require arguments enclosed by parentheses. |
The following case-insensitive options are available: |
The following case-insensitive options are available: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Cm center |
.It Cm allbox |
This option is not supported by |
Draw a single-line box around each table cell. |
.Xr mandoc 1 . |
Currently treated as a synonym for |
This may also be invoked with |
.Cm box . |
.Cm centre . |
|
.It Cm delim |
|
Accepts a two-character argument. |
|
This option is not supported by |
|
.Xr mandoc 1 . |
|
.It Cm expand |
|
This option is not supported by |
|
.Xr mandoc 1 . |
|
.It Cm box |
.It Cm box |
Draw a single-line box around the table. |
Draw a single-line box around the table. |
This may also be invoked with |
For GNU compatibility, this may also be invoked with |
.Cm frame . |
.Cm frame . |
|
.It Cm center |
|
Center the table instead of left-adjusting it. |
|
For GNU compatibility, this may also be invoked with |
|
.Cm centre . |
|
.It Cm decimalpoint |
|
Use the single-character argument as the decimal point with the |
|
.Cm n |
|
layout key. |
|
This is a GNU extension. |
|
.It Cm delim |
|
Use the two characters of the argument as |
|
.Xr eqn 7 |
|
delimiters. |
|
Currently unsupported. |
.It Cm doublebox |
.It Cm doublebox |
Draw a double-line box around the table. |
Draw a double-line box around the table. |
This may also be invoked with |
For GNU compatibility, this may also be invoked with |
.Cm doubleframe . |
.Cm doubleframe . |
.It Cm allbox |
.It Cm expand |
This option is not supported by |
Increase the width of the table to the current line length. |
.Xr mandoc 1 . |
Currently ignored. |
.It Cm tab |
|
Accepts a single-character argument. |
|
This character is used as a delimiter between data cells, which otherwise |
|
defaults to the tab character. |
|
.It Cm linesize |
.It Cm linesize |
Accepts a natural number (all digits). |
Draw lines with the point size given by the unsigned integer argument. |
This option is not supported by |
Currently ignored. |
.Xr mandoc 1 . |
|
.It Cm nokeep |
.It Cm nokeep |
This option is not supported by |
Allow page breaks within the table. |
.Xr mandoc 1 . |
This is a GNU extension and currently ignored. |
.It Cm decimalpoint |
|
Accepts a single-character argument. |
|
This character will be used as the decimal point with the |
|
.Cm n |
|
layout key. |
|
.It Cm nospaces |
.It Cm nospaces |
This option is not supported by |
Ignore leading and trailing spaces in data cells. |
.Xr mandoc 1 . |
This is a GNU extension and currently ignored. |
|
.It Cm nowarn |
|
Suppress warnings about tables exceeding the current line length. |
|
This is a GNU extension and currently ignored. |
|
.It Cm tab |
|
Use the single-character argument as a delimiter between data cells. |
|
By default, the tab character is used. |
.El |
.El |
.Ss Layout |
.Ss Layout |
The table layout follows |
The table layout follows |
Line 198 Layout lines may also be separated by a comma. |
|
Line 200 Layout lines may also be separated by a comma. |
|
Each layout cell consists of one of the following case-insensitive keys: |
Each layout cell consists of one of the following case-insensitive keys: |
.Bl -tag -width 2n |
.Bl -tag -width 2n |
.It Cm c |
.It Cm c |
Centre a literal string within its column. |
Center a literal string within its column. |
.It Cm r |
.It Cm r |
Right-justify a literal string within its column. |
Right-justify a literal string within its column. |
.It Cm l |
.It Cm l |
Line 248 The following case-insensitive modifier keys are avail |
|
Line 250 The following case-insensitive modifier keys are avail |
|
.Bl -tag -width 2n |
.Bl -tag -width 2n |
.It Cm b |
.It Cm b |
Use a bold font for the contents of this column. |
Use a bold font for the contents of this column. |
|
.It Cm d |
|
Move cell content down to the last cell of a vertical span. |
|
Currently ignored. |
.It Cm e |
.It Cm e |
Make this column wider to match the maximum width |
Make this column wider to match the maximum width |
of any other column also having the |
of any other column also having the |
|
|
manual for supported one-character font names. |
manual for supported one-character font names. |
.It Cm i |
.It Cm i |
Use an italic font for the contents of this column. |
Use an italic font for the contents of this column. |
|
.It Cm m |
|
Specify a cell start macro. |
|
This is a GNU extension and currently unsupported. |
|
.It Cm p |
|
Set the point size to the following unsigned argument, |
|
or change it by the following signed argument. |
|
Currently ignored. |
|
.It Cm v |
|
Set the vertical line spacing to the following unsigned argument, |
|
or change it by the following signed argument. |
|
Currently ignored. |
|
.It Cm t |
|
Do not vertically center cell content in the vertical span, |
|
leave it at the top. |
|
Currently ignored. |
|
.It Cm u |
|
Move cell content up by half a table line. |
|
Currently ignored. |
|
.It Cm w |
|
Specify minimum column width. |
|
Currently ignored. |
.It Cm x |
.It Cm x |
After determining the width of all other columns, distribute the |
After determining the width of all other columns, distribute the |
rest of the line length among all columns having the |
rest of the line length among all columns having the |
|
|
Do not use this cell for determining the width of this column. |
Do not use this cell for determining the width of this column. |
.El |
.El |
.Pp |
.Pp |
The modifiers |
For example, the following layout specifies a center-justified column of |
.Cm d , |
|
.Cm t , |
|
.Cm u , |
|
and |
|
.Cm w |
|
are ignored by |
|
.Xr mandoc 1 . |
|
.Pp |
|
For example, the following layout specifies a centre-justified column of |
|
minimum width 10, followed by vertical bar, followed by a left-justified |
minimum width 10, followed by vertical bar, followed by a left-justified |
column of minimum width 10, another vertical bar, then a column using |
column of minimum width 10, another vertical bar, then a column using |
bold font justified about the decimal point in numbers: |
bold font justified about the decimal point in numbers: |
Line 311 It may then be followed by a tab |
|
Line 328 It may then be followed by a tab |
|
.Pq or as designated by Cm tab |
.Pq or as designated by Cm tab |
or an end-of-line to terminate the row. |
or an end-of-line to terminate the row. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other |
|
.Nm |
|
implementations, at this time limited to GNU tbl. |
|
.Pp |
|
.Bl -dash -compact |
|
.It |
|
In GNU tbl, comments and macros are disallowed prior to the data block |
|
of a table. |
|
The |
The |
.Xr mandoc 1 |
.Xr mandoc 1 |
implementation allows them. |
implementation of |
.El |
.Nm |
|
doesn't support |
|
.Xr mdoc 7 |
|
and |
|
.Xr man 7 |
|
macros and |
|
.Xr eqn 7 |
|
equations inside tables. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr man 7 , |
.Xr man 7 , |