In mdoc(7), don't mistreat negative .sp arguments as large positive ones.

[mandoc.git] / tbl.7

diff --git a/tbl.7 b/tbl.7
index 11dc12cbde556c235b181b17bbdbc1db73ac1783..c8fa8e48449903a0862e74af82c474aaaaa5e9bb 100644 (file)
--- a/tbl.7
+++ b/tbl.7
@@ -1,6 +1,7 @@
-.\"    $Id: tbl.7,v 1.3 2011/01/05 20:02:34 kristaps Exp $
+.\"    $Id: tbl.7,v 1.26 2015/01/29 00:33:57 schwarze Exp $

 .\"
 .\"

-.\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: January 5 2011 $
+.Dd $Mdocdate: January 29 2015 $

 .Dt TBL 7
 .Os
 .Sh NAME
 .Dt TBL 7
 .Os
 .Sh NAME


@@ -132,59 +133,59 @@ c c c.
 in the case of
 .Xr man 7 .
 .Ss Options
 in the case of
 .Xr man 7 .
 .Ss Options

-The first line of a table consists of space-separated option keys and
-modifiers terminated by a semicolon.
+The first line of a table may contain options separated by spaces, tabs,
+or commas and 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
 .Sx Layout
 is processed.
 If the first line does not have a terminating semicolon, it is assumed
 that no options are specified and instead a
 .Sx Layout
 is processed.

-Some options accept arguments enclosed by parenthesis.
+Some options require arguments enclosed by parentheses.

 The following case-insensitive options are available:
 .Bl -tag -width Ds
 The following case-insensitive options are available:
 .Bl -tag -width Ds

-.It Cm center
-This option is not supported by
-.Xr mandoc 1 .
-This may also be invoked with
-.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 allbox
+Draw a single-line box around each table cell.
+Currently treated as a synonym for
+.Cm box .

 .It Cm box
 Draw a single-line box around the table.
 .It Cm box
 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
 Draw a double-line box around the table.
 .It Cm doublebox
 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
-This option is not supported by
-.Xr mandoc 1 .
-.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 expand
+Increase the width of the table to the current line length.
+Currently ignored.

 .It Cm linesize
 .It Cm linesize

-Accepts a natural number (all digits).
-This option is not supported by
-.Xr mandoc 1 .
+Draw lines with the point size given by the unsigned integer argument.
+Currently ignored.

 .It Cm nokeep
 .It Cm nokeep

-This option is not supported by
-.Xr mandoc 1 .
-.It Cm decimalpoint
-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 .
+Allow page breaks within the table.
+This is a GNU extension and currently ignored.

 .It Cm nospaces
 .It Cm nospaces

-This option is not supported by
-.Xr mandoc 1 .
+Ignore leading and trailing spaces in data cells.
+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
 .Ss Layout
 The table layout follows
 .El
 .Ss Layout
 The table layout follows


@@ -197,26 +198,37 @@ 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:
 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
 .It Cm c

-Centre a literal string within its column.
+Center 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
 .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.
+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
 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 \-
+or
+.Cm \(ba
+cell, or come first.

 This option is not supported by
 .Xr mandoc 1 .
 .It Cm a
 This option is not supported by
 .Xr mandoc 1 .
 .It Cm a

-This option is not supported by
-.Xr mandoc 1 .
+Left-justify a literal string and pad with one space.

 .It Cm ^
 .It Cm ^

-This option is not supported by
-.Xr mandoc 1 .
+Vertically span rows from the last
+.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.
 .It Cm \-
 Replace the data cell (its contents will be lost) with a single
 horizontal line.


@@ -231,30 +243,64 @@ Emit a vertical bar instead of data.
 Emit a double-vertical bar instead of data.
 .El
 .Pp
 Emit a double-vertical bar instead of data.
 .El
 .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
-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
 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:
 The following case-insensitive modifier keys are available:

-.Cm z ,
-.Cm u ,
-.Cm e ,
-.Cm t ,
-.Cm d ,
-.Cm f ,
-.Cm b ,
-.Cm i ,
-.Cm b ,
-and
-.Cm i .
-All of these are ignored by
-.Xr mandoc 1 .
+.Bl -tag -width 2n
+.It Cm b
+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
+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 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
+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
+For example, the following layout specifies a center-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.
 .Ss Data
 The data section follows the last layout row.
 By default, cells in a data section are delimited by a tab.


@@ -277,20 +323,22 @@ If the last cell of a line is
 .Cm T{ ,
 all subsequent lines are included as part of the cell until
 .Cm T}
 .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
 .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
 .Xr mandoc 1
 The
 .Xr mandoc 1

-implementation allows them.
-.El
+implementation of
+.Nm
+doesn't support
+.Xr mdoc 7
+and
+.Xr man 7
+macros and
+.Xr eqn 7
+equations inside tables.

 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr man 7 ,
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr man 7 ,


@@ -313,7 +361,7 @@ This formed the basis of the implementation that is part of the
 .Xr mandoc 1
 utility.
 .Sh AUTHORS
 .Xr mandoc 1
 utility.
 .Sh AUTHORS

-This partial
+This

 .Nm
 reference was written by
 .Nm
 reference was written by

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