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<pattern>...:: 30 If one or more patterns are given, only refs are shown that 31 match against at least one pattern, either using fnmatch(3) or 32 literally, in the latter case matching completely or from the 33 beginning up to a slash. 34 35--count=<count>:: 36 By default the command shows all refs that match 37 `<pattern>`. This option makes it stop after showing 38 that many refs. 39 40--sort=<key>:: 41 A field name to sort on. Prefix `-` to sort in 42 descending order of the value. When unspecified, 43 `refname` is used. You may use the --sort=<key> option 44 multiple times, in which case the last key becomes the primary 45 key. 46 47--format=<format>:: 48 A string that interpolates `%(fieldname)` from a ref being shown 49 and the object it points at. If `fieldname` 50 is prefixed with an asterisk (`*`) and the ref points 51 at a tag object, use the value for the field in the object 52 which the tag object refers to (instead of the field in the tag object). 53 When unspecified, `<format>` defaults to 54 `%(objectname) SPC %(objecttype) TAB %(refname)`. 55 It also interpolates `%%` to `%`, and `%xx` where `xx` 56 are hex digits interpolates to character with hex code 57 `xx`; for example `%00` interpolates to `\0` (NUL), 58 `%09` to `\t` (TAB) and `%0a` to `\n` (LF). 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"). 144+ 145For any remote-tracking branch `%(upstream)`, `%(upstream:remotename)` 146and `%(upstream:remoteref)` refer to the name of the remote and the 147name of the tracked remote ref, respectively. In other words, the 148remote-tracking branch can be updated explicitly and individually by 149using the refspec `%(upstream:remoteref):%(upstream)` to fetch from 150`%(upstream:remotename)`. 151+ 152Has no effect if the ref does not have tracking information associated 153with it. All the options apart from `nobracket` are mutually exclusive, 154but if used together the last option is selected. 155 156push:: 157 The name of a local ref which represents the `@{push}` 158 location for the displayed ref. Respects `:short`, `:lstrip`, 159 `:rstrip`, `:track`, `:trackshort`, `:remotename`, and `:remoteref` 160 options as `upstream` does. Produces an empty string if no `@{push}` 161 ref is configured. 162 163HEAD:: 164 '*' if HEAD matches current ref (the checked out branch), ' ' 165 otherwise. 166 167color:: 168 Change output color. Followed by `:<colorname>`, where color 169 names are described under Values in the "CONFIGURATION FILE" 170 section of linkgit:git-config[1]. For example, 171 `%(color:bold red)`. 172 173align:: 174 Left-, middle-, or right-align the content between 175 %(align:...) and %(end). The "align:" is followed by 176 `width=<width>` and `position=<position>` in any order 177 separated by a comma, where the `<position>` is either left, 178 right or middle, default being left and `<width>` is the total 179 length of the content with alignment. For brevity, the 180 "width=" and/or "position=" prefixes may be omitted, and bare 181 <width> and <position> used instead. For instance, 182 `%(align:<width>,<position>)`. If the contents length is more 183 than the width then no alignment is performed. If used with 184 `--quote` everything in between %(align:...) and %(end) is 185 quoted, but if nested then only the topmost level performs 186 quoting. 187 188if:: 189 Used as %(if)...%(then)...%(end) or 190 %(if)...%(then)...%(else)...%(end). If there is an atom with 191 value or string literal after the %(if) then everything after 192 the %(then) is printed, else if the %(else) atom is used, then 193 everything after %(else) is printed. We ignore space when 194 evaluating the string before %(then), this is useful when we 195 use the %(HEAD) atom which prints either "*" or " " and we 196 want to apply the 'if' condition only on the 'HEAD' ref. 197 Append ":equals=<string>" or ":notequals=<string>" to compare 198 the value between the %(if:...) and %(then) atoms with the 199 given string. 200 201symref:: 202 The ref which the given symbolic ref refers to. If not a 203 symbolic ref, nothing is printed. Respects the `:short`, 204 `:lstrip` and `:rstrip` options in the same way as `refname` 205 above. 206 207In addition to the above, for commit and tag objects, the header 208field names (`tree`, `parent`, `object`, `type`, and `tag`) can 209be used to specify the value in the header field. 210 211For commit and tag objects, the special `creatordate` and `creator` 212fields will correspond to the appropriate date or name-email-date tuple 213from the `committer` or `tagger` fields depending on the object type. 214These are intended for working on a mix of annotated and lightweight tags. 215 216Fields that have name-email-date tuple as its value (`author`, 217`committer`, and `tagger`) can be suffixed with `name`, `email`, 218and `date` to extract the named component. 219 220The complete message in a commit and tag object is `contents`. 221Its first line is `contents:subject`, where subject is the concatenation 222of all lines of the commit message up to the first blank line. The next 223line is 'contents:body', where body is all of the lines after the first 224blank line. The optional GPG signature is `contents:signature`. The 225first `N` lines of the message is obtained using `contents:lines=N`. 226Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1] 227are obtained as 'contents:trailers'. 228 229For sorting purposes, fields with numeric values sort in numeric order 230(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). 231All other fields are used to sort in their byte-value order. 232 233There is also an option to sort by versions, this can be done by using 234the fieldname `version:refname` or its alias `v:refname`. 235 236In any case, a field name that refers to a field inapplicable to 237the object referred by the ref does not cause an error. It 238returns an empty string instead. 239 240As a special case for the date-type fields, you may specify a format for 241the date by adding `:` followed by date format name (see the 242values the `--date` option to linkgit:git-rev-list[1] takes). 243 244Some atoms like %(align) and %(if) always require a matching %(end). 245We call them "opening atoms" and sometimes denote them as %($open). 246 247When a scripting language specific quoting is in effect, everything 248between a top-level opening atom and its matching %(end) is evaluated 249according to the semantics of the opening atom and only its result 250from the top-level is quoted. 251 252 253EXAMPLES 254-------- 255 256An example directly producing formatted text. Show the most recent 2573 tagged commits: 258 259------------ 260#!/bin/sh 261 262git for-each-ref --count=3 --sort='-*authordate' \ 263--format='From: %(*authorname) %(*authoremail) 264Subject: %(*subject) 265Date: %(*authordate) 266Ref: %(*refname) 267 268%(*body) 269' 'refs/tags' 270------------ 271 272 273A simple example showing the use of shell eval on the output, 274demonstrating the use of --shell. List the prefixes of all heads: 275------------ 276#!/bin/sh 277 278git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ 279while read entry 280do 281 eval "$entry" 282 echo `dirname $ref` 283done 284------------ 285 286 287A bit more elaborate report on tags, demonstrating that the format 288may be an entire script: 289------------ 290#!/bin/sh 291 292fmt=' 293 r=%(refname) 294 t=%(*objecttype) 295 T=${r#refs/tags/} 296 297 o=%(*objectname) 298 n=%(*authorname) 299 e=%(*authoremail) 300 s=%(*subject) 301 d=%(*authordate) 302 b=%(*body) 303 304 kind=Tag 305 if test "z$t" = z 306 then 307 # could be a lightweight tag 308 t=%(objecttype) 309 kind="Lightweight tag" 310 o=%(objectname) 311 n=%(authorname) 312 e=%(authoremail) 313 s=%(subject) 314 d=%(authordate) 315 b=%(body) 316 fi 317 echo "$kind $T points at a $t object $o" 318 if test "z$t" = zcommit 319 then 320 echo "The commit was authored by $n $e 321at $d, and titled 322 323 $s 324 325Its message reads as: 326" 327 echo "$b" | sed -e "s/^/ /" 328 echo 329 fi 330' 331 332eval=`git for-each-ref --shell --format="$fmt" \ 333 --sort='*objecttype' \ 334 --sort=-taggerdate \ 335 refs/tags` 336eval "$eval" 337------------ 338 339 340An example to show the usage of %(if)...%(then)...%(else)...%(end). 341This prefixes the current branch with a star. 342 343------------ 344git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/ 345------------ 346 347 348An example to show the usage of %(if)...%(then)...%(end). 349This prints the authorname, if present. 350 351------------ 352git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)" 353------------ 354 355SEE ALSO 356-------- 357linkgit:git-show-ref[1] 358 359GIT 360--- 361Part of the linkgit:git[1] suite