import updated upstream code
[alioth/rs.git] / rs.1
1 .\"     $MirOS: src/usr.bin/rs/rs.1,v 1.2 2012/03/25 13:47:52 tg Exp $
2 .\"     $OpenBSD: rs.1,v 1.15 2009/10/15 07:38:09 sobrado Exp $
3 .\"     $FreeBSD: src/usr.bin/rs/rs.1,v 1.4 1999/08/28 01:05:21 peter Exp $
4 .\"
5 .\" Copyright (c) 1993
6 .\"     The Regents of the University of California.  All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)rs.1        8.2 (Berkeley) 12/30/93
33 .\"
34 .Dd $Mdocdate: March 25 2012 $
35 .Dt RS 1
36 .Os
37 .Sh NAME
38 .Nm rs
39 .Nd reshape a data array
40 .Sh SYNOPSIS
41 .Nm rs
42 .Op Fl CcSs Ns Op Ar x
43 .Op Fl GgKkw Ar N
44 .Op Fl EeHhjmnTtyz
45 .Op Ar rows Op Ar cols
46 .Sh DESCRIPTION
47 .Nm
48 reads the standard input, interpreting each line as a row
49 of blank-separated entries in an array,
50 transforms the array according to the options,
51 and writes it on the standard output.
52 With no arguments it transforms stream input into a columnar
53 format convenient for terminal viewing.
54 .Pp
55 The shape of the input array is deduced from the number of lines
56 and the number of columns on the first line.
57 If that shape is inconvenient, a more useful one might be
58 obtained by skipping some of the input with the
59 .Fl k
60 option.
61 Other options control interpretation of the input columns.
62 .Pp
63 The shape of the output array is influenced by the
64 .Ar rows
65 and
66 .Ar cols
67 specifications, which should be positive integers.
68 If only one of them is a positive integer,
69 .Nm
70 computes a value for the other which will accommodate
71 all of the data.
72 When necessary, missing data are supplied in a manner
73 specified by the options and surplus data are deleted.
74 There are options to control presentation of the output columns,
75 including transposition of the rows and columns.
76 .Pp
77 The options are as follows:
78 .Bl -tag -width Ds
79 .It Fl C Ns Op Ar x
80 Output columns are delimited by the single character
81 .Ar x .
82 A missing
83 .Ar x
84 is taken to be
85 .Ql ^I .
86 .It Fl c Ns Op Ar x
87 Input columns are delimited by the single character
88 .Ar x .
89 A missing
90 .Ar x
91 is taken to be
92 .Ql ^I .
93 .It Fl E
94 Consider each character of input as an array entry.
95 .It Fl e
96 Consider each line of input as an array entry.
97 .It Fl G Ns Ar N
98 The gutter width has
99 .Ar N
100 percent of the maximum column width added to it.
101 .It Fl g Ns Ar N
102 The gutter width (inter-column space), normally 2, is taken to be
103 .Ar N .
104 .It Fl H
105 Like
106 .Fl h ,
107 but also print the length of each line.
108 .It Fl h
109 Print the shape of the input array and do nothing else.
110 The shape is just the number of lines and the number of
111 entries on the first line.
112 .It Fl j
113 Right adjust entries within columns.
114 .It Fl K Ns Ar N
115 Like
116 .Fl k ,
117 but print the ignored lines.
118 .It Fl k Ns Ar N
119 Ignore the first
120 .Ar N
121 lines of input.
122 .It Fl m
123 Do not trim excess delimiters from the ends of the output array.
124 .It Fl n
125 On lines having fewer entries than the first line,
126 use null entries to pad out the line.
127 Normally, missing entries are taken from the next line of input.
128 .It Fl S Ns Op Ar x
129 Like
130 .Fl C ,
131 but padded strings of
132 .Ar x
133 are delimiters.
134 .It Fl s Ns Op Ar x
135 Like
136 .Fl c ,
137 but maximal strings of
138 .Ar x
139 are delimiters.
140 .It Fl T
141 Print the pure transpose of the input, ignoring any
142 .Ar rows
143 or
144 .Ar cols
145 specification.
146 .It Fl t
147 Fill in the rows of the output array using the columns of the
148 input array, that is, transpose the input while honoring any
149 .Ar rows
150 and
151 .Ar cols
152 specifications.
153 .It Fl w Ns Ar N
154 The width of the display, normally 80, is taken to be the positive
155 integer
156 .Ar N .
157 .It Fl y
158 If there are too few entries to make up the output dimensions,
159 pad the output by recycling the input from the beginning.
160 Normally, the output is padded with blanks.
161 .It Fl z
162 Shrink column widths to fit the largest entries appearing in them.
163 .El
164 .Pp
165 With no arguments,
166 .Nm
167 transposes its input, and assumes one array entry per input line
168 unless the first non-ignored line is longer than the display width.
169 Option letters which take numerical arguments interpret a missing
170 number as zero unless otherwise indicated.
171 .Sh EXAMPLES
172 .Nm
173 can be used as a filter to convert the stream output
174 of certain programs (e.g.,
175 .Xr spell ,
176 .Xr du ,
177 .Xr file ,
178 .Xr look ,
179 .Xr nm ,
180 .Xr who ,
181 and
182 .Xr wc 1 )
183 into a convenient
184 .Dq window
185 format, as in
186 .Bd -literal -offset indent
187 $ who | rs
188 .Ed
189 .Pp
190 This function has been incorporated into the
191 .Xr ls 1
192 program, though for most programs with similar output
193 .Nm
194 suffices.
195 .Pp
196 To convert stream input into vector output and back again, use
197 .Bd -literal -offset indent
198 $ rs 1 0 | rs 0 1
199 .Ed
200 .Pp
201 A 10 by 10 array of random numbers from 1 to 100 and
202 its transpose can be generated with
203 .Bd -literal -offset indent
204 $ jot \-r 100 | rs 10 10 | tee array | rs \-T >tarray
205 .Ed
206 .Pp
207 In the editor
208 .Xr vi 1 ,
209 a file consisting of a multi-line vector with 9 elements per line
210 can undergo insertions and deletions,
211 and then be neatly reshaped into 9 columns with
212 .Bd -literal -offset indent
213 :1,$!rs 0 9
214 .Ed
215 .Pp
216 Finally, to sort a database by the first line of each 4-line field, try
217 .Bd -literal -offset indent
218 $ rs \-eC 0 4 | sort | rs \-c 0 1
219 .Ed
220 .Sh SEE ALSO
221 .Xr jot 1 ,
222 .Xr pr 1 ,
223 .Xr sort 1 ,
224 .Xr vi 1
225 .Sh BUGS
226 Handles only two dimensional arrays.
227 .Pp
228 The algorithm currently reads the whole file into memory,
229 so files that do not fit in memory will not be reshaped.
230 .Pp
231 Fields cannot be defined yet on character positions.
232 .Pp
233 Re-ordering of columns is not yet possible.
234 .Pp
235 There are too many options.