Merge branch 'jc/ident'
[gitweb.git] / Documentation / git-grep.txt
index 5f082167c1b55f1606f0a9ff48db0e03d10faa7b..bf4b592f48d60836a624bb399c65ffd4b1b55ee6 100644 (file)
@@ -1,6 +1,5 @@
 git-grep(1)
 ===========
-v0.99.6, Sep 2005
 
 NAME
 ----
@@ -9,7 +8,7 @@ git-grep - print lines matching a pattern
 
 SYNOPSIS
 --------
-'git-grep' <option>... <pattern> <path>...
+'git-grep' [<option>...] [-e] <pattern> [--] [<path>...]
 
 DESCRIPTION
 -----------
@@ -19,16 +18,26 @@ containing a match to the given pattern.
 
 OPTIONS
 -------
+`--`::
+       Signals the end of options; the rest of the parameters
+       are <path> limiters.
+
 <option>...::
        Either an option to pass to `grep` or `git-ls-files`.
-       Some `grep` options, such as `-C` and `-m`, that take
-       parameters are known to `git-grep`.
+
+       The following are the specific `git-ls-files` options
+       that may be given: `-o`, `--cached`, `--deleted`, `--others`,
+       `--killed`, `--ignored`, `--modified`, `--exclude=*`,
+       `--exclude-from=*`, and `--exclude-per-directory=*`.
+
+       All other options will be passed to `grep`.
 
 <pattern>::
-       The pattern to look for.
+       The pattern to look for.  The first non option is taken
+       as the pattern; if your pattern begins with a dash, use
+       `-e <pattern>`.
 
 <path>...::
-
        Optional paths to limit the set of files to be searched;
        passed to `git-ls-files`.