| blob | ae996fc15a2bafff824a82d2e084bac0eb638714 |
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 v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-10-04
6 .\" Manual: Git Manual
7 .\" Source: Git 2.47.0.rc1.33.g90fe3800b9
8 .\" Language: English
9 .\"
10 .TH "GIT\-FOR\-EACH\-REF" "1" "2024-10-04" "Git 2\&.47\&.0\&.rc1\&.33\&.g9" "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 [\-\-include\-root\-refs] [ \-\-stdin | <pattern>\&...\: ]
38 [\-\-points\-at=<object>]
39 [\-\-merged[=<object>]] [\-\-no\-merged[=<object>]]
40 [\-\-contains[=<object>]] [\-\-no\-contains[=<object>]]
41 [\-\-exclude=<pattern> \&...\:]
42 .fi
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\&. In addition, the string literal
80 \fB%%\fR
81 renders as
82 \fB%\fR
83 and
84 \fB%xx\fR
85 \- where
86 \fBxx\fR
87 are hex digits \- renders as the character with hex code
88 \fBxx\fR\&. For example,
89 \fB%00\fR
90 interpolates to
91 \fB\e0\fR
92 (NUL),
93 \fB%09\fR
94 to
95 \fB\et\fR
96 (TAB), and
97 \fB%0a\fR
98 to
99 \fB\en\fR
100 (LF)\&.
101 .sp
102 When unspecified,
103 \fB<format>\fR
104 defaults to
105 \fB%(objectname) SPC %(objecttype) TAB %(refname)\fR\&.
106 .RE
107 .PP
108 \-\-color[=<when>]
109 .RS 4
110 Respect any colors specified in the
111 \fB\-\-format\fR
112 option\&. The
113 \fB<when>\fR
114 field must be one of
115 \fBalways\fR,
116 \fBnever\fR, or
117 \fBauto\fR
118 (if
119 \fB<when>\fR
120 is absent, behave as if
121 \fBalways\fR
122 was given)\&.
123 .RE
124 .PP
125 \-\-shell, \-\-perl, \-\-python, \-\-tcl
126 .RS 4
127 If given, strings that substitute
128 \fB%(fieldname)\fR
129 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\&.
130 .RE
131 .PP
132 \-\-points\-at=<object>
133 .RS 4
134 Only list refs which points at the given object\&.
135 .RE
136 .PP
137 \-\-merged[=<object>]
138 .RS 4
139 Only list refs whose tips are reachable from the specified commit (HEAD if not specified)\&.
140 .RE
141 .PP
142 \-\-no\-merged[=<object>]
143 .RS 4
144 Only list refs whose tips are not reachable from the specified commit (HEAD if not specified)\&.
145 .RE
146 .PP
147 \-\-contains[=<object>]
148 .RS 4
149 Only list refs which contain the specified commit (HEAD if not specified)\&.
150 .RE
151 .PP
152 \-\-no\-contains[=<object>]
153 .RS 4
154 Only list refs which don\(cqt contain the specified commit (HEAD if not specified)\&.
155 .RE
156 .PP
157 \-\-ignore\-case
158 .RS 4
159 Sorting and filtering refs are case insensitive\&.
160 .RE
161 .PP
162 \-\-omit\-empty
163 .RS 4
164 Do not print a newline after formatted refs where the format expands to the empty string\&.
165 .RE
166 .PP
167 \-\-exclude=<pattern>
168 .RS 4
169 If one or more patterns are given, only refs which do not match any excluded pattern(s) are shown\&. Matching is done using the same rules as
170 \fB<pattern>\fR
171 above\&.
172 .RE
173 .PP
174 \-\-include\-root\-refs
175 .RS 4
176 List root refs (HEAD and pseudorefs) apart from regular refs\&.
177 .RE
178 .SH "FIELD NAMES"
179 .sp
180 Various values from structured fields in referenced objects can be used to interpolate into the resulting output, or as sort keys\&.
181 .sp
182 For all objects, the following names can be used:
183 .PP
184 refname
185 .RS 4
186 The name of the ref (the part after $GIT_DIR/)\&. For a non\-ambiguous short name of the ref append
187 \fB:short\fR\&. The option core\&.warnAmbiguousRefs is used to select the strict abbreviation mode\&. If
188 \fBlstrip=<N>\fR
189 (\fBrstrip=<N>\fR) is appended, strips
190 \fB<N>\fR
191 slash\-separated path components from the front (back) of the refname (e\&.g\&.
192 \fB%(refname:lstrip=2)\fR
193 turns
194 \fBrefs/tags/foo\fR
195 into
196 \fBfoo\fR
197 and
198 \fB%(refname:rstrip=2)\fR
199 turns
200 \fBrefs/tags/foo\fR
201 into
202 \fBrefs\fR)\&. If
203 \fB<N>\fR
204 is a negative number, strip as many path components as necessary from the specified end to leave
205 \fB\-<N>\fR
206 path components (e\&.g\&.
207 \fB%(refname:lstrip=\-2)\fR
208 turns
209 \fBrefs/tags/foo\fR
210 into
211 \fBtags/foo\fR
212 and
213 \fB%(refname:rstrip=\-1)\fR
214 turns
215 \fBrefs/tags/foo\fR
216 into
217 \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\&.
218 .sp
219 \fBstrip\fR
220 can be used as a synonym to
221 \fBlstrip\fR\&.
222 .RE
223 .PP
224 objecttype
225 .RS 4
226 The type of the object (\fBblob\fR,
227 \fBtree\fR,
228 \fBcommit\fR,
229 \fBtag\fR)\&.
230 .RE
231 .PP
232 objectsize
233 .RS 4
234 The size of the object (the same as
235 \fIgit cat\-file \-s\fR
236 reports)\&. Append
237 \fB:disk\fR
238 to get the size, in bytes, that the object takes up on disk\&. See the note about on\-disk sizes in the
239 \fBCAVEATS\fR
240 section below\&.
241 .RE
242 .PP
243 objectname
244 .RS 4
245 The object name (aka SHA\-1)\&. For a non\-ambiguous abbreviation of the object name append
246 \fB:short\fR\&. For an abbreviation of the object name with desired length append
247 \fB:short=<length>\fR, where the minimum length is MINIMUM_ABBREV\&. The length may be exceeded to ensure unique object names\&.
248 .RE
249 .PP
250 deltabase
251 .RS 4
252 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)\&.
253 .RE
254 .PP
255 upstream
256 .RS 4
257 The name of a local ref which can be considered
258 \(lqupstream\(rq
259 from the displayed ref\&. Respects
260 \fB:short\fR,
261 \fB:lstrip\fR
262 and
263 \fB:rstrip\fR
264 in the same way as
265 \fBrefname\fR
266 above\&. Additionally respects
267 \fB:track\fR
268 to show "[ahead N, behind M]" and
269 \fB:trackshort\fR
270 to show the terse version: ">" (ahead), "<" (behind), "<>" (ahead and behind), or "=" (in sync)\&.
271 \fB:track\fR
272 also prints "[gone]" whenever unknown upstream ref is encountered\&. Append
273 \fB:track,nobracket\fR
274 to show tracking information without brackets (i\&.e "ahead N, behind M")\&.
275 .sp
276 For any remote\-tracking branch
277 \fB%(upstream)\fR,
278 \fB%(upstream:remotename)\fR
279 and
280 \fB%(upstream:remoteref)\fR
281 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
282 \fB%(upstream:remoteref):%(upstream)\fR
283 to fetch from
284 \fB%(upstream:remotename)\fR\&.
285 .sp
286 Has no effect if the ref does not have tracking information associated with it\&. All the options apart from
287 \fBnobracket\fR
288 are mutually exclusive, but if used together the last option is selected\&.
289 .RE
290 .PP
291 push
292 .RS 4
293 The name of a local ref which represents the
294 \fB@{push}\fR
295 location for the displayed ref\&. Respects
296 \fB:short\fR,
297 \fB:lstrip\fR,
298 \fB:rstrip\fR,
299 \fB:track\fR,
300 \fB:trackshort\fR,
301 \fB:remotename\fR, and
302 \fB:remoteref\fR
303 options as
304 \fBupstream\fR
305 does\&. Produces an empty string if no
306 \fB@{push}\fR
307 ref is configured\&.
308 .RE
309 .PP
310 HEAD
311 .RS 4
312 \fI*\fR
313 if HEAD matches current ref (the checked out branch), \*(Aq \*(Aq otherwise\&.
314 .RE
315 .PP
316 color
317 .RS 4
318 Change output color\&. Followed by
319 \fB:<colorname>\fR, where color names are described under Values in the "CONFIGURATION FILE" section of
320 \fBgit-config\fR(1)\&. For example,
321 \fB%(color:bold red)\fR\&.
322 .RE
323 .PP
324 align
325 .RS 4
326 Left\-, middle\-, or right\-align the content between %(align:\&...\:) and %(end)\&. The "align:" is followed by
327 \fBwidth=<width>\fR
328 and
329 \fBposition=<position>\fR
330 in any order separated by a comma, where the
331 \fB<position>\fR
332 is either left, right or middle, default being left and
333 \fB<width>\fR
334 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,
335 \fB%(align:<width>,<position>)\fR\&. If the contents length is more than the width then no alignment is performed\&. If used with
336 \fB\-\-quote\fR
337 everything in between %(align:\&...\:) and %(end) is quoted, but if nested then only the topmost level performs quoting\&.
338 .RE
339 .PP
340 if
341 .RS 4
342 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
343 \fIif\fR
344 condition only on the
345 \fIHEAD\fR
346 ref\&. Append ":equals=<string>" or ":notequals=<string>" to compare the value between the %(if:\&...\:) and %(then) atoms with the given string\&.
347 .RE
348 .PP
349 symref
350 .RS 4
351 The ref which the given symbolic ref refers to\&. If not a symbolic ref, nothing is printed\&. Respects the
352 \fB:short\fR,
353 \fB:lstrip\fR
354 and
355 \fB:rstrip\fR
356 options in the same way as
357 \fBrefname\fR
358 above\&.
359 .RE
360 .PP
361 signature
362 .RS 4
363 The GPG signature of a commit\&.
364 .RE
365 .PP
366 signature:grade
367 .RS 4
368 Show "G" for a good (valid) signature, "B" for a bad signature, "U" for a good signature with unknown validity, "X" for a good signature that has expired, "Y" for a good signature made by an expired key, "R" for a good signature made by a revoked key, "E" if the signature cannot be checked (e\&.g\&. missing key) and "N" for no signature\&.
369 .RE
370 .PP
371 signature:signer
372 .RS 4
373 The signer of the GPG signature of a commit\&.
374 .RE
375 .PP
376 signature:key
377 .RS 4
378 The key of the GPG signature of a commit\&.
379 .RE
380 .PP
381 signature:fingerprint
382 .RS 4
383 The fingerprint of the GPG signature of a commit\&.
384 .RE
385 .PP
386 signature:primarykeyfingerprint
387 .RS 4
388 The primary key fingerprint of the GPG signature of a commit\&.
389 .RE
390 .PP
391 signature:trustlevel
392 .RS 4
393 The trust level of the GPG signature of a commit\&. Possible outputs are
394 \fBultimate\fR,
395 \fBfully\fR,
396 \fBmarginal\fR,
397 \fBnever\fR
398 and
399 \fBundefined\fR\&.
400 .RE
401 .PP
402 worktreepath
403 .RS 4
404 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\&.
405 .RE
406 .PP
407 ahead\-behind:<committish>
408 .RS 4
409 Two integers, separated by a space, demonstrating the number of commits ahead and behind, respectively, when comparing the output ref to the
410 \fB<committish>\fR
411 specified in the format\&.
412 .RE
413 .PP
414 is\-base:<committish>
415 .RS 4
416 In at most one row,
417 \fB(<committish>)\fR
418 will appear to indicate the ref that is most likely the ref used as a starting point for the branch that produced
419 \fB<committish>\fR\&. This choice is made using a heuristic: choose the ref that minimizes the number of commits in the first\-parent history of
420 \fB<committish>\fR
421 and not in the first\-parent history of the ref\&.
422 .sp
423 For example, consider the following figure of first\-parent histories of several refs:
424 .sp
425 .if n \{\
426 .RS 4
427 .\}
428 .nf
429 *\-\-*\-\-*\-\-*\-\-*\-\-* refs/heads/A
430 \e
431 \e
432 *\-\-*\-\-*\-\-* refs/heads/B
433 \e \e
434 \e \e
435 * * refs/heads/C
436 \e
437 \e
438 *\-\-* refs/heads/D
439 .fi
440 .if n \{\
441 .RE
442 .\}
443 .sp
444 Here, if
445 \fBA\fR,
446 \fBB\fR, and
447 \fBC\fR
448 are the filtered references, and the format string is
449 \fB%(refname):%(is\-base:D)\fR, then the output would be
450 .sp
451 .if n \{\
452 .RS 4
453 .\}
454 .nf
455 refs/heads/A:
456 refs/heads/B:(D)
457 refs/heads/C:
458 .fi
459 .if n \{\
460 .RE
461 .\}
462 .sp
463 This is because the first\-parent history of
464 \fBD\fR
465 has its earliest intersection with the first\-parent histories of the filtered refs at a common first\-parent ancestor of
466 \fBB\fR
467 and
468 \fBC\fR
469 and ties are broken by the earliest ref in the sorted order\&.
470 .sp
471 Note that this token will not appear if the first\-parent history of
472 \fB<committish>\fR
473 does not intersect the first\-parent histories of the filtered refs\&.
474 .RE
475 .PP
476 describe[:options]
477 .RS 4
478 A human\-readable name, like
479 \fBgit-describe\fR(1); empty string for undescribable commits\&. The
480 \fBdescribe\fR
481 string may be followed by a colon and one or more comma\-separated options\&.
482 .PP
483 tags=<bool\-value>
484 .RS 4
485 Instead of only considering annotated tags, consider lightweight tags as well; see the corresponding option in
486 \fBgit-describe\fR(1)
487 for details\&.
488 .RE
489 .PP
490 abbrev=<number>
491 .RS 4
492 Use at least <number> hexadecimal digits; see the corresponding option in
493 \fBgit-describe\fR(1)
494 for details\&.
495 .RE
496 .PP
497 match=<pattern>
498 .RS 4
499 Only consider tags matching the given
500 \fBglob(7)\fR
501 pattern, excluding the "refs/tags/" prefix; see the corresponding option in
502 \fBgit-describe\fR(1)
503 for details\&.
504 .RE
505 .PP
506 exclude=<pattern>
507 .RS 4
508 Do not consider tags matching the given
509 \fBglob(7)\fR
510 pattern, excluding the "refs/tags/" prefix; see the corresponding option in
511 \fBgit-describe\fR(1)
512 for details\&.
513 .RE
514 .RE
515 .sp
516 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\&.
517 .sp
518 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\&.
519 .sp
520 For tag objects, a \fBfieldname\fR prefixed with an asterisk (\fB*\fR) expands to the \fBfieldname\fR value of the peeled object, rather than that of the tag object itself\&.
521 .sp
522 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\&. In addition to these, the \fB:mailmap\fR option and the corresponding \fB:mailmap,trim\fR and \fB:mailmap,localpart\fR can be used (order does not matter) to get values of the name and email according to the \&.mailmap file or according to the file set in the mailmap\&.file or mailmap\&.blob configuration variable (see \fBgitmailmap\fR(5))\&.
523 .sp
524 The raw data in an object is \fBraw\fR\&.
525 .PP
526 raw:size
527 .RS 4
528 The raw data size of the object\&.
529 .RE
530 .sp
531 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\&.
532 .sp
533 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:
534 .PP
535 contents:size
536 .RS 4
537 The size in bytes of the commit or tag message\&.
538 .RE
539 .PP
540 contents:subject
541 .RS 4
542 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
543 \fBcontents:subject\fR, field
544 \fBsubject\fR
545 can also be used to obtain same results\&.
546 \fB:sanitize\fR
547 can be appended to
548 \fBsubject\fR
549 for subject line suitable for filename\&.
550 .RE
551 .PP
552 contents:body
553 .RS 4
554 The remainder of the commit or the tag message that follows the "subject"\&.
555 .RE
556 .PP
557 contents:signature
558 .RS 4
559 The optional GPG signature of the tag\&.
560 .RE
561 .PP
562 contents:lines=N
563 .RS 4
564 The first
565 \fBN\fR
566 lines of the message\&.
567 .RE
568 .sp
569 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)\&.
570 .sp
571 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\&.
572 .sp
573 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\&.
574 .sp
575 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\&.
576 .sp
577 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)\&. If this formatting is provided in a \fB\-\-sort\fR key, references will be sorted according to the byte\-value of the formatted string rather than the numeric value of the underlying timestamp\&.
578 .sp
579 Some atoms like %(align) and %(if) always require a matching %(end)\&. We call them "opening atoms" and sometimes denote them as %($open)\&.
580 .sp
581 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\&.
582 .SH "EXAMPLES"
583 .sp
584 An example directly producing formatted text\&. Show the most recent 3 tagged commits:
585 .sp
586 .if n \{\
587 .RS 4
588 .\}
589 .nf
590 #!/bin/sh
592 git for\-each\-ref \-\-count=3 \-\-sort=\*(Aq\-*authordate\*(Aq \e
593 \-\-format=\*(AqFrom: %(*authorname) %(*authoremail)
594 Subject: %(*subject)
595 Date: %(*authordate)
596 Ref: %(*refname)
598 %(*body)
599 \*(Aq \*(Aqrefs/tags\*(Aq
600 .fi
601 .if n \{\
602 .RE
603 .\}
604 .sp
605 A simple example showing the use of shell eval on the output, demonstrating the use of \-\-shell\&. List the prefixes of all heads:
606 .sp
607 .if n \{\
608 .RS 4
609 .\}
610 .nf
611 #!/bin/sh
613 git for\-each\-ref \-\-shell \-\-format="ref=%(refname)" refs/heads | \e
614 while read entry
615 do
616 eval "$entry"
617 echo `dirname $ref`
618 done
619 .fi
620 .if n \{\
621 .RE
622 .\}
623 .sp
624 A bit more elaborate report on tags, demonstrating that the format may be an entire script:
625 .sp
626 .if n \{\
627 .RS 4
628 .\}
629 .nf
630 #!/bin/sh
632 fmt=\*(Aq
633 r=%(refname)
634 t=%(*objecttype)
635 T=${r#refs/tags/}
637 o=%(*objectname)
638 n=%(*authorname)
639 e=%(*authoremail)
640 s=%(*subject)
641 d=%(*authordate)
642 b=%(*body)
644 kind=Tag
645 if test "z$t" = z
646 then
647 # could be a lightweight tag
648 t=%(objecttype)
649 kind="Lightweight tag"
650 o=%(objectname)
651 n=%(authorname)
652 e=%(authoremail)
653 s=%(subject)
654 d=%(authordate)
655 b=%(body)
656 fi
657 echo "$kind $T points at a $t object $o"
658 if test "z$t" = zcommit
659 then
660 echo "The commit was authored by $n $e
661 at $d, and titled
663 $s
665 Its message reads as:
666 "
667 echo "$b" | sed \-e "s/^/ /"
668 echo
669 fi
670 \*(Aq
672 eval=`git for\-each\-ref \-\-shell \-\-format="$fmt" \e
673 \-\-sort=\*(Aq*objecttype\*(Aq \e
674 \-\-sort=\-taggerdate \e
675 refs/tags`
676 eval "$eval"
677 .fi
678 .if n \{\
679 .RE
680 .\}
681 .sp
682 An example to show the usage of %(if)\&...\:%(then)\&...\:%(else)\&...\:%(end)\&. This prefixes the current branch with a star\&.
683 .sp
684 .if n \{\
685 .RS 4
686 .\}
687 .nf
688 git for\-each\-ref \-\-format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/
689 .fi
690 .if n \{\
691 .RE
692 .\}
693 .sp
694 An example to show the usage of %(if)\&...\:%(then)\&...\:%(end)\&. This prints the authorname, if present\&.
695 .sp
696 .if n \{\
697 .RS 4
698 .\}
699 .nf
700 git for\-each\-ref \-\-format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"
701 .fi
702 .if n \{\
703 .RE
704 .\}
705 .SH "CAVEATS"
706 .sp
707 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\&.
708 .sp
709 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\&.
710 .SH "NOTES"
711 .sp
712 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\&.
713 .sp
714 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\&.
715 .SH "SEE ALSO"
716 .sp
717 \fBgit-show-ref\fR(1)
718 .SH "GIT"
719 .sp
720 Part of the \fBgit\fR(1) suite