ncurses 6.1 - patch 20190209
[ncurses.git] / man / tabs.1
1 .\"***************************************************************************
2 .\" Copyright (c) 2008-2017,2018 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: tabs.1,v 1.19 2018/07/28 21:46:31 tom Exp $
30 .TH @TABS@ 1 ""
31 .ds n 5
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de bP
37 .ie n  .IP \(bu 4
38 .el    .IP \(bu 2
39 ..
40 .de NS
41 .ie n  .sp
42 .el    .sp .5
43 .ie n  .in +4
44 .el    .in +2
45 .nf
46 .ft C                   \" Courier
47 ..
48 .de NE
49 .fi
50 .ft R
51 .ie n  .in -4
52 .el    .in -2
53 ..
54 .SH NAME
55 \fB@TABS@\fR \- set tabs on a terminal
56 .SH SYNOPSIS
57 \fB@TABS@\fR [\fIoptions\fR]] \fI[tabstop-list]\fR
58 .SH DESCRIPTION
59 .PP
60 The \fB@TABS@\fP program clears and sets tab-stops on the terminal.
61 This uses the terminfo \fIclear_all_tabs\fP and \fIset_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@\fR(1), \fB@TABS@\fR writes to the standard output.
69 You can redirect the standard output to a file (which prevents
70 \fB@TABS@\fR from actually changing the tabstops),
71 and later \fBcat\fP the file to the screen, setting tabstops at that point.
72 .SH OPTIONS
73 .SS General Options
74 .TP 5
75 .BI \-T "name"
76 Tell \fB@TABS@\fP which terminal type to use.
77 If this option is not given, \fB@TABS@\fP will use the \fB$TERM\fP
78 environment variable.
79 If that is not set, it will use the \fIansi+tabs\fP entry.
80 .TP 5
81 .B \-d
82 The debugging option shows a ruler line, followed by two data lines.
83 The first data line shows the expected tab-stops marked with asterisks.
84 The second data line shows the actual tab-stops, marked with asterisks.
85 .TP 5
86 .B \-n
87 This option tells \fB@TABS@\fP to check the options and run any debugging
88 option, but not to modify the terminal settings.
89 .TP
90 \fB\-V\fR
91 reports the version of ncurses which was used in this program, and exits.
92 .PP
93 The \fB@TABS@\fP program processes a single list of tab stops.
94 The last option to be processed which defines a list is the one that
95 determines the list to be processed.
96 .SS Implicit Lists
97 Use a single number as an option,
98 e.g., \*(``\fB\-5\fP\*('' to set tabs at the given
99 interval (in this case 1, 6, 11, 16, 21, etc.).
100 Tabs are repeated up to the right margin of the screen.
101 .PP
102 Use \*(``\fB\-0\fP\*('' to clear all tabs.
103 .PP
104 Use \*(``\fB\-8\fP\*('' to set tabs to the standard interval.
105 .SS Explicit Lists
106 An explicit list can be defined after the options
107 (this does not use a \*(``\-\*('').
108 The values in the list must be in increasing numeric order,
109 and greater than zero.
110 They are separated by a comma or a blank, for example,
111 .NS
112 tabs 1,6,11,16,21
113 .br
114 tabs 1 6 11 16 21
115 .NE
116 .PP
117 Use a \*(``+\*('' to treat a number
118 as an increment relative to the previous value,
119 e.g.,
120 .NS
121 tabs 1,+5,+5,+5,+5
122 .NE
123 .PP
124 which is equivalent to the 1,6,11,16,21 example.
125 .SS Predefined Tab-Stops
126 X/Open defines several predefined lists of tab stops.
127 .TP 5
128 .B \-a
129 Assembler, IBM S/370, first format
130 .TP 5
131 .B \-a2
132 Assembler, IBM S/370, second format
133 .TP 5
134 .B \-c
135 COBOL, normal format
136 .TP 5
137 .B \-c2
138 COBOL compact format
139 .TP 5
140 .B \-c3
141 COBOL compact format extended
142 .TP 5
143 .B \-f
144 FORTRAN
145 .TP 5
146 .B \-p
147 PL/I
148 .TP 5
149 .B \-s
150 SNOBOL
151 .TP 5
152 .B \-u
153 UNIVAC 1100 Assembler
154 .SH PORTABILITY
155 .PP
156 \fIIEEE Std 1003.1/The Open Group Base Specifications Issue 7\fP (POSIX.1-2008)
157 describes a \fBtabs\fP utility.
158 However
159 .bP
160 This standard describes a \fB+m\fP option, to set a terminal's left-margin.
161 Very few of the entries in the terminal database provide this capability.
162 .bP
163 There is no counterpart in X/Open Curses Issue 7 for this utility,
164 unlike \fB@TPUT@(1)\fP.
165 .PP
166 The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided
167 by other implementations.
168 .PP
169 Documentation for other implementations states that there is a limit on the
170 number of tab stops.
171 While some terminals may not accept an arbitrary number
172 of tab stops, this implementation will attempt to set tab stops up to the
173 right margin of the screen, if the given list happens to be that long.
174 .SH SEE ALSO
175 \fB@TSET@\fR(1),
176 \fB@INFOCMP@\fR(1M),
177 \fBcurses\fR(3X),
178 \fBterminfo\fR(\*n).
179 .PP
180 This describes \fBncurses\fR
181 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).