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