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