xref: /freebsd/usr.bin/rs/rs.1 (revision 77a0943ded95b9e6438f7db70c4a28e4d93946d4)
1.\" Copyright (c) 1993
2.\"	The Regents of the University of California.  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.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. 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.\" $FreeBSD$
34.\"
35.Dd December 30, 1993
36.Dt RS 1
37.Os
38.Sh NAME
39.Nm rs
40.Nd reshape a data array
41.Sh SYNOPSIS
42.Nm
43.Oo
44.Fl Op csCS
45.Op Ar x
46.Op kKgGw
47.Op Ar N
48tTeEnyjhHmz
49.Oc
50.Op Ar rows Op Ar cols
51.Sh DESCRIPTION
52.Nm Rs
53reads the standard input, interpreting each line as a row
54of blank-separated entries in an array,
55transforms the array according to the options,
56and writes it on the standard output.
57With no arguments it transforms stream input into a columnar
58format convenient for terminal viewing.
59.Pp
60The shape of the input array is deduced from the number of lines
61and the number of columns on the first line.
62If that shape is inconvenient, a more useful one might be
63obtained by skipping some of the input with the
64.Fl k
65option.
66Other options control interpretation of the input columns.
67.Pp
68The shape of the output array is influenced by the
69.Ar rows
70and
71.Ar cols
72specifications, which should be positive integers.
73If only one of them is a positive integer,
74.Nm
75computes a value for the other which will accommodate
76all of the data.
77When necessary, missing data are supplied in a manner
78specified by the options and surplus data are deleted.
79There are options to control presentation of the output columns,
80including transposition of the rows and columns.
81.Pp
82The following options are available:
83.Bl -tag -width indent
84.It Fl c Ns Ar x
85Input columns are delimited by the single character
86.Ar x .
87A missing
88.Ar x
89is taken to be `^I'.
90.It Fl s Ns Ar x
91Like
92.Fl c ,
93but maximal strings of
94.Ar x
95are delimiters.
96.It Fl C Ns Ar x
97Output columns are delimited by the single character
98.Ar x .
99A missing
100.Ar x
101is taken to be `^I'.
102.It Fl S Ns Ar x
103Like
104.Fl C ,
105but padded strings of
106.Ar x
107are delimiters.
108.It Fl t
109Fill in the rows of the output array using the columns of the
110input array, that is, transpose the input while honoring any
111.Ar rows
112and
113.Ar cols
114specifications.
115.It Fl T
116Print the pure transpose of the input, ignoring any
117.Ar rows
118or
119.Ar cols
120specification.
121.It Fl k Ns Ar N
122Ignore the first
123.Ar N
124lines of input.
125.It Fl K Ns Ar N
126Like
127.Fl k ,
128but print the ignored lines.
129.It Fl g Ns Ar N
130The gutter width (inter-column space), normally 2, is taken to be
131.Ar N .
132.It Fl G Ns Ar N
133The gutter width has
134.Ar N
135percent of the maximum column width added to it.
136.It Fl e
137Consider each line of input as an array entry.
138.It Fl n
139On lines having fewer entries than the first line,
140use null entries to pad out the line.
141Normally, missing entries are taken from the next line of input.
142.It Fl y
143If there are too few entries to make up the output dimensions,
144pad the output by recycling the input from the beginning.
145Normally, the output is padded with blanks.
146.It Fl h
147Print the shape of the input array and do nothing else.
148The shape is just the number of lines and the number of
149entries on the first line.
150.It Fl H
151Like
152.Fl h ,
153but also print the length of each line.
154.It Fl j
155Right adjust entries within columns.
156.It Fl w Ns Ar N
157The width of the display, normally 80, is taken to be the positive
158integer
159.Ar N .
160.It Fl m
161Do not trim excess delimiters from the ends of the output array.
162.It Fl z
163Adapt column widths to fit the largest entries appearing in them.
164.El
165.Pp
166With no arguments,
167.Nm
168transposes its input, and assumes one array entry per input line
169unless the first non-ignored line is longer than the display width.
170Option letters which take numerical arguments interpret a missing
171number as zero unless otherwise indicated.
172.Sh EXAMPLES
173.Nm Rs
174can be used as a filter to convert the stream output
175of certain programs (e.g.,
176.Xr spell ,
177.Xr du ,
178.Xr file ,
179.Xr look ,
180.Xr nm ,
181.Xr who ,
182and
183.Xr wc 1 )
184into a convenient ``window'' format, as in
185.Bd -literal -offset indent
186% who | rs
187.Ed
188.Pp
189This function has been incorporated into the
190.Xr ls 1
191program, though for most programs with similar output
192.Nm
193suffices.
194.Pp
195To convert stream input into vector output and back again, use
196.Bd -literal -offset indent
197% rs 1 0 | rs 0 1
198.Ed
199.Pp
200A 10 by 10 array of random numbers from 1 to 100 and
201its transpose can be generated with
202.Bd -literal -offset indent
203% jot \-r 100 | rs 10 10 | tee array | rs \-T > tarray
204.Ed
205.Pp
206In the editor
207.Xr vi 1 ,
208a file consisting of a multi-line vector with 9 elements per line
209can undergo insertions and deletions,
210and then be neatly reshaped into 9 columns with
211.Bd -literal -offset indent
212:1,$!rs 0 9
213.Ed
214.Pp
215Finally, to sort a database by the first line of each 4-line field, try
216.Bd -literal -offset indent
217% rs \-eC 0 4 | sort | rs \-c 0 1
218.Ed
219.Sh SEE ALSO
220.Xr jot 1 ,
221.Xr pr 1 ,
222.Xr sort 1 ,
223.Xr vi 1
224.Sh BUGS
225Handles only two dimensional arrays.
226
227The algorithm currently reads the whole file into memory,
228so files that do not fit in memory will not be reshaped.
229
230Fields cannot be defined yet on character positions.
231
232Re-ordering of columns is not yet possible.
233
234There are too many options.
235