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