Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / usr.bin / column / column.1
1 .\" Copyright (c) 1989, 1990, 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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)column.1    8.1 (Berkeley) 6/6/93
29 .\" $FreeBSD: src/usr.bin/column/column.1,v 1.5.2.4 2001/08/16 13:16:46 ru Exp $
30 .\"
31 .Dd June 6, 1993
32 .Dt COLUMN 1
33 .Os
34 .Sh NAME
35 .Nm column
36 .Nd columnate lists
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl tx
40 .Op Fl c Ar columns
41 .Op Fl s Ar sep
42 .Op Ar
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility formats its input into multiple columns.
47 Rows are filled before columns.
48 Input is taken from
49 .Ar file
50 operands, or, by default, from the standard input.
51 Empty lines are ignored.
52 .Pp
53 The options are as follows:
54 .Bl -tag -width indent
55 .It Fl c
56 Output is formatted for a display
57 .Ar columns
58 wide.
59 .It Fl s
60 Specify a set of characters to be used to delimit columns for the
61 .Fl t
62 option.
63 .It Fl t
64 Determine the number of columns the input contains and create a table.
65 Columns are delimited with whitespace, by default, or with the characters
66 supplied using the
67 .Fl s
68 option.
69 Useful for pretty-printing displays.
70 .It Fl x
71 Fill columns before filling rows.
72 .El
73 .Sh ENVIRONMENT
74 .Bl -tag -width COLUMNS
75 .It Ev COLUMNS
76 The environment variable
77 .Ev COLUMNS
78 is used to determine the size of
79 the screen if no other information is available.
80 .El
81 .Sh EXIT STATUS
82 .Ex -std
83 .Sh EXAMPLES
84 .Dl (printf \&"PERM LINKS OWNER GROUP SIZE MONTH DAY \&"\ \&;\ \&\e
85 .Dl printf \&"HH:MM/YEAR NAME\en\&"\ \&;\ \&\e
86 .Dl ls -l \&| sed 1d) \&| column -t
87 .Sh SEE ALSO
88 .Xr colrm 1 ,
89 .Xr ls 1 ,
90 .Xr paste 1 ,
91 .Xr sort 1
92 .Sh HISTORY
93 The
94 .Nm
95 command appeared in
96 .Bx 4.3 Reno .