man/tabs.1

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2021,2023 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.39 2023/07/01 15:46:10 tom Exp $
  31 .TH @TABS@ 1 2023-07-01 "ncurses 6.4" "User commands"
  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 CR                  \" 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@\fP \- set tabs on a terminal
  57 .SH SYNOPSIS
  58 \fB@TABS@\fP [\fIoptions\fP]] \fI[tabstop-list]\fP
  59 .SH DESCRIPTION
  60 The \fB@TABS@\fP program clears and sets tab-stops on the terminal.
  61 This uses the terminfo \fBclear_all_tabs\fP and \fBset_tab\fP capabilities.
  62 If either is absent, \fB@TABS@\fP is unable to clear/set tab-stops.
  63 The terminal should be configured to use hard tabs, e.g.,
  64 .NS
  65 stty tab0
  66 .NE
  67 .PP
  68 Like \fB@CLEAR@\fP(1), \fB@TABS@\fP writes to the standard output.
  69 You can redirect the standard output to a file (which prevents
  70 \fB@TABS@\fP from actually changing the tabstops),
  71 and later \fBcat\fP the file to the screen, setting tabstops at that point.
  72 .PP
  73 These are hardware tabs, which cannot be queried rapidly by applications
  74 running in the terminal, if at all.
  75 Curses and other full-screen applications may use hardware tabs
  76 in optimizing their output to the terminal.
  77 If the hardware tabstops differ from the information in the terminal
  78 database, the result is unpredictable.
  79 Before running curses programs,
  80 you should either reset tab-stops to the standard interval
  81 .NS
  82 tabs -8
  83 .NE
  84 .PP
  85 or use the \fB@RESET@\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 \fB@TABS@\fP which terminal type to use.
  93 If this option is not given, \fB@TABS@\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 \fB@TABS@\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 ncurses which was used in this program, and exits.
 108 .PP
 109 The \fB@TABS@\fP program processes a single list of tab stops.
 110 The last option to be processed which defines a list is the one that
 111 determines the list to be processed.
 112 .SS Implicit Lists
 113 Use a single number as an option,
 114 e.g., \*(``\fB\-5\fP\*('' to set tabs at the given
 115 interval (in this case 1, 6, 11, 16, 21, etc.).
 116 Tabs are repeated up to the right margin of the screen.
 117 .PP
 118 Use \*(``\fB\-0\fP\*('' to clear all tabs.
 119 .PP
 120 Use \*(``\fB\-8\fP\*('' to set tabs to the standard interval.
 121 .SS Explicit Lists
 122 An explicit list can be defined after the options
 123 (this does not use a \*(``\-\*('').
 124 The values in the list must be in increasing numeric order,
 125 and greater than zero.
 126 They are separated by a comma or a blank, for example,
 127 .NS
 128 tabs 1,6,11,16,21
 129 .br
 130 tabs 1 6 11 16 21
 131 .NE
 132 .PP
 133 Use a \*(``+\*('' to treat a number
 134 as an increment relative to the previous value,
 135 e.g.,
 136 .NS
 137 tabs 1,+5,+5,+5,+5
 138 .NE
 139 .PP
 140 which is equivalent to the 1,6,11,16,21 example.
 141 .SS Predefined Tab-Stops
 142 POSIX defines several predefined lists of tab stops.
 143 .TP 5
 144 .B \-a
 145 Assembler, IBM S/370, first format
 146 .br
 147 1,10,16,36,72
 148 .TP 5
 149 .B \-a2
 150 Assembler, IBM S/370, second format
 151 .br
 152 1,10,16,40,72
 153 .TP 5
 154 .B \-c
 155 COBOL, normal format
 156 .br
 157 1,8,12,16,20,55
 158 .TP 5
 159 .B \-c2
 160 COBOL compact format
 161 .br
 162 1,6,10,14,49
 163 .TP 5
 164 .B \-c3
 165 COBOL compact format extended
 166 .br
 167 1,6,10,14,18,22,26,30,34,38,42,46,50,54,58,62,67
 168 .TP 5
 169 .B \-f
 170 FORTRAN
 171 .br
 172 1,7,11,15,19,23
 173 .TP 5
 174 .B \-p
 175 PL/I
 176 .br
 177 1,5,9,13,17,21,25,29,33,37,41,45,49,53,57,61
 178 .TP 5
 179 .B \-s
 180 SNOBOL
 181 .br
 182 1,10,55
 183 .TP 5
 184 .B \-u
 185 UNIVAC 1100 Assembler
 186 .br
 187 1,12,20,44
 188 .SS Margins
 189 A few terminals provide the capability for changing their left/right margins.
 190 The @TABS@ program has an option to use this feature:
 191 .TP 5
 192 .BI +m \ margin
 193 The effect depends on whether the terminal has the margin capabilities:
 194 .RS
 195 .bP
 196 If the terminal provides the capability for setting the left margin,
 197 @TABS@ uses this, and adjusts the available width for tab-stops.
 198 .bP
 199 If the terminal does not provide the margin capabilities,
 200 @TABS@ imitates the effect, putting the tab stops at the appropriate
 201 place on each line.
 202 The terminal's left-margin is not modified.
 203 .RE
 204 .IP
 205 If the \fImargin\fP parameter is omitted, the default is 10.
 206 Use \fB+m0\fP to reset the left margin,
 207 i.e., to the left edge of the terminal's display.
 208 Before setting a left-margin,
 209 @TABS@ resets the margin to reduce problems which might arise
 210 on moving the cursor before the current left-margin.
 211 .PP
 212 When setting or resetting the left-margin,
 213 @TABS@ may reset the right-margin.
 214 .SH PORTABILITY
 215 \fIIEEE Std 1003.1/The Open Group Base Specifications Issue 7\fP (POSIX.1-2008)
 216 describes a \fBtabs\fP utility.
 217 However
 218 .bP
 219 This standard describes a \fB+m\fP option, to set a terminal's left-margin.
 220 Very few of the entries in the terminal database provide the
 221 \fBsmgl\fP (\fBset_left_margin\fP) or
 222 \fBsmglp\fP (\fBset_left_margin_parm\fP)
 223 capability needed to support the feature.
 224 .bP
 225 There is no counterpart in X/Open Curses Issue 7 for this utility,
 226 unlike \fB@TPUT@\fP(1).
 227 .PP
 228 The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided
 229 by other implementations.
 230 .PP
 231 A \fBtabs\fP utility appeared in PWB/Unix 1.0 (1977).
 232 There was a reduced version of the \fBtabs\fP utility
 233 in Unix 7th edition and in 3BSD (1979).
 234 The latter supported a single \*(``\-n\*('' option
 235 (to cause the first tab stop to be set on the left margin).
 236 That option is not documented by POSIX.
 237 .PP
 238 The PWB/Unix \fBtabs\fP utility, which was included in System III (1980),
 239 used built-in tables rather than the terminal database,
 240 to support a half-dozen hardcopy terminal (printer) types.
 241 It also had built-in logic to support the left-margin,
 242 as well as a feature for copying the tab settings from a file.
 243 .PP
 244 Later versions of Unix, e.g., SVr4,
 245 added support for the terminal database,
 246 but kept the tables to support the printers.
 247 In an earlier development effort,
 248 the tab-stop initialization provided by \fBtset\fP (1982)
 249 and incorporated into \fBtput\fP uses the terminal database,
 250 .PP
 251 The \fB+m\fP option was documented
 252 in the Base Specifications Issue 5 (Unix98, 1997),
 253 and omitted in Issue 6 (Unix03, 2004) without documenting the rationale,
 254 though an introductory comment
 255 \fI\*(``and optionally adjusts the margin\*(''\fP remains,
 256 overlooked in the removal.
 257 The documented \fBtabs\fP utility in Issues 6 and later has no mechanism
 258 for setting margins.
 259 The \fB+m\fP option in this implementation differs from the feature
 260 in SVr4 by using terminal capabilities rather than built-in tables.
 261 .PP
 262 POSIX documents no limits on the number of tab stops.
 263 Documentation for other implementations states that there is a limit on the
 264 number of tab stops
 265 (e.g., 20 in PWB/Unix's \fBtabs\fP utility).
 266 While some terminals may not accept an arbitrary number
 267 of tab stops, this implementation will attempt to set tab stops up to the
 268 right margin of the screen, if the given list happens to be that long.
 269 .PP
 270 The \fIRationale\fP section of the POSIX documentation goes into some
 271 detail about the ways the committee considered redesigning the
 272 \fBtabs\fP and \fBtput\fP utilities,
 273 without proposing an improved solution.
 274 It comments that
 275 .RS 5
 276 .PP
 277 no known historical version of tabs supports the capability of setting
 278 arbitrary tab stops.
 279 .RE
 280 .PP
 281 However, the \fIExplicit Lists\fP described in this manual page
 282 were implemented in PWB/Unix.
 283 Those provide the capability of setting abitrary tab stops.
 284 .SH SEE ALSO
 285 \fB@INFOCMP@\fP(1M),
 286 \fB@TSET@\fP(1),
 287 \fBcurses\fP(3X),
 288 \fBterminfo\fP(\*n).
 289 .PP
 290 This describes \fBncurses\fP
 291 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).