]> git.ipfire.org Git - thirdparty/util-linux.git/blame - text-utils/column.1
libfdisk: (dos) accept start for log.partitions on template
[thirdparty/util-linux.git] / text-utils / column.1
CommitLineData
6dbe3af9
KZ
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. 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.\" @(#)column.1 8.1 (Berkeley) 6/6/93
33.\"
d7a3bf94 34.TH COLUMN 1 "January 2017" "util-linux" "User Commands"
6cebde5c 35.SH NAME
1b19ea31 36column \- columnate lists
6cebde5c 37.SH SYNOPSIS
07990fdc 38.BR column " [options]"
c927a0b9 39.RI [ file ...]
6cebde5c 40.SH DESCRIPTION
232dc924
BS
41The
42.B column
23609217
KZ
43utility formats its input into multiple columns. The util support three modes:
44.TP
45.BR "columns are filled before rows"
46This is the default mode (required by backward compatibility).
47.TP
48.BR "rows are filed before columns"
49This mode is enabled by option \fB-x, \-\-fillrows\fP
50.TP
51.BR "table"
52Determine the number of columns the input contains and create a table. This
53mode is enabled by option \fB-t, \-\-table\fP and columns formatting is
54possible to modify by \fB\-\-table-*\fP options. Use this mode if not sure.
55.PP
56Input is taken from \fIfile\fR, or otherwise from standard input. Empty lines
57are ignored.
6cebde5c
SK
58.PP
59.SH OPTIONS
23609217
KZ
60The argument \fIcolumns\fP for \fB\-\-table-*\fP options is comma separated
61list of the column names as defined by \fB\-\-table-columns\fP or it's column
62number in order as specified by input. It's possible to mix names and numbers.
63.PP
9dbe8e1c
KZ
64.IP "\fB\-J, \-\-json\fP"
65Use JSON output format to print the table, the option
23609217 66\fB\-\-table\-columns\fP is required and the option \fB\-\-table\-name\fP is recommended.
d7a3bf94
KZ
67.IP "\fB\-c, \-\-output\-width\fP \fIwidth\fP"
68Output is formatted to a width specified as number of characters. The original
838ca70c
KZ
69name of this option is --columns; this name is deprecated since v2.30. Note that input
70longer than \fIwidth\fP is not truncated by default.
b06c1ca6 71.IP "\fB\-o, \-\-output\-separator\fP \fIstring\fP"
07990fdc
BS
72Specify the columns delimiter for table output (default is two spaces).
73.IP "\fB\-s, \-\-separator\fP \fIseparators\fP"
74Specify the possible input item delimiters (default is whitespace).
6cebde5c 75.IP "\fB\-t, \-\-table\fP"
6dbe3af9
KZ
76Determine the number of columns the input contains and create a table.
77Columns are delimited with whitespace, by default, or with the characters
b06c1ca6 78supplied using the \fB\-\-output\-separator\fP option.
c927a0b9 79Table output is useful for pretty-printing.
01e335c9 80.IP "\fB\-N, \-\-table-columns\fP \fInames\fP"
11a1092a 81Specify the columns names by comma separated list of names. The names are used
01e335c9
KZ
82for the table header or to addres column in option arguments.
83.IP "\fB\-R, \-\-table-right\fP \fIcolumns\fP"
23609217 84Right align text in the specified columns.
3ba01db0
KZ
85.IP "\fB\-T, \-\-table-truncate\fP \fIcolumns\fP"
86Specify columns where is allowed to truncate text when necessary, otherwise
23609217 87very long table entries may be printed on multiple lines.
1ae24ec2
KZ
88.IP "\fB\-E, \-\-table-noextreme\fP \fIcolumns\fP"
89Specify columns where is possible to ignore unusually long (longer than
90average) cells when calculate column width. The option has impact to the width
c728e000
KZ
91calculation and table formatting, but the printed text is not affected.
92
93The option is used for the last visible column by default.
68916af3
KZ
94.IP "\fB\-W, \-\-table-wrap\fP \fIcolumns\fP"
95Specify columns where is possible to use multi-line cell for long text when
23609217 96necessary.
9624f615 97.IP "\fB\-H, \-\-table-hide\fP \fIcolumns\fP"
23609217 98Don't print specified columns.
166271a9 99.IP "\fB\-O, \-\-table-order\fP \fIcolumns\fP"
23609217 100Specify columns order on output.
9dbe8e1c
KZ
101.IP "\fB\-n, \-\-table-name\fP \fIname\fP"
102Specify the table name used for JSON output. The defaout is "table".
435846ef 103.IP "\fB\-r, \-\-tree\fP \fIcolumn\fP"
60102db5
KZ
104Specify column to use tree-like output. Note that the circular dependencies and
105another anomalies in child and parent relation are silently ignored.
435846ef
KZ
106.IP "\fB\-i, \-\-tree\-id\fP \fIcolumn\fP"
107Specify column with line ID to create child-parent relation.
108.IP "\fB\-p, \-\-tree\-parent\fP \fIcolumn\fP"
109Specify column with parent ID to create child-parent relation.
23609217 110.PP
6cebde5c 111.IP "\fB\-x, \-\-fillrows\fP"
3e094e5f 112Fill rows before filling columns.
07990fdc
BS
113.IP "\fB\-V\fR, \fB\-\-version\fR"
114Display version information and exit.
6cebde5c 115.IP "\fB\-h, \-\-help\fP"
b4362b6f 116Display help text and exit.
6cebde5c 117.SH ENVIRONMENT
07990fdc 118The environment variable \fBCOLUMNS\fR is used to determine the size of
6dbe3af9 119the screen if no other information is available.
6cebde5c 120.SH EXAMPLES
435846ef
KZ
121Print fstab with header line and align number to the right:
122.EX
123\fBsed 's/#.*//' /etc/fstab | column --table --table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ --table-right PASS,FREQ\fR
124.EE
125.PP
126Print a tree:
127.EX
2571d743 128\fBecho -e '1 0 A\\n2 1 AA\\n3 1 AB\\n4 2 AAA\\n5 2 AAB' | column --tree-id 1 --tree-parent 2 --tree 3\fR
435846ef 1291 0 A
2571d743
SK
1302 1 |-AA
1314 2 | |-AAA
1325 2 | `-AAB
1333 1 `-AB
435846ef 134.EE
018dfb0f 135.SH BUGS
07990fdc 136Version 2.23 changed the
018dfb0f
SK
137.B \-s
138option to be non-greedy, for example:
139.PP
140.EX
07990fdc 141\fBprintf "a:b:c\\n1::3\\n" | column -t -s ':'\fR
018dfb0f
SK
142.EE
143.PP
07990fdc 144Old output:
018dfb0f
SK
145.EX
146a b c
1471 3
148.EE
149.PP
07990fdc 150New output (since util-linux 2.23):
018dfb0f
SK
151.EX
152a b c
1531 3
154.EE
6cebde5c
SK
155.SH "SEE ALSO"
156.BR colrm (1),
157.BR ls (1),
158.BR paste (1),
159.BR sort (1)
160.SH HISTORY
161The column command appeared in 4.3BSD-Reno.
162.SH AVAILABILITY
601d12fb 163The column command is part of the util-linux package and is available from
d673b74e 164https://www.kernel.org/pub/linux/utils/util-linux/.