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