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 74--no-merged [<object>]:: 75 Only list refs whose tips are not reachable from the 76 specified commit (HEAD if not specified). 77 78--contains [<object>]:: 79 Only list refs which contain the specified commit (HEAD if not 80 specified). 81 82--ignore-case:: 83 Sorting and filtering refs are case insensitive. 84 85FIELD NAMES 86----------- 87 88Various values from structured fields in referenced objects can 89be used to interpolate into the resulting output, or as sort 90keys. 91 92For all objects, the following names can be used: 93 94refname:: 95 The name of the ref (the part after $GIT_DIR/). 96 For a non-ambiguous short name of the ref append `:short`. 97 The option core.warnAmbiguousRefs is used to select the strict 98 abbreviation mode. If `strip=<N>` is appended, strips `<N>` 99 slash-separated path components from the front of the refname 100 (e.g., `%(refname:strip=2)` turns `refs/tags/foo` into `foo`. 101 `<N>` must be a positive integer. If a displayed ref has fewer 102 components than `<N>`, the command aborts with an error. 103 104objecttype:: 105 The type of the object (`blob`, `tree`, `commit`, `tag`). 106 107objectsize:: 108 The size of the object (the same as 'git cat-file -s' reports). 109 110objectname:: 111 The object name (aka SHA-1). 112 For a non-ambiguous abbreviation of the object name append `:short`. 113 For an abbreviation of the object name with desired length append 114 `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The 115 length may be exceeded to ensure unique object names. 116 117upstream:: 118 The name of a local ref which can be considered ``upstream'' 119 from the displayed ref. Respects `:short` in the same way as 120 `refname` above. Additionally respects `:track` to show 121 "[ahead N, behind M]" and `:trackshort` to show the terse 122 version: ">" (ahead), "<" (behind), "<>" (ahead and behind), 123 or "=" (in sync). Has no effect if the ref does not have 124 tracking information associated with it. `:track` also prints 125 "[gone]" whenever unknown upstream ref is encountered. 126 127push:: 128 The name of a local ref which represents the `@{push}` location 129 for the displayed ref. Respects `:short`, `:track`, and 130 `:trackshort` options as `upstream` does. Produces an empty 131 string if no `@{push}` ref is configured. 132 133HEAD:: 134 '*' if HEAD matches current ref (the checked out branch), ' ' 135 otherwise. 136 137color:: 138 Change output color. Followed by `:<colorname>`, where names 139 are described in `color.branch.*`. 140 141align:: 142 Left-, middle-, or right-align the content between 143 %(align:...) and %(end). The "align:" is followed by 144 `width=<width>` and `position=<position>` in any order 145 separated by a comma, where the `<position>` is either left, 146 right or middle, default being left and `<width>` is the total 147 length of the content with alignment. For brevity, the 148 "width=" and/or "position=" prefixes may be omitted, and bare 149 <width> and <position> used instead. For instance, 150 `%(align:<width>,<position>)`. If the contents length is more 151 than the width then no alignment is performed. If used with 152 `--quote` everything in between %(align:...) and %(end) is 153 quoted, but if nested then only the topmost level performs 154 quoting. 155 156if:: 157 Used as %(if)...%(then)...%(end) or 158 %(if)...%(then)...%(else)...%(end). If there is an atom with 159 value or string literal after the %(if) then everything after 160 the %(then) is printed, else if the %(else) atom is used, then 161 everything after %(else) is printed. We ignore space when 162 evaluating the string before %(then), this is useful when we 163 use the %(HEAD) atom which prints either "*" or " " and we 164 want to apply the 'if' condition only on the 'HEAD' ref. 165 Append ":equals=<string>" or ":notequals=<string>" to compare 166 the value between the %(if:...) and %(then) atoms with the 167 given string. 168 169In addition to the above, for commit and tag objects, the header 170field names (`tree`, `parent`, `object`, `type`, and `tag`) can 171be used to specify the value in the header field. 172 173For commit and tag objects, the special `creatordate` and `creator` 174fields will correspond to the appropriate date or name-email-date tuple 175from the `committer` or `tagger` fields depending on the object type. 176These are intended for working on a mix of annotated and lightweight tags. 177 178Fields that have name-email-date tuple as its value (`author`, 179`committer`, and `tagger`) can be suffixed with `name`, `email`, 180and `date` to extract the named component. 181 182The complete message in a commit and tag object is `contents`. 183Its first line is `contents:subject`, where subject is the concatenation 184of all lines of the commit message up to the first blank line. The next 185line is 'contents:body', where body is all of the lines after the first 186blank line. The optional GPG signature is `contents:signature`. The 187first `N` lines of the message is obtained using `contents:lines=N`. 188Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1] 189are obtained as 'contents:trailers'. 190 191For sorting purposes, fields with numeric values sort in numeric order 192(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). 193All other fields are used to sort in their byte-value order. 194 195There is also an option to sort by versions, this can be done by using 196the fieldname `version:refname` or its alias `v:refname`. 197 198In any case, a field name that refers to a field inapplicable to 199the object referred by the ref does not cause an error. It 200returns an empty string instead. 201 202As a special case for the date-type fields, you may specify a format for 203the date by adding `:` followed by date format name (see the 204values the `--date` option to linkgit:git-rev-list[1] takes). 205 206Some atoms like %(align) and %(if) always require a matching %(end). 207We call them "opening atoms" and sometimes denote them as %($open). 208 209When a scripting language specific quoting is in effect, everything 210between a top-level opening atom and its matching %(end) is evaluated 211according to the semantics of the opening atom and only its result 212from the top-level is quoted. 213 214 215EXAMPLES 216-------- 217 218An example directly producing formatted text. Show the most recent 2193 tagged commits: 220 221------------ 222#!/bin/sh 223 224git for-each-ref --count=3 --sort='-*authordate' \ 225--format='From: %(*authorname) %(*authoremail) 226Subject: %(*subject) 227Date: %(*authordate) 228Ref: %(*refname) 229 230%(*body) 231' 'refs/tags' 232------------ 233 234 235A simple example showing the use of shell eval on the output, 236demonstrating the use of --shell. List the prefixes of all heads: 237------------ 238#!/bin/sh 239 240git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ 241while read entry 242do 243 eval "$entry" 244 echo `dirname $ref` 245done 246------------ 247 248 249A bit more elaborate report on tags, demonstrating that the format 250may be an entire script: 251------------ 252#!/bin/sh 253 254fmt=' 255 r=%(refname) 256 t=%(*objecttype) 257 T=${r#refs/tags/} 258 259 o=%(*objectname) 260 n=%(*authorname) 261 e=%(*authoremail) 262 s=%(*subject) 263 d=%(*authordate) 264 b=%(*body) 265 266 kind=Tag 267 if test "z$t" = z 268 then 269 # could be a lightweight tag 270 t=%(objecttype) 271 kind="Lightweight tag" 272 o=%(objectname) 273 n=%(authorname) 274 e=%(authoremail) 275 s=%(subject) 276 d=%(authordate) 277 b=%(body) 278 fi 279 echo "$kind $T points at a $t object $o" 280 if test "z$t" = zcommit 281 then 282 echo "The commit was authored by $n $e 283at $d, and titled 284 285 $s 286 287Its message reads as: 288" 289 echo "$b" | sed -e "s/^/ /" 290 echo 291 fi 292' 293 294eval=`git for-each-ref --shell --format="$fmt" \ 295 --sort='*objecttype' \ 296 --sort=-taggerdate \ 297 refs/tags` 298eval "$eval" 299------------ 300 301 302An example to show the usage of %(if)...%(then)...%(else)...%(end). 303This prefixes the current branch with a star. 304 305------------ 306git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/ 307------------ 308 309 310An example to show the usage of %(if)...%(then)...%(end). 311This prints the authorname, if present. 312 313------------ 314git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)" 315------------ 316 317SEE ALSO 318-------- 319linkgit:git-show-ref[1] 320 321GIT 322--- 323Part of the linkgit:git[1] suite