Move split_cmdline() to alias.c

[git.git] / Documentation / git-for-each-ref.txt

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 6df8e8500450ad65a2de86e3daa0ab2f7692a2d2..b347bfbb14784a4292124a4575086411a4697527 100644 (file)
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -8,9 +8,8 @@ git-for-each-ref - Output information on each ref
 SYNOPSIS
 --------
 [verse]
-'git-for-each-ref' [--count=<count>]\*
-                   [--shell|--perl|--python|--tcl]
-                   [--sort=<key>]\* [--format=<format>] [<pattern>]
+'git-for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
+                  [--sort=<key>]\* [--format=<format>] [<pattern>...]
 
 DESCRIPTION
 -----------
@@ -32,8 +31,9 @@ OPTIONS
 <key>::
        A field name to sort on.  Prefix `-` to sort in
        descending order of the value.  When unspecified,
-       `refname` is used.  More than one sort keys can be
-       given.
+       `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
@@ -48,11 +48,15 @@ OPTIONS
        `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
 
 <pattern>::
-       If given, the name of the ref is matched against this
-       using fnmatch(3).  Refs that do not match the pattern
-       are not shown.
-
---shell, --perl, --python, --tcl::
+       If one or more patterns are given, only refs are shown that
+       match againt 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
@@ -100,6 +104,11 @@ 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 one of `:default`, `:relative`, `:short`, `:local`,
+`:iso8601` or `:rfc2822` to the end of the fieldname; e.g.
+`%(taggerdate:relative)`.
+
 
 EXAMPLES
 --------