822e677b975a708fcd0d1f4e3c47e33aad93e88a
[ncurses.git] / man / tabs.1
1 .\"***************************************************************************
2 .\" Copyright 2018-2020,2021 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.30 2021/10/09 23:48:50 tom Exp $
31 .TH @TABS@ 1 ""
32 .ds n 5
33 .ie \n(.g .ds `` \(lq
34 .el       .ds `` ``
35 .ie \n(.g .ds '' \(rq
36 .el       .ds '' ''
37 .de bP
38 .ie n  .IP \(bu 4
39 .el    .IP \(bu 2
40 ..
41 .de NS
42 .ie n  .sp
43 .el    .sp .5
44 .ie n  .in +4
45 .el    .in +2
46 .nf
47 .ft C                   \" Courier
48 ..
49 .de NE
50 .fi
51 .ft R
52 .ie n  .in -4
53 .el    .in -2
54 ..
55 .SH NAME
56 \fB@TABS@\fR \- set tabs on a terminal
57 .SH SYNOPSIS
58 \fB@TABS@\fR [\fIoptions\fR]] \fI[tabstop-list]\fR
59 .SH DESCRIPTION
60 .PP
61 The \fB@TABS@\fP program clears and sets tab-stops on the terminal.
62 This uses the terminfo \fIclear_all_tabs\fP and \fIset_tab\fP capabilities.
63 If either is absent, \fB@TABS@\fP is unable to clear/set tab-stops.
64 The terminal should be configured to use hard tabs, e.g.,
65 .NS
66 stty tab0
67 .NE
68 .PP
69 Like \fB@CLEAR@\fR(1), \fB@TABS@\fR writes to the standard output.
70 You can redirect the standard output to a file (which prevents
71 \fB@TABS@\fR from actually changing the tabstops),
72 and later \fBcat\fP the file to the screen, setting tabstops at that point.
73 .PP
74 These are hardware tabs, which cannot be queried rapidly by applications
75 running in the terminal, if at all.
76 Curses and other full-screen applications may use hardware tabs
77 in optimizing their output to the terminal.
78 If the hardware tabstops differ from the information in the terminal
79 database, the result is unpredictable.
80 Before running curses programs,
81 you should either reset tab-stops to the standard interval
82 .NS
83 tabs -8
84 .NE
85 .PP
86 or use the \fB@RESET@\fP program,
87 since the normal initialization sequences do not ensure that tab-stops
88 are reset.
89 .SH OPTIONS
90 .SS General Options
91 .TP 5
92 .BI \-T "name"
93 Tell \fB@TABS@\fP which terminal type to use.
94 If this option is not given, \fB@TABS@\fP will use the \fB$TERM\fP
95 environment variable.
96 If that is not set, it will use the \fIansi+tabs\fP entry.
97 .TP 5
98 .B \-d
99 The debugging option shows a ruler line, followed by two data lines.
100 The first data line shows the expected tab-stops marked with asterisks.
101 The second data line shows the actual tab-stops, marked with asterisks.
102 .TP 5
103 .B \-n
104 This option tells \fB@TABS@\fP to check the options and run any debugging
105 option, but not to modify the terminal settings.
106 .TP
107 \fB\-V\fR
108 reports the version of ncurses which was used in this program, and exits.
109 .PP
110 The \fB@TABS@\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 .NS
129 tabs 1,6,11,16,21
130 .br
131 tabs 1 6 11 16 21
132 .NE
133 .PP
134 Use a \*(``+\*('' to treat a number
135 as an increment relative to the previous value,
136 e.g.,
137 .NS
138 tabs 1,+5,+5,+5,+5
139 .NE
140 .PP
141 which is equivalent to the 1,6,11,16,21 example.
142 .SS Predefined Tab-Stops
143 POSIX defines several predefined lists of tab stops.
144 .TP 5
145 .B \-a
146 Assembler, IBM S/370, first format
147 .br
148 1,10,16,36,72
149 .TP 5
150 .B \-a2
151 Assembler, IBM S/370, second format
152 .br
153 1,10,16,40,72
154 .TP 5
155 .B \-c
156 COBOL, normal format
157 .br
158 1,8,12,16,20,55
159 .TP 5
160 .B \-c2
161 COBOL compact format
162 .br
163 1,6,10,14,49
164 .TP 5
165 .B \-c3
166 COBOL compact format extended
167 .br
168 1,6,10,14,18,22,26,30,34,38,42,46,50,54,58,62,67
169 .TP 5
170 .B \-f
171 FORTRAN
172 .br
173 1,7,11,15,19,23
174 .TP 5
175 .B \-p
176 PL/I
177 .br
178 1,5,9,13,17,21,25,29,33,37,41,45,49,53,57,61
179 .TP 5
180 .B \-s
181 SNOBOL
182 .br
183 1,10,55
184 .TP 5
185 .B \-u
186 UNIVAC 1100 Assembler
187 .br
188 1,12,20,44
189 .SS Margins
190 A few terminals provide the capability for changing their left/right margins.
191 The @TABS@ program has an option to use this feature:
192 .TP 5
193 .BI \+m \ margin
194 The effect depends on whether the terminal has the margin capabilities:
195 .RS
196 .bP
197 If the terminal provides the capability for setting the left margin,
198 @TABS@ uses this, and adjusts the available width for tab-stops.
199 .bP
200 If the terminal does not provide the margin capabilities,
201 @TABS@ imitates the effect, putting the tab stops at the appropriate
202 place on each line.
203 The terminal's left-margin is not modified.
204 .RE
205 .IP
206 If the \fImargin\fP parameter is omitted, the default is 10.
207 Use \fB\+m0\fP to reset the left margin,
208 i.e., to the left edge of the terminal's display.
209 Before setting a left-margin,
210 @TABS@ resets the margin to reduce problems which might arise
211 on moving the cursor before the current left-margin.
212 .PP
213 When setting or resetting the left-margin,
214 @TABS@ may reset the right-margin.
215 .SH PORTABILITY
216 .PP
217 \fIIEEE Std 1003.1/The Open Group Base Specifications Issue 7\fP (POSIX.1-2008)
218 describes a \fBtabs\fP utility.
219 However
220 .bP
221 This standard describes a \fB+m\fP option, to set a terminal's left-margin.
222 Very few of the entries in the terminal database provide the
223 \fBsmgl\fP (\fBset_left_margin\fP) or
224 \fBsmglp\fP (\fBset_left_margin_parm\fP)
225 capability needed to support the feature.
226 .bP
227 There is no counterpart in X/Open Curses Issue 7 for this utility,
228 unlike \fB@TPUT@\fP(1).
229 .PP
230 The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided
231 by other implementations.
232 .PP
233 A \fBtabs\fP utility appeared in PWB/Unix 1.0 (1977).
234 There was a reduced version of the \fBtabs\fP utility
235 in Unix 7th edition and in 3BSD (1979).
236 The latter supported a single \*(``\-n\*('' option
237 (to cause the first tab stop to be set on the left margin).
238 That option is not documented by POSIX.
239 .PP
240 The PWB/Unix \fBtabs\fP utility, which was included in System III (1980),
241 used built-in tables rather than the terminal database,
242 to support a half-dozen terminal types.
243 It also had built-in logic to support the left-margin,
244 as well as a feature for copying the tab settings from a file.
245 .PP
246 Later versions of Unix, e.g., SVr4,
247 added support for the terminal database,
248 but kept the tables, as a fallback.
249 In an earlier development effort,
250 the tab-stop initialization provided by \fBtset\fP (1982)
251 and incorporated into \fBtput\fP uses the terminal database,
252 .PP
253 POSIX documents no limits on the number of tab stops.
254 Documentation for other implementations states that there is a limit on the
255 number of tab stops
256 (e.g., 20 in PWB/Unix's \fBtabs\fP utility).
257 While some terminals may not accept an arbitrary number
258 of tab stops, this implementation will attempt to set tab stops up to the
259 right margin of the screen, if the given list happens to be that long.
260 .PP
261 The \fIRationale\fP section of the POSIX documentation goes into some
262 detail about the ways the committee considered redesigning the
263 \fBtabs\fP and \fBtput\fP utilities,
264 without proposing an improved solution.
265 It comments that
266 .RS 5
267 .PP
268 no known historical version of tabs supports the capability of setting
269 arbitrary tab stops.
270 .RE
271 .PP
272 However, the \fIExplicit Lists\fP described in this manual page
273 were implemented in PWB/Unix.
274 Those provide the capability of setting abitrary tab stops.
275 .SH SEE ALSO
276 \fB@INFOCMP@\fR(1M),
277 \fB@TSET@\fR(1),
278 \fBcurses\fR(3X),
279 \fBterminfo\fR(\*n).
280 .PP
281 This describes \fBncurses\fR
282 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).