Skip to content

Commit 6271d94

Browse files
Frederick Eatongitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c263279 commit 6271d94

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

Documentation/git-column.txt

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ SYNOPSIS
1313

1414
DESCRIPTION
1515
-----------
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.
1720

1821
OPTIONS
1922
-------
@@ -23,7 +26,7 @@ OPTIONS
2326

2427
--mode=<mode>::
2528
Specify layout mode. See configuration variable column.ui for option
26-
syntax.
29+
syntax in linkgit:git-config[1].
2730

2831
--raw-mode=<n>::
2932
Same as --mode but take mode encoded as a number. This is mainly used
@@ -43,6 +46,34 @@ OPTIONS
4346
--padding=<N>::
4447
The number of spaces between columns. One space by default.
4548

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+
4677
GIT
4778
---
4879
Part of the linkgit:git[1] suite

0 commit comments

Comments
 (0)