Debian Codegraph @

upstream/debian-trixie/man1/tabs.1

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2024,2025 Thomas E. Dickey *
3 .\" Copyright 2008-2016,2017 Free Software Foundation, Inc. *
4 .\" *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
12 .\" *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
15 .\" *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 .\" *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
27 .\" authorization. *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: tabs.1,v 1.70 2025/02/15 14:55:00 tom Exp $
31 .TH tabs 1 2025-02-15 "ncurses 6.5" "User commands"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .
43 .de bP
44 .ie n .IP \(bu 4
45 .el .IP \(bu 2
46 ..
47 .
48 .SH NAME
49 \fB\%tabs\fP \-
50 set terminal tab stops
51 .SH SYNOPSIS
52 \fBtabs\fP [\fIoptions\fP] [\fItabstop-list\fP]
53 .SH DESCRIPTION
54 The \fBtabs\fP program clears and sets tab-stops on the terminal.
55 This uses the terminfo \fBclear_all_tabs\fP and \fBset_tab\fP capabilities.
56 If either is absent, \fBtabs\fP is unable to clear/set tab-stops.
57 The terminal should be configured to use hard tabs, e.g.,
58 .PP
59 .RS 4
60 .EX
61 stty tab0
62 .EE
63 .RE
64 .PP
65 Like \fB\%clear\fP(1), \fBtabs\fP writes to the standard output.
66 You can redirect the standard output to a file (which prevents
67 \fBtabs\fP from actually changing the tabstops),
68 and later \fBcat\fP the file to the screen, setting tabstops at that point.
69 .PP
70 These are hardware tabs, which cannot be queried rapidly by applications
71 running in the terminal, if at all.
72 Curses and other full-screen applications may use hardware tabs
73 in optimizing their output to the terminal.
74 If the hardware tabstops differ from the information in the terminal
75 database, the result is unpredictable.
76 Before running curses programs,
77 you should either reset tab-stops to the standard interval
78 .PP
79 .RS 4
80 .EX
81 tabs \-8
82 .EE
83 .RE
84 .PP
85 or use the \fBreset\fP program,
86 since the normal initialization sequences do not ensure that tab-stops
87 are reset.
88 .SH OPTIONS
89 .SS "General Options"
90 .TP 5
91 .BI \-T "name"
92 Tell \fBtabs\fP which terminal type to use.
93 If this option is not given, \fBtabs\fP will use the \fB$TERM\fP
94 environment variable.
95 If that is not set, it will use the \fIansi+tabs\fP entry.
96 .TP 5
97 .B \-d
98 The debugging option shows a ruler line, followed by two data lines.
99 The first data line shows the expected tab-stops marked with asterisks.
100 The second data line shows the actual tab-stops, marked with asterisks.
101 .TP 5
102 .B \-n
103 This option tells \fBtabs\fP to check the options and run any debugging
104 option, but not to modify the terminal settings.
105 .TP
106 \fB\-V\fP
107 reports the version of \fI\%ncurses\fP which was used in this program,
108 and exits.
109 .PP
110 The \fBtabs\fP program processes a single list of tab stops.
111 The last option to be processed which defines a list is the one that
112 determines the list to be processed.
113 .SS "Implicit Lists"
114 Use a single number as an option,
115 e.g., \*(``\fB\-5\fP\*('' to set tabs at the given
116 interval (in this case 1, 6, 11, 16, 21, etc.).
117 Tabs are repeated up to the right margin of the screen.
118 .PP
119 Use \*(``\fB\-0\fP\*('' to clear all tabs.
120 .PP
121 Use \*(``\fB\-8\fP\*('' to set tabs to the standard interval.
122 .SS "Explicit Lists"
123 An explicit list can be defined after the options
124 (this does not use a \*(``\-\*('').
125 The values in the list must be in increasing numeric order,
126 and greater than zero.
127 They are separated by a comma or a blank, for example,
128 .PP
129 .RS 4
130 .EX
131 tabs 1,6,11,16,21
132 tabs 1 6 11 16 21
133 .EE
134 .RE
135 .PP
136 Use a \*(``+\*('' to treat a number
137 as an increment relative to the previous value,
138 e.g.,
139 .PP
140 .RS 4
141 .EX
142 tabs 1,+5,+5,+5,+5
143 .EE
144 .RE
145 .PP
146 which is equivalent to the 1,6,11,16,21 example.
147 .SS "Predefined Tab Stops"
148 POSIX defines several predefined lists of tab stops.
149 .TP 5
150 .B \-a
151 Assembler, IBM S/370, first format
152 .br
153 1,10,16,36,72
154 .TP 5
155 .B \-a2
156 Assembler, IBM S/370, second format
157 .br
158 1,10,16,40,72
159 .TP 5
160 .B \-c
161 COBOL, normal format
162 .br
163 1,8,12,16,20,55
164 .TP 5
165 .B \-c2
166 COBOL compact format
167 .br
168 1,6,10,14,49
169 .TP 5
170 .B \-c3
171 COBOL compact format extended
172 .br
173 1,6,10,14,18,22,26,30,34,38,42,46,50,54,58,62,67
174 .TP 5
175 .B \-f
176 FORTRAN
177 .br
178 1,7,11,15,19,23
179 .TP 5
180 .B \-p
181 PL/I
182 .br
183 1,5,9,13,17,21,25,29,33,37,41,45,49,53,57,61
184 .TP 5
185 .B \-s
186 SNOBOL
187 .br
188 1,10,55
189 .TP 5
190 .B \-u
191 UNIVAC 1100 Assembler
192 .br
193 1,12,20,44
194 .SS Margins
195 A few terminals expose a means of changing their left and right margins.
196 \fBtabs\fP supports this feature with an option.
197 .TP 5
198 .BI +m \ margin
199 The effect depends on whether the terminal has the margin capabilities:
200 .RS
201 .bP
202 If the terminal provides the capability for setting the left margin,
203 \fBtabs\fP uses this,
204 and adjusts the available tab stop widths.
205 .bP
206 If the terminal does not provide the margin capabilities,
207 \fBtabs\fP imitates their effect,
208 putting tab stops at appropriate places on each line.
209 The terminal's left margin is not modified.
210 .RE
211 .IP
212 If the
213 .I margin
214 parameter is omitted,
215 the default is 10.
216 Use
217 .B +m0
218 to reset the left margin,
219 that is,
220 to make it the left edge of the terminal's display.
221 Before setting a left margin,
222 \fBtabs\fP resets the margin to reduce problems that might arise
223 from moving the cursor to the left of the current left margin.
224 .PP
225 When setting or resetting the left margin,
226 \fBtabs\fP may also reset the right margin.
227 .SH FILES
228 .TP
229 .I /usr/share/tabset
230 tab stop initialization database
231 .SH PORTABILITY
232 IEEE Std 1003.1/The Open Group Base Specifications Issue\ 7
233 (POSIX.1-2008)
234 describes a
235 .I tabs
236 utility.
237 However,
238 .bP
239 this standard describes a
240 .B +m
241 option to set a terminal's left margin.
242 Very few of the entries in the terminal database provide the
243 .B \%set_left_margin
244 .RB ( smgl )
245 or
246 .B \%set_left_margin_parm
247 .RB \%( smglp )
248 capabilities needed to support the feature.
249 .bP
250 Unlike
251 .IR tput ,
252 .I tabs
253 has no specification in X/Open Curses Issue\ 7.
254 .PP
255 The
256 .B \-d
257 (debug) and
258 .B \-n
259 (no-op) options are
260 .I \%ncurses
261 extensions not provided by other implementations.
262 .SH HISTORY
263 A
264 .I tabs
265 utility appeared in PWB/Unix 1.0 (1977).
266 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=PWB1/sys/source/s2/\
267 .\" tabs.c
268 A reduced version shipped in Seventh Edition Unix
269 (early 1979)
270 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=V7/usr/src/cmd/tabs.c
271 and in 3BSD
272 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=3BSD/usr/src/cmd/\
273 .\" tabs.c
274 (later the same year);
275 it supported an option \*(``\-n\*('' to set the first tab stop at the
276 left margin.
277 That option is not specified by POSIX.
278 .PP
279 The PWB/Unix
280 .I tabs
281 utility returned in System III (1980),
282 and used built-in tables
283 to support a half-dozen hardcopy terminal (printer) types.
284 It also had logic to support setting the left margin,
285 as well as a feature for copying the tab settings from a file.
286 .PP
287 Versions of the program in later releases of AT&T Unix,
288 such as SVr4,
289 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=SysVR4/cmd/tabs/tabs.c
290 added support for the terminal database,
291 but retained the tables to support the printers.
292 By this time,
293 System\ V
294 .I tput
295 had incorporated the tab stop initialization feature of BSD's
296 .I tset
297 from 1982,
298 but employed the
299 .I \%term\%info
300 database to do so.
301 .PP
302 The
303 .B +m
304 option was documented in the POSIX Base Specifications Issue\ 5
305 (Unix98, 1997),
306 then omitted in Issue\ 6
307 (Unix03, 2004)
308 without express motivation,
309 though an introductory comment
310 \*(``and optionally adjusts the margin\*('' remains,
311 overlooked in the removal.
312 The
313 .I tabs
314 utility documented in Issues 6 and later has no mechanism for setting
315 margins.
316 The
317 .B +m
318 option in
319 .IR \%ncurses 's
320 implementation
321 differs from the SVr4 feature by using terminal capabilities
322 rather than built-in tables.
323 .PP
324 POSIX documents no limit on the number of tab stops.
325 Other implementations impose one;
326 the limit is 20 in PWB/Unix's
327 .I tabs
328 utility.
329 While some terminals may not accept an arbitrary number of tab stops,
330 .I \%ncurses
331 attempts to set tab stops up to the right margin
332 if the list thereof is sufficiently long.
333 .PP
334 The \*(``Rationale\*('' section of the Issue\ 6
335 .I tabs
336 reference page
337 .\" https://pubs.opengroup.org/onlinepubs/009604499/utilities/tabs.html
338 details how the committee considered redesigning the
339 .I tabs
340 and
341 .I tput
342 utilities,
343 without settling on an improved solution.
344 It claims that
345 .PP
346 .RS 4
347 no known historical version of
348 .I tabs
349 supports the capability of setting arbitrary tab stops.
350 .RE
351 .PP
352 The feature described in subsection \*(``Explicit Lists\*('' above was
353 implemented in PWB/Unix,
354 .\" see URL above
355 and permitted the setting of arbitrary tab stops nevertheless.
356 .SH SEE ALSO
357 \fB\%infocmp\fP(1),
358 \fB\%tset\fP(1),
359 \fB\%ncurses\fP(3NCURSES),
360 \fB\%terminfo\fP(5)