| blob | a1b6a53583db3a858518bbf489711f5b0f7bcc61 |
1 '\" t
2 .\" Title: git-for-each-ref
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: 04/25/2023
6 .\" Manual: Git Manual
7 .\" Source: Git 2.40.1.423.g2807bd2c10
8 .\" Language: English
9 .\"
10 .TH "GIT\-FOR\-EACH\-REF" "1" "04/25/2023" "Git 2\&.40\&.1\&.423\&.g2807bd" "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-for-each-ref \- Output information on each ref
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit for\-each\-ref\fR [\-\-count=<count>] [\-\-shell|\-\-perl|\-\-python|\-\-tcl]
36 [(\-\-sort=<key>)\&...] [\-\-format=<format>]
37 [ \-\-stdin | <pattern>\&... ]
38 [\-\-points\-at=<object>]
39 [\-\-merged[=<object>]] [\-\-no\-merged[=<object>]]
40 [\-\-contains[=<object>]] [\-\-no\-contains[=<object>]]
41 .fi
42 .sp
43 .SH "DESCRIPTION"
44 .sp
45 Iterate over all refs that match \fB<pattern>\fR and show them according to the given \fB<format>\fR, after sorting them according to the given set of \fB<key>\fR\&. If \fB<count>\fR is given, stop after showing that many refs\&. The interpolated values in \fB<format>\fR can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language\&.
46 .SH "OPTIONS"
47 .PP
48 <pattern>\&...
49 .RS 4
50 If one or more patterns are given, only refs are shown that match against at least one pattern, either using fnmatch(3) or literally, in the latter case matching completely or from the beginning up to a slash\&.
51 .RE
52 .PP
53 \-\-stdin
54 .RS 4
55 If
56 \fB\-\-stdin\fR
57 is supplied, then the list of patterns is read from standard input instead of from the argument list\&.
58 .RE
59 .PP
60 \-\-count=<count>
61 .RS 4
62 By default the command shows all refs that match
63 \fB<pattern>\fR\&. This option makes it stop after showing that many refs\&.
64 .RE
65 .PP
66 \-\-sort=<key>
67 .RS 4
68 A field name to sort on\&. Prefix
69 \fB\-\fR
70 to sort in descending order of the value\&. When unspecified,
71 \fBrefname\fR
72 is used\&. You may use the \-\-sort=<key> option multiple times, in which case the last key becomes the primary key\&.
73 .RE
74 .PP
75 \-\-format=<format>
76 .RS 4
77 A string that interpolates
78 \fB%(fieldname)\fR
79 from a ref being shown and the object it points at\&. If
80 \fBfieldname\fR
81 is prefixed with an asterisk (\fB*\fR) and the ref points at a tag object, use the value for the field in the object which the tag object refers to (instead of the field in the tag object)\&. When unspecified,
82 \fB<format>\fR
83 defaults to
84 \fB%(objectname) SPC %(objecttype) TAB %(refname)\fR\&. It also interpolates
85 \fB%%\fR
86 to
87 \fB%\fR, and
88 \fB%xx\fR
89 where
90 \fBxx\fR
91 are hex digits interpolates to character with hex code
92 \fBxx\fR; for example
93 \fB%00\fR
94 interpolates to
95 \fB\e0\fR
96 (NUL),
97 \fB%09\fR
98 to
99 \fB\et\fR
100 (TAB) and
101 \fB%0a\fR
102 to
103 \fB\en\fR
104 (LF)\&.
105 .RE
106 .PP
107 \-\-color[=<when>]
108 .RS 4
109 Respect any colors specified in the
110 \fB\-\-format\fR
111 option\&. The
112 \fB<when>\fR
113 field must be one of
114 \fBalways\fR,
115 \fBnever\fR, or
116 \fBauto\fR
117 (if
118 \fB<when>\fR
119 is absent, behave as if
120 \fBalways\fR
121 was given)\&.
122 .RE
123 .PP
124 \-\-shell, \-\-perl, \-\-python, \-\-tcl
125 .RS 4
126 If given, strings that substitute
127 \fB%(fieldname)\fR
128 placeholders are quoted as string literals suitable for the specified host language\&. This is meant to produce a scriptlet that can directly be `eval`ed\&.
129 .RE
130 .PP
131 \-\-points\-at=<object>
132 .RS 4
133 Only list refs which points at the given object\&.
134 .RE
135 .PP
136 \-\-merged[=<object>]
137 .RS 4
138 Only list refs whose tips are reachable from the specified commit (HEAD if not specified)\&.
139 .RE
140 .PP
141 \-\-no\-merged[=<object>]
142 .RS 4
143 Only list refs whose tips are not reachable from the specified commit (HEAD if not specified)\&.
144 .RE
145 .PP
146 \-\-contains[=<object>]
147 .RS 4
148 Only list refs which contain the specified commit (HEAD if not specified)\&.
149 .RE
150 .PP
151 \-\-no\-contains[=<object>]
152 .RS 4
153 Only list refs which don\(cqt contain the specified commit (HEAD if not specified)\&.
154 .RE
155 .PP
156 \-\-ignore\-case
157 .RS 4
158 Sorting and filtering refs are case insensitive\&.
159 .RE
160 .PP
161 \-\-omit\-empty
162 .RS 4
163 Do not print a newline after formatted refs where the format expands to the empty string\&.
164 .RE
165 .SH "FIELD NAMES"
166 .sp
167 Various values from structured fields in referenced objects can be used to interpolate into the resulting output, or as sort keys\&.
168 .sp
169 For all objects, the following names can be used:
170 .PP
171 refname
172 .RS 4
173 The name of the ref (the part after $GIT_DIR/)\&. For a non\-ambiguous short name of the ref append
174 \fB:short\fR\&. The option core\&.warnAmbiguousRefs is used to select the strict abbreviation mode\&. If
175 \fBlstrip=<N>\fR
176 (\fBrstrip=<N>\fR) is appended, strips
177 \fB<N>\fR
178 slash\-separated path components from the front (back) of the refname (e\&.g\&.
179 \fB%(refname:lstrip=2)\fR
180 turns
181 \fBrefs/tags/foo\fR
182 into
183 \fBfoo\fR
184 and
185 \fB%(refname:rstrip=2)\fR
186 turns
187 \fBrefs/tags/foo\fR
188 into
189 \fBrefs\fR)\&. If
190 \fB<N>\fR
191 is a negative number, strip as many path components as necessary from the specified end to leave
192 \fB\-<N>\fR
193 path components (e\&.g\&.
194 \fB%(refname:lstrip=\-2)\fR
195 turns
196 \fBrefs/tags/foo\fR
197 into
198 \fBtags/foo\fR
199 and
200 \fB%(refname:rstrip=\-1)\fR
201 turns
202 \fBrefs/tags/foo\fR
203 into
204 \fBrefs\fR)\&. When the ref does not have enough components, the result becomes an empty string if stripping with positive <N>, or it becomes the full refname if stripping with negative <N>\&. Neither is an error\&.
205 .sp
206 \fBstrip\fR
207 can be used as a synonym to
208 \fBlstrip\fR\&.
209 .RE
210 .PP
211 objecttype
212 .RS 4
213 The type of the object (\fBblob\fR,
214 \fBtree\fR,
215 \fBcommit\fR,
216 \fBtag\fR)\&.
217 .RE
218 .PP
219 objectsize
220 .RS 4
221 The size of the object (the same as
222 \fIgit cat\-file \-s\fR
223 reports)\&. Append
224 \fB:disk\fR
225 to get the size, in bytes, that the object takes up on disk\&. See the note about on\-disk sizes in the
226 \fBCAVEATS\fR
227 section below\&.
228 .RE
229 .PP
230 objectname
231 .RS 4
232 The object name (aka SHA\-1)\&. For a non\-ambiguous abbreviation of the object name append
233 \fB:short\fR\&. For an abbreviation of the object name with desired length append
234 \fB:short=<length>\fR, where the minimum length is MINIMUM_ABBREV\&. The length may be exceeded to ensure unique object names\&.
235 .RE
236 .PP
237 deltabase
238 .RS 4
239 This expands to the object name of the delta base for the given object, if it is stored as a delta\&. Otherwise it expands to the null object name (all zeroes)\&.
240 .RE
241 .PP
242 upstream
243 .RS 4
244 The name of a local ref which can be considered \(lqupstream\(rq from the displayed ref\&. Respects
245 \fB:short\fR,
246 \fB:lstrip\fR
247 and
248 \fB:rstrip\fR
249 in the same way as
250 \fBrefname\fR
251 above\&. Additionally respects
252 \fB:track\fR
253 to show "[ahead N, behind M]" and
254 \fB:trackshort\fR
255 to show the terse version: ">" (ahead), "<" (behind), "<>" (ahead and behind), or "=" (in sync)\&.
256 \fB:track\fR
257 also prints "[gone]" whenever unknown upstream ref is encountered\&. Append
258 \fB:track,nobracket\fR
259 to show tracking information without brackets (i\&.e "ahead N, behind M")\&.
260 .sp
261 For any remote\-tracking branch
262 \fB%(upstream)\fR,
263 \fB%(upstream:remotename)\fR
264 and
265 \fB%(upstream:remoteref)\fR
266 refer to the name of the remote and the name of the tracked remote ref, respectively\&. In other words, the remote\-tracking branch can be updated explicitly and individually by using the refspec
267 \fB%(upstream:remoteref):%(upstream)\fR
268 to fetch from
269 \fB%(upstream:remotename)\fR\&.
270 .sp
271 Has no effect if the ref does not have tracking information associated with it\&. All the options apart from
272 \fBnobracket\fR
273 are mutually exclusive, but if used together the last option is selected\&.
274 .RE
275 .PP
276 push
277 .RS 4
278 The name of a local ref which represents the
279 \fB@{push}\fR
280 location for the displayed ref\&. Respects
281 \fB:short\fR,
282 \fB:lstrip\fR,
283 \fB:rstrip\fR,
284 \fB:track\fR,
285 \fB:trackshort\fR,
286 \fB:remotename\fR, and
287 \fB:remoteref\fR
288 options as
289 \fBupstream\fR
290 does\&. Produces an empty string if no
291 \fB@{push}\fR
292 ref is configured\&.
293 .RE
294 .PP
295 HEAD
296 .RS 4
297 \fI*\fR
298 if HEAD matches current ref (the checked out branch), \*(Aq \*(Aq otherwise\&.
299 .RE
300 .PP
301 color
302 .RS 4
303 Change output color\&. Followed by
304 \fB:<colorname>\fR, where color names are described under Values in the "CONFIGURATION FILE" section of
305 \fBgit-config\fR(1)\&. For example,
306 \fB%(color:bold red)\fR\&.
307 .RE
308 .PP
309 align
310 .RS 4
311 Left\-, middle\-, or right\-align the content between %(align:\&...) and %(end)\&. The "align:" is followed by
312 \fBwidth=<width>\fR
313 and
314 \fBposition=<position>\fR
315 in any order separated by a comma, where the
316 \fB<position>\fR
317 is either left, right or middle, default being left and
318 \fB<width>\fR
319 is the total length of the content with alignment\&. For brevity, the "width=" and/or "position=" prefixes may be omitted, and bare <width> and <position> used instead\&. For instance,
320 \fB%(align:<width>,<position>)\fR\&. If the contents length is more than the width then no alignment is performed\&. If used with
321 \fB\-\-quote\fR
322 everything in between %(align:\&...) and %(end) is quoted, but if nested then only the topmost level performs quoting\&.
323 .RE
324 .PP
325 if
326 .RS 4
327 Used as %(if)\&...%(then)\&...%(end) or %(if)\&...%(then)\&...%(else)\&...%(end)\&. If there is an atom with value or string literal after the %(if) then everything after the %(then) is printed, else if the %(else) atom is used, then everything after %(else) is printed\&. We ignore space when evaluating the string before %(then), this is useful when we use the %(HEAD) atom which prints either "*" or " " and we want to apply the
328 \fIif\fR
329 condition only on the
330 \fIHEAD\fR
331 ref\&. Append ":equals=<string>" or ":notequals=<string>" to compare the value between the %(if:\&...) and %(then) atoms with the given string\&.
332 .RE
333 .PP
334 symref
335 .RS 4
336 The ref which the given symbolic ref refers to\&. If not a symbolic ref, nothing is printed\&. Respects the
337 \fB:short\fR,
338 \fB:lstrip\fR
339 and
340 \fB:rstrip\fR
341 options in the same way as
342 \fBrefname\fR
343 above\&.
344 .RE
345 .PP
346 worktreepath
347 .RS 4
348 The absolute path to the worktree in which the ref is checked out, if it is checked out in any linked worktree\&. Empty string otherwise\&.
349 .RE
350 .PP
351 ahead\-behind:<committish>
352 .RS 4
353 Two integers, separated by a space, demonstrating the number of commits ahead and behind, respectively, when comparing the output ref to the
354 \fB<committish>\fR
355 specified in the format\&.
356 .RE
357 .sp
358 In addition to the above, for commit and tag objects, the header field names (\fBtree\fR, \fBparent\fR, \fBobject\fR, \fBtype\fR, and \fBtag\fR) can be used to specify the value in the header field\&. Fields \fBtree\fR and \fBparent\fR can also be used with modifier \fB:short\fR and \fB:short=<length>\fR just like \fBobjectname\fR\&.
359 .sp
360 For commit and tag objects, the special \fBcreatordate\fR and \fBcreator\fR fields will correspond to the appropriate date or name\-email\-date tuple from the \fBcommitter\fR or \fBtagger\fR fields depending on the object type\&. These are intended for working on a mix of annotated and lightweight tags\&.
361 .sp
362 Fields that have name\-email\-date tuple as its value (\fBauthor\fR, \fBcommitter\fR, and \fBtagger\fR) can be suffixed with \fBname\fR, \fBemail\fR, and \fBdate\fR to extract the named component\&. For email fields (\fBauthoremail\fR, \fBcommitteremail\fR and \fBtaggeremail\fR), \fB:trim\fR can be appended to get the email without angle brackets, and \fB:localpart\fR to get the part before the \fB@\fR symbol out of the trimmed email\&.
363 .sp
364 The raw data in an object is \fBraw\fR\&.
365 .PP
366 raw:size
367 .RS 4
368 The raw data size of the object\&.
369 .RE
370 .sp
371 Note that \fB\-\-format=%(raw)\fR can not be used with \fB\-\-python\fR, \fB\-\-shell\fR, \fB\-\-tcl\fR, because such language may not support arbitrary binary data in their string variable type\&.
372 .sp
373 The message in a commit or a tag object is \fBcontents\fR, from which \fBcontents:<part>\fR can be used to extract various parts out of:
374 .PP
375 contents:size
376 .RS 4
377 The size in bytes of the commit or tag message\&.
378 .RE
379 .PP
380 contents:subject
381 .RS 4
382 The first paragraph of the message, which typically is a single line, is taken as the "subject" of the commit or the tag message\&. Instead of
383 \fBcontents:subject\fR, field
384 \fBsubject\fR
385 can also be used to obtain same results\&.
386 \fB:sanitize\fR
387 can be appended to
388 \fBsubject\fR
389 for subject line suitable for filename\&.
390 .RE
391 .PP
392 contents:body
393 .RS 4
394 The remainder of the commit or the tag message that follows the "subject"\&.
395 .RE
396 .PP
397 contents:signature
398 .RS 4
399 The optional GPG signature of the tag\&.
400 .RE
401 .PP
402 contents:lines=N
403 .RS 4
404 The first
405 \fBN\fR
406 lines of the message\&.
407 .RE
408 .sp
409 Additionally, the trailers as interpreted by \fBgit-interpret-trailers\fR(1) are obtained as \fBtrailers[:options]\fR (or by using the historical alias \fBcontents:trailers[:options]\fR)\&. For valid [:option] values see \fBtrailers\fR section of \fBgit-log\fR(1)\&.
410 .sp
411 For sorting purposes, fields with numeric values sort in numeric order (\fBobjectsize\fR, \fBauthordate\fR, \fBcommitterdate\fR, \fBcreatordate\fR, \fBtaggerdate\fR)\&. All other fields are used to sort in their byte\-value order\&.
412 .sp
413 There is also an option to sort by versions, this can be done by using the fieldname \fBversion:refname\fR or its alias \fBv:refname\fR\&.
414 .sp
415 In any case, a field name that refers to a field inapplicable to the object referred by the ref does not cause an error\&. It returns an empty string instead\&.
416 .sp
417 As a special case for the date\-type fields, you may specify a format for the date by adding \fB:\fR followed by date format name (see the values the \fB\-\-date\fR option to \fBgit-rev-list\fR(1) takes)\&.
418 .sp
419 Some atoms like %(align) and %(if) always require a matching %(end)\&. We call them "opening atoms" and sometimes denote them as %($open)\&.
420 .sp
421 When a scripting language specific quoting is in effect, everything between a top\-level opening atom and its matching %(end) is evaluated according to the semantics of the opening atom and only its result from the top\-level is quoted\&.
422 .SH "EXAMPLES"
423 .sp
424 An example directly producing formatted text\&. Show the most recent 3 tagged commits:
425 .sp
426 .if n \{\
427 .RS 4
428 .\}
429 .nf
430 #!/bin/sh
432 git for\-each\-ref \-\-count=3 \-\-sort=\*(Aq\-*authordate\*(Aq \e
433 \-\-format=\*(AqFrom: %(*authorname) %(*authoremail)
434 Subject: %(*subject)
435 Date: %(*authordate)
436 Ref: %(*refname)
438 %(*body)
439 \*(Aq \*(Aqrefs/tags\*(Aq
440 .fi
441 .if n \{\
442 .RE
443 .\}
444 .sp
445 .sp
446 A simple example showing the use of shell eval on the output, demonstrating the use of \-\-shell\&. List the prefixes of all heads:
447 .sp
448 .if n \{\
449 .RS 4
450 .\}
451 .nf
452 #!/bin/sh
454 git for\-each\-ref \-\-shell \-\-format="ref=%(refname)" refs/heads | \e
455 while read entry
456 do
457 eval "$entry"
458 echo `dirname $ref`
459 done
460 .fi
461 .if n \{\
462 .RE
463 .\}
464 .sp
465 .sp
466 A bit more elaborate report on tags, demonstrating that the format may be an entire script:
467 .sp
468 .if n \{\
469 .RS 4
470 .\}
471 .nf
472 #!/bin/sh
474 fmt=\*(Aq
475 r=%(refname)
476 t=%(*objecttype)
477 T=${r#refs/tags/}
479 o=%(*objectname)
480 n=%(*authorname)
481 e=%(*authoremail)
482 s=%(*subject)
483 d=%(*authordate)
484 b=%(*body)
486 kind=Tag
487 if test "z$t" = z
488 then
489 # could be a lightweight tag
490 t=%(objecttype)
491 kind="Lightweight tag"
492 o=%(objectname)
493 n=%(authorname)
494 e=%(authoremail)
495 s=%(subject)
496 d=%(authordate)
497 b=%(body)
498 fi
499 echo "$kind $T points at a $t object $o"
500 if test "z$t" = zcommit
501 then
502 echo "The commit was authored by $n $e
503 at $d, and titled
505 $s
507 Its message reads as:
508 "
509 echo "$b" | sed \-e "s/^/ /"
510 echo
511 fi
512 \*(Aq
514 eval=`git for\-each\-ref \-\-shell \-\-format="$fmt" \e
515 \-\-sort=\*(Aq*objecttype\*(Aq \e
516 \-\-sort=\-taggerdate \e
517 refs/tags`
518 eval "$eval"
519 .fi
520 .if n \{\
521 .RE
522 .\}
523 .sp
524 .sp
525 An example to show the usage of %(if)\&...%(then)\&...%(else)\&...%(end)\&. This prefixes the current branch with a star\&.
526 .sp
527 .if n \{\
528 .RS 4
529 .\}
530 .nf
531 git for\-each\-ref \-\-format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/
532 .fi
533 .if n \{\
534 .RE
535 .\}
536 .sp
537 .sp
538 An example to show the usage of %(if)\&...%(then)\&...%(end)\&. This prints the authorname, if present\&.
539 .sp
540 .if n \{\
541 .RS 4
542 .\}
543 .nf
544 git for\-each\-ref \-\-format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"
545 .fi
546 .if n \{\
547 .RE
548 .\}
549 .sp
550 .SH "CAVEATS"
551 .sp
552 Note that the sizes of objects on disk are reported accurately, but care should be taken in drawing conclusions about which refs or objects are responsible for disk usage\&. The size of a packed non\-delta object may be much larger than the size of objects which delta against it, but the choice of which object is the base and which is the delta is arbitrary and is subject to change during a repack\&.
553 .sp
554 Note also that multiple copies of an object may be present in the object database; in this case, it is undefined which copy\(cqs size or delta base will be reported\&.
555 .SH "NOTES"
556 .sp
557 When combining multiple \fB\-\-contains\fR and \fB\-\-no\-contains\fR filters, only references that contain at least one of the \fB\-\-contains\fR commits and contain none of the \fB\-\-no\-contains\fR commits are shown\&.
558 .sp
559 When combining multiple \fB\-\-merged\fR and \fB\-\-no\-merged\fR filters, only references that are reachable from at least one of the \fB\-\-merged\fR commits and from none of the \fB\-\-no\-merged\fR commits are shown\&.
560 .SH "SEE ALSO"
561 .sp
562 \fBgit-show-ref\fR(1)
563 .SH "GIT"
564 .sp
565 Part of the \fBgit\fR(1) suite