ncurses 5.9 - patch 20130615
[ncurses.git] / man / tabs.1
1 .\"***************************************************************************
2 .\" Copyright (c) 2008-2011,2013 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.10 2013/06/11 00:56:40 tom Exp $
30 .TH @TABS@ 1 ""
31 .ds n 5
32 .SH NAME
33 \fB@TABS@\fR \- set tabs on a terminal
34 .SH SYNOPSIS
35 \fB@TABS@\fR [\fIoptions\fR]] \fI[tabstop-list]\fR
36 .br
37 .SH DESCRIPTION
38 .PP
39 The \fB@TABS@\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, \fB@TABS@\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 \fB@TABS@\fP which terminal type to use.
52 If this option is not given, \fB@TABS@\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 \fB@TABS@\fP to check the options and run any debugging
63 option, but not to modify the terminal settings.
64 .TP
65 \fB\-V\fR
66 reports the version of ncurses which was used in this program, and exits.
67 .PP
68 The \fB@TABS@\fP program processes a single list of tab stops.
69 The last option to be processed which defines a list is the one that
70 determines the list to be processed.
71 .SS Implicit Lists
72 Use a single number as an option, e.g., "\fB\-5\fP" to set tabs at the given
73 interval (in this case 1, 6, 11, 16, 21, etc.).  Tabs are repeated up to
74 the right margin of the screen.
75 .PP
76 Use "\fB\-0\fP" to clear all tabs.
77 .PP
78 Use "\fB\-8\fP" to set tabs to the standard interval.
79 .SS Explicit Lists
80 An explicit list can be defined after the options (this does not use a "\-").
81 The values in the list must be in increasing numeric order, and greater than
82 zero.  They are separated by a comma or a blank, for example,
83 .sp
84 .RS
85 tabs 1,6,11,16,21
86 .br
87 tabs 1 6 11 16 21
88 .RE
89 Use a '+' to treat a number as an increment relative to the previous value,
90 e.g.,
91 .sp
92 .RS
93 tabs 1,+5,+5,+5,+5
94 .RE
95 which is equivalent to the 1,6,11,16,21 example.
96 .SS Predefined Tab-Stops
97 X/Open defines several predefined lists of tab stops.
98 .TP 5
99 .B \-a
100 Assembler, IBM S/370, first format
101 .TP 5
102 .B \-a2
103 Assembler, IBM S/370, second format
104 .TP 5
105 .B \-c
106 COBOL, normal format
107 .TP 5
108 .B \-c2
109 COBOL compact format
110 .TP 5
111 .B \-c3
112 COBOL compact format extended
113 .TP 5
114 .B \-f
115 FORTRAN
116 .TP 5
117 .B \-p
118 PL/I
119 .TP 5
120 .B \-s
121 SNOBOL
122 .TP 5
123 .B \-u
124 UNIVAC 1100 Assembler
125 .SH PORTABILITY
126 .PP
127 X/Open describes a \fB+m\fP option, to set a terminal's left-margin.
128 Very few of the entries in the terminal database provide this capability.
129 .PP
130 The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided
131 by other implementations.
132 .PP
133 Documentation for other implementations states that there is a limit on the
134 number of tab stops.  While some terminals may not accept an arbitrary number
135 of tab stops, this implementation will attempt to set tab stops up to the
136 right margin of the screen, if the given list happens to be that long.
137 .SH SEE ALSO
138 \fB@TSET@\fR(1),
139 \fB@INFOCMP@\fR(1M),
140 \fBcurses\fR(3X),
141 \fBterminfo\fR(\*n).
142 .PP
143 This describes \fBncurses\fR
144 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).