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 tags which contain the specified commit (HEAD if not 80 specified). 81 82FIELD NAMES 83----------- 84 85Various values from structured fields in referenced objects can 86be used to interpolate into the resulting output, or as sort 87keys. 88 89For all objects, the following names can be used: 90 91refname:: 92 The name of the ref (the part after $GIT_DIR/). 93 For a non-ambiguous short name of the ref append `:short`. 94 The option core.warnAmbiguousRefs is used to select the strict 95 abbreviation mode. 96 97objecttype:: 98 The type of the object (`blob`, `tree`, `commit`, `tag`). 99 100objectsize:: 101 The size of the object (the same as 'git cat-file -s' reports). 102 103objectname:: 104 The object name (aka SHA-1). 105 For a non-ambiguous abbreviation of the object name append `:short`. 106 107upstream:: 108 The name of a local ref which can be considered ``upstream'' 109 from the displayed ref. Respects `:short` in the same way as 110 `refname` above. Additionally respects `:track` to show 111 "[ahead N, behind M]" and `:trackshort` to show the terse 112 version: ">" (ahead), "<" (behind), "<>" (ahead and behind), 113 or "=" (in sync). Has no effect if the ref does not have 114 tracking information associated with it. 115 116push:: 117 The name of a local ref which represents the `@{push}` location 118 for the displayed ref. Respects `:short`, `:track`, and 119 `:trackshort` options as `upstream` does. Produces an empty 120 string if no `@{push}` ref is configured. 121 122HEAD:: 123 '*' if HEAD matches current ref (the checked out branch), ' ' 124 otherwise. 125 126color:: 127 Change output color. Followed by `:<colorname>`, where names 128 are described in `color.branch.*`. 129 130align:: 131 Left-, middle-, or right-align the content between 132 %(align:...) and %(end). The "align:" is followed by `<width>` 133 and `<position>` in any order separated by a comma, where the 134 `<position>` is either left, right or middle, default being 135 left and `<width>` is the total length of the content with 136 alignment. If the contents length is more than the width then 137 no alignment is performed. If used with '--quote' everything 138 in between %(align:...) and %(end) is quoted, but if nested 139 then only the topmost level performs quoting. 140 141In addition to the above, for commit and tag objects, the header 142field names (`tree`, `parent`, `object`, `type`, and `tag`) can 143be used to specify the value in the header field. 144 145For commit and tag objects, the special `creatordate` and `creator` 146fields will correspond to the appropriate date or name-email-date tuple 147from the `committer` or `tagger` fields depending on the object type. 148These are intended for working on a mix of annotated and lightweight tags. 149 150Fields that have name-email-date tuple as its value (`author`, 151`committer`, and `tagger`) can be suffixed with `name`, `email`, 152and `date` to extract the named component. 153 154The complete message in a commit and tag object is `contents`. 155Its first line is `contents:subject`, where subject is the concatenation 156of all lines of the commit message up to the first blank line. The next 157line is 'contents:body', where body is all of the lines after the first 158blank line. The optional GPG signature is `contents:signature`. The 159first `N` lines of the message is obtained using `contents:lines=N`. 160 161For sorting purposes, fields with numeric values sort in numeric order 162(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). 163All other fields are used to sort in their byte-value order. 164 165There is also an option to sort by versions, this can be done by using 166the fieldname `version:refname` or its alias `v:refname`. 167 168In any case, a field name that refers to a field inapplicable to 169the object referred by the ref does not cause an error. It 170returns an empty string instead. 171 172As a special case for the date-type fields, you may specify a format for 173the date by adding `:` followed by date format name (see the 174values the `--date` option to linkgit::git-rev-list[1] takes). 175 176 177EXAMPLES 178-------- 179 180An example directly producing formatted text. Show the most recent 1813 tagged commits: 182 183------------ 184#!/bin/sh 185 186git for-each-ref --count=3 --sort='-*authordate' \ 187--format='From: %(*authorname) %(*authoremail) 188Subject: %(*subject) 189Date: %(*authordate) 190Ref: %(*refname) 191 192%(*body) 193' 'refs/tags' 194------------ 195 196 197A simple example showing the use of shell eval on the output, 198demonstrating the use of --shell. List the prefixes of all heads: 199------------ 200#!/bin/sh 201 202git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ 203while read entry 204do 205 eval "$entry" 206 echo `dirname $ref` 207done 208------------ 209 210 211A bit more elaborate report on tags, demonstrating that the format 212may be an entire script: 213------------ 214#!/bin/sh 215 216fmt=' 217 r=%(refname) 218 t=%(*objecttype) 219 T=${r#refs/tags/} 220 221 o=%(*objectname) 222 n=%(*authorname) 223 e=%(*authoremail) 224 s=%(*subject) 225 d=%(*authordate) 226 b=%(*body) 227 228 kind=Tag 229 if test "z$t" = z 230 then 231 # could be a lightweight tag 232 t=%(objecttype) 233 kind="Lightweight tag" 234 o=%(objectname) 235 n=%(authorname) 236 e=%(authoremail) 237 s=%(subject) 238 d=%(authordate) 239 b=%(body) 240 fi 241 echo "$kind $T points at a $t object $o" 242 if test "z$t" = zcommit 243 then 244 echo "The commit was authored by $n $e 245at $d, and titled 246 247 $s 248 249Its message reads as: 250" 251 echo "$b" | sed -e "s/^/ /" 252 echo 253 fi 254' 255 256eval=`git for-each-ref --shell --format="$fmt" \ 257 --sort='*objecttype' \ 258 --sort=-taggerdate \ 259 refs/tags` 260eval "$eval" 261------------ 262 263SEE ALSO 264-------- 265linkgit:git-show-ref[1] 266 267GIT 268--- 269Part of the linkgit:git[1] suite