Merge branch 'gb/split-cmdline-errmsg' into gb/shell-ext
[gitweb.git] / Documentation / git-grep.txt
index 37ce94305bdc1b41fef7f24c7e5a274f39df1ba2..5474dd7f94c4b3217230808e656662d0edcef207 100644 (file)
@@ -14,14 +14,15 @@ SYNOPSIS
           [-E | --extended-regexp] [-G | --basic-regexp]
           [-F | --fixed-strings] [-n]
           [-l | --files-with-matches] [-L | --files-without-match]
+          [(-O | --open-files-in-pager) [<pager>]]
           [-z | --null]
           [-c | --count] [--all-match] [-q | --quiet]
           [--max-depth <depth>]
-          [--color | --no-color]
+          [--color[=<when>] | --no-color]
           [-A <post-context>] [-B <pre-context>] [-C <context>]
           [-f <file>] [-e] <pattern>
           [--and|--or|--not|(|)|-e <pattern>...]
-          [--cached | <tree>...]
+          [--cached | --no-index | <tree>...]
           [--] [<pathspec>...]
 
 DESCRIPTION
@@ -33,8 +34,11 @@ registered in the index file, or blobs in given tree objects.
 OPTIONS
 -------
 --cached::
-       Instead of searching in the working tree files, check
-       the blobs registered in the index file.
+       Instead of searching tracked files in the working tree, search
+       blobs registered in the index file.
+
+--no-index::
+       Search files in the current directory, not just those tracked by git.
 
 -a::
 --text::
@@ -101,6 +105,13 @@ OPTIONS
        For better compatibility with 'git diff', `--name-only` is a
        synonym for `--files-with-matches`.
 
+-O [<pager>]::
+--open-files-in-pager [<pager>]::
+       Open the matching files in the pager (not the output of 'grep').
+       If the pager happens to be "less" or "vi", and the user
+       specified only one pattern, the first file is positioned at
+       the first match automatically.
+
 -z::
 --null::
        Output \0 instead of the character that normally follows a
@@ -111,12 +122,14 @@ OPTIONS
        Instead of showing every matched line, show the number of
        lines that match.
 
---color::
+--color[=<when>]::
        Show colored matches.
+       The value must be always (the default), never, or auto.
 
 --no-color::
        Turn off match highlighting, even when the configuration file
        gives the default to color output.
+       Same as `--color=never`.
 
 -[ABC] <context>::
        Show `context` trailing (`A` -- after), or leading (`B`
@@ -164,7 +177,8 @@ OPTIONS
        there is a match and with non-zero status when there isn't.
 
 <tree>...::
-       Search blobs in the trees for specified patterns.
+       Instead of searching tracked files in the working tree, search
+       blobs in the given trees.
 
 \--::
        Signals the end of options; the rest of the parameters
@@ -177,7 +191,7 @@ OPTIONS
 Examples
 --------
 
-git grep 'time_t' -- '*.[ch]'::
+git grep 'time_t' \-- '*.[ch]'::
        Looks for `time_t` in all tracked .c and .h files in the working
        directory and its subdirectories.