tbl/tbl.man

   1 .\" -*- nroff -*-
   2 .TH @G@TBL @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
   3 .SH NAME
   4 @g@tbl \- format tables for troff
   5 .SH SYNOPSIS
   6 .B @g@tbl
   7 [
   8 .B \-Cv
   9 ]
  10 [
  11 .IR files \|.\|.\|.
  12 ]
  13 .SH DESCRIPTION
  14 This manual page describes the GNU version of
  15 .BR tbl ,
  16 which is part of the groff document formatting system.
  17 .B tbl
  18 compiles descriptions of tables embedded within
  19 .B troff
  20 input files into commands that are understood by
  21 .BR troff .
  22 Normally, it should be invoked using the
  23 .B \-t
  24 option of
  25 .B groff.
  26 It is highly compatible with Unix
  27 .BR tbl .
  28 The output generated by GNU
  29 .B tbl
  30 cannot be processed with Unix
  31 .BR troff ;
  32 it must be processed with GNU
  33 .BR troff .
  34 If no files are given on the command line, the standard input
  35 will be read.
  36 A filename of
  37 .B \-
  38 will cause the standard input to be read.
  39 .SH OPTIONS
  40 .TP
  41 .B \-C
  42 Recognize
  43 .B .TS
  44 and
  45 .B .TE
  46 even when followed by a character other than space or newline.
  47 .TP
  48 .B \-v
  49 Print the version number.
  50 .SH USAGE
  51 Only the differences between GNU
  52 .B tbl
  53 and Unix
  54 .B tbl
  55 are described here.
  56 .LP
  57 The
  58 .B f
  59 format modifier can be followed by an arbitrary length
  60 font name in parentheses.
  61 .LP
  62 There is a
  63 .B d
  64 format modifier which means that a vertically spanning entry
  65 should be aligned at the bottom of its range.
  66 .LP
  67 There is no limit on the number of columns in a table, nor any limit
  68 on the number of text blocks.
  69 All the lines of a table are considered in deciding column
  70 widths, not just the first 200.
  71 Table continuation
  72 .RB ( .T& )
  73 lines are not restricted to the first 200 lines.
  74 .LP
  75 Numeric and alphabetic items may appear in the same column.
  76 .LP
  77 Numeric and alphabetic items may span horizontally.
  78 .LP
  79 .B tbl
  80 uses register, string, macro and diversion names beginning with
  81 .BR 3 .
  82 When using
  83 .B tbl
  84 you should avoid using any names beginning with a
  85 .BR 3 .
  86 .SH BUGS
  87 You should use
  88 .BR .TS\ H / .TH
  89 for
  90 .I all
  91 multi-page boxed tables.
  92 If there is no header that you wish to appear at the top of each page
  93 of the table, place the
  94 .B .TH
  95 line immediately after the format section.
  96 Do not enclose a multi-page table within keep/release macros,
  97 or divert it in any other way.
  98 .LP
  99 A text block within a table must be able to fit on one page.
 100 .LP
 101 The
 102 .B bp
 103 request cannot be used to force a page-break in a multi-page table.
 104 Instead, define
 105 .B BP
 106 as follows
 107 .IP
 108 .B .de BP
 109 .br
 110 .B .ie '\e\en(.z'' .bp \e\e$1
 111 .br
 112 .B .el \e!.BP \e\e$1
 113 .br
 114 .B ..
 115 .br
 116 .LP
 117 and use
 118 .B BP
 119 instead of
 120 .BR bp .
 121 .SH "SEE ALSO"
 122 .BR groff (@MAN1EXT@),
 123 .BR @g@troff (@MAN1EXT@)