[BACK]Return to tbl.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/tbl.7 between version 1.14 and 1.26

version 1.14, 2011/08/18 08:58:44 version 1.26, 2015/01/29 00:33:57
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2010, 2011 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  .\" 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 69  c5 c5 c5.
Line 70  c5 c5 c5.
 4:5:6  4:5:6
 .TE  .TE
 .Ed  .Ed
 .Pp  
 The  
 .Nm  
 implementation in  
 .Xr mandoc 1  
 is  
 .Ud  
 .Sh TABLE STRUCTURE  .Sh TABLE STRUCTURE
 Tables are enclosed by the  Tables are enclosed by the
 .Sq TS  .Sq TS
Line 139  c c c.
Line 133  c c c.
 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 202  Each layout line corresponds to a line of data; the la
Line 198  Each layout line corresponds to a line of data; the la
 applies to all remaining data lines.  applies to all remaining data lines.
 Layout lines may also be separated by a comma.  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 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  .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 251  Keys may be followed by a set of modifiers.
Line 247  Keys may be followed by a set of modifiers.
 A modifier is either a modifier key or a natural number for specifying  A modifier is either a modifier key or a natural number for specifying
 the minimum width of a column.  the minimum width of a column.
 The following case-insensitive modifier keys are available:  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 d
 .Cm d ,  Move cell content down to the last cell of a vertical span.
 .Cm f ,  Currently ignored.
 .Cm b ,  .It Cm e
 .Cm i ,  Make this column wider to match the maximum width
 .Cm b ,  of any other column also having the
 and  .Cm e
 .Cm i .  modifier.
 All of these are ignored by  .It Cm f
 .Xr mandoc 1 .  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  .Pp
 For example, the following layout specifies a centre-justified column of  For example, the following layout specifies a center-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  column of minimum width 10, another vertical bar, then a column using
 justified about the decimal point in numbers:  bold font justified about the decimal point in numbers:
 .Pp  .Pp
 .Dl c10 | l10 | n  .Dl c10 | l10 | nfB
 .Ss Data  .Ss Data
 The data section follows the last layout row.  The data section follows the last layout row.
 By default, cells in a data section are delimited by a tab.  By default, cells in a data section are delimited by a tab.
Line 298  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 ,
Line 335  utility.
Line 364  utility.
 This  This
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.26
CVSweb