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