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