5cb0e3fa555039c3d17ad1a88562127678dc4ba6
[ncurses.git] / man / tabs.1
1 .\"***************************************************************************
2 .\" Copyright (c) 2008-2013,2016 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.15 2016/12/31 16:07:39 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 .IP \(bu 4
38 ..
39 .de NS
40 .ie \n(.sp
41 .el    .sp .5
42 .ie \n(.in +4
43 .el    .in +2
44 .nf
45 .ft C                   \" Courier
46 ..
47 .de NE
48 .fi
49 .ft R
50 .in -4
51 ..
52 .SH NAME
53 \fB@TABS@\fR \- set tabs on a terminal
54 .SH SYNOPSIS
55 \fB@TABS@\fR [\fIoptions\fR]] \fI[tabstop-list]\fR
56 .SH DESCRIPTION
57 .PP
58 The \fB@TABS@\fP program clears and sets tab-stops on the terminal.
59 This uses the terminfo \fIclear_all_tabs\fP and \fIset_tab\fP capabilities.
60 If either is absent, \fB@TABS@\fP is unable to clear/set tab-stops.
61 The terminal should be configured to use hard tabs, e.g.,
62 .NS
63 stty tab0
64 .NE
65 .PP
66 Like \fB@CLEAR@\fR(1), \fB@TABS@\fR writes to the standard output.
67 You can redirect the standard output to a file (which prevents
68 \fB@TABS@\fR from actually changing the tabstops),
69 and later \fBcat\fP the file to the screen, setting tabstops at that point.
70 .SH OPTIONS
71 .SS General Options
72 .TP 5
73 .BI \-T "name"
74 Tell \fB@TABS@\fP which terminal type to use.
75 If this option is not given, \fB@TABS@\fP will use the \fB$TERM\fP
76 environment variable.
77 If that is not set, it will use the \fIansi+tabs\fP entry.
78 .TP 5
79 .B \-d
80 The debugging option shows a ruler line, followed by two data lines.
81 The first data line shows the expected tab-stops marked with asterisks.
82 The second data line shows the actual tab-stops, marked with asterisks.
83 .TP 5
84 .B \-n
85 This option tells \fB@TABS@\fP to check the options and run any debugging
86 option, but not to modify the terminal settings.
87 .TP
88 \fB\-V\fR
89 reports the version of ncurses which was used in this program, and exits.
90 .PP
91 The \fB@TABS@\fP program processes a single list of tab stops.
92 The last option to be processed which defines a list is the one that
93 determines the list to be processed.
94 .SS Implicit Lists
95 Use a single number as an option, e.g., \*(``\fB\-5\fP\*('' to set tabs at the given
96 interval (in this case 1, 6, 11, 16, 21, etc.).  Tabs are repeated up to
97 the right margin of the screen.
98 .PP
99 Use \*(``\fB\-0\fP\*('' to clear all tabs.
100 .PP
101 Use \*(``\fB\-8\fP\*('' to set tabs to the standard interval.
102 .SS Explicit Lists
103 An explicit list can be defined after the options
104 (this does not use a \*(``\-\*('').
105 The values in the list must be in increasing numeric order,
106 and greater than zero.
107 They are separated by a comma or a blank, for example,
108 .NS
109 tabs 1,6,11,16,21
110 .br
111 tabs 1 6 11 16 21
112 .NE
113 .PP
114 Use a \*(``+\*('' to treat a number as an increment relative to the previous value,
115 e.g.,
116 .NS
117 tabs 1,+5,+5,+5,+5
118 .NE
119 .PP
120 which is equivalent to the 1,6,11,16,21 example.
121 .SS Predefined Tab-Stops
122 X/Open defines several predefined lists of tab stops.
123 .TP 5
124 .B \-a
125 Assembler, IBM S/370, first format
126 .TP 5
127 .B \-a2
128 Assembler, IBM S/370, second format
129 .TP 5
130 .B \-c
131 COBOL, normal format
132 .TP 5
133 .B \-c2
134 COBOL compact format
135 .TP 5
136 .B \-c3
137 COBOL compact format extended
138 .TP 5
139 .B \-f
140 FORTRAN
141 .TP 5
142 .B \-p
143 PL/I
144 .TP 5
145 .B \-s
146 SNOBOL
147 .TP 5
148 .B \-u
149 UNIVAC 1100 Assembler
150 .SH PORTABILITY
151 .PP
152 IEEE Std 1003.1/The Open Group  Base Specifications Issue 7 (POSIX.1-2008) describes
153 a \fBtabs\fP utility.  However
154 .bP
155 This standard describes a \fB+m\fP option, to set a terminal's left-margin.
156 Very few of the entries in the terminal database provide this capability.
157 .bP
158 There is no counterpart in X/Open Curses Issue 7 for this utility,
159 unlike \fB@TPUT@(1)\fP.
160 .PP
161 The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided
162 by other implementations.
163 .PP
164 Documentation for other implementations states that there is a limit on the
165 number of tab stops.  While some terminals may not accept an arbitrary number
166 of tab stops, this implementation will attempt to set tab stops up to the
167 right margin of the screen, if the given list happens to be that long.
168 .SH SEE ALSO
169 \fB@TSET@\fR(1),
170 \fB@INFOCMP@\fR(1M),
171 \fBcurses\fR(3X),
172 \fBterminfo\fR(\*n).
173 .PP
174 This describes \fBncurses\fR
175 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).