git-for-each-ref(1)

NAME

   git-for-each-ref - Output information on each ref

SYNOPSIS

   git for-each-ref [--count=<count>] [--shell|--perl|--python|--tcl]
                      [(--sort=<key>)...] [--format=<format>] [<pattern>...]
                      [--points-at <object>] [(--merged | --no-merged) [<object>]]
                      [--contains [<object>]]

DESCRIPTION

   Iterate over all refs that match <pattern> and show them according to
   the given <format>, after sorting them according to the given set of
   <key>. If <count> is given, stop after showing that many refs. The
   interpolated values in <format> can optionally be quoted as string
   literals in the specified host language allowing their direct
   evaluation in that language.

OPTIONS

   <count>
       By default the command shows all refs that match <pattern>. This
       option makes it stop after showing that many refs.

   <key>
       A field name to sort on. Prefix - to sort in descending order of
       the value. When unspecified, refname is used. You may use the
       --sort=<key> option multiple times, in which case the last key
       becomes the primary key.

   <format>
       A string that interpolates %(fieldname) from the object pointed at
       by a ref being shown. If fieldname is prefixed with an asterisk (*)
       and the ref points at a tag object, the value for the field in the
       object tag refers is used. When unspecified, defaults to
       %(objectname) SPC %(objecttype) TAB %(refname). It also
       interpolates %% to %, and %xx where xx are hex digits interpolates
       to character with hex code xx; for example %00 interpolates to \0
       (NUL), %09 to \t (TAB) and %0a to \n (LF).

   <pattern>...
       If one or more patterns are given, only refs are shown that match
       against at least one pattern, either using fnmatch(3) or literally,
       in the latter case matching completely or from the beginning up to
       a slash.

   --shell, --perl, --python, --tcl
       If given, strings that substitute %(fieldname) placeholders are
       quoted as string literals suitable for the specified host language.
       This is meant to produce a scriptlet that can directly be `eval`ed.

   --points-at <object>
       Only list refs which points at the given object.

   --merged [<object>]
       Only list refs whose tips are reachable from the specified commit
       (HEAD if not specified).

   --no-merged [<object>]
       Only list refs whose tips are not reachable from the specified
       commit (HEAD if not specified).

   --contains [<object>]
       Only list refs which contain the specified commit (HEAD if not
       specified).

FIELD NAMES

   Various values from structured fields in referenced objects can be used
   to interpolate into the resulting output, or as sort keys.

   For all objects, the following names can be used:

   refname
       The name of the ref (the part after $GIT_DIR/). For a non-ambiguous
       short name of the ref append :short. The option
       core.warnAmbiguousRefs is used to select the strict abbreviation
       mode. If strip=<N> is appended, strips <N> slash-separated path
       components from the front of the refname (e.g., %(refname:strip=2)
       turns refs/tags/foo into foo.  <N> must be a positive integer. If a
       displayed ref has fewer components than <N>, the command aborts
       with an error.

   objecttype
       The type of the object (blob, tree, commit, tag).

   objectsize
       The size of the object (the same as git cat-file -s reports).

   objectname
       The object name (aka SHA-1). For a non-ambiguous abbreviation of
       the object name append :short.

   upstream
       The name of a local ref which can be considered "upstream" from the
       displayed ref. Respects :short in the same way as refname above.
       Additionally respects :track to show "[ahead N, behind M]" and
       :trackshort to show the terse version: ">" (ahead), "<" (behind),
       "<>" (ahead and behind), or "=" (in sync). Has no effect if the ref
       does not have tracking information associated with it.

   push
       The name of a local ref which represents the @{push} location for
       the displayed ref. Respects :short, :track, and :trackshort options
       as upstream does. Produces an empty string if no @{push} ref is
       configured.

   HEAD
       * if HEAD matches current ref (the checked out branch), ' '
       otherwise.

   color
       Change output color. Followed by :<colorname>, where names are
       described in color.branch.*.

   align
       Left-, middle-, or right-align the content between %(align:...) and
       %(end). The "align:" is followed by width=<width> and
       position=<position> in any order separated by a comma, where the
       <position> is either left, right or middle, default being left and
       <width> is the total length of the content with alignment. For
       brevity, the "width=" and/or "position=" prefixes may be omitted,
       and bare <width> and <position> used instead. For instance,
       %(align:<width>,<position>). If the contents length is more than
       the width then no alignment is performed. If used with --quote
       everything in between %(align:...) and %(end) is quoted, but if
       nested then only the topmost level performs quoting.

   In addition to the above, for commit and tag objects, the header field
   names (tree, parent, object, type, and tag) can be used to specify the
   value in the header field.

   For commit and tag objects, the special creatordate and creator fields
   will correspond to the appropriate date or name-email-date tuple from
   the committer or tagger fields depending on the object type. These are
   intended for working on a mix of annotated and lightweight tags.

   Fields that have name-email-date tuple as its value (author, committer,
   and tagger) can be suffixed with name, email, and date to extract the
   named component.

   The complete message in a commit and tag object is contents. Its first
   line is contents:subject, where subject is the concatenation of all
   lines of the commit message up to the first blank line. The next line
   is contents:body, where body is all of the lines after the first blank
   line. The optional GPG signature is contents:signature. The first N
   lines of the message is obtained using contents:lines=N.

   For sorting purposes, fields with numeric values sort in numeric order
   (objectsize, authordate, committerdate, creatordate, taggerdate). All
   other fields are used to sort in their byte-value order.

   There is also an option to sort by versions, this can be done by using
   the fieldname version:refname or its alias v:refname.

   In any case, a field name that refers to a field inapplicable to the
   object referred by the ref does not cause an error. It returns an empty
   string instead.

   As a special case for the date-type fields, you may specify a format
   for the date by adding : followed by date format name (see the values
   the --date option to git-rev-list(1) takes).

EXAMPLES

   An example directly producing formatted text. Show the most recent 3
   tagged commits:

       #!/bin/sh

       git for-each-ref --count=3 --sort='-*authordate' \
       --format='From: %(*authorname) %(*authoremail)
       Subject: %(*subject)
       Date: %(*authordate)
       Ref: %(*refname)

       %(*body)
       ' 'refs/tags'

   A simple example showing the use of shell eval on the output,
   demonstrating the use of --shell. List the prefixes of all heads:

       #!/bin/sh

       git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
       while read entry
       do
               eval "$entry"
               echo `dirname $ref`
       done

   A bit more elaborate report on tags, demonstrating that the format may
   be an entire script:

       #!/bin/sh

       fmt='
               r=%(refname)
               t=%(*objecttype)
               T=${r#refs/tags/}

               o=%(*objectname)
               n=%(*authorname)
               e=%(*authoremail)
               s=%(*subject)
               d=%(*authordate)
               b=%(*body)

               kind=Tag
               if test "z$t" = z
               then
                       # could be a lightweight tag
                       t=%(objecttype)
                       kind="Lightweight tag"
                       o=%(objectname)
                       n=%(authorname)
                       e=%(authoremail)
                       s=%(subject)
                       d=%(authordate)
                       b=%(body)
               fi
               echo "$kind $T points at a $t object $o"
               if test "z$t" = zcommit
               then
                       echo "The commit was authored by $n $e
       at $d, and titled

           $s

       Its message reads as:
       "
                       echo "$b" | sed -e "s/^/    /"
                       echo
               fi
       '

       eval=`git for-each-ref --shell --format="$fmt" \
               --sort='*objecttype' \
               --sort=-taggerdate \
               refs/tags`
       eval "$eval"

SEE ALSO

   git-show-ref(1)

GIT

   Part of the git(1) suite

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.