summaryrefslogtreecommitdiffstats
path: root/man1/git-column.1
blob: 6aa6701681380701f0c370d34d72ef71542e8b69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
'\" t
.\"     Title: git-column
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024-04-12
.\"    Manual: Git Manual
.\"    Source: Git 2.44.0.591.g8f7582d995
.\"  Language: English
.\"
.TH "GIT\-COLUMN" "1" "2024\-04\-12" "Git 2\&.44\&.0\&.591\&.g8f7582" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-column \- Display data in columns
.SH "SYNOPSIS"
.sp
.nf
\fIgit column\fR [\-\-command=<name>] [\-\-[raw\-]mode=<mode>] [\-\-width=<width>]
             [\-\-indent=<string>] [\-\-nl=<string>] [\-\-padding=<n>]
.fi
.sp
.SH "DESCRIPTION"
.sp
This command formats the lines of its standard input into a table with multiple columns\&. Each input line occupies one cell of the table\&. It is used internally by other git commands to format output into columns\&.
.SH "OPTIONS"
.PP
\-\-command=<name>
.RS 4
Look up layout mode using configuration variable column\&.<name> and column\&.ui\&.
.RE
.PP
\-\-mode=<mode>
.RS 4
Specify layout mode\&. See configuration variable column\&.ui for option syntax in
\fBgit-config\fR(1)\&.
.RE
.PP
\-\-raw\-mode=<n>
.RS 4
Same as \-\-mode but take mode encoded as a number\&. This is mainly used by other commands that have already parsed layout mode\&.
.RE
.PP
\-\-width=<width>
.RS 4
Specify the terminal width\&. By default
\fIgit column\fR
will detect the terminal width, or fall back to 80 if it is unable to do so\&.
.RE
.PP
\-\-indent=<string>
.RS 4
String to be printed at the beginning of each line\&.
.RE
.PP
\-\-nl=<string>
.RS 4
String to be printed at the end of each line, including newline character\&.
.RE
.PP
\-\-padding=<N>
.RS 4
The number of spaces between columns\&. One space by default\&.
.RE
.SH "EXAMPLES"
.sp
Format data by columns:
.sp
.if n \{\
.RS 4
.\}
.nf
$ seq 1 24 | git column \-\-mode=column \-\-padding=5
1      4      7      10     13     16     19     22
2      5      8      11     14     17     20     23
3      6      9      12     15     18     21     24
.fi
.if n \{\
.RE
.\}
.sp
.sp
Format data by rows:
.sp
.if n \{\
.RS 4
.\}
.nf
$ seq 1 21 | git column \-\-mode=row \-\-padding=5
1      2      3      4      5      6      7
8      9      10     11     12     13     14
15     16     17     18     19     20     21
.fi
.if n \{\
.RE
.\}
.sp
.sp
List some tags in a table with unequal column widths:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git tag \-\-list \*(Aqv2\&.4\&.*\*(Aq \-\-column=row,dense
v2\&.4\&.0  v2\&.4\&.0\-rc0  v2\&.4\&.0\-rc1  v2\&.4\&.0\-rc2  v2\&.4\&.0\-rc3
v2\&.4\&.1  v2\&.4\&.10     v2\&.4\&.11     v2\&.4\&.12     v2\&.4\&.2
v2\&.4\&.3  v2\&.4\&.4      v2\&.4\&.5      v2\&.4\&.6      v2\&.4\&.7
v2\&.4\&.8  v2\&.4\&.9
.fi
.if n \{\
.RE
.\}
.sp
.SH "CONFIGURATION"
.sp
Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
.PP
column\&.ui
.RS 4
Specify whether supported commands should output in columns\&. This variable consists of a list of tokens separated by spaces or commas:
.sp
These options control when the feature should be enabled (defaults to
\fInever\fR):
.PP
\fBalways\fR
.RS 4
always show in columns
.RE
.PP
\fBnever\fR
.RS 4
never show in columns
.RE
.PP
\fBauto\fR
.RS 4
show in columns if the output is to the terminal
.RE
.sp
These options control layout (defaults to
\fIcolumn\fR)\&. Setting any of these implies
\fIalways\fR
if none of
\fIalways\fR,
\fInever\fR, or
\fIauto\fR
are specified\&.
.PP
\fBcolumn\fR
.RS 4
fill columns before rows
.RE
.PP
\fBrow\fR
.RS 4
fill rows before columns
.RE
.PP
\fBplain\fR
.RS 4
show in one column
.RE
.sp
Finally, these options can be combined with a layout option (defaults to
\fInodense\fR):
.PP
\fBdense\fR
.RS 4
make unequal size columns to utilize more space
.RE
.PP
\fBnodense\fR
.RS 4
make equal size columns
.RE
.RE
.PP
column\&.branch
.RS 4
Specify whether to output branch listing in
\fBgit branch\fR
in columns\&. See
\fBcolumn\&.ui\fR
for details\&.
.RE
.PP
column\&.clean
.RS 4
Specify the layout when listing items in
\fBgit clean \-i\fR, which always shows files and directories in columns\&. See
\fBcolumn\&.ui\fR
for details\&.
.RE
.PP
column\&.status
.RS 4
Specify whether to output untracked files in
\fBgit status\fR
in columns\&. See
\fBcolumn\&.ui\fR
for details\&.
.RE
.PP
column\&.tag
.RS 4
Specify whether to output tag listings in
\fBgit tag\fR
in columns\&. See
\fBcolumn\&.ui\fR
for details\&.
.RE
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite