Merge branch 'js/objc-funchdr'
[gitweb.git] / Documentation / git-grep.txt
index 0140c8e3580c7be90648f5ea0186a5c925ee1584..553da6cbb1777a94cb3d6b48dc77c445e18ca2b0 100644 (file)
@@ -9,15 +9,17 @@ git-grep - Print lines matching a pattern
 SYNOPSIS
 --------
 [verse]
-'git-grep' [--cached]
+'git grep' [--cached]
           [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
           [-v | --invert-match] [-h|-H] [--full-name]
-          [-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings]
-          [-n] [-l | --files-with-matches] [-L | --files-without-match]
+          [-E | --extended-regexp] [-G | --basic-regexp]
+          [-F | --fixed-strings] [-n]
+          [-l | --files-with-matches] [-L | --files-without-match]
+          [-z | --null]
           [-c | --count] [--all-match]
           [-A <post-context>] [-B <pre-context>] [-C <context>]
-          [-f <file>] [-e] <pattern> [--and|--or|--not|(|)|-e <pattern>...]
-          [<tree>...]
+          [-f <file>] [-e] <pattern>
+          [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
           [--] [<path>...]
 
 DESCRIPTION
@@ -32,22 +34,30 @@ OPTIONS
        Instead of searching in the working tree files, check
        the blobs registered in the index file.
 
--a | --text::
+-a::
+--text::
        Process binary files as if they were text.
 
--i | --ignore-case::
+-i::
+--ignore-case::
        Ignore case differences between the patterns and the
        files.
 
--w | --word-regexp::
+-I::
+       Don't match the pattern in binary files.
+
+-w::
+--word-regexp::
        Match the pattern only at word boundary (either begin at the
        beginning of a line, or preceded by a non-word character; end at
        the end of a line or followed by a non-word character).
 
--v | --invert-match::
+-v::
+--invert-match::
        Select non-matching lines.
 
--h | -H::
+-h::
+-H::
        By default, the command shows the filename for each
        match.  `-h` option is used to suppress this output.
        `-H` is there for completeness and does not do anything
@@ -60,18 +70,38 @@ OPTIONS
        option forces paths to be output relative to the project
        top directory.
 
--E | --extended-regexp | -G | --basic-regexp::
+-E::
+--extended-regexp::
+-G::
+--basic-regexp::
        Use POSIX extended/basic regexp for patterns.  Default
        is to use basic regexp.
 
+-F::
+--fixed-strings::
+       Use fixed strings for patterns (don't interpret pattern
+       as a regex).
+
 -n::
        Prefix the line number to matching lines.
 
--l | --files-with-matches | -L | --files-without-match::
+-l::
+--files-with-matches::
+--name-only::
+-L::
+--files-without-match::
        Instead of showing every matched line, show only the
        names of files that contain (or do not contain) matches.
+       For better compatibility with 'git-diff', --name-only is a
+       synonym for --files-with-matches.
+
+-z::
+--null::
+       Output \0 instead of the character that normally follows a
+       file name.
 
--c | --count::
+-c::
+--count::
        Instead of showing every matched line, show the number of
        lines that match.
 
@@ -81,6 +111,9 @@ OPTIONS
        line containing `--` between contiguous groups of
        matches.
 
+-<num>::
+       A shortcut for specifying -C<num>.
+
 -f <file>::
        Read patterns from <file>, one per line.
 
@@ -90,7 +123,10 @@ OPTIONS
        scripts passing user input to grep.  Multiple patterns are
        combined by 'or'.
 
---and | --or | --not | ( | )::
+--and::
+--or::
+--not::
+( ... )::
        Specify how multiple patterns are combined using Boolean
        expressions.  `--or` is the default operator.  `--and` has
        higher precedence than `--or`.  `-e` has to be used for all
@@ -132,5 +168,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite