git-fetch, git-branch: Support local --track via a special remote '.'

[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 d5fdcef8d9e60d061ed83a8388ad1d3d0a47e6a5..f49b0d944c613a9d5f4a6c5b6713d5c556f0390e 100644 (file)
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -7,15 +7,15 @@ git-for-each-ref - Output information on each ref
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-for-each-ref' [--count=<count>]* [--shell|--perl|--python] [--sort=<key>]* [--format=<format>] [<pattern>]
+'git-for-each-ref' [--count=<count>]\* [--shell|--perl|--python|--tcl] [--sort=<key>]\* [--format=<format>] [<pattern>]

 
 DESCRIPTION
 -----------
 
 Iterate over all refs that match `<pattern>` and show them
 according to the given `<format>`, after sorting them according
 
 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>`s.  If `<max>` is given, stop after
-showing that many refs.  The interporated values in `<format>`
+to the given set of `<key>`.  If `<max>` 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.
 
 can optionally be quoted as string literals in the specified
 host language allowing their direct evaluation in that language.
 


@@ -38,14 +38,18 @@ OPTIONS
        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
        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

-       `%(refname)`.
+       `%(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 given, the name of the ref is matched against this
        using fnmatch(3).  Refs that do not match the pattern
        are not shown.
 
 
 <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::
+--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
        If given, strings that substitute `%(fieldname)`
        placeholders are quoted as string literals suitable for
        the specified host language.  This is meant to produce


@@ -62,7 +66,7 @@ keys.
 For all objects, the following names can be used:
 
 refname::
 For all objects, the following names can be used:
 
 refname::

-       The name of the ref (the part after $GIT_DIR/refs/).
+       The name of the ref (the part after $GIT_DIR/).

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