man/gtbl.man

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