Sync with 'maint'
[git.git] / Documentation / git-column.txt
blob18431647a2da9fb825330bbb0eebbc25f11c14c6
1 git-column(1)
2 =============
4 NAME
5 ----
6 git-column - Display data in columns
8 SYNOPSIS
9 --------
10 [verse]
11 'git column' [--command=<name>] [--[raw-]mode=<mode>] [--width=<width>]
12              [--indent=<string>] [--nl=<string>] [--padding=<n>]
14 DESCRIPTION
15 -----------
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.
21 OPTIONS
22 -------
23 --command=<name>::
24         Look up layout mode using configuration variable column.<name> and
25         column.ui.
27 --mode=<mode>::
28         Specify layout mode. See configuration variable column.ui for option
29         syntax in linkgit:git-config[1].
31 --raw-mode=<n>::
32         Same as --mode but take mode encoded as a number. This is mainly used
33         by other commands that have already parsed layout mode.
35 --width=<width>::
36         Specify the terminal width. By default 'git column' will detect the
37         terminal width, or fall back to 80 if it is unable to do so.
39 --indent=<string>::
40         String to be printed at the beginning of each line.
42 --nl=<string>::
43         String to be printed at the end of each line,
44         including newline character.
46 --padding=<N>::
47         The number of spaces between columns. One space by default.
49 EXAMPLES
50 --------
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 ------------
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 ------------
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 ------------
77 CONFIGURATION
78 -------------
80 include::includes/cmd-config-section-all.txt[]
82 include::config/column.txt[]
84 GIT
85 ---
86 Part of the linkgit:git[1] suite