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