ncurses 5.7 - patch 20081115
[ncurses.git] / man / tabs.1
1 .\"***************************************************************************
2 .\" Copyright (c) 2008 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.2 2008/11/15 23:03:45 tom Exp $
30 .TH @TABS@ 1M ""
31 .ds n 5
32 .SH NAME
33 \fBtabs\fR - set tabs on a terminal
34 .SH SYNOPSIS
35 \fBtabs\fR [\fB-v\fR[\fIn\fR]] [\fB-ahuUV\fR] \fIfile...\fR
36 .br
37 .SH DESCRIPTION
38 .PP
39 The \fBtabs\fP program clears and sets tab-stops on the terminal.
40 This uses the terminfo \fIclear_all_tabs\fP and \fIset_tab\fP capabilities.
41 If either is absent, \fBtabs\fP is unable to clear/set tab-stops.
42 The terminal should be configured to use hard tabs, e.g.,
43 .sp
44 .RS
45 stty tab0
46 .RE
47 .SH OPTIONS
48 .SS General Options
49 .TP 5
50 .BI -T "name"
51 Tell \fBtabs\fP which terminal type to use.
52 If this option is not given, \fBtabs\fP will use the \fB$TERM\fP
53 environment variable.
54 If that is not set, it will use the \fIansi+tabs\fP entry.
55 .TP 5
56 .B -d
57 The debugging option shows a ruler line, followed by two data lines.
58 The first data line shows the expected tab-stops marked with asterisks.
59 The second data line shows the actual tab-stops, marked with asterisks.
60 .TP 5
61 .B -n
62 This option tells \fBtabs\fP to check the options and run any debugging
63 option, but not to modify the terminal settings.
64 .PP
65 The \fBtabs\fP program processes a single list of tab stops.
66 The last option to be processed which defines a list is the one that
67 determines the list to be processed.
68 .SS Implicit Lists
69 Use a single number as an option, e.g., "\fB-5\fP" to set tabs at the given
70 interval (in this case 1, 6, 11, 16, 21, etc.).  Tabs are repeated up to
71 the right margin of the screen.
72 .SS Explicit Lists
73 An explicit list can be defined after the options (this does not use a "-").
74 The values in the list must be in increasing numeric order, and greater than
75 zero.  They are separated by a comma or a blank, for example,
76 .sp
77 .RS
78 tabs 1,6,11,16,21
79 .br
80 tabs 1 6 11 16 21
81 .RE
82 Use a '+' to treat a number as an increment relative to the previous value,
83 e.g.,
84 .sp
85 .RS
86 tabs 1,+5,+5,+5,+5
87 .RE
88 which is equivalent to the 1,6,11,16,21 example.
89 .SS Predefined Tab-Stops
90 X/Open defines several predefined lists of tab stops.
91 .TP 5
92 .B -a
93 Assembler, IBM S/370, first format
94 .TP 5
95 .B -a2
96 Assembler, IBM S/370, second format
97 .TP 5
98 .B -c
99 COBOL, normal format
100 .TP 5
101 .B -c2
102 COBOL compact format
103 .TP 5
104 .B -c3
105 COBOL compact format extended
106 .TP 5
107 .B -f
108 FORTRAN
109 .TP 5
110 .B -p
111 PL/I
112 .TP 5
113 .B -s
114 SNOBOL
115 .TP 5
116 .B -u
117 UNIVAC 1100 Assembler
118 .SH PORTABILITY
119 .PP
120 X/Open describes a \fB+m\fP option, to set a terminal's left-margin.
121 None of the entries in the terminal database provide this capability.
122 .PP
123 The \fB-d\fP (debug) and \fB-n\fP (no-op) options are extensions not provided
124 by other implementations.
125 .PP
126 Documentation for other implementations states that there is a limit on the
127 number of tab stops.  While some terminals may not accept an arbitrary number
128 of tab stops, this implementation will attempt to set tab stops up to the
129 right margin of the screen, if the given list happens to be that long.
130 .SH SEE ALSO
131 \fB@TSET@\fR(1),
132 \fB@INFOCMP@\fR(1M),
133 \fBcurses\fR(3X),
134 \fBterminfo\fR(\*n).
135 .PP
136 This describes \fBncurses\fR
137 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
138 .\"#
139 .\"# The following sets edit modes for GNU EMACS
140 .\"# Local Variables:
141 .\"# mode:nroff
142 .\"# fill-column:79
143 .\"# End: