Annotation of src/usr.bin/column/column.1, Revision 1.18
1.18 ! schwarze 1: .\" $OpenBSD: column.1,v 1.17 2016/10/21 07:42:17 schwarze Exp $
1.1 deraadt 2: .\" $NetBSD: column.1,v 1.3 1995/03/26 09:08:28 glass Exp $
3: .\"
4: .\" Copyright (c) 1989, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
1.9 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" @(#)column.1 8.1 (Berkeley) 6/6/93
32: .\"
1.18 ! schwarze 33: .Dd $Mdocdate: October 21 2016 $
1.7 aaron 34: .Dt COLUMN 1
1.1 deraadt 35: .Os
36: .Sh NAME
37: .Nm column
38: .Nd columnate lists
39: .Sh SYNOPSIS
40: .Nm column
41: .Op Fl tx
42: .Op Fl c Ar columns
43: .Op Fl s Ar sep
44: .Op Ar
45: .Sh DESCRIPTION
46: The
1.4 aaron 47: .Nm
1.1 deraadt 48: utility formats its input into multiple columns.
1.17 schwarze 49: Each input line provides the text for one output cell.
50: Columns are filled before rows.
51: .Pp
52: The column width is determined by the longest input line rounded
53: up to the nearest tabstop; tabstops are assumed to be at multiples
54: of eight.
55: Output uses tab characters to advance to the next column.
56: The number of columns is chosen to fill the terminal width.
57: .Pp
1.1 deraadt 58: Input is taken from
59: .Ar file
1.14 jmc 60: operands or, by default, from the standard input.
1.17 schwarze 61: Empty lines and lines containing only whitespace are ignored.
1.1 deraadt 62: .Pp
63: The options are as follows:
64: .Bl -tag -width Ds
1.3 aaron 65: .It Fl c Ar columns
1.1 deraadt 66: Output is formatted for a display
67: .Ar columns
68: wide.
1.3 aaron 69: .It Fl s Ar sep
1.17 schwarze 70: Specify a set of characters to delimit columns for the
1.1 deraadt 71: .Fl t
72: option.
1.17 schwarze 73: It defaults to space and tab.
1.1 deraadt 74: .It Fl t
1.17 schwarze 75: Table mode.
76: Each input line provides the text for one output row.
77: It is split into cells using the
1.1 deraadt 78: .Fl s
79: option.
1.17 schwarze 80: Leading, trailing, and multiple adjacent delimiters are ignored.
81: Each column is as wide as the widest cell in it.
82: Columns are separated by two spaces.
1.1 deraadt 83: .It Fl x
1.17 schwarze 84: Fill rows before filling columns.
1.1 deraadt 85: .El
86: .Sh ENVIRONMENT
1.17 schwarze 87: .Bl -tag -width LC_CTYPE
1.1 deraadt 88: .It Ev COLUMNS
1.15 bentley 89: If set to a positive integer,
1.17 schwarze 90: output is formatted to the given width in display columns.
1.15 bentley 91: Otherwise,
92: .Nm
93: defaults to the terminal width, or 80 columns if the output is not a terminal.
1.17 schwarze 94: .It Ev LC_CTYPE
95: The character encoding
96: .Xr locale 1 .
97: It decides which byte sequences form characters, what their display
98: width is, and which characters are whitespace.
99: If unset or set to
100: .Qq C ,
101: .Qq POSIX ,
102: or an unsupported value, each byte except the tab is treated as a
103: character of display width 1.
1.1 deraadt 104: .El
1.13 jmc 105: .Sh EXIT STATUS
106: .Ex -std column
1.1 deraadt 107: .Sh SEE ALSO
108: .Xr colrm 1 ,
1.18 ! schwarze 109: .Xr fmt 1 ,
1.1 deraadt 110: .Xr paste 1 ,
1.18 ! schwarze 111: .Xr rs 1
1.1 deraadt 112: .Sh HISTORY
113: The
114: .Nm
1.6 aaron 115: command appeared in
1.1 deraadt 116: .Bx 4.3 Reno .