usr.bin/rs/rs.1

   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: src/usr.bin/rs/rs.1,v 1.4.2.5 2002/06/21 15:28:55 charnier Exp $
  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 Oo Cm csCS Oc Ns Op Ar x
  45 .Oo Cm kKgGw Oc Ns Op Ar N
  46 .Cm tTeEnyjhHmz
  47 .Oc
  48 .Op Ar rows Op Ar cols
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility reads the standard input, interpreting each line as a row
  53 of blank-separated entries in an array,
  54 transforms the array according to the options,
  55 and writes it on the standard output.
  56 With no arguments it transforms stream input into a columnar
  57 format convenient for terminal viewing.
  58 .Pp
  59 The shape of the input array is deduced from the number of lines
  60 and the number of columns on the first line.
  61 If that shape is inconvenient, a more useful one might be
  62 obtained by skipping some of the input with the
  63 .Fl k
  64 option.
  65 Other options control interpretation of the input columns.
  66 .Pp
  67 The shape of the output array is influenced by the
  68 .Ar rows
  69 and
  70 .Ar cols
  71 specifications, which should be positive integers.
  72 If only one of them is a positive integer,
  73 .Nm
  74 computes a value for the other which will accommodate
  75 all of the data.
  76 When necessary, missing data are supplied in a manner
  77 specified by the options and surplus data are deleted.
  78 There are options to control presentation of the output columns,
  79 including transposition of the rows and columns.
  80 .Pp
  81 The following options are available:
  82 .Bl -tag -width indent
  83 .It Fl c Ns Ar x
  84 Input columns are delimited by the single character
  85 .Ar x .
  86 A missing
  87 .Ar x
  88 is taken to be `^I'.
  89 .It Fl s Ns Ar x
  90 Like
  91 .Fl c ,
  92 but maximal strings of
  93 .Ar x
  94 are delimiters.
  95 .It Fl C Ns Ar x
  96 Output columns are delimited by the single character
  97 .Ar x .
  98 A missing
  99 .Ar x
 100 is taken to be `^I'.
 101 .It Fl S Ns Ar x
 102 Like
 103 .Fl C ,
 104 but padded strings of
 105 .Ar x
 106 are delimiters.
 107 .It Fl t
 108 Fill in the rows of the output array using the columns of the
 109 input array, that is, transpose the input while honoring any
 110 .Ar rows
 111 and
 112 .Ar cols
 113 specifications.
 114 .It Fl T
 115 Print the pure transpose of the input, ignoring any
 116 .Ar rows
 117 or
 118 .Ar cols
 119 specification.
 120 .It Fl k Ns Ar N
 121 Ignore the first
 122 .Ar N
 123 lines of input.
 124 .It Fl K Ns Ar N
 125 Like
 126 .Fl k ,
 127 but print the ignored lines.
 128 .It Fl g Ns Ar N
 129 The gutter width (inter-column space), normally 2, is taken to be
 130 .Ar N .
 131 .It Fl G Ns Ar N
 132 The gutter width has
 133 .Ar N
 134 percent of the maximum column width added to it.
 135 .It Fl e
 136 Consider each line of input as an array entry.
 137 .It Fl n
 138 On lines having fewer entries than the first line,
 139 use null entries to pad out the line.
 140 Normally, missing entries are taken from the next line of input.
 141 .It Fl y
 142 If there are too few entries to make up the output dimensions,
 143 pad the output by recycling the input from the beginning.
 144 Normally, the output is padded with blanks.
 145 .It Fl h
 146 Print the shape of the input array and do nothing else.
 147 The shape is just the number of lines and the number of
 148 entries on the first line.
 149 .It Fl H
 150 Like
 151 .Fl h ,
 152 but also print the length of each line.
 153 .It Fl j
 154 Right adjust entries within columns.
 155 .It Fl w Ns Ar N
 156 The width of the display, normally 80, is taken to be the positive
 157 integer
 158 .Ar N .
 159 .It Fl m
 160 Do not trim excess delimiters from the ends of the output array.
 161 .It Fl z
 162 Adapt 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 The
 173 .Nm
 174 utility can be used as a filter to convert the stream output
 175 of certain programs (e.g.,
 176 .Xr spell ,
 177 .Xr du ,
 178 .Xr file ,
 179 .Xr look ,
 180 .Xr nm ,
 181 .Xr who ,
 182 and
 183 .Xr wc 1 )
 184 into a convenient ``window'' format, as in
 185 .Bd -literal -offset indent
 186 % who | rs
 187 .Ed
 188 .Pp
 189 This function has been incorporated into the
 190 .Xr ls 1
 191 program, though for most programs with similar output
 192 .Nm
 193 suffices.
 194 .Pp
 195 To 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
 200 A 10 by 10 array of random numbers from 1 to 100 and
 201 its 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
 206 In the editor
 207 .Xr vi 1 ,
 208 a file consisting of a multi-line vector with 9 elements per line
 209 can undergo insertions and deletions,
 210 and then be neatly reshaped into 9 columns with
 211 .Bd -literal -offset indent
 212 :1,$!rs 0 9
 213 .Ed
 214 .Pp
 215 Finally, 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
 225 .Bl -item
 226 .It
 227 Handles only two dimensional arrays.
 228 .It
 229 The algorithm currently reads the whole file into memory,
 230 so files that do not fit in memory will not be reshaped.
 231 .It
 232 Fields cannot be defined yet on character positions.
 233 .It
 234 Re-ordering of columns is not yet possible.
 235 .It
 236 There are too many options.
 237 .El