Debian Codegraph @

upstream/debian-trixie/man1/tbl.1

raw
1 '\" t
2 .TH \%tbl 1 "3 June 2025" "groff 1.23.0"
3 .SH Name
4 \%tbl \- prepare tables for
5 .I groff
6 documents
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_tbl_1_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY \%tbl
56 .RB [ \-C ]
57 .RI [ file\~ .\|.\|.]
58 .YS
59 .
60 .
61 .SY \%tbl
62 .B \-\-help
63 .YS
64 .
65 .
66 .SY \%tbl
67 .B \-v
68 .
69 .SY \%tbl
70 .B \-\-version
71 .YS
72 .
73 .
74 .\" ====================================================================
75 .SH Description
76 .\" ====================================================================
77 .
78 The GNU implementation of
79 .I tbl \" generic
80 is part of the
81 .MR groff 1
82 document formatting system.
83 .
84 .I \%tbl
85 is a
86 .MR \%troff 1
87 preprocessor that translates descriptions of tables embedded in
88 .MR roff 7
89 input files into the language understood by
90 .IR \%troff .
91 .
92 It copies the contents of each
93 .I file
94 to the standard output stream,
95 except that lines between
96 .B .TS
97 and
98 .B .TE
99 are interpreted as table descriptions.
100 .
101 While GNU
102 .IR tbl 's \" GNU
103 input syntax is highly compatible with AT&T
104 .IR tbl , \" AT&T
105 the output GNU
106 .I tbl \" GNU
107 produces cannot be processed by AT&T
108 .IR troff ; \" AT&T
109 GNU
110 .I troff \" GNU
111 (or a
112 .I troff \" generic
113 implementing any GNU extensions employed)
114 must be used.
115 .
116 Normally,
117 .I \%tbl
118 is not executed directly by the user,
119 but invoked by specifying the
120 .B \-t
121 option to
122 .MR groff 1 .
123 .
124 If no
125 .I file
126 operands are given on the command line,
127 or if
128 .I file
129 is
130 .RB \[lq] \- \[rq],
131 .I \%tbl
132 reads the standard input stream.
133 .
134 .
135 .\" ====================================================================
136 .SS Overview
137 .\" ====================================================================
138 .
139 .I \%tbl
140 expects to find table descriptions between input lines that begin with
141 .B .TS
142 (table start)
143 and
144 .B .TE
145 (table end).
146 .
147 Each such
148 .I table region
149 encloses one or more table descriptions.
150 .
151 Within a table region,
152 table descriptions beyond the first must each be preceded
153 by an input line beginning with
154 .BR .T& .
155 .
156 This mechanism does not start a new table region;
157 all table descriptions are treated as part of their
158 .BR .TS / .TE
159 enclosure,
160 even if they are boxed or have column headings that repeat on subsequent
161 pages
162 (see below).
163 .
164 .
165 .P
166 (Experienced
167 .I roff
168 users should observe that
169 .I \%tbl
170 is not a
171 .I roff
172 language interpreter:
173 the default control character must be used,
174 and no spaces or tabs are permitted between the control character and
175 the macro name.
176 .
177 These
178 .I \%tbl
179 input tokens remain as-is in the output,
180 where they become ordinary macro calls.
181 .
182 Macro packages often define
183 .BR TS ,
184 .BR T& ,
185 and
186 .B TE
187 macros to handle issues of table placement on the page.
188 .
189 .I \%tbl
190 produces
191 .I groff
192 code to define these macros as empty if their definitions do not exist
193 when the formatter encounters a table region.)
194 .
195 .
196 .P
197 Each table region may begin with
198 .I region options,
199 and must contain one or more
200 .I table definitions;
201 each table definition contains a
202 .I format specification
203 followed by one or more input lines (rows) of
204 .I entries.
205 .
206 These entries comprise the
207 .I table data.
208 .
209 .
210 .
211 .\" ====================================================================
212 .SS "Region options"
213 .\" ====================================================================
214 .
215 The line immediately following the
216 .B .TS
217 token may specify region options,
218 keywords that influence the interpretation or rendering of the region as
219 a whole or all table entries within it indiscriminately.
220 .
221 They must be separated by commas,
222 spaces,
223 or tabs.
224 .
225 Those that require a parenthesized argument permit spaces and tabs
226 between the option's name and the opening parenthesis.
227 .
228 Options accumulate and cannot be unset within a region once declared;
229 if an option that takes a parameter is repeated,
230 the last occurrence controls.
231 .
232 If present,
233 the set of region options must be terminated with a semicolon
234 .RB ( ; ).
235 .
236 .
237 .P
238 Any of the
239 .BR allbox ,
240 .BR box ,
241 .BR doublebox ,
242 .BR frame ,
243 and
244 .B doubleframe
245 region options makes a table \[lq]boxed\[rq] for the purpose of later
246 discussion.
247 .
248 .
249 .TP
250 .B allbox
251 Enclose each table entry in a box;
252 implies
253 .BR box .
254 .
255 .
256 .TP
257 .B box
258 Enclose the entire table region in a box.
259 .
260 As a GNU extension,
261 the alternative option name
262 .B frame
263 is also recognized.
264 .
265 .
266 .TP
267 .B center
268 Center the table region with respect to the current indentation and line
269 length;
270 the default is to left-align it.
271 .
272 As a GNU extension,
273 the alternative option name
274 .B centre
275 is also recognized.
276 .
277 .
278 .TP
279 .BI decimalpoint( c )
280 Recognize character
281 .I c
282 as the decimal separator in columns using the
283 .B N
284 (numeric) classifier
285 (see subsection \[lq]Column classifiers\[rq] below).
286 .
287 This is a GNU extension.
288 .
289 .
290 .TP
291 .BI delim( xy )
292 Recognize characters
293 .I x
294 .RI and\~ y
295 as start and end delimiters,
296 respectively,
297 for
298 .MR \%eqn 1
299 input,
300 and ignore input between them.
301 .
302 .I x
303 .RI and\~ y
304 need not be distinct.
305 .
306 .
307 .TP
308 .B doublebox
309 Enclose the entire table region in a double box;
310 implies
311 .BR box .
312 .
313 As a GNU extension,
314 the alternative option name
315 .B \%doubleframe
316 is also recognized.
317 .
318 .
319 .TP
320 .B expand
321 Spread the table horizontally to fill the available space
322 (line length minus indentation)
323 by increasing column separation.
324 .
325 Ordinarily,
326 a table is made only as wide as necessary to accommodate the widths of
327 its entries and its column separations
328 (whether specified or default).
329 .
330 When
331 .B expand
332 applies to a table that exceeds the available horizontal space,
333 column separation is reduced as far as necessary
334 (even to zero).
335 .
336 .I \%tbl
337 produces
338 .I groff
339 input that issues a diagnostic if such compression occurs.
340 .
341 The column modifier
342 .B x
343 (see below)
344 overrides this option.
345 .
346 .
347 .TP
348 .BI linesize( n )
349 Draw lines or rules
350 (e.g.,
351 from
352 .BR box )
353 with a thickness of
354 .IR n \~points.
355 .
356 The default is the current type size when the region begins.
357 .
358 This option is ignored on terminal devices.
359 .
360 .
361 .TP
362 .B nokeep
363 Don't use
364 .I roff
365 diversions to manage page breaks.
366 .
367 Normally,
368 .I \%tbl
369 employs them to avoid breaking a page within a table row.
370 .
371 This usage can sometimes interact badly with macro packages' own use of
372 diversions\[em]when footnotes,
373 for example,
374 are employed.
375 .
376 This is a GNU extension.
377 .
378 .
379 .TP
380 .B nospaces
381 Ignore leading and trailing spaces in table entries.
382 .
383 This is a GNU extension.
384 .
385 .
386 .TP
387 .B nowarn
388 Suppress diagnostic messages produced at document formatting time when
389 the line or page lengths are inadequate to contain a table row.
390 .
391 This is a GNU extension.
392 .
393 .
394 .\" TODO: How about "right"? (and "left" for symmetry)
395 .TP
396 .BI tab( c )
397 Use the character
398 .I c
399 instead of a tab to separate entries in a row of table data.
400 .
401 .
402 .\" ====================================================================
403 .SS "Table format specification"
404 .\" ====================================================================
405 .
406 The table format specification is mandatory:
407 it determines the number of columns in the table and directs how the
408 entries within it are to be typeset.
409 .
410 The format specification is a series of column
411 .I descriptors.
412 .
413 Each descriptor encodes a
414 .I classifier
415 followed by zero or more
416 .I modifiers.
417 .
418 Classifiers are letters
419 (recognized case-insensitively)
420 or punctuation symbols;
421 modifiers consist of or begin with letters or numerals.
422 .
423 Spaces,
424 tabs,
425 newlines,
426 and commas separate descriptors.
427 .
428 Newlines and commas are special;
429 they apply the descriptors following them to a subsequent row of the
430 table.
431 .
432 (This enables column headings to be centered or emboldened while the
433 table entries for the data are not,
434 for instance.)
435 .
436 We term the resulting group of column descriptors a
437 .I row definition.
438 .
439 Within a row definition,
440 separation between column descriptors
441 (by spaces or tabs)
442 is often optional;
443 only some modifiers,
444 described below,
445 make separation necessary.
446 .
447 .
448 .P
449 Each column descriptor begins with a mandatory
450 .I classifier,
451 a character that selects from one of several arrangements.
452 .
453 Some determine the positioning of table entries within a rectangular
454 cell:
455 centered,
456 left-aligned,
457 numeric
458 (aligned to a configurable decimal separator),
459 and so on.
460 .
461 Others perform special operations like drawing lines or spanning entries
462 from adjacent cells in the table.
463 .
464 Except for
465 .RB \[lq] | \[rq],
466 any classifier can be followed by one or more
467 .I modifiers;
468 some of these accept an argument,
469 which in GNU
470 .I tbl \" GNU
471 can be parenthesized.
472 .\" AT&T tbl allowed parentheses only after 'w'.
473 .\" TODO: Accept parentheses after 'p' and 'v'.
474 .
475 Modifiers select fonts,
476 set the type size,
477 .\"define the column width,
478 .\"adjust inter-column spacing, \" slack text for window/orphan control
479 and perform other tasks described below.
480 .
481 .
482 .P
483 The format specification can occupy multiple input lines,
484 but must conclude with a dot
485 .RB \[lq] .\& \[rq]
486 followed by a newline.
487 .
488 Each row definition is applied in turn to one row of the table.
489 .
490 The last row definition is applied to rows of table data in excess of
491 the row definitions.
492 .
493 .
494 .P
495 For clarity in this document's examples,
496 we shall write classifiers in uppercase and modifiers in lowercase.
497 .
498 Thus,
499 .RB \[lq] CbCb,LR.\& \[rq]
500 defines two rows of two columns.
501 .
502 The first row's entries are centered and boldfaced;
503 the second and any further rows' first and second columns are left- and
504 right-aligned,
505 respectively.
506 .
507 .\" slack text for window/orphan control
508 .\"If more rows of entries are added to the table data,
509 .\"they reuse the row definition
510 .\".RB \[lq] LR \[rq].
511 .
512 .
513 .P
514 The row definition with the most column descriptors determines the
515 number of columns in the table;
516 any row definition with fewer is implicitly extended on the right-hand
517 side with
518 .B L
519 classifiers as many times as necessary to make the table rectangular.
520 .
521 .
522 .\" ====================================================================
523 .SS "Column classifiers"
524 .\" ====================================================================
525 .
526 The
527 .BR L ,
528 .BR R ,
529 and
530 .B C
531 classifiers are the easiest to understand and use.
532 .
533 .
534 .TP
535 .BR A ,\~ a
536 Center longest entry in this column,
537 left-align remaining entries in the column with respect to the centered
538 entry,
539 then indent all entries by one en.
540 .
541 Such \[lq]alphabetic\[rq] entries
542 (hence the name of the classifier)
543 can be used in the same column as
544 .BR L -classified
545 entries,
546 as in
547 .RB \[lq] LL,AR.\& \[rq].
548 .
549 The
550 .B A
551 entries are often termed \[lq]sub-columns\[rq] due to their indentation.
552 .
553 .
554 .TP
555 .BR C ,\~ c
556 Center entry within the column.
557 .
558 .
559 .TP
560 .BR L ,\~ l
561 Left-align entry within the column.
562 .
563 .
564 .TP
565 .BR N ,\~ n
566 Numerically align entry in the column.
567 .
568 .I \%tbl
569 aligns columns of numbers vertically at the units place.
570 .
571 If multiple decimal separators are adjacent to a digit,
572 it uses the rightmost one for vertical alignment.
573 .
574 If there is no decimal separator,
575 the rightmost digit is used for vertical alignment;
576 otherwise,
577 .I \%tbl
578 centers the entry within the column.
579 .
580 The
581 .I roff
582 dummy character
583 .B \[rs]&
584 in an entry marks the glyph preceding it
585 (if any)
586 as the units place;
587 if multiple instances occur in the data,
588 the leftmost is used for alignment.
589 .
590 .
591 .IP
592 If
593 .BR N -classified
594 entries share a column with
595 .B L
596 or
597 .BR R \~entries,
598 .I \%tbl
599 centers the widest
600 .BR N \~entry
601 with respect to the widest
602 .B L
603 or
604 .BR R \~entry,
605 preserving the alignment of
606 .BR N \~entries
607 with respect to each other.
608 .
609 .
610 .IP
611 The appearance of
612 .I \%eqn
613 equations
614 within
615 .BR N -classified
616 columns
617 can be troublesome due to the foregoing textual scan for a decimal
618 separator.
619 .
620 Use the
621 .B \%delim
622 region option to make
623 .I \%tbl
624 ignore the data within
625 .I eqn
626 delimiters for that purpose.
627 .
628 .
629 .TP
630 .BR R ,\~ r
631 Right-align entry within the column.
632 .
633 .
634 .TP
635 .BR S ,\~ s
636 Span previous entry on the left into this column.
637 .
638 .
639 .TP
640 .B \[ha]
641 Span entry in the same column from the previous row into this row.
642 .
643 .
644 .TP
645 .BR _ ,\~ \-
646 Replace table entry with a horizontal rule.
647 .
648 An empty table entry is expected to correspond to this classifier;
649 if data are found there,
650 .I \%tbl
651 issues a diagnostic message.
652 .
653 .
654 .TP
655 .B =
656 Replace table entry with a double horizontal rule.
657 .
658 An empty table entry is expected to correspond to this classifier;
659 if data are found there,
660 .I \%tbl
661 issues a diagnostic message.
662 .
663 .
664 .TP
665 .B |
666 Place a vertical rule (line) on the corresponding row of the table
667 (if two of these are adjacent,
668 a double vertical rule).
669 .
670 This classifier does not contribute to the column count and no table
671 entries correspond to it.
672 .
673 A
674 .B |
675 to the left of the first column descriptor or to the right of the last
676 one produces a vertical rule at the edge of the table;
677 these are redundant
678 (and ignored)
679 in boxed tables.
680 .
681 .
682 .P
683 To change the table format within a
684 .I \%tbl
685 region,
686 use the
687 .B .T&
688 token at the start of a line.
689 .
690 It is followed by a format specification and table data,
691 but
692 .I not
693 region options.
694 .
695 The quantity of columns in a new table format thus introduced cannot
696 increase relative to the previous table format;
697 in that case,
698 you must end the table region and start another.
699 .
700 If that will not serve because the region uses box options or the
701 columns align in an undesirable manner,
702 you must design the initial table format specification to include the
703 maximum quantity of columns required,
704 and use the
705 .B S
706 horizontal spanning classifier where necessary to achieve the desired
707 columnar alignment.
708 .
709 .
710 .P
711 Attempting to horizontally span in the first column or vertically span
712 on the first row is an error.
713 .
714 Non-rectangular span areas are also not supported.
715 .
716 .
717 .\" ====================================================================
718 .SS "Column modifiers"
719 .\" ====================================================================
720 .
721 Any number of modifiers can follow a column classifier.
722 .
723 Arguments to modifiers,
724 where accepted,
725 are case-sensitive.
726 .
727 If the same modifier is applied to a column specifier more than once,
728 or if conflicting modifiers are applied,
729 only the last occurrence has effect.
730 .
731 The
732 .RB modifier\~ x
733 is mutually exclusive with
734 .B e
735 .RB and\~ w ,
736 but
737 .B e
738 is not mutually exclusive
739 .RB with\~ w ;
740 if these are used in combination,
741 .BR x \~unsets
742 both
743 .B e
744 .RB and\~ w ,
745 while either
746 .B e
747 or
748 .B w
749 .RB overrides\~ x .
750 .
751 .
752 .br
753 .ne 4v \" Keep next two tagged paragraphs together.
754 .TP
755 .BR b ,\~ B
756 Typeset entry in boldface,
757 abbreviating
758 .BR f(B) .
759 .
760 .
761 .TP
762 .BR d ,\~ D
763 Align a vertically spanned table entry to the bottom
764 (\[lq]down\[rq]),
765 instead of the center,
766 of its range.
767 .
768 This is a GNU extension.
769 .
770 .
771 .TP
772 .BR e ,\~ E
773 Equalize the widths of columns with this modifier.
774 .
775 The column with the largest width controls.
776 .
777 This modifier sets the default line length used in a text block.
778 .
779 .
780 .TP
781 .BR f ,\~ F
782 Select the typeface for the table entry.
783 .
784 This modifier must be followed by a font or style name
785 (one or two characters not starting with a digit),
786 font mounting position
787 (a single digit),
788 or a name or mounting position of any length in parentheses.
789 .
790 The last form is a GNU extension.
791 .
792 (The parameter corresponds to that accepted by the
793 .I troff \" generic
794 .B ft
795 request.)
796 .
797 A one-character argument not in parentheses must be separated by one or
798 more spaces or tabs from what follows.
799 .
800 .
801 .TP
802 .BR i ,\~ I
803 Typeset entry in an oblique or italic face,
804 abbreviating
805 .BR f(I) .
806 .
807 .
808 .TP
809 .BR m ,\~ M
810 Call a
811 .I groff
812 macro before typesetting a text block
813 (see subsection \[lq]Text blocks\[rq] below).
814 .
815 This is a GNU extension.
816 .
817 This modifier must be followed by a macro name of one or two characters
818 or a name of any length in parentheses.
819 .
820 A one-character macro name not in parentheses must be separated by one
821 or more spaces or tabs from what follows.
822 .
823 The named macro must be defined before the table region containing this
824 column modifier is encountered.
825 .
826 The macro should contain only simple
827 .I groff
828 requests to change text formatting,
829 like adjustment or hyphenation.
830 .
831 The macro is called
832 .I after
833 the column modifiers
834 .BR b ,
835 .BR f ,
836 .BR i ,
837 .BR p ,
838 and
839 .B v
840 take effect;
841 it can thus override other column modifiers.
842 .
843 .
844 .TP
845 .BR p ,\~ P
846 Set the type size for the table entry.
847 .
848 This modifier must be followed by an
849 .RI integer\~ n
850 with an optional leading sign.
851 .
852 If unsigned,
853 the type size is set to
854 .IR n \~scaled
855 points.
856 .
857 Otherwise,
858 the type size is incremented or decremented per the sign by
859 .IR n \~scaled
860 points.
861 .
862 The use of a signed multi-digit number is a GNU extension.
863 .
864 (The parameter corresponds to that accepted by the
865 .I troff \" generic
866 .B ps
867 request.)
868 .
869 If a type size modifier is followed by a column separation modifier
870 (see below),
871 they must be separated by at least one space or tab.
872 .\" TODO: Allow parentheses so scaling units and fractional values can
873 .\" be used?
874 .
875 .
876 .TP
877 .BR t ,\~ T
878 Align a vertically spanned table entry to the top,
879 instead of the center,
880 of its range.
881 .
882 .
883 .TP
884 .BR u ,\~ U
885 Move the column up one half-line,
886 \[lq]staggering\[rq] the rows.
887 .
888 This is a GNU extension.
889 .
890 .
891 .TP
892 .BR v ,\~ V
893 Set the vertical spacing to be used in a text block.
894 .
895 This modifier must be followed by an
896 .RI integer\~ n
897 with an optional leading sign.
898 .
899 If unsigned,
900 the vertical spacing is set to
901 .IR n\~ points.
902 .
903 Otherwise,
904 the vertical spacing is incremented or decremented per the sign by
905 .IR n\~ points.
906 .
907 The use of a signed multi-digit number is a GNU extension.
908 .
909 (This parameter corresponds to that accepted by the
910 .I troff \" generic
911 .B vs
912 request.)
913 .
914 If a vertical spacing modifier is followed by a column separation
915 modifier
916 (see below),
917 they must be separated by at least one space or tab.
918 .\" TODO: Allow parentheses so scaling units and fractional values can
919 .\" be used?
920 .
921 .
922 .TP
923 .BR w ,\~ W
924 Set the column's minimum width.
925 .
926 This modifier must be followed by a number,
927 which is either a unitless integer,
928 or a
929 .I roff
930 horizontal measurement in parentheses.
931 .
932 Parentheses are required if the width is to be followed immediately by
933 an explicit column separation
934 (alternatively,
935 follow the width with one or more spaces or tabs).
936 .
937 If no unit is specified,
938 ens are assumed.
939 .
940 This modifier sets the default line length used in a text block.
941 .
942 .
943 .TP
944 .BR x ,\~ X
945 Expand the column.
946 .
947 After computing the column widths,
948 distribute any remaining line length evenly over all columns bearing
949 this modifier.
950 .
951 Applying the
952 .BR x \~modifier
953 to more than one column is a GNU extension.
954 .\" 'x' wasn't documented at all in Lesk 1979.
955 .
956 This modifier sets the default line length used in a text block.
957 .
958 .
959 .TP
960 .BR z ,\~ Z
961 Ignore the table entries corresponding to this column for width
962 calculation purposes;
963 that is,
964 compute the column's width using only the information in its descriptor.
965 .
966 .
967 .TP
968 .I n
969 A numeric suffix on a column descriptor sets the separation distance
970 (in ens)
971 from the succeeding column;
972 the default separation is
973 .BR 3n .
974 .
975 This separation is
976 proportionally multiplied if the
977 .B expand
978 region option is in effect;
979 in the case of tables wider than the output line length,
980 this separation might be zero.
981 .
982 A negative separation cannot be specified.
983 .
984 A separation amount after the last column in a row is nonsensical and
985 provokes a diagnostic from
986 .IR \%tbl .
987 .
988 .
989 .\" ====================================================================
990 .SS "Table data"
991 .\" ====================================================================
992 .
993 The table data come after the format specification.
994 .
995 Each input line corresponds to a table row,
996 except that a backslash at the end of a line of table data continues an
997 entry on the next input line.
998 .
999 (Text blocks,
1000 discussed below,
1001 also spread table entries across multiple input lines.)
1002 .
1003 Table entries within a row are separated in the input by a tab character
1004 by default;
1005 see the
1006 .B tab
1007 region option above.
1008 .
1009 Excess entries in a row of table data
1010 (those that have no corresponding column descriptor,
1011 not even an implicit one arising from rectangularization of the table)
1012 are discarded with a diagnostic message.
1013 .
1014 .I roff
1015 control lines are accepted between rows of table data and within text
1016 blocks.
1017 .
1018 If you wish to visibly mark an empty table entry in the document source,
1019 populate it with the
1020 .B \[rs]&
1021 .I roff
1022 dummy character.
1023 .
1024 The table data are interrupted by a line consisting of the
1025 .B .T&
1026 input token,
1027 and conclude with the line
1028 .BR .TE .
1029 .
1030 .
1031 .P
1032 Ordinarily,
1033 a table entry is typeset rigidly.
1034 .
1035 It is not filled,
1036 broken,
1037 hyphenated,
1038 adjusted,
1039 or populated with additional inter-sentence space.
1040 .
1041 .I \%tbl
1042 instructs the formatter to measure each table entry as it occurs in the
1043 input,
1044 updating the width required by its corresponding column.
1045 .
1046 If the
1047 .B z
1048 modifier applies to the column,
1049 this measurement is ignored;
1050 if
1051 .B w
1052 applies and its argument is larger than this width,
1053 that argument is used instead.
1054 .
1055 In contrast to conventional
1056 .I roff
1057 input
1058 (within a paragraph,
1059 say),
1060 changes to text formatting,
1061 such as font selection or vertical spacing,
1062 do not persist between entries.
1063 .
1064 .
1065 .P
1066 Several forms of table entry are interpreted specially.
1067 .
1068 .
1069 .IP \[bu] 2n
1070 If a table row contains only an underscore or equals sign
1071 .RB ( _
1072 or
1073 .BR = ),
1074 a single or double horizontal rule (line),
1075 respectively,
1076 is drawn across the table at that point.
1077 .
1078 .
1079 .IP \[bu] 2n
1080 A table entry containing only
1081 .B _
1082 or
1083 .B =
1084 on an otherwise populated row is replaced by a single or double
1085 horizontal rule,
1086 respectively,
1087 joining its
1088 neighbors.
1089 .
1090 .
1091 .IP \[bu] 2n
1092 Prefixing a lone underscore or equals sign with a backslash also has
1093 meaning.
1094 .
1095 If a table entry consists only of
1096 .B \[rs]_
1097 or
1098 .B \[rs]=
1099 on an otherwise populated row,
1100 it is replaced by a single or double horizontal rule,
1101 respectively,
1102 that does
1103 .I not
1104 (quite) join its neighbors.
1105 .
1106 .
1107 .IP \[bu]
1108 A table entry consisting of
1109 .BI \[rs]R x\c
1110 ,
1111 where
1112 .IR x \~is
1113 any
1114 .I roff
1115 ordinary or special character,
1116 is replaced by enough repetitions of the glyph corresponding
1117 .RI to\~ x
1118 to fill the column,
1119 albeit without joining its neighbors.
1120 .\" TODO: Bad things happen if there's garbage in the entry after 'x',
1121 .\" which can be a *roff special character escape sequence, so
1122 .\" validation is not trivial.
1123 .
1124 .
1125 .IP \[bu]
1126 On any row but the first,
1127 a table entry of
1128 .B \[rs]\[ha]
1129 causes the entry above it to span down into the current one.
1130 .
1131 .
1132 .P
1133 On occasion,
1134 these special tokens may be required as literal table data.
1135 .
1136 To use either
1137 .B _
1138 or
1139 .B =
1140 literally and alone in an entry,
1141 prefix or suffix it with the
1142 .I roff
1143 dummy character
1144 .BR \[rs]& .
1145 .
1146 To express
1147 .BR \[rs]_ ,
1148 .BR \[rs]= ,
1149 or
1150 .BR \[rs]R ,
1151 use a
1152 .I roff
1153 escape sequence to interpolate the backslash
1154 .RB ( \[rs]e
1155 or
1156 .BR \[rs][rs] ).
1157 .
1158 A reliable way to emplace the
1159 .B \[rs]\[ha]
1160 glyph sequence within a table entry is to use a pair of
1161 .I groff
1162 special character escape sequences
1163 .RB ( \[rs][rs]\[rs][ha] ).
1164 .
1165 .
1166 .P
1167 Rows of table entries can be interleaved with
1168 .I groff
1169 control lines;
1170 these do not count as table data.
1171 .
1172 On such lines the default control character
1173 .RB ( .\& )
1174 must be used
1175 (and not changed);
1176 the no-break control character is not recognized.
1177 .
1178 To start the first table entry in a row with a dot,
1179 precede it with the
1180 .I roff
1181 dummy character
1182 .BR \[rs]& .
1183 .
1184 .
1185 .\" ====================================================================
1186 .SS "Text blocks"
1187 .\" ====================================================================
1188 .
1189 An ordinary table entry's contents can make a column,
1190 and therefore the table,
1191 excessively wide;
1192 the table then exceeds the line length of the page,
1193 and becomes ugly or is exposed to truncation by the output device.
1194 .
1195 When a table entry requires more conventional typesetting,
1196 breaking across more than one output line
1197 (and thereby increasing the height of its row),
1198 it can be placed within a
1199 .I text block.
1200 .
1201 .
1202 .P
1203 .I \%tbl
1204 interprets a table entry beginning with
1205 .RB \[lq] T{ \[rq]
1206 at the end of an input line not as table data,
1207 but as a token starting a text block.
1208 .
1209 Similarly,
1210 .RB \[lq] T} \[rq]
1211 at the start of an input line ends a text block;
1212 it must also end the table entry.
1213 .
1214 Text block tokens can share an input line with other table data
1215 (preceding
1216 .B T{
1217 and following
1218 .BR T} ).
1219 .
1220 Input lines between these tokens are formatted in a diversion by
1221 .IR troff . \" generic
1222 .
1223 Text blocks cannot be nested.
1224 .
1225 Multiple text blocks can occur in a table row.
1226 .
1227 .
1228 .P
1229 Text blocks are formatted as was the text prior to the table,
1230 modified by applicable column descriptors.
1231 .
1232 Specifically,
1233 the classifiers
1234 .BR A ,
1235 .BR C ,
1236 .BR L ,
1237 .BR N ,
1238 .BR R ,
1239 and
1240 .B S
1241 determine a text block's
1242 .I alignment
1243 within its cell,
1244 but not its
1245 .I adjustment.
1246 .
1247 Add
1248 .B na
1249 or
1250 .B ad
1251 requests to the beginning of a text block to alter its adjustment
1252 distinctly from other text in the document.
1253 .
1254 As with other table entries,
1255 when a text block ends,
1256 any alterations to formatting parameters are discarded.
1257 .
1258 They do not affect subsequent table entries,
1259 not even other text blocks.
1260 .
1261 .
1262 .P
1263 .ne 2v
1264 If
1265 .B w
1266 or
1267 .B x
1268 modifiers are not specified for
1269 .I all
1270 columns of a text block's span,
1271 the default length of the text block
1272 (more precisely,
1273 the line length used to process the text block diversion)
1274 is computed as
1275 .IR L \[tmu] C /( N +1),
1276 .\" ...and rounded to the horizontal motion quantum of the output device
1277 where
1278 .I L
1279 is the current line length,
1280 .I C
1281 the number of columns spanned by the text block,
1282 and
1283 .I N
1284 the number of columns in the table.
1285 .
1286 If necessary,
1287 you can also control a text block's width by including an
1288 .B ll
1289 (line length)
1290 request in it prior to any text to be formatted.
1291 .
1292 Because a diversion is used to format the text block,
1293 its height and width are subsequently available in the registers
1294 .B dn
1295 and
1296 .BR dl ,
1297 respectively.
1298 .
1299 .
1300 .\" ====================================================================
1301 .SS \f[I]roff\f[] interface
1302 .\" ====================================================================
1303 .
1304 The register
1305 .B TW
1306 stores the width of the table region in basic units;
1307 it can't be used within the region itself,
1308 but is defined before the
1309 .B .TE
1310 token is output so that a
1311 .I groff
1312 macro named
1313 .B TE
1314 can make use of it.
1315 .
1316 .B T.\&
1317 is a Boolean-valued register indicating whether the bottom of the table
1318 is being processed.
1319 .
1320 The
1321 .B #T
1322 register marks the top of the table.
1323 .
1324 Avoid using these names for any other purpose.
1325 .
1326 .
1327 .P
1328 .I \%tbl
1329 also defines a macro
1330 .B T#
1331 to produce the bottom and side lines of a boxed table.
1332 .
1333 While
1334 .I \%tbl
1335 itself arranges for the output to include a call of this macro at the
1336 end of such a table,
1337 it can also be used by macro packages to create boxes for multi-page
1338 tables by calling it from a page footer macro that is itself called by
1339 a trap planted near the bottom of the page.
1340 .
1341 See section \[lq]Limitations\[rq] below for more on multi-page tables.
1342 .
1343 .
1344 .P
1345 GNU
1346 .I tbl \" GNU
1347 .\" AT&T tbl used all kinds of registers; many began with "3".
1348 internally employs register,
1349 string,
1350 macro,
1351 and diversion names beginning with the
1352 .RB numeral\~ 3 .
1353 .
1354 A document to be preprocessed with GNU
1355 .I tbl \" GNU
1356 should not use any such identifiers.
1357 .\" XXX: Why are they not named starting with "gtbl*" or something? GNU
1358 .\" tbl turns AT&T troff compatibility mode off anyway.
1359 .
1360 .
1361 .\" ====================================================================
1362 .SS "Interaction with \f[I]\%eqn\f[]"
1363 .\" ====================================================================
1364 .
1365 .I \%tbl
1366 should always be called before
1367 .MR \%eqn 1 .
1368 .
1369 (\c
1370 .MR groff 1
1371 automatically arranges preprocessors in the correct order.)
1372 .
1373 Don't call the
1374 .B EQ
1375 and
1376 .B EN
1377 macros within tables;
1378 instead,
1379 set up delimiters in your
1380 .I eqn \" generic
1381 input and use the
1382 .B \%delim
1383 region option so that
1384 .I \%tbl
1385 will recognize them.
1386 .
1387 .
1388 .br
1389 .ne 5v \" Keep enough space for heading, intro sentence, and first item.
1390 .\" ====================================================================
1391 .SS "GNU \f[I]tbl\f[] enhancements"
1392 .\" ====================================================================
1393 .
1394 In addition to extensions noted above,
1395 GNU
1396 .I tbl \" GNU
1397 removes constraints endured by users of AT&T
1398 .IR tbl .\" AT&T
1399 .
1400 .
1401 .IP \[bu] 2n
1402 Region options can be specified in any lettercase.
1403 .
1404 .
1405 .IP \[bu]
1406 There is no limit on the number of columns in a table,
1407 regardless of their classification,
1408 nor any limit on the number of text blocks.
1409 .
1410 .
1411 .IP \[bu]
1412 All table rows are considered when deciding column widths,
1413 not just those occurring in the first 200 input lines of a region.
1414 .
1415 Similarly,
1416 table continuation
1417 .RB ( .T& )
1418 tokens are recognized outside a region's first 200 input lines.
1419 .
1420 .
1421 .IP \[bu]
1422 Numeric and alphabetic entries may appear in the same column.
1423 .
1424 .
1425 .IP \[bu]
1426 Numeric and alphabetic entries may span horizontally.
1427 .
1428 .
1429 .\" ====================================================================
1430 .SS "Using GNU \f[I]tbl\f[] within macros"
1431 .\" ====================================================================
1432 .
1433 You can embed a table region inside a macro definition.
1434 .
1435 However,
1436 since
1437 .I \%tbl
1438 writes its own macro definitions at the beginning of each table region,
1439 it is necessary to call end macros instead of ending macro definitions
1440 with
1441 .RB \[lq] ..\& \[rq].
1442 .\" XXX: Why don't we fix that by ending all of tbl's own macro
1443 .\" definitions with a call to a macro in its own reserved name space?
1444 .
1445 Additionally,
1446 the escape character must be disabled. \" XXX: Why?
1447 .
1448 .
1449 .P
1450 Not all
1451 .I \%tbl
1452 features can be exercised from such macros because
1453 .I \%tbl
1454 is a
1455 .I roff
1456 preprocessor:
1457 it sees the input earlier than
1458 .I \%troff
1459 does.
1460 .
1461 For example,
1462 vertically aligning decimal separators fails if the numbers containing
1463 them occur as macro or string parameters;
1464 the alignment is performed by
1465 .I \%tbl
1466 itself,
1467 which sees only
1468 .BR \[rs]$1 ,
1469 .BR \[rs]$2 ,
1470 and so on,
1471 and therefore can't recognize a decimal separator that only appears
1472 later when
1473 .I \%troff
1474 interpolates a macro or string definition.
1475 .
1476 .
1477 .\" XXX: The following is a general caveat about preprocessors; move it.
1478 .P
1479 Using
1480 .I \%tbl
1481 macros within conditional input
1482 (that is,
1483 contingent upon an
1484 .BR if ,
1485 .BR ie ,
1486 .BR el ,
1487 or
1488 .B while
1489 request)
1490 can result in misleading line numbers in subsequent diagnostics.
1491 .
1492 .I \%tbl
1493 unconditionally injects its output into the source document,
1494 but the conditional branch containing it may not be taken,
1495 and if it is not,
1496 the
1497 .B lf
1498 requests that
1499 .I \%tbl
1500 injects to restore the source line number cannot take effect.
1501 .
1502 Consider copying the input line counter register
1503 .B c.\&
1504 and restoring its value at a convenient location after applicable
1505 arithmetic.
1506 .
1507 .
1508 .br
1509 .ne 5v
1510 .\" ====================================================================
1511 .SH Options
1512 .\" ====================================================================
1513 .
1514 .B \-\-help
1515 displays a usage message,
1516 while
1517 .B \-v
1518 and
1519 .B \-\-version
1520 show version information;
1521 all exit afterward.
1522 .
1523 .
1524 .TP
1525 .B \-C
1526 Enable AT&T compatibility mode:
1527 recognize
1528 .B .TS
1529 and
1530 .B .TE
1531 even when followed by a character other than space or newline.
1532 .
1533 Furthermore,
1534 interpret the uninterpreted leader escape sequence
1535 .BR \[rs]a .
1536 .
1537 .
1538 .\" ====================================================================
1539 .SH Limitations
1540 .\" ====================================================================
1541 .
1542 Multi-page tables,
1543 if boxed and/or if you want their column headings repeated after page
1544 breaks,
1545 require support at the time the document is formatted.
1546 .
1547 A convention for such support has arisen in macro packages such as
1548 .IR ms ,
1549 .IR mm ,
1550 and
1551 .IR me .
1552 .
1553 To use it,
1554 follow the
1555 .B .TS
1556 token with a space and then
1557 .RB \[lq] H \[rq];
1558 this will be interpreted by the formatter
1559 as a
1560 .B TS
1561 macro call with an
1562 .B H
1563 argument.
1564 .
1565 Then,
1566 within the table data,
1567 call the
1568 .B TH
1569 macro;
1570 this informs the macro package where the headings end.
1571 .
1572 If your table has no such heading rows,
1573 or you do not desire their repetition,
1574 call
1575 .B TH
1576 immediately after the table format specification.
1577 .
1578 If a multi-page table is boxed or has repeating column headings,
1579 do not enclose it with keep/release macros,
1580 or divert it in any other way.
1581 .
1582 Further,
1583 the
1584 .B bp
1585 request will not cause a page break in a
1586 .RB \[lq] "TS H" \[rq]
1587 table.
1588 .
1589 Define a macro to wrap
1590 .BR bp :
1591 invoke it normally if there is no current diversion.
1592 .
1593 Otherwise,
1594 pass the macro call to the enclosing diversion using the transparent
1595 line escape sequence
1596 .BR \[rs]!\& ;
1597 this will \[lq]bubble up\[rq] the page break to the output device.
1598 .
1599 See section \[lq]Examples\[rq] below for a demonstration.
1600 .
1601 .
1602 .P
1603 Double horizontal rules are not supported by
1604 .MR grotty 1 ;
1605 single rules are used instead.
1606 .
1607 .I \%grotty
1608 also ignores half-line motions,
1609 so the
1610 .B u
1611 column modifier has no effect.
1612 .
1613 On terminal devices
1614 .RI (\[lq] nroff\~ mode\[rq]),
1615 horizontal rules and box borders occupy a full vee of space;
1616 this amount is doubled for
1617 .B doublebox
1618 tables.
1619 .
1620 Tables using these features thus require more vertical space in
1621 .I nroff
1622 mode than in
1623 .I troff
1624 mode:
1625 write
1626 .B ne
1627 requests accordingly.
1628 .
1629 Vertical rules between columns are drawn in the space between columns in
1630 .I nroff
1631 mode;
1632 using double vertical rules and/or reducing the column separation below
1633 the default can make them ugly or overstrike them with table data.
1634 .
1635 .
1636 .P
1637 A text block within a table must be able to fit on one page.
1638 .
1639 .
1640 .P
1641 Using
1642 .B \[rs]a
1643 to put leaders in table entries does not work
1644 in GNU
1645 .IR tbl , \" GNU
1646 except in compatibility mode.
1647 .
1648 This is correct behavior:
1649 .B \[rs]a
1650 is an
1651 .I uninterpreted
1652 leader.
1653 .
1654 You can still use the
1655 .I roff
1656 leader character (Control+A) or define a string to use
1657 .B \[rs]a
1658 as it was designed:
1659 to be interpreted only in copy mode.
1660 .
1661 .
1662 .RS
1663 .P
1664 .EX
1665 \&.ds a \[rs]a
1666 \&.TS
1667 \&box center tab(;);
1668 \&Lw(2i)0 L.
1669 \&Population\[rs]*a;6,327,119
1670 \&.TE
1671 .EE
1672 .RE
1673 .
1674 .
1675 .\" We use a real leader to avoid defining a string in a man page.
1676 .P
1677 .TS
1678 box center tab(;);
1679 Lw(2i)0 L.
1680 Population;6,327,119
1681 .TE
1682 .
1683 .
1684 .P
1685 A leading and/or trailing
1686 .B |
1687 in a format specification,
1688 such as
1689 .RB \[lq] |LCR|.\& \[rq],
1690 produces an en space between the vertical rules and the content of the
1691 adjacent columns.
1692 .
1693 If no such space is desired
1694 (so that the rule abuts the content),
1695 you can introduce \[lq]dummy\[rq] columns with zero separation and empty
1696 corresponding table entries before and/or after.
1697 .
1698 .
1699 .RS
1700 .P
1701 .EX
1702 \&.TS
1703 \&center tab(#);
1704 \&R0|L C R0|L.
1705 _
1706 \&#levulose#glucose#dextrose#
1707 _
1708 \&.TE
1709 .EE
1710 .RE
1711 .
1712 .
1713 .P
1714 These dummy columns have zero width and are therefore invisible;
1715 unfortunately they usually don't work as intended on terminal devices.
1716 .
1717 .
1718 .if t \{\
1719 .TS
1720 center tab(#);
1721 R0|L C R0|L.
1722 _
1723 #levulose#glucose#dextrose#
1724 _
1725 .TE
1726 .\}
1727 .
1728 .
1729 .\" ====================================================================
1730 .SH Examples
1731 .\" ====================================================================
1732 .
1733 It can be easier to acquire the language of
1734 .I tbl \" generic
1735 through examples than formal description,
1736 especially at first.
1737 .
1738 .
1739 .\" Note: This example is nearly at the column limit (78n) for nroff
1740 .\" output. Recast with care.
1741 .RS
1742 .P
1743 .EX
1744 \&.TS
1745 box center tab(#);
1746 Cb Cb
1747 L L.
1748 Ability#Application
1749 Strength#crushes a tomato
1750 Dexterity#dodges a thrown tomato
1751 Constitution#eats a month-old tomato without becoming ill
1752 Intelligence#knows that a tomato is a fruit
1753 Wisdom#chooses \[rs]f[I]not\[rs]f[] to put tomato in a fruit salad
1754 Charisma#sells obligate carnivores tomato-based fruit salads
1755 \&.TE
1756 .EE
1757 .RE
1758 .
1759 .
1760 .P
1761 .TS
1762 box center tab(#);
1763 Cb Cb
1764 L L.
1765 Ability#Application
1766 Strength#crushes a tomato
1767 Dexterity#dodges a thrown tomato
1768 Constitution#eats a month-old tomato without becoming ill
1769 Intelligence#knows that a tomato is a fruit
1770 Wisdom#chooses \f[I]not\f[] to put tomato in a fruit salad
1771 Charisma#sells obligate carnivores tomato-based fruit salads
1772 .TE
1773 .
1774 .
1775 .P
1776 The
1777 .B A
1778 and
1779 .B N
1780 column classifiers can be easier to grasp in visual rendering than in
1781 description.
1782 .
1783 .
1784 .RS
1785 .P
1786 .EX
1787 \&.TS
1788 center tab(;);
1789 CbS,LN,AN.
1790 Daily energy intake (in MJ)
1791 Macronutrients
1792 \&.\[rs]" assume 3 significant figures of precision
1793 Carbohydrates;4.5
1794 Fats;2.25
1795 Protein;3
1796 \&.T&
1797 LN,AN.
1798 Mineral
1799 Pu\-239;14.6
1800 _
1801 \&.T&
1802 LN.
1803 Total;\[rs][ti]24.4
1804 \&.TE
1805 .EE
1806 .RE
1807 .
1808 .
1809 .RS
1810 .P
1811 .TS
1812 center tab(;);
1813 CbS,LN,AN.
1814 Daily energy intake (in MJ)
1815 .\" assume 3 significant figures of precision
1816 Macronutrients
1817 Carbohydrates;4.5
1818 Fats;2.25
1819 Protein;3
1820 .T&
1821 LN,AN.
1822 Mineral
1823 Pu-239;14.6
1824 _
1825 .T&
1826 LN.
1827 Total;\[ti]24.4
1828 .TE
1829 .RE
1830 .
1831 .
1832 .br
1833 .ne 12v
1834 .P
1835 Next,
1836 we'll lightly adapt a compact presentation of spanning,
1837 vertical alignment,
1838 and zero-width column modifiers from the
1839 .I mandoc
1840 reference for its
1841 .I tbl \" generic
1842 interpreter.
1843 .
1844 It rewards close study.
1845 .
1846 .
1847 .RS
1848 .P
1849 .EX
1850 \&.TS
1851 box center tab(:);
1852 Lz S | Rt
1853 Ld| Cb| \[ha]
1854 \[ha] | Rz S.
1855 left:r
1856 l:center:
1857 :right
1858 \&.TE
1859 .EE
1860 .RE
1861 .
1862 .
1863 .RS
1864 .P
1865 .TS
1866 box center tab(:);
1867 Lz S | Rt
1868 Ld| Cb| ^
1869 ^ | Rz S.
1870 left:r
1871 l:center:
1872 :right
1873 .TE
1874 .RE
1875 .
1876 .
1877 .P
1878 .ne 2v
1879 Row staggering is not visually achievable on terminal devices,
1880 but a table using it can remain comprehensible nonetheless.
1881 .
1882 .
1883 .RS
1884 .P
1885 .EX
1886 \&.TS
1887 center tab(|);
1888 Cf(BI) Cf(BI) Cf(B), C C Cu.
1889 n|n\[rs]f[B]\[rs][tmu]\[rs]f[]n|difference
1890 1|1
1891 2|4|3
1892 3|9|5
1893 4|16|7
1894 5|25|9
1895 6|36|11
1896 \&.TE
1897 .EE
1898 .RE
1899 .
1900 .
1901 .RS
1902 .P
1903 .TS
1904 center tab(|);
1905 Cf(BI) Cf(BI) Cf(B), C C Cu.
1906 n|n\f[B]\[tmu]\f[]n|difference
1907 1|1
1908 2|4|3
1909 3|9|5
1910 4|16|7
1911 5|25|9
1912 6|36|11
1913 .TE
1914 .RE
1915 .
1916 .
1917 .P
1918 Some
1919 .I \%tbl
1920 features cannot be illustrated in the limited environment of a portable
1921 man page.
1922 .
1923 .
1924 .\" TODO: Find a better example than this.
1925 .\".P
1926 .\"As noted above,
1927 .\"we can embed a table region in a
1928 .\".I groff
1929 .\"macro definition.
1930 .\".
1931 .\".IR \%tbl ,
1932 .\"however,
1933 .\"cannot know what will result from any macro argument interpolations,
1934 .\"so we might confine such interpolations to one column of the table and
1935 .\"apply the
1936 .\".B x
1937 .\"modifier to it.
1938 .\".
1939 .\".
1940 .\".RS
1941 .\".P
1942 .\".EX
1943 .\"\&.de END
1944 .\"\&..
1945 .\"\&.eo
1946 .\"\&.de MYTABLE END
1947 .\"\&.TS
1948 .\"\&allbox tab(;);
1949 .\"\&C Lx.
1950 .\"\&This is table \[rs]$1.;\[rs]$2
1951 .\"\&.TE
1952 .\"\&.END
1953 .\"\&.ec
1954 .\"\&.MYTABLE 1 alpha
1955 .\"\&.MYTABLE 2 beta
1956 .\"\&.MYTABLE 3 "gamma delta"
1957 .\".EE
1958 .\".RE
1959 .\"
1960 .\"
1961 .P
1962 We can define a macro outside of a
1963 .I tbl \" generic
1964 region that we can call from within it to cause a page break inside a
1965 multi-page boxed table.
1966 .
1967 You can choose a different name;
1968 be sure to change both occurrences of \[lq]BP\[rq].
1969 .
1970 .
1971 .RS
1972 .P
1973 .ne 4v
1974 .EX
1975 \&.de BP
1976 \&.\& ie \[aq]\[rs]\[rs]n(.z\[aq]\[aq] \&.bp \[rs]\[rs]$1
1977 \&.\& el \[rs]!.BP \[rs]\[rs]$1
1978 \&..
1979 .EE
1980 .RE
1981 .
1982 .
1983 .\" ====================================================================
1984 .SH "See also"
1985 .\" ====================================================================
1986 .
1987 \[lq]Tbl\[em]A Program to Format Tables\[rq],
1988 by M.\& E.\& Lesk,
1989 1976
1990 (revised 16 January 1979),
1991 AT&T Bell Laboratories Computing Science Technical Report No.\& 49.
1992 .
1993 .
1994 .P
1995 The spanning example above was taken from
1996 .UR https://man.openbsd.org/tbl.7
1997 .IR mandoc 's
1998 man page for its
1999 .I tbl \" mandoc
2000 implementation
2001 .UE .
2002 .
2003 .
2004 .P
2005 .MR groff 1 ,
2006 .MR \%troff 1
2007 .
2008 .
2009 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
2010 .cp \n[*groff_tbl_1_man_C]
2011 .do rr *groff_tbl_1_man_C
2012 .
2013 .
2014 .\" Local Variables:
2015 .\" fill-column: 72
2016 .\" mode: nroff
2017 .\" End:
2018 .\" vim: set filetype=groff textwidth=72: