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>] [(--merged | --no-merged) [<object>]] 14 [--contains [<object>]] 15 16DESCRIPTION 17----------- 18 19Iterate over all refs that match `<pattern>` and show them 20according to the given `<format>`, after sorting them according 21to the given set of `<key>`. If `<count>` is given, stop after 22showing that many refs. The interpolated values in `<format>` 23can optionally be quoted as string literals in the specified 24host language allowing their direct evaluation in that language. 25 26OPTIONS 27------- 28<count>:: 29 By default the command shows all refs that match 30 `<pattern>`. This option makes it stop after showing 31 that many refs. 32 33<key>:: 34 A field name to sort on. Prefix `-` to sort in 35 descending order of the value. When unspecified, 36 `refname` is used. You may use the --sort=<key> option 37 multiple times, in which case the last key becomes the primary 38 key. 39 40<format>:: 41 A string that interpolates `%(fieldname)` from the 42 object pointed at by a ref being shown. If `fieldname` 43 is prefixed with an asterisk (`*`) and the ref points 44 at a tag object, the value for the field in the object 45 tag refers is used. When unspecified, defaults to 46 `%(objectname) SPC %(objecttype) TAB %(refname)`. 47 It also interpolates `%%` to `%`, and `%xx` where `xx` 48 are hex digits interpolates to character with hex code 49 `xx`; for example `%00` interpolates to `\0` (NUL), 50 `%09` to `\t` (TAB) and `%0a` to `\n` (LF). 51 52<pattern>...:: 53 If one or more patterns are given, only refs are shown that 54 match against at least one pattern, either using fnmatch(3) or 55 literally, in the latter case matching completely or from the 56 beginning up to a slash. 57 58--shell:: 59--perl:: 60--python:: 61--tcl:: 62 If given, strings that substitute `%(fieldname)` 63 placeholders are quoted as string literals suitable for 64 the specified host language. This is meant to produce 65 a scriptlet that can directly be `eval`ed. 66 67--points-at <object>:: 68 Only list refs which points at the given object. 69 70--merged [<object>]:: 71 Only list refs whose tips are reachable from the 72 specified commit (HEAD if not specified), 73 incompatible with `--no-merged`. 74 75--no-merged [<object>]:: 76 Only list refs whose tips are not reachable from the 77 specified commit (HEAD if not specified), 78 incompatible with `--merged`. 79 80--contains [<object>]:: 81 Only list refs which contain the specified commit (HEAD if not 82 specified). 83 84--ignore-case:: 85 Sorting and filtering refs are case insensitive. 86 87FIELD NAMES 88----------- 89 90Various values from structured fields in referenced objects can 91be used to interpolate into the resulting output, or as sort 92keys. 93 94For all objects, the following names can be used: 95 96refname:: 97 The name of the ref (the part after $GIT_DIR/). 98 For a non-ambiguous short name of the ref append `:short`. 99 The option core.warnAmbiguousRefs is used to select the strict 100 abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>` 101 slash-separated path components from the front (back) of the refname 102 (e.g. `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo` and 103 `%(refname:rstrip=2)` turns `refs/tags/foo` into `refs`). 104 If `<N>` is a negative number, strip as many path components as 105 necessary from the specified end to leave `-<N>` path components 106 (e.g. `%(refname:lstrip=-2)` turns 107 `refs/tags/foo` into `tags/foo` and `%(refname:rstrip=-1)` 108 turns `refs/tags/foo` into `refs`). When the ref does not have 109 enough components, the result becomes an empty string if 110 stripping with positive <N>, or it becomes the full refname if 111 stripping with negative <N>. Neither is an error. 112+ 113`strip` can be used as a synomym to `lstrip`. 114 115objecttype:: 116 The type of the object (`blob`, `tree`, `commit`, `tag`). 117 118objectsize:: 119 The size of the object (the same as 'git cat-file -s' reports). 120 121objectname:: 122 The object name (aka SHA-1). 123 For a non-ambiguous abbreviation of the object name append `:short`. 124 For an abbreviation of the object name with desired length append 125 `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The 126 length may be exceeded to ensure unique object names. 127 128upstream:: 129 The name of a local ref which can be considered ``upstream'' 130 from the displayed ref. Respects `:short`, `:lstrip` and 131 `:rstrip` in the same way as `refname` above. Additionally 132 respects `:track` to show "[ahead N, behind M]" and 133 `:trackshort` to show the terse version: ">" (ahead), "<" 134 (behind), "<>" (ahead and behind), or "=" (in sync). `:track` 135 also prints "[gone]" whenever unknown upstream ref is 136 encountered. Append `:track,nobracket` to show tracking 137 information without brackets (i.e "ahead N, behind M"). Has 138 no effect if the ref does not have tracking information 139 associated with it. All the options apart from `nobracket` 140 are mutually exclusive, but if used together the last option 141 is selected. 142 143push:: 144 The name of a local ref which represents the `@{push}` 145 location for the displayed ref. Respects `:short`, `:lstrip`, 146 `:rstrip`, `:track`, and `:trackshort` options as `upstream` 147 does. Produces an empty string if no `@{push}` ref is 148 configured. 149 150HEAD:: 151 '*' if HEAD matches current ref (the checked out branch), ' ' 152 otherwise. 153 154color:: 155 Change output color. Followed by `:<colorname>`, where names 156 are described in `color.branch.*`. 157 158align:: 159 Left-, middle-, or right-align the content between 160 %(align:...) and %(end). The "align:" is followed by 161 `width=<width>` and `position=<position>` in any order 162 separated by a comma, where the `<position>` is either left, 163 right or middle, default being left and `<width>` is the total 164 length of the content with alignment. For brevity, the 165 "width=" and/or "position=" prefixes may be omitted, and bare 166 <width> and <position> used instead. For instance, 167 `%(align:<width>,<position>)`. If the contents length is more 168 than the width then no alignment is performed. If used with 169 `--quote` everything in between %(align:...) and %(end) is 170 quoted, but if nested then only the topmost level performs 171 quoting. 172 173if:: 174 Used as %(if)...%(then)...%(end) or 175 %(if)...%(then)...%(else)...%(end). If there is an atom with 176 value or string literal after the %(if) then everything after 177 the %(then) is printed, else if the %(else) atom is used, then 178 everything after %(else) is printed. We ignore space when 179 evaluating the string before %(then), this is useful when we 180 use the %(HEAD) atom which prints either "*" or " " and we 181 want to apply the 'if' condition only on the 'HEAD' ref. 182 Append ":equals=<string>" or ":notequals=<string>" to compare 183 the value between the %(if:...) and %(then) atoms with the 184 given string. 185 186symref:: 187 The ref which the given symbolic ref refers to. If not a 188 symbolic ref, nothing is printed. Respects the `:short`, 189 `:lstrip` and `:rstrip` options in the same way as `refname` 190 above. 191 192In addition to the above, for commit and tag objects, the header 193field names (`tree`, `parent`, `object`, `type`, and `tag`) can 194be used to specify the value in the header field. 195 196For commit and tag objects, the special `creatordate` and `creator` 197fields will correspond to the appropriate date or name-email-date tuple 198from the `committer` or `tagger` fields depending on the object type. 199These are intended for working on a mix of annotated and lightweight tags. 200 201Fields that have name-email-date tuple as its value (`author`, 202`committer`, and `tagger`) can be suffixed with `name`, `email`, 203and `date` to extract the named component. 204 205The complete message in a commit and tag object is `contents`. 206Its first line is `contents:subject`, where subject is the concatenation 207of all lines of the commit message up to the first blank line. The next 208line is 'contents:body', where body is all of the lines after the first 209blank line. The optional GPG signature is `contents:signature`. The 210first `N` lines of the message is obtained using `contents:lines=N`. 211Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1] 212are obtained as 'contents:trailers'. 213 214For sorting purposes, fields with numeric values sort in numeric order 215(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). 216All other fields are used to sort in their byte-value order. 217 218There is also an option to sort by versions, this can be done by using 219the fieldname `version:refname` or its alias `v:refname`. 220 221In any case, a field name that refers to a field inapplicable to 222the object referred by the ref does not cause an error. It 223returns an empty string instead. 224 225As a special case for the date-type fields, you may specify a format for 226the date by adding `:` followed by date format name (see the 227values the `--date` option to linkgit:git-rev-list[1] takes). 228 229Some atoms like %(align) and %(if) always require a matching %(end). 230We call them "opening atoms" and sometimes denote them as %($open). 231 232When a scripting language specific quoting is in effect, everything 233between a top-level opening atom and its matching %(end) is evaluated 234according to the semantics of the opening atom and only its result 235from the top-level is quoted. 236 237 238EXAMPLES 239-------- 240 241An example directly producing formatted text. Show the most recent 2423 tagged commits: 243 244------------ 245#!/bin/sh 246 247git for-each-ref --count=3 --sort='-*authordate' \ 248--format='From: %(*authorname) %(*authoremail) 249Subject: %(*subject) 250Date: %(*authordate) 251Ref: %(*refname) 252 253%(*body) 254' 'refs/tags' 255------------ 256 257 258A simple example showing the use of shell eval on the output, 259demonstrating the use of --shell. List the prefixes of all heads: 260------------ 261#!/bin/sh 262 263git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ 264while read entry 265do 266 eval "$entry" 267 echo `dirname $ref` 268done 269------------ 270 271 272A bit more elaborate report on tags, demonstrating that the format 273may be an entire script: 274------------ 275#!/bin/sh 276 277fmt=' 278 r=%(refname) 279 t=%(*objecttype) 280 T=${r#refs/tags/} 281 282 o=%(*objectname) 283 n=%(*authorname) 284 e=%(*authoremail) 285 s=%(*subject) 286 d=%(*authordate) 287 b=%(*body) 288 289 kind=Tag 290 if test "z$t" = z 291 then 292 # could be a lightweight tag 293 t=%(objecttype) 294 kind="Lightweight tag" 295 o=%(objectname) 296 n=%(authorname) 297 e=%(authoremail) 298 s=%(subject) 299 d=%(authordate) 300 b=%(body) 301 fi 302 echo "$kind $T points at a $t object $o" 303 if test "z$t" = zcommit 304 then 305 echo "The commit was authored by $n $e 306at $d, and titled 307 308 $s 309 310Its message reads as: 311" 312 echo "$b" | sed -e "s/^/ /" 313 echo 314 fi 315' 316 317eval=`git for-each-ref --shell --format="$fmt" \ 318 --sort='*objecttype' \ 319 --sort=-taggerdate \ 320 refs/tags` 321eval "$eval" 322------------ 323 324 325An example to show the usage of %(if)...%(then)...%(else)...%(end). 326This prefixes the current branch with a star. 327 328------------ 329git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/ 330------------ 331 332 333An example to show the usage of %(if)...%(then)...%(end). 334This prints the authorname, if present. 335 336------------ 337git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)" 338------------ 339 340SEE ALSO 341-------- 342linkgit:git-show-ref[1] 343 344GIT 345--- 346Part of the linkgit:git[1] suite