Resync patch with contrib.
[dragonfly.git] / usr.bin / tabs / tabs.1
blob0a859acf669fd7065eb9b233fe70c2e4f3fc7dcf
1 .\" Copyright (c) 2002 Tim J. Robbins.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/usr.bin/tabs/tabs.1,v 1.6 2002/11/26 17:33:36 ru Exp $
26 .\" $DragonFly: src/usr.bin/tabs/tabs.1,v 1.3 2007/07/30 22:11:33 swildner Exp $
27 .\"
28 .Dd June 19, 2004
29 .Dt TABS 1
30 .Os
31 .Sh NAME
32 .Nm tabs
33 .Nd set terminal tabs
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl Ar n | Fl a | a2 | c | c2 | c3 | f | p | s | u
37 .Op Cm +m Ns Op Ar n
38 .Op Fl T Ar type
39 .Nm
40 .Op Fl T Ar type
41 .Op Cm + Ns Op Ar n
42 .Ar n1 Ns Op Ns , Ns Ar n2 , Ns ...
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility displays a series of characters that clear the hardware terminal
47 tab settings then initialises tab stops at specified positions, and
48 optionally adjusts the margin.
49 .Pp
50 In the first synopsis form, the tab stops set depend on the command line
51 options used, and may be one of the predefined formats or at regular
52 intervals.
53 .Pp
54 In the second synopsis form, tab stops are set at positions
55 .Ar n1 , n2 ,
56 etc.
57 If a position is preceded by a
58 .Ql + ,
59 it is relative to the previous position set.
60 No more than 20 positions may be specified.
61 .Pp
62 If no tab stops are specified, the
63 .Dq standard
64 .Ux
65 tab width of 8 is used.
66 .Pp
67 The options are as follows:
68 .Bl -tag -width indent
69 .It Fl Ar n
70 Set a tab stop every
71 .Ar n
72 columns.
74 .Ar n
75 is 0, the tab stops are cleared but no new ones are set.
76 .It Fl a
77 Assembler format (columns 1, 10, 16, 36, 72).
78 .It Fl a2
79 Assembler format (columns 1, 10, 16, 40, 72).
80 .It Fl c
81 .Tn COBOL
82 normal format (columns 1, 8, 12, 16, 20, 55)
83 .It Fl c2
84 .Tn COBOL
85 compact format (columns 1, 6, 10, 14, 49)
86 .It Fl c3
87 .Tn COBOL
88 compact format (columns 1, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46,
89 50, 54, 58, 62, 67).
90 .It Fl f
91 .Tn FORTRAN
92 format (columns 1, 7, 11, 15, 19, 23).
93 .It Fl p
94 .Tn PL/1
95 format (columns 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53,
96 57, 61).
97 .It Fl s
98 .Tn SNOBOL
99 format (columns 1, 10, 55).
100 .It Fl u
101 Assembler format (columns 1, 12, 20, 44).
102 .It Xo
103 .Cm +m Ns Op Ar n ,
104 .Cm + Ns Op Ar n
106 Set an
107 .Ar n
108 character left margin, or 10 if
109 .Ar n
110 is omitted.
111 .It Fl T Ar type
112 Output escape sequence for the terminal type
113 .Ar type .
115 .Sh ENVIRONMENT
117 .Ev LANG , LC_ALL , LC_CTYPE
119 .Ev TERM
120 environment variables affect the execution of
122 as described in
123 .Xr environ 7 .
126 .Fl T
127 option overrides the setting of the
128 .Ev TERM
129 environment variable.
130 If neither
131 .Ev TERM
132 nor the
133 .Fl T
134 option are present,
136 will fail.
137 .Sh DIAGNOSTICS
138 .Ex -std
139 .Sh SEE ALSO
140 .Xr expand 1 ,
141 .Xr stty 1 ,
142 .Xr tput 1 ,
143 .Xr unexpand 1 ,
144 .Xr termcap 5
145 .Sh STANDARDS
148 utility conforms to
149 .St -p1003.1-2001 .
150 .Sh HISTORY
153 utility appeared in PWB
154 .Ux .
155 .Sh BUGS
156 The current
157 .Xr termcap 5
158 database does not define the
159 .Ql ML
160 (set left soft margin) capability for any terminals.