git-column.1: clarify initial description, provide examples
When I read this man page I couldn't figure out what kind of input it was referring to, or how input was being put into columns, or where I should look for the syntax of the --mode option. Signed-off-by: Frederick Eaton <frederik@ofb.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Frederick Eaton committed
Sep 19, 2018 at 13:12 UTC
6271d94769c4db0a2938761d255a438289561639
1 file changed
+33
-2
Documentation/git-column.txt
+33
-2
@@ -13,7 +13,10 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-This command formats its input into multiple columns.
16
+This command formats the lines of its standard input into a table with
17
+multiple columns. Each input line occupies one cell of the table. It
18
+is used internally by other git commands to format output into
19
+columns.
20
21
OPTIONS
22
-------
@@ -23,7 +26,7 @@ OPTIONS
26
27
--mode=<mode>::
28
Specify layout mode. See configuration variable column.ui for option
26
- syntax.
29
+ syntax in linkgit:git-config[1].
30
31
--raw-mode=<n>::
32
Same as --mode but take mode encoded as a number. This is mainly used
@@ -43,6 +46,34 @@ OPTIONS
46
--padding=<N>::
47
The number of spaces between columns. One space by default.
48
49
+EXAMPLES
50
+------
51
+
52
+Format data by columns:
53
+------------
54
+$ seq 1 24 | git column --mode=column --padding=5
55
+1 4 7 10 13 16 19 22
56
+2 5 8 11 14 17 20 23
57
+3 6 9 12 15 18 21 24
58
+------------
59
+
60
+Format data by rows:
61
+------------
62
+$ seq 1 21 | git column --mode=row --padding=5
63
+1 2 3 4 5 6 7
64
+8 9 10 11 12 13 14
65
+15 16 17 18 19 20 21
66
+------------
67
+
68
+List some tags in a table with unequal column widths:
69
+------------
70
+$ git tag --list 'v2.4.*' --column=row,dense
71
+v2.4.0 v2.4.0-rc0 v2.4.0-rc1 v2.4.0-rc2 v2.4.0-rc3
72
+v2.4.1 v2.4.10 v2.4.11 v2.4.12 v2.4.2
73
+v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
74
+v2.4.8 v2.4.9
75
+------------
76
+
77
GIT
78
---
79
Part of the linkgit:git[1] suite