Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently

[thirdparty/util-linux.git] / text-utils / column.1

diff --git a/text-utils/column.1 b/text-utils/column.1
index 84243b5bd264e2d3c638d445df91f75cbe25015b..e43d6fee406ec63ad969d304eba0963d0cafe2b7 100644 (file)
--- a/text-utils/column.1
+++ b/text-utils/column.1
@@ -46,11 +46,11 @@ utility formats its input into multiple columns.  The util support three modes:
 This is the default mode (required by backward compatibility).
 .TP
 .B rows are filled before columns
 This is the default mode (required by backward compatibility).
 .TP
 .B rows are filled before columns

-This mode is enabled by option \fB-x, \-\-fillrows\fP
+This mode is enabled by option \fB\-x, \-\-fillrows\fP

 .TP
 .B table
 Determine the number of columns the input contains and create a table.  This
 .TP
 .B table
 Determine the number of columns the input contains and create a table.  This

-mode is enabled by option \fB-t, \-\-table\fP and columns formatting is
+mode is enabled by option \fB\-t, \-\-table\fP and columns formatting is

 possible to modify by \fB\-\-table-*\fP options.  Use this mode if not sure.
 .PP
 Input is taken from \fIfile\fR, or otherwise from standard input.  Empty lines
 possible to modify by \fB\-\-table-*\fP options.  Use this mode if not sure.
 .PP
 Input is taken from \fIfile\fR, or otherwise from standard input.  Empty lines


@@ -66,7 +66,7 @@ Use JSON output format to print the table, the option
 \fB\-\-table\-columns\fP is required and the option \fB\-\-table\-name\fP is recommended.
 .IP "\fB\-c, \-\-output\-width\fP \fIwidth\fP"
 Output is formatted to a width specified as number of characters. The original
 \fB\-\-table\-columns\fP is required and the option \fB\-\-table\-name\fP is recommended.
 .IP "\fB\-c, \-\-output\-width\fP \fIwidth\fP"
 Output is formatted to a width specified as number of characters. The original

-name of this option is --columns; this name is deprecated since v2.30. Note that input
+name of this option is \-\-columns; this name is deprecated since v2.30. Note that input

 longer than \fIwidth\fP is not truncated by default.
 .IP "\fB\-d, \-\-table\-noheadings\fP"
 Do not print header. This option allows to use logical column names on command line, but keep the header hidden when print the table.
 longer than \fIwidth\fP is not truncated by default.
 .IP "\fB\-d, \-\-table\-noheadings\fP"
 Do not print header. This option allows to use logical column names on command line, but keep the header hidden when print the table.


@@ -100,8 +100,8 @@ Print header line for each page.
 Specify columns where is possible to use multi-line cell for long text when
 necessary.
 .IP "\fB\-H, \-\-table-hide\fP \fIcolumns\fP"
 Specify columns where is possible to use multi-line cell for long text when
 necessary.
 .IP "\fB\-H, \-\-table-hide\fP \fIcolumns\fP"

-Don't print specified columns. The special placeholder '-' maybe be used to
-hide all unnamed columns (see --table-columns).
+Don't print specified columns. The special placeholder '\-' may be used to
+hide all unnamed columns (see \-\-table-columns).

 .IP "\fB\-O, \-\-table-order\fP \fIcolumns\fP"
 Specify columns order on output.
 .IP "\fB\-n, \-\-table-name\fP \fIname\fP"
 .IP "\fB\-O, \-\-table-order\fP \fIcolumns\fP"
 Specify columns order on output.
 .IP "\fB\-n, \-\-table-name\fP \fIname\fP"


@@ -126,35 +126,15 @@ Display help text and exit.
 .SH ENVIRONMENT
 The environment variable \fBCOLUMNS\fR is used to determine the size of
 the screen if no other information is available.
 .SH ENVIRONMENT
 The environment variable \fBCOLUMNS\fR is used to determine the size of
 the screen if no other information is available.

-.SH EXAMPLES
-Print fstab with header line and align number to the right:
-.EX
-\fBsed 's/#.*//' /etc/fstab | column --table --table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ --table-right PASS,FREQ\fR
-.EE
-.PP
-Print fstab and hide unnamed columns:
-.EX
-\fBsed 's/#.*//' /etc/fstab | column --table --table-columns SOURCE,TARGET,TYPE --table-hide -\fR
-.EE
-.PP
-
-.PP
-Print a tree:
-.EX
-\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
-1  0  A
-2  1  |-AA
-4  2  | |-AAA
-5  2  | `-AAB
-3  1  `-AB
-.EE
+.SH HISTORY
+The column command appeared in 4.3BSD-Reno.

 .SH BUGS
 Version 2.23 changed the
 .B \-s
 option to be non-greedy, for example:
 .PP
 .EX
 .SH BUGS
 Version 2.23 changed the
 .B \-s
 option to be non-greedy, for example:
 .PP
 .EX

-\fBprintf "a:b:c\\n1::3\\n" | column  -t -s ':'\fR
+\fBprintf "a:b:c\\n1::3\\n" | column \-t \-s ':'\fR

 .EE
 .PP
 Old output:
 .EE
 .PP
 Old output:


@@ -177,13 +157,33 @@ has since been corrected (see above). Other implementations of
 .B column
 may continue to use the older documentation, but the behavior should be
 identical in any case.
 .B column
 may continue to use the older documentation, but the behavior should be
 identical in any case.

-.SH "SEE ALSO"
+.SH EXAMPLE
+Print fstab with header line and align number to the right:
+.EX
+\fBsed 's/#.*//' /etc/fstab | column \-\-table \-\-table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ \-\-table-right PASS,FREQ\fR
+.EE
+.PP
+Print fstab and hide unnamed columns:
+.EX
+\fBsed 's/#.*//' /etc/fstab | column \-\-table \-\-table-columns SOURCE,TARGET,TYPE \-\-table-hide \-\fR
+.EE
+.PP
+
+.PP
+Print a tree:
+.EX
+\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
+1  0  A
+2  1  |-AA
+4  2  | |-AAA
+5  2  | `-AAB
+3  1  `-AB
+.EE
+.SH SEE ALSO

 .BR colrm (1),
 .BR ls (1),
 .BR paste (1),
 .BR sort (1)
 .BR colrm (1),
 .BR ls (1),
 .BR paste (1),
 .BR sort (1)

-.SH HISTORY
-The column command appeared in 4.3BSD-Reno.

 .SH AVAILABILITY
 The column command is part of the util-linux package and is available from
 https://www.kernel.org/pub/linux/utils/util-linux/.
 .SH AVAILABILITY
 The column command is part of the util-linux package and is available from
 https://www.kernel.org/pub/linux/utils/util-linux/.