b921bf8570da9e2aabe4da1b60b83da7bc99b99b
[ncurses.git] / doc / html / man / tabs.1.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2008-2018,2019 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   * @Id: tabs.1,v 1.25 2019/06/15 23:08:12 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>tabs 1</TITLE>
37 <link rel="author" href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">tabs 1</H1>
42 <PRE>
43 <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>                     General Commands Manual                    <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>tabs</STRONG> - set tabs on a terminal
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>tabs</STRONG> [<EM>options</EM>]] <EM>[tabstop-list]</EM>
54
55
56 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
57        The  <STRONG>tabs</STRONG> program clears and sets tab-stops on the terminal.  This uses
58        the terminfo <EM>clear</EM><STRONG>_</STRONG><EM>all</EM><STRONG>_</STRONG><EM>tabs</EM> and <EM>set</EM><STRONG>_</STRONG><EM>tab</EM>  capabilities.   If  either  is
59        absent,  <STRONG>tabs</STRONG> is unable to clear/set tab-stops.  The terminal should be
60        configured to use hard tabs, e.g.,
61
62            stty tab0
63
64        Like <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG>tabs</STRONG> writes to the standard output.   You  can  redirect
65        the standard output to a file (which prevents <STRONG>tabs</STRONG> from actually chang-
66        ing the tabstops), and later <STRONG>cat</STRONG> the file to the screen,  setting  tab-
67        stops at that point.
68
69        These  are  hardware  tabs, which cannot be queried rapidly by applica-
70        tions running in the terminal, if at all.  Curses and other full-screen
71        applications  may  use  hardware tabs in optimizing their output to the
72        terminal.  If the hardware tabstops differ from the information in  the
73        terminal  database, the result is unpredictable.  Before running curses
74        programs, you should either reset tab-stops to the standard interval
75
76            tabs -8
77
78        or use the <STRONG>reset</STRONG> program, since the normal initialization sequences  do
79        not ensure that tab-stops are reset.
80
81
82 </PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
83
84 </PRE><H3><a name="h3-General-Options">General Options</a></H3><PRE>
85        <STRONG>-T</STRONG><EM>name</EM>
86             Tell  <STRONG>tabs</STRONG>  which  terminal  type  to  use.  If this option is not
87             given, <STRONG>tabs</STRONG> will use the <STRONG>$TERM</STRONG> environment variable.  If  that  is
88             not set, it will use the <EM>ansi+tabs</EM> entry.
89
90        <STRONG>-d</STRONG>   The  debugging  option  shows  a  ruler line, followed by two data
91             lines.  The first data line shows the  expected  tab-stops  marked
92             with  asterisks.  The second data line shows the actual tab-stops,
93             marked with asterisks.
94
95        <STRONG>-n</STRONG>   This option tells <STRONG>tabs</STRONG> to check the options and run any  debugging
96             option, but not to modify the terminal settings.
97
98        <STRONG>-V</STRONG>   reports the version of ncurses which was used in this program, and
99             exits.
100
101        The <STRONG>tabs</STRONG> program processes a single list of tab stops.  The last option
102        to  be  processed  which  defines a list is the one that determines the
103        list to be processed.
104
105
106 </PRE><H3><a name="h3-Implicit-Lists">Implicit Lists</a></H3><PRE>
107        Use a single number as an option, e.g., "<STRONG>-5</STRONG>" to set tabs at  the  given
108        interval  (in  this case 1, 6, 11, 16, 21, etc.).  Tabs are repeated up
109        to the right margin of the screen.
110
111        Use "<STRONG>-0</STRONG>" to clear all tabs.
112
113        Use "<STRONG>-8</STRONG>" to set tabs to the standard interval.
114
115
116 </PRE><H3><a name="h3-Explicit-Lists">Explicit Lists</a></H3><PRE>
117        An explicit list can be defined after the options (this does not use  a
118        "-").   The values in the list must be in increasing numeric order, and
119        greater than zero.  They are separated by a comma or a blank, for exam-
120        ple,
121
122            tabs 1,6,11,16,21
123            tabs 1 6 11 16 21
124
125        Use  a  "+"  to treat a number as an increment relative to the previous
126        value, e.g.,
127
128            tabs 1,+5,+5,+5,+5
129
130        which is equivalent to the 1,6,11,16,21 example.
131
132
133 </PRE><H3><a name="h3-Predefined-Tab-Stops">Predefined Tab-Stops</a></H3><PRE>
134        X/Open defines several predefined lists of tab stops.
135
136        <STRONG>-a</STRONG>   Assembler, IBM S/370, first format
137
138        <STRONG>-a2</STRONG>  Assembler, IBM S/370, second format
139
140        <STRONG>-c</STRONG>   COBOL, normal format
141
142        <STRONG>-c2</STRONG>  COBOL compact format
143
144        <STRONG>-c3</STRONG>  COBOL compact format extended
145
146        <STRONG>-f</STRONG>   FORTRAN
147
148        <STRONG>-p</STRONG>   PL/I
149
150        <STRONG>-s</STRONG>   SNOBOL
151
152        <STRONG>-u</STRONG>   UNIVAC 1100 Assembler
153
154
155 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
156        <EM>IEEE</EM>  <EM>Std</EM>  <EM>1003.1/The</EM>  <EM>Open</EM>   <EM>Group</EM>   <EM>Base</EM>   <EM>Specifications</EM>   <EM>Issue</EM>   <EM>7</EM>
157        (POSIX.1-2008) describes a <STRONG>tabs</STRONG> utility.  However
158
159        <STRONG>o</STRONG>   This  standard describes a <STRONG>+m</STRONG> option, to set a terminal's left-mar-
160            gin.  Very few of the entries in the terminal database provide  the
161            <STRONG>smgl</STRONG>  (<STRONG>set_left_margin</STRONG>)  or <STRONG>smglp</STRONG> (<STRONG>set_left_margin_parm</STRONG>) capability
162            needed to support the feature.
163
164        <STRONG>o</STRONG>   There is no counterpart in X/Open Curses Issue 7 for this  utility,
165            unlike <STRONG>tput(1)</STRONG>.
166
167        The  <STRONG>-d</STRONG>  (debug)  and <STRONG>-n</STRONG> (no-op) options are extensions not provided by
168        other implementations.
169
170        A <STRONG>tabs</STRONG> utility appeared in PWB/Unix 1.0 (1977), and thereafter in  3BSD
171        (1979).  It supported a single "-n" option (to cause the first tab stop
172        to be set on the left margin).  That option is not documented by POSIX.
173        Initially, <STRONG>tabs</STRONG> used built-in tables rather than the terminal database,
174        to support a half-dozen terminal types.  It also had built-in logic  to
175        support  the left-margin, as well as a feature for copying the tab set-
176        tings from a file.
177
178        Later versions of Unix, e.g., SVr4,  added  support  for  the  terminal
179        database,  but  kept the tables, as a fallback.  In an earlier develop-
180        ment effort, the tab-stop initialization provided by  <STRONG>tset</STRONG>  (1982)  and
181        incorporated into <STRONG>tput</STRONG> uses the terminal database,
182
183        POSIX  documents  no  limits on the number of tab stops.  Documentation
184        for other implementations states that there is a limit on the number of
185        tab  stops.  While some terminals may not accept an arbitrary number of
186        tab stops, this implementation will attempt to set tab stops up to  the
187        right margin of the screen, if the given list happens to be that long.
188
189        The  <EM>Rationale</EM> section of the POSIX documentation goes into some detail
190        about the ways the committee considered redesigning the <STRONG>tabs</STRONG>  and  <STRONG>tput</STRONG>
191        utilities, without proposing an improved solution.  It comments that
192
193             no  known  historical  version  of tabs supports the capability of
194             setting arbitrary tab stops.
195
196        However, the <EM>Explicit</EM> <EM>Lists</EM> described in this manual page  were  imple-
197        mented  in  PWB/Unix.  Those provide the capability of setting abitrary
198        tab stops.
199
200
201 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
202        <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
203
204        This describes <STRONG>ncurses</STRONG> version 6.1 (patch 20190615).
205
206
207
208                                                                        <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>
209 </PRE>
210 <div class="nav">
211 <ul>
212 <li><a href="#h2-NAME">NAME</a></li>
213 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
214 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
215 <li><a href="#h2-OPTIONS">OPTIONS</a>
216 <ul>
217 <li><a href="#h3-General-Options">General Options</a></li>
218 <li><a href="#h3-Implicit-Lists">Implicit Lists</a></li>
219 <li><a href="#h3-Explicit-Lists">Explicit Lists</a></li>
220 <li><a href="#h3-Predefined-Tab-Stops">Predefined Tab-Stops</a></li>
221 </ul>
222 </li>
223 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
224 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
225 </ul>
226 </div>
227 </BODY>
228 </HTML>