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