mandoc/tbl.7 - diff

Return to tbl.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/tbl.7 between version 1.1 and 1.20

version 1.1, 2011/01/04 23:32:21

version 1.20, 2014/10/14 02:16:06

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 49 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

table layout, followed by data.

.Pp

For example, the following creates a boxed table with digits centered in

For example, the following creates a boxed table with digits centred in

the cells.

.Bd -literal -offset indent

\&.TS

Line 76 and

Line 77 and

.Sq TE

.Xr roff 7

macros.

A table consists of an optional single line of table options terminated

A table consists of an optional single line of table

by a semicolon, followed by one or more lines of layout specification

.Sx Options

terminated by a period, then table data.

terminated by a semicolon, followed by one or more lines of

.Sx Layout

specifications terminated by a period, then

.Sx Data .

All input must be 7-bit ASCII.

Example:

.Bd -literal -offset indent

Line 95 Table data is

Line 99 Table data is

.Em pre-processed ,

that is, data rows are parsed then inserted into the underlying stream

of input data.

This allows data rows to be interspersed by arbitrary

.Xr roff 7 ,

.Xr mdoc 7 ,

and

Line 128 c c c.

Line 132 c c c.

.Pp

in the case of

.Xr man 7 .

.Ss Table Options

.Ss Options

The first line of a table consists of its options, which consists of

The first line of a table consists of space-separated option keys and

space-separated keys and modifiers terminated by a semicolon.

modifiers terminated by a semicolon.

If the first line does not have a terminating semicolon, it is assumed

that no options are specified and instead a layout is processed.

that no options are specified and instead a

Some options accept arguments enclosed by paranthesis.

.Sx Layout

is processed.

Some options accept arguments enclosed by parenthesis.

The following case-insensitive options are available:

.Bl -tag -width Ds

.It Cm center

Line 161 This option is not supported by

Line 167 This option is not supported by

.Xr mandoc 1 .

.It Cm tab

Accepts a single-character argument.

This character is used a delimiter between data cells, which otherwise

This character is used as a delimiter between data cells, which otherwise

defaults to the tab character.

.It Cm linesize

Accepts a natural number (all digits).

Line 175 Accepts a single-character argument.

Line 181 Accepts a single-character argument.

This character will be used as the decimal point with the

.Cm n

layout key.

This option is not supported by

.Xr mandoc 1 .

.It Cm nospaces

This option is not supported by

.Xr mandoc 1 .

.El

.Ss Table Layout

.Ss Layout

The table layout follows table options, except in the case of

The table layout follows

.Sx \&T& ,

.Sx Options

where it immediately procedes invocation.

or a

.Sq \&T&

macro invocation.

Layout specifies how data rows are displayed on output.

Each layout line corresponds to a line of data; the last layout line

applies to all remaining data lines.

Layout lines may also be separated by a comma.

Each layout cell consists of one of the following case-insensitive keys:

.Bl -tag -width Ds

.Bl -tag -width 2n

.It Cm c

Centre a literal string within its column.

.It Cm r

Line 198 Right-justify a literal string within its column.

Line 204 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.

Justify a number around its last decimal point.

If the decimal point is not found on the number, it's assumed to trail

the number.

.It Cm s

Horizontally span columns from the last

.No non- Ns Cm s

data cell.

It is an error if spanning columns follow a

.Cm \-

.Cm \(ba

cell, or come first.

This option is not supported by

.Xr mandoc 1 .

.It Cm a

This option is not supported by

Left-justify a literal string and pad with one space.

.Xr mandoc 1 .

.It Cm ^

This option is not supported by

Vertically span rows from the last

.Xr mandoc 1 .

.No non- Ns Cm ^

data cell.

It is an error to invoke a vertical span on the first layout row.

Unlike a horizontal spanner, you must specify an empty cell (if it not

empty, the data is discarded) in the corresponding data cell.

.It Cm \-

Replace the data cell (its contents will be lost) with a single

horizontal line.

Line 224 Emit a vertical bar instead of data.

Line 241 Emit a vertical bar instead of data.

Emit a double-vertical bar instead of data.

.El

.Pp

For example, following layout specifies a centre-justified column of

minimum width 10, followed by vertical bar, followed by a left-justified

column of minimum width 10, another vertical bar, then a column

justified about the decimal point in numbers:

.Pp

.Dl c10 | l10 | n

.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 minimum width of a column.

The following case-insensitive modifier keys are available:

.Cm z ,

.Bl -tag -width 2n

.Cm u ,

.It Cm b

.Cm e ,

Use a bold font for the contents of this column.

.Cm t ,

.It Cm e

Make this column wider to match the maximum width

of any other column also having the

.Cm e

modifier.

.It Cm f

The next character selects the font to use for this column.

See the

.Xr roff 7

manual for supported one-character font names.

.It Cm i

Use an italic font for the contents of this column.

.It Cm x

After determining the width of all other columns, distribute the

rest of the line length among all columns having the

.Cm x

modifier.

.It Cm z

Do not use this cell for determining the width of this column.

.El

.Pp

The modifiers

.Cm d ,

.Cm f ,

.Cm t ,

.Cm b ,

.Cm u ,

.Cm i ,

.Cm b ,

and

.Cm i .

.Cm w

All of these are ignored by

are ignored by

.Xr mandoc 1 .

.Ss Table Data

.Pp

For example, the following layout specifies a centre-justified column of

minimum width 10, followed by vertical bar, followed by a left-justified

column of minimum width 10, another vertical bar, then a column using

bold font justified about the decimal point in numbers:

.Pp

.Dl c10 | l10 | nfB

.Ss Data

The data section follows the last layout row.

By default, cells in a data section are delimited by a tab.

This behaviour may be changed with the

Line 264 If

Line 300 If

.Cm \e-

.Cm \e=

is specified, a line is drawn within the data field (i.e., terminating

is specified, a line is drawn within the data field (i.e. terminating

within the cell and not draw to the border).

If the last cell of a line is

.Cm T{ ,

all subsequent lines are included as part of the cell until

.Cm T}

is specified on its own line.

is specified as its own data cell.

It may then be followed by a tab

.Pq or as designated by Cm tab

or an end-of-line to terminate the row.

.Sh COMPATIBILITY

This section documents compatibility between mandoc and other

.Nm

Line 286 implementation allows them.

Line 325 implementation allows them.

.El

.Sh SEE ALSO

.Xr mandoc 1 ,

.Xr mandoc_char 7 ,

.Xr roff 7 ,

.Xr man 7 ,

.Xr mdoc 7

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr roff 7

.Rs

.%A M. E. Lesk

.%T Tbl\(emA Program to Format Tables

Line 306 This formed the basis of the implementation that is pa

Line 345 This formed the basis of the implementation that is pa

.Xr mandoc 1

utility.

.Sh AUTHORS

This partial

This

.Nm

reference was written by

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

CVSweb