Blame


1 dfc67f9b 2004-05-16 devnull .TH TBL 1
2 dfc67f9b 2004-05-16 devnull .SH NAME
3 dfc67f9b 2004-05-16 devnull tbl \- format tables for nroff or troff
4 dfc67f9b 2004-05-16 devnull .SH SYNOPSIS
5 dfc67f9b 2004-05-16 devnull .B tbl
6 dfc67f9b 2004-05-16 devnull [
7 dfc67f9b 2004-05-16 devnull .I file ...
8 dfc67f9b 2004-05-16 devnull ]
9 dfc67f9b 2004-05-16 devnull .SH DESCRIPTION
10 dfc67f9b 2004-05-16 devnull .I Tbl
11 dfc67f9b 2004-05-16 devnull is a preprocessor for formatting tables for
12 dfc67f9b 2004-05-16 devnull .I nroff
13 dfc67f9b 2004-05-16 devnull or
14 d32deab1 2020-08-16 rsc .MR troff (1) .
15 dfc67f9b 2004-05-16 devnull The input
16 dfc67f9b 2004-05-16 devnull .I files
17 dfc67f9b 2004-05-16 devnull are copied to the standard output,
18 dfc67f9b 2004-05-16 devnull except for segments of the form
19 dfc67f9b 2004-05-16 devnull .IP
20 dfc67f9b 2004-05-16 devnull .nf
21 dfc67f9b 2004-05-16 devnull .B .TS
22 dfc67f9b 2004-05-16 devnull .IB options " ;
23 dfc67f9b 2004-05-16 devnull .IB format " .
24 dfc67f9b 2004-05-16 devnull .I data
25 dfc67f9b 2004-05-16 devnull .B .T&
26 dfc67f9b 2004-05-16 devnull .IB format " .
27 dfc67f9b 2004-05-16 devnull .I data
28 dfc67f9b 2004-05-16 devnull \&. . .
29 dfc67f9b 2004-05-16 devnull .B .TE
30 dfc67f9b 2004-05-16 devnull .fi
31 dfc67f9b 2004-05-16 devnull .LP
32 dfc67f9b 2004-05-16 devnull which describe tables
33 dfc67f9b 2004-05-16 devnull and are replaced by
34 dfc67f9b 2004-05-16 devnull .I troff
35 dfc67f9b 2004-05-16 devnull requests to lay out the tables.
36 dfc67f9b 2004-05-16 devnull If no arguments are given,
37 dfc67f9b 2004-05-16 devnull .I tbl
38 dfc67f9b 2004-05-16 devnull reads the standard input.
39 dfc67f9b 2004-05-16 devnull .PP
40 dfc67f9b 2004-05-16 devnull The (optional)
41 dfc67f9b 2004-05-16 devnull .I options
42 dfc67f9b 2004-05-16 devnull line is terminated by a semicolon and contains one or more
43 dfc67f9b 2004-05-16 devnull of
44 dfc67f9b 2004-05-16 devnull .RS
45 dfc67f9b 2004-05-16 devnull .TF linesize(n)
46 dfc67f9b 2004-05-16 devnull .TP
47 dfc67f9b 2004-05-16 devnull .B center
48 dfc67f9b 2004-05-16 devnull center the table; default is left-adjust
49 dfc67f9b 2004-05-16 devnull .TP
50 dfc67f9b 2004-05-16 devnull .B expand
51 dfc67f9b 2004-05-16 devnull make table as wide as current line length
52 dfc67f9b 2004-05-16 devnull .TP
53 dfc67f9b 2004-05-16 devnull .B box
54 dfc67f9b 2004-05-16 devnull .TP
55 dfc67f9b 2004-05-16 devnull .B doublebox
56 dfc67f9b 2004-05-16 devnull enclose the table in a box or double box
57 dfc67f9b 2004-05-16 devnull .TP
58 dfc67f9b 2004-05-16 devnull .B allbox
59 dfc67f9b 2004-05-16 devnull enclose every item in a box
60 dfc67f9b 2004-05-16 devnull .TP
61 dfc67f9b 2004-05-16 devnull .BI tab( x )
62 dfc67f9b 2004-05-16 devnull use
63 dfc67f9b 2004-05-16 devnull .I x
64 dfc67f9b 2004-05-16 devnull to separate input items; default is tab
65 dfc67f9b 2004-05-16 devnull .TP
66 dfc67f9b 2004-05-16 devnull .BI linesize( n )
67 dfc67f9b 2004-05-16 devnull set rules in
68 dfc67f9b 2004-05-16 devnull .IR n -point
69 dfc67f9b 2004-05-16 devnull type
70 dfc67f9b 2004-05-16 devnull .TP
71 dfc67f9b 2004-05-16 devnull .BI delim( xy )
72 dfc67f9b 2004-05-16 devnull recognize
73 dfc67f9b 2004-05-16 devnull .I x
74 dfc67f9b 2004-05-16 devnull and
75 dfc67f9b 2004-05-16 devnull .I y
76 dfc67f9b 2004-05-16 devnull as
77 d32deab1 2020-08-16 rsc .MR eqn (1)
78 dfc67f9b 2004-05-16 devnull delimiters
79 dfc67f9b 2004-05-16 devnull .PD
80 dfc67f9b 2004-05-16 devnull .RE
81 dfc67f9b 2004-05-16 devnull .PP
82 dfc67f9b 2004-05-16 devnull Each line, except the last, of the obligatory
83 dfc67f9b 2004-05-16 devnull .I format
84 dfc67f9b 2004-05-16 devnull describes one row of the table.
85 dfc67f9b 2004-05-16 devnull The last line describes all rows until the next
86 dfc67f9b 2004-05-16 devnull .BR .T& ,
87 dfc67f9b 2004-05-16 devnull where the format changes,
88 dfc67f9b 2004-05-16 devnull or the end of the table at
89 dfc67f9b 2004-05-16 devnull .BR .TE .
90 dfc67f9b 2004-05-16 devnull A format is specified by key letters, one per column, either upper or lower case:
91 dfc67f9b 2004-05-16 devnull .RS
92 dfc67f9b 2004-05-16 devnull .TP 0
93 dfc67f9b 2004-05-16 devnull .B L
94 dfc67f9b 2004-05-16 devnull Left justify: the default for
95 dfc67f9b 2004-05-16 devnull columns without format keys.
96 dfc67f9b 2004-05-16 devnull .PD0
97 dfc67f9b 2004-05-16 devnull .TP
98 dfc67f9b 2004-05-16 devnull .B R
99 dfc67f9b 2004-05-16 devnull Right justify.
100 dfc67f9b 2004-05-16 devnull .TP
101 dfc67f9b 2004-05-16 devnull .B C
102 dfc67f9b 2004-05-16 devnull Center.
103 dfc67f9b 2004-05-16 devnull .TP
104 dfc67f9b 2004-05-16 devnull .B N
105 dfc67f9b 2004-05-16 devnull Numeric: align at decimal point (inferred for integers) or at
106 dfc67f9b 2004-05-16 devnull .LR \e& .
107 dfc67f9b 2004-05-16 devnull .TP
108 dfc67f9b 2004-05-16 devnull .B S
109 dfc67f9b 2004-05-16 devnull Span: extend previous column across this one.
110 dfc67f9b 2004-05-16 devnull .TP
111 dfc67f9b 2004-05-16 devnull .B A
112 dfc67f9b 2004-05-16 devnull Alphabetic: left-aligned within column, widest item centered, indented relative to
113 dfc67f9b 2004-05-16 devnull .B L
114 dfc67f9b 2004-05-16 devnull rows.
115 dfc67f9b 2004-05-16 devnull .TP
116 dfc67f9b 2004-05-16 devnull .B ^
117 dfc67f9b 2004-05-16 devnull Vertical span: continue item from previous row into this row.
118 dfc67f9b 2004-05-16 devnull .TP
119 dfc67f9b 2004-05-16 devnull .B -
120 dfc67f9b 2004-05-16 devnull Draw a horizontal rule in this column.
121 dfc67f9b 2004-05-16 devnull .TP
122 dfc67f9b 2004-05-16 devnull .B =
123 dfc67f9b 2004-05-16 devnull Draw a double horizontal rule in this column.
124 dfc67f9b 2004-05-16 devnull .PD
125 dfc67f9b 2004-05-16 devnull .RE
126 dfc67f9b 2004-05-16 devnull .PP
127 dfc67f9b 2004-05-16 devnull Key letters may be followed by modifiers, also either case:
128 dfc67f9b 2004-05-16 devnull .RS
129 dfc67f9b 2004-05-16 devnull .TP \w'\fLF\fIfont\fLXX'u
130 dfc67f9b 2004-05-16 devnull .B |
131 dfc67f9b 2004-05-16 devnull Draw vertical rule between columns.
132 dfc67f9b 2004-05-16 devnull .PD0
133 dfc67f9b 2004-05-16 devnull .TP
134 dfc67f9b 2004-05-16 devnull .B ||
135 dfc67f9b 2004-05-16 devnull Draw a double vertical rule between columns.
136 dfc67f9b 2004-05-16 devnull .TP
137 dfc67f9b 2004-05-16 devnull .I n
138 dfc67f9b 2004-05-16 devnull Gap between column is
139 dfc67f9b 2004-05-16 devnull .I n
140 dfc67f9b 2004-05-16 devnull ens wide.
141 dfc67f9b 2004-05-16 devnull Default is 3.
142 dfc67f9b 2004-05-16 devnull .TP
143 dfc67f9b 2004-05-16 devnull .BI F font
144 dfc67f9b 2004-05-16 devnull Use specified
145 dfc67f9b 2004-05-16 devnull .IR font .
146 dfc67f9b 2004-05-16 devnull .B B
147 dfc67f9b 2004-05-16 devnull and
148 dfc67f9b 2004-05-16 devnull .B I
149 dfc67f9b 2004-05-16 devnull mean
150 dfc67f9b 2004-05-16 devnull .B FB
151 dfc67f9b 2004-05-16 devnull and
152 dfc67f9b 2004-05-16 devnull .BR FI .
153 dfc67f9b 2004-05-16 devnull .TP
154 dfc67f9b 2004-05-16 devnull .B T
155 dfc67f9b 2004-05-16 devnull Begin vertically-spanned item at top row of range; default is
156 dfc67f9b 2004-05-16 devnull vertical centering (with
157 dfc67f9b 2004-05-16 devnull .LR ^ ).
158 dfc67f9b 2004-05-16 devnull .TP
159 dfc67f9b 2004-05-16 devnull .BI P n
160 dfc67f9b 2004-05-16 devnull Use point size
161 dfc67f9b 2004-05-16 devnull .IR n .
162 dfc67f9b 2004-05-16 devnull .TP
163 dfc67f9b 2004-05-16 devnull .BI V n
164 dfc67f9b 2004-05-16 devnull Use
165 dfc67f9b 2004-05-16 devnull .IR n -point
166 dfc67f9b 2004-05-16 devnull vertical spacing in text block; signed
167 dfc67f9b 2004-05-16 devnull .I n
168 dfc67f9b 2004-05-16 devnull means relative change.
169 dfc67f9b 2004-05-16 devnull .TP
170 dfc67f9b 2004-05-16 devnull .BI W( n )
171 dfc67f9b 2004-05-16 devnull Column width as a
172 dfc67f9b 2004-05-16 devnull .I troff
173 dfc67f9b 2004-05-16 devnull width specification.
174 dfc67f9b 2004-05-16 devnull Parens are optional if
175 dfc67f9b 2004-05-16 devnull .I n
176 dfc67f9b 2004-05-16 devnull is a simple integer.
177 dfc67f9b 2004-05-16 devnull .TP
178 dfc67f9b 2004-05-16 devnull .B E
179 dfc67f9b 2004-05-16 devnull Equalize the widths of all columns marked
180 dfc67f9b 2004-05-16 devnull .BR E .
181 dfc67f9b 2004-05-16 devnull .PD
182 dfc67f9b 2004-05-16 devnull .RE
183 dfc67f9b 2004-05-16 devnull .PP
184 dfc67f9b 2004-05-16 devnull Each line of
185 dfc67f9b 2004-05-16 devnull .I data
186 dfc67f9b 2004-05-16 devnull becomes one row of the table; tabs separate items.
187 dfc67f9b 2004-05-16 devnull Lines beginning with
188 dfc67f9b 2004-05-16 devnull .L .
189 dfc67f9b 2004-05-16 devnull are
190 dfc67f9b 2004-05-16 devnull .I troff
191 dfc67f9b 2004-05-16 devnull requests.
192 dfc67f9b 2004-05-16 devnull Certain special data items are recognized:
193 dfc67f9b 2004-05-16 devnull .RS
194 dfc67f9b 2004-05-16 devnull .TP 0
195 dfc67f9b 2004-05-16 devnull .B _
196 dfc67f9b 2004-05-16 devnull Draw a horizontal rule in this column.
197 dfc67f9b 2004-05-16 devnull .PD0
198 dfc67f9b 2004-05-16 devnull .TP
199 dfc67f9b 2004-05-16 devnull .B =
200 dfc67f9b 2004-05-16 devnull Draw a double horizontal rule in this column.
201 dfc67f9b 2004-05-16 devnull A data line consisting of a single
202 dfc67f9b 2004-05-16 devnull .L _
203 dfc67f9b 2004-05-16 devnull or
204 dfc67f9b 2004-05-16 devnull .L =
205 dfc67f9b 2004-05-16 devnull draws the rule across the whole table.
206 dfc67f9b 2004-05-16 devnull .TP
207 dfc67f9b 2004-05-16 devnull .B \e_
208 dfc67f9b 2004-05-16 devnull Draw a rule only as wide as the contents of the column.
209 dfc67f9b 2004-05-16 devnull .TP
210 dfc67f9b 2004-05-16 devnull .BI \eR x
211 dfc67f9b 2004-05-16 devnull Repeat character
212 dfc67f9b 2004-05-16 devnull .I x
213 dfc67f9b 2004-05-16 devnull across the column.
214 dfc67f9b 2004-05-16 devnull .TP
215 dfc67f9b 2004-05-16 devnull .B \e^
216 dfc67f9b 2004-05-16 devnull Span the previous item in this column down into this row.
217 dfc67f9b 2004-05-16 devnull .TP
218 dfc67f9b 2004-05-16 devnull .B T{
219 dfc67f9b 2004-05-16 devnull The item is a text block to be separately formatted
220 dfc67f9b 2004-05-16 devnull by
221 dfc67f9b 2004-05-16 devnull .I troff
222 dfc67f9b 2004-05-16 devnull and placed in the table.
223 dfc67f9b 2004-05-16 devnull The block continues to the next line beginning with
224 dfc67f9b 2004-05-16 devnull .BR T} .
225 dfc67f9b 2004-05-16 devnull The remainder of the data line follows at that point.
226 dfc67f9b 2004-05-16 devnull .PD
227 dfc67f9b 2004-05-16 devnull .RE
228 dfc67f9b 2004-05-16 devnull .PP
229 dfc67f9b 2004-05-16 devnull When it is used in a pipeline with
230 dfc67f9b 2004-05-16 devnull .IR eqn ,
231 dfc67f9b 2004-05-16 devnull the
232 dfc67f9b 2004-05-16 devnull .I tbl
233 dfc67f9b 2004-05-16 devnull command should be first, to minimize the volume
234 dfc67f9b 2004-05-16 devnull of data passed through
235 dfc67f9b 2004-05-16 devnull pipes.
236 dfc67f9b 2004-05-16 devnull .SH EXAMPLES
237 dfc67f9b 2004-05-16 devnull .ds tb \fR<tab>\fP
238 dfc67f9b 2004-05-16 devnull Let \*(tb
239 dfc67f9b 2004-05-16 devnull represent a tab (which should
240 dfc67f9b 2004-05-16 devnull be typed as a genuine tab).
241 dfc67f9b 2004-05-16 devnull .if t .2C
242 dfc67f9b 2004-05-16 devnull .EX
243 dfc67f9b 2004-05-16 devnull \&.TS
244 dfc67f9b 2004-05-16 devnull c s s
245 dfc67f9b 2004-05-16 devnull c c s
246 dfc67f9b 2004-05-16 devnull c c c
247 dfc67f9b 2004-05-16 devnull l n n.
248 dfc67f9b 2004-05-16 devnull Household Population
249 dfc67f9b 2004-05-16 devnull Town\*(tbHouseholds
250 dfc67f9b 2004-05-16 devnull \*(tbNumber\*(tbSize
251 dfc67f9b 2004-05-16 devnull Bedminster\*(tb789\*(tb3.26
252 dfc67f9b 2004-05-16 devnull Bernards Twp.\*(tb3087\*(tb3.74
253 dfc67f9b 2004-05-16 devnull Bernardsville\*(tb2018\*(tb3.30
254 dfc67f9b 2004-05-16 devnull \&.TE
255 dfc67f9b 2004-05-16 devnull .if t \{\0
256 dfc67f9b 2004-05-16 devnull \0
257 dfc67f9b 2004-05-16 devnull \0\}
258 dfc67f9b 2004-05-16 devnull .if n .PP
259 dfc67f9b 2004-05-16 devnull .TS
260 dfc67f9b 2004-05-16 devnull c s s
261 dfc67f9b 2004-05-16 devnull c c s
262 dfc67f9b 2004-05-16 devnull c c c
263 dfc67f9b 2004-05-16 devnull l n n.
264 dfc67f9b 2004-05-16 devnull Household Population
265 dfc67f9b 2004-05-16 devnull Town Households
266 dfc67f9b 2004-05-16 devnull Number Size
267 dfc67f9b 2004-05-16 devnull Bedminster 789 3.26
268 dfc67f9b 2004-05-16 devnull Bernards Twp. 3087 3.74
269 dfc67f9b 2004-05-16 devnull Bernardsville 2018 3.30
270 dfc67f9b 2004-05-16 devnull .TE
271 dfc67f9b 2004-05-16 devnull .EE
272 dfc67f9b 2004-05-16 devnull .if t \{.sp3
273 dfc67f9b 2004-05-16 devnull .1C\}
274 dfc67f9b 2004-05-16 devnull .SH SOURCE
275 c3674de4 2005-01-11 devnull .B \*9/src/cmd/tbl
276 dfc67f9b 2004-05-16 devnull .SH SEE ALSO
277 dfc67f9b 2004-05-16 devnull .IR troff (1),
278 d32deab1 2020-08-16 rsc .MR eqn (1) ,
279 d32deab1 2020-08-16 rsc .MR doctype (1)
280 dfc67f9b 2004-05-16 devnull .br
281 dfc67f9b 2004-05-16 devnull M. E. Lesk and L. L. Cherry,
282 dfc67f9b 2004-05-16 devnull ``TBL\(ema Program to Format Tables'',
283 dfc67f9b 2004-05-16 devnull .I
284 dfc67f9b 2004-05-16 devnull Unix Research System Programmer's Manual,
285 dfc67f9b 2004-05-16 devnull Tenth Edition, Volume 2.