| blob | b36e52818e171c2049eae7ced39f52c0a0fd5962 |
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: 02/17/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.35.1.225.ge2ac9141e6
8 .\" Language: English
9 .\"
10 .TH "GIT\-FOR\-EACH\-REF" "1" "02/17/2022" "Git 2\&.35\&.1\&.225\&.ge2ac91" "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>] [<pattern>\&...]
37 [\-\-points\-at=<object>]
38 [\-\-merged[=<object>]] [\-\-no\-merged[=<object>]]
39 [\-\-contains[=<object>]] [\-\-no\-contains[=<object>]]
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 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\&.
45 .SH "OPTIONS"
46 .PP
47 <pattern>\&...
48 .RS 4
49 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\&.
50 .RE
51 .PP
52 \-\-count=<count>
53 .RS 4
54 By default the command shows all refs that match
55 \fB<pattern>\fR\&. This option makes it stop after showing that many refs\&.
56 .RE
57 .PP
58 \-\-sort=<key>
59 .RS 4
60 A field name to sort on\&. Prefix
61 \fB\-\fR
62 to sort in descending order of the value\&. When unspecified,
63 \fBrefname\fR
64 is used\&. You may use the \-\-sort=<key> option multiple times, in which case the last key becomes the primary key\&.
65 .RE
66 .PP
67 \-\-format=<format>
68 .RS 4
69 A string that interpolates
70 \fB%(fieldname)\fR
71 from a ref being shown and the object it points at\&. If
72 \fBfieldname\fR
73 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,
74 \fB<format>\fR
75 defaults to
76 \fB%(objectname) SPC %(objecttype) TAB %(refname)\fR\&. It also interpolates
77 \fB%%\fR
78 to
79 \fB%\fR, and
80 \fB%xx\fR
81 where
82 \fBxx\fR
83 are hex digits interpolates to character with hex code
84 \fBxx\fR; for example
85 \fB%00\fR
86 interpolates to
87 \fB\e0\fR
88 (NUL),
89 \fB%09\fR
90 to
91 \fB\et\fR
92 (TAB) and
93 \fB%0a\fR
94 to
95 \fB\en\fR
96 (LF)\&.
97 .RE
98 .PP
99 \-\-color[=<when>]
100 .RS 4
101 Respect any colors specified in the
102 \fB\-\-format\fR
103 option\&. The
104 \fB<when>\fR
105 field must be one of
106 \fBalways\fR,
107 \fBnever\fR, or
108 \fBauto\fR
109 (if
110 \fB<when>\fR
111 is absent, behave as if
112 \fBalways\fR
113 was given)\&.
114 .RE
115 .PP
116 \-\-shell, \-\-perl, \-\-python, \-\-tcl
117 .RS 4
118 If given, strings that substitute
119 \fB%(fieldname)\fR
120 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\&.
121 .RE
122 .PP
123 \-\-points\-at=<object>
124 .RS 4
125 Only list refs which points at the given object\&.
126 .RE
127 .PP
128 \-\-merged[=<object>]
129 .RS 4
130 Only list refs whose tips are reachable from the specified commit (HEAD if not specified)\&.
131 .RE
132 .PP
133 \-\-no\-merged[=<object>]
134 .RS 4
135 Only list refs whose tips are not reachable from the specified commit (HEAD if not specified)\&.
136 .RE
137 .PP
138 \-\-contains[=<object>]
139 .RS 4
140 Only list refs which contain the specified commit (HEAD if not specified)\&.
141 .RE
142 .PP
143 \-\-no\-contains[=<object>]
144 .RS 4
145 Only list refs which don\(cqt contain the specified commit (HEAD if not specified)\&.
146 .RE
147 .PP
148 \-\-ignore\-case
149 .RS 4
150 Sorting and filtering refs are case insensitive\&.
151 .RE
152 .SH "FIELD NAMES"
153 .sp
154 Various values from structured fields in referenced objects can be used to interpolate into the resulting output, or as sort keys\&.
155 .sp
156 For all objects, the following names can be used:
157 .PP
158 refname
159 .RS 4
160 The name of the ref (the part after $GIT_DIR/)\&. For a non\-ambiguous short name of the ref append
161 \fB:short\fR\&. The option core\&.warnAmbiguousRefs is used to select the strict abbreviation mode\&. If
162 \fBlstrip=<N>\fR
163 (\fBrstrip=<N>\fR) is appended, strips
164 \fB<N>\fR
165 slash\-separated path components from the front (back) of the refname (e\&.g\&.
166 \fB%(refname:lstrip=2)\fR
167 turns
168 \fBrefs/tags/foo\fR
169 into
170 \fBfoo\fR
171 and
172 \fB%(refname:rstrip=2)\fR
173 turns
174 \fBrefs/tags/foo\fR
175 into
176 \fBrefs\fR)\&. If
177 \fB<N>\fR
178 is a negative number, strip as many path components as necessary from the specified end to leave
179 \fB\-<N>\fR
180 path components (e\&.g\&.
181 \fB%(refname:lstrip=\-2)\fR
182 turns
183 \fBrefs/tags/foo\fR
184 into
185 \fBtags/foo\fR
186 and
187 \fB%(refname:rstrip=\-1)\fR
188 turns
189 \fBrefs/tags/foo\fR
190 into
191 \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\&.
192 .sp
193 \fBstrip\fR
194 can be used as a synonym to
195 \fBlstrip\fR\&.
196 .RE
197 .PP
198 objecttype
199 .RS 4
200 The type of the object (\fBblob\fR,
201 \fBtree\fR,
202 \fBcommit\fR,
203 \fBtag\fR)\&.
204 .RE
205 .PP
206 objectsize
207 .RS 4
208 The size of the object (the same as
209 \fIgit cat\-file \-s\fR
210 reports)\&. Append
211 \fB:disk\fR
212 to get the size, in bytes, that the object takes up on disk\&. See the note about on\-disk sizes in the
213 \fBCAVEATS\fR
214 section below\&.
215 .RE
216 .PP
217 objectname
218 .RS 4
219 The object name (aka SHA\-1)\&. For a non\-ambiguous abbreviation of the object name append
220 \fB:short\fR\&. For an abbreviation of the object name with desired length append
221 \fB:short=<length>\fR, where the minimum length is MINIMUM_ABBREV\&. The length may be exceeded to ensure unique object names\&.
222 .RE
223 .PP
224 deltabase
225 .RS 4
226 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)\&.
227 .RE
228 .PP
229 upstream
230 .RS 4
231 The name of a local ref which can be considered \(lqupstream\(rq from the displayed ref\&. Respects
232 \fB:short\fR,
233 \fB:lstrip\fR
234 and
235 \fB:rstrip\fR
236 in the same way as
237 \fBrefname\fR
238 above\&. Additionally respects
239 \fB:track\fR
240 to show "[ahead N, behind M]" and
241 \fB:trackshort\fR
242 to show the terse version: ">" (ahead), "<" (behind), "<>" (ahead and behind), or "=" (in sync)\&.
243 \fB:track\fR
244 also prints "[gone]" whenever unknown upstream ref is encountered\&. Append
245 \fB:track,nobracket\fR
246 to show tracking information without brackets (i\&.e "ahead N, behind M")\&.
247 .sp
248 For any remote\-tracking branch
249 \fB%(upstream)\fR,
250 \fB%(upstream:remotename)\fR
251 and
252 \fB%(upstream:remoteref)\fR
253 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
254 \fB%(upstream:remoteref):%(upstream)\fR
255 to fetch from
256 \fB%(upstream:remotename)\fR\&.
257 .sp
258 Has no effect if the ref does not have tracking information associated with it\&. All the options apart from
259 \fBnobracket\fR
260 are mutually exclusive, but if used together the last option is selected\&.
261 .RE
262 .PP
263 push
264 .RS 4
265 The name of a local ref which represents the
266 \fB@{push}\fR
267 location for the displayed ref\&. Respects
268 \fB:short\fR,
269 \fB:lstrip\fR,
270 \fB:rstrip\fR,
271 \fB:track\fR,
272 \fB:trackshort\fR,
273 \fB:remotename\fR, and
274 \fB:remoteref\fR
275 options as
276 \fBupstream\fR
277 does\&. Produces an empty string if no
278 \fB@{push}\fR
279 ref is configured\&.
280 .RE
281 .PP
282 HEAD
283 .RS 4
284 \fI*\fR
285 if HEAD matches current ref (the checked out branch), \(aq \(aq otherwise\&.
286 .RE
287 .PP
288 color
289 .RS 4
290 Change output color\&. Followed by
291 \fB:<colorname>\fR, where color names are described under Values in the "CONFIGURATION FILE" section of
292 \fBgit-config\fR(1)\&. For example,
293 \fB%(color:bold red)\fR\&.
294 .RE
295 .PP
296 align
297 .RS 4
298 Left\-, middle\-, or right\-align the content between %(align:\&...) and %(end)\&. The "align:" is followed by
299 \fBwidth=<width>\fR
300 and
301 \fBposition=<position>\fR
302 in any order separated by a comma, where the
303 \fB<position>\fR
304 is either left, right or middle, default being left and
305 \fB<width>\fR
306 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,
307 \fB%(align:<width>,<position>)\fR\&. If the contents length is more than the width then no alignment is performed\&. If used with
308 \fB\-\-quote\fR
309 everything in between %(align:\&...) and %(end) is quoted, but if nested then only the topmost level performs quoting\&.
310 .RE
311 .PP
312 if
313 .RS 4
314 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
315 \fIif\fR
316 condition only on the
317 \fIHEAD\fR
318 ref\&. Append ":equals=<string>" or ":notequals=<string>" to compare the value between the %(if:\&...) and %(then) atoms with the given string\&.
319 .RE
320 .PP
321 symref
322 .RS 4
323 The ref which the given symbolic ref refers to\&. If not a symbolic ref, nothing is printed\&. Respects the
324 \fB:short\fR,
325 \fB:lstrip\fR
326 and
327 \fB:rstrip\fR
328 options in the same way as
329 \fBrefname\fR
330 above\&.
331 .RE
332 .PP
333 worktreepath
334 .RS 4
335 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\&.
336 .RE
337 .sp
338 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\&.
339 .sp
340 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\&.
341 .sp
342 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\&.
343 .sp
344 The raw data in an object is \fBraw\fR\&.
345 .PP
346 raw:size
347 .RS 4
348 The raw data size of the object\&.
349 .RE
350 .sp
351 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\&.
352 .sp
353 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:
354 .PP
355 contents:size
356 .RS 4
357 The size in bytes of the commit or tag message\&.
358 .RE
359 .PP
360 contents:subject
361 .RS 4
362 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
363 \fBcontents:subject\fR, field
364 \fBsubject\fR
365 can also be used to obtain same results\&.
366 \fB:sanitize\fR
367 can be appended to
368 \fBsubject\fR
369 for subject line suitable for filename\&.
370 .RE
371 .PP
372 contents:body
373 .RS 4
374 The remainder of the commit or the tag message that follows the "subject"\&.
375 .RE
376 .PP
377 contents:signature
378 .RS 4
379 The optional GPG signature of the tag\&.
380 .RE
381 .PP
382 contents:lines=N
383 .RS 4
384 The first
385 \fBN\fR
386 lines of the message\&.
387 .RE
388 .sp
389 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)\&.
390 .sp
391 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\&.
392 .sp
393 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\&.
394 .sp
395 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\&.
396 .sp
397 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)\&.
398 .sp
399 Some atoms like %(align) and %(if) always require a matching %(end)\&. We call them "opening atoms" and sometimes denote them as %($open)\&.
400 .sp
401 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\&.
402 .SH "EXAMPLES"
403 .sp
404 An example directly producing formatted text\&. Show the most recent 3 tagged commits:
405 .sp
406 .if n \{\
407 .RS 4
408 .\}
409 .nf
410 #!/bin/sh
412 git for\-each\-ref \-\-count=3 \-\-sort=\(aq\-*authordate\(aq \e
413 \-\-format=\(aqFrom: %(*authorname) %(*authoremail)
414 Subject: %(*subject)
415 Date: %(*authordate)
416 Ref: %(*refname)
418 %(*body)
419 \(aq \(aqrefs/tags\(aq
420 .fi
421 .if n \{\
422 .RE
423 .\}
424 .sp
425 .sp
426 A simple example showing the use of shell eval on the output, demonstrating the use of \-\-shell\&. List the prefixes of all heads:
427 .sp
428 .if n \{\
429 .RS 4
430 .\}
431 .nf
432 #!/bin/sh
434 git for\-each\-ref \-\-shell \-\-format="ref=%(refname)" refs/heads | \e
435 while read entry
436 do
437 eval "$entry"
438 echo `dirname $ref`
439 done
440 .fi
441 .if n \{\
442 .RE
443 .\}
444 .sp
445 .sp
446 A bit more elaborate report on tags, demonstrating that the format may be an entire script:
447 .sp
448 .if n \{\
449 .RS 4
450 .\}
451 .nf
452 #!/bin/sh
454 fmt=\(aq
455 r=%(refname)
456 t=%(*objecttype)
457 T=${r#refs/tags/}
459 o=%(*objectname)
460 n=%(*authorname)
461 e=%(*authoremail)
462 s=%(*subject)
463 d=%(*authordate)
464 b=%(*body)
466 kind=Tag
467 if test "z$t" = z
468 then
469 # could be a lightweight tag
470 t=%(objecttype)
471 kind="Lightweight tag"
472 o=%(objectname)
473 n=%(authorname)
474 e=%(authoremail)
475 s=%(subject)
476 d=%(authordate)
477 b=%(body)
478 fi
479 echo "$kind $T points at a $t object $o"
480 if test "z$t" = zcommit
481 then
482 echo "The commit was authored by $n $e
483 at $d, and titled
485 $s
487 Its message reads as:
488 "
489 echo "$b" | sed \-e "s/^/ /"
490 echo
491 fi
492 \(aq
494 eval=`git for\-each\-ref \-\-shell \-\-format="$fmt" \e
495 \-\-sort=\(aq*objecttype\(aq \e
496 \-\-sort=\-taggerdate \e
497 refs/tags`
498 eval "$eval"
499 .fi
500 .if n \{\
501 .RE
502 .\}
503 .sp
504 .sp
505 An example to show the usage of %(if)\&...%(then)\&...%(else)\&...%(end)\&. This prefixes the current branch with a star\&.
506 .sp
507 .if n \{\
508 .RS 4
509 .\}
510 .nf
511 git for\-each\-ref \-\-format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/
512 .fi
513 .if n \{\
514 .RE
515 .\}
516 .sp
517 .sp
518 An example to show the usage of %(if)\&...%(then)\&...%(end)\&. This prints the authorname, if present\&.
519 .sp
520 .if n \{\
521 .RS 4
522 .\}
523 .nf
524 git for\-each\-ref \-\-format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"
525 .fi
526 .if n \{\
527 .RE
528 .\}
529 .sp
530 .SH "CAVEATS"
531 .sp
532 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\&.
533 .sp
534 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\&.
535 .SH "NOTES"
536 .sp
537 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\&.
538 .sp
539 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\&.
540 .SH "SEE ALSO"
541 .sp
542 \fBgit-show-ref\fR(1)
543 .SH "GIT"
544 .sp
545 Part of the \fBgit\fR(1) suite