1git-for-each-ref(1) 2=================== 3 4NAME 5---- 6git-for-each-ref - Output information on each ref 7 8SYNOPSIS 9-------- 10[verse] 11'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] 12 [(--sort=<key>)...] [--format=<format>] [<pattern>...] 13 [--points-at <object>] 14 15DESCRIPTION 16----------- 17 18Iterate over all refs that match `<pattern>` and show them 19according to the given `<format>`, after sorting them according 20to the given set of `<key>`. If `<count>` is given, stop after 21showing that many refs. The interpolated values in `<format>` 22can optionally be quoted as string literals in the specified 23host language allowing their direct evaluation in that language. 24 25OPTIONS 26------- 27<count>:: 28 By default the command shows all refs that match 29 `<pattern>`. This option makes it stop after showing 30 that many refs. 31 32<key>:: 33 A field name to sort on. Prefix `-` to sort in 34 descending order of the value. When unspecified, 35 `refname` is used. You may use the --sort=<key> option 36 multiple times, in which case the last key becomes the primary 37 key. 38 39<format>:: 40 A string that interpolates `%(fieldname)` from the 41 object pointed at by a ref being shown. If `fieldname` 42 is prefixed with an asterisk (`*`) and the ref points 43 at a tag object, the value for the field in the object 44 tag refers is used. When unspecified, defaults to 45 `%(objectname) SPC %(objecttype) TAB %(refname)`. 46 It also interpolates `%%` to `%`, and `%xx` where `xx` 47 are hex digits interpolates to character with hex code 48 `xx`; for example `%00` interpolates to `\0` (NUL), 49 `%09` to `\t` (TAB) and `%0a` to `\n` (LF). 50 51<pattern>...:: 52 If one or more patterns are given, only refs are shown that 53 match against at least one pattern, either using fnmatch(3) or 54 literally, in the latter case matching completely or from the 55 beginning up to a slash. 56 57--shell:: 58--perl:: 59--python:: 60--tcl:: 61 If given, strings that substitute `%(fieldname)` 62 placeholders are quoted as string literals suitable for 63 the specified host language. This is meant to produce 64 a scriptlet that can directly be `eval`ed. 65 66--points-at <object>:: 67 Only list refs which points at the given object. 68 69FIELD NAMES 70----------- 71 72Various values from structured fields in referenced objects can 73be used to interpolate into the resulting output, or as sort 74keys. 75 76For all objects, the following names can be used: 77 78refname:: 79 The name of the ref (the part after $GIT_DIR/). 80 For a non-ambiguous short name of the ref append `:short`. 81 The option core.warnAmbiguousRefs is used to select the strict 82 abbreviation mode. 83 84objecttype:: 85 The type of the object (`blob`, `tree`, `commit`, `tag`). 86 87objectsize:: 88 The size of the object (the same as 'git cat-file -s' reports). 89 90objectname:: 91 The object name (aka SHA-1). 92 For a non-ambiguous abbreviation of the object name append `:short`. 93 94upstream:: 95 The name of a local ref which can be considered ``upstream'' 96 from the displayed ref. Respects `:short` in the same way as 97 `refname` above. Additionally respects `:track` to show 98 "[ahead N, behind M]" and `:trackshort` to show the terse 99 version: ">" (ahead), "<" (behind), "<>" (ahead and behind), 100 or "=" (in sync). Has no effect if the ref does not have 101 tracking information associated with it. 102 103push:: 104 The name of a local ref which represents the `@{push}` location 105 for the displayed ref. Respects `:short`, `:track`, and 106 `:trackshort` options as `upstream` does. Produces an empty 107 string if no `@{push}` ref is configured. 108 109HEAD:: 110 '*' if HEAD matches current ref (the checked out branch), ' ' 111 otherwise. 112 113color:: 114 Change output color. Followed by `:<colorname>`, where names 115 are described in `color.branch.*`. 116 117In addition to the above, for commit and tag objects, the header 118field names (`tree`, `parent`, `object`, `type`, and `tag`) can 119be used to specify the value in the header field. 120 121Fields that have name-email-date tuple as its value (`author`, 122`committer`, and `tagger`) can be suffixed with `name`, `email`, 123and `date` to extract the named component. 124 125The complete message in a commit and tag object is `contents`. 126Its first line is `contents:subject`, where subject is the concatenation 127of all lines of the commit message up to the first blank line. The next 128line is 'contents:body', where body is all of the lines after the first 129blank line. Finally, the optional GPG signature is `contents:signature`. 130 131For sorting purposes, fields with numeric values sort in numeric 132order (`objectsize`, `authordate`, `committerdate`, `taggerdate`). 133All other fields are used to sort in their byte-value order. 134 135In any case, a field name that refers to a field inapplicable to 136the object referred by the ref does not cause an error. It 137returns an empty string instead. 138 139As a special case for the date-type fields, you may specify a format for 140the date by adding one of `:default`, `:relative`, `:short`, `:local`, 141`:iso8601`, `:rfc2822` or `:raw` to the end of the fieldname; e.g. 142`%(taggerdate:relative)`. 143 144 145EXAMPLES 146-------- 147 148An example directly producing formatted text. Show the most recent 1493 tagged commits: 150 151------------ 152#!/bin/sh 153 154git for-each-ref --count=3 --sort='-*authordate' \ 155--format='From: %(*authorname) %(*authoremail) 156Subject: %(*subject) 157Date: %(*authordate) 158Ref: %(*refname) 159 160%(*body) 161' 'refs/tags' 162------------ 163 164 165A simple example showing the use of shell eval on the output, 166demonstrating the use of --shell. List the prefixes of all heads: 167------------ 168#!/bin/sh 169 170git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ 171while read entry 172do 173 eval "$entry" 174 echo `dirname $ref` 175done 176------------ 177 178 179A bit more elaborate report on tags, demonstrating that the format 180may be an entire script: 181------------ 182#!/bin/sh 183 184fmt=' 185 r=%(refname) 186 t=%(*objecttype) 187 T=${r#refs/tags/} 188 189 o=%(*objectname) 190 n=%(*authorname) 191 e=%(*authoremail) 192 s=%(*subject) 193 d=%(*authordate) 194 b=%(*body) 195 196 kind=Tag 197 if test "z$t" = z 198 then 199 # could be a lightweight tag 200 t=%(objecttype) 201 kind="Lightweight tag" 202 o=%(objectname) 203 n=%(authorname) 204 e=%(authoremail) 205 s=%(subject) 206 d=%(authordate) 207 b=%(body) 208 fi 209 echo "$kind $T points at a $t object $o" 210 if test "z$t" = zcommit 211 then 212 echo "The commit was authored by $n $e 213at $d, and titled 214 215 $s 216 217Its message reads as: 218" 219 echo "$b" | sed -e "s/^/ /" 220 echo 221 fi 222' 223 224eval=`git for-each-ref --shell --format="$fmt" \ 225 --sort='*objecttype' \ 226 --sort=-taggerdate \ 227 refs/tags` 228eval "$eval" 229------------ 230 231SEE ALSO 232-------- 233linkgit:git-show-ref[1] 234 235GIT 236--- 237Part of the linkgit:git[1] suite