Documentation / git-grep.txton commit Merge branch 'jl/diff-submodule-ignore' (d539de9)
   1git-grep(1)
   2===========
   3
   4NAME
   5----
   6git-grep - Print lines matching a pattern
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git grep' [--cached]
  13           [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
  14           [-v | --invert-match] [-h|-H] [--full-name]
  15           [-E | --extended-regexp] [-G | --basic-regexp]
  16           [-F | --fixed-strings] [-n]
  17           [-l | --files-with-matches] [-L | --files-without-match]
  18           [-z | --null]
  19           [-c | --count] [--all-match]
  20           [--max-depth <depth>]
  21           [--color | --no-color]
  22           [-A <post-context>] [-B <pre-context>] [-C <context>]
  23           [-f <file>] [-e] <pattern>
  24           [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
  25           [--] [<path>...]
  26
  27DESCRIPTION
  28-----------
  29Look for specified patterns in the working tree files, blobs
  30registered in the index file, or given tree objects.
  31
  32
  33OPTIONS
  34-------
  35--cached::
  36        Instead of searching in the working tree files, check
  37        the blobs registered in the index file.
  38
  39-a::
  40--text::
  41        Process binary files as if they were text.
  42
  43-i::
  44--ignore-case::
  45        Ignore case differences between the patterns and the
  46        files.
  47
  48-I::
  49        Don't match the pattern in binary files.
  50
  51--max-depth <depth>::
  52        For each pathspec given on command line, descend at most <depth>
  53        levels of directories. A negative value means no limit.
  54
  55-w::
  56--word-regexp::
  57        Match the pattern only at word boundary (either begin at the
  58        beginning of a line, or preceded by a non-word character; end at
  59        the end of a line or followed by a non-word character).
  60
  61-v::
  62--invert-match::
  63        Select non-matching lines.
  64
  65-h::
  66-H::
  67        By default, the command shows the filename for each
  68        match.  `-h` option is used to suppress this output.
  69        `-H` is there for completeness and does not do anything
  70        except it overrides `-h` given earlier on the command
  71        line.
  72
  73--full-name::
  74        When run from a subdirectory, the command usually
  75        outputs paths relative to the current directory.  This
  76        option forces paths to be output relative to the project
  77        top directory.
  78
  79-E::
  80--extended-regexp::
  81-G::
  82--basic-regexp::
  83        Use POSIX extended/basic regexp for patterns.  Default
  84        is to use basic regexp.
  85
  86-F::
  87--fixed-strings::
  88        Use fixed strings for patterns (don't interpret pattern
  89        as a regex).
  90
  91-n::
  92        Prefix the line number to matching lines.
  93
  94-l::
  95--files-with-matches::
  96--name-only::
  97-L::
  98--files-without-match::
  99        Instead of showing every matched line, show only the
 100        names of files that contain (or do not contain) matches.
 101        For better compatibility with 'git diff', --name-only is a
 102        synonym for --files-with-matches.
 103
 104-z::
 105--null::
 106        Output \0 instead of the character that normally follows a
 107        file name.
 108
 109-c::
 110--count::
 111        Instead of showing every matched line, show the number of
 112        lines that match.
 113
 114--color::
 115        Show colored matches.
 116
 117--no-color::
 118        Turn off match highlighting, even when the configuration file
 119        gives the default to color output.
 120
 121-[ABC] <context>::
 122        Show `context` trailing (`A` -- after), or leading (`B`
 123        -- before), or both (`C` -- context) lines, and place a
 124        line containing `--` between contiguous groups of
 125        matches.
 126
 127-<num>::
 128        A shortcut for specifying -C<num>.
 129
 130-p::
 131--show-function::
 132        Show the preceding line that contains the function name of
 133        the match, unless the matching line is a function name itself.
 134        The name is determined in the same way as 'git diff' works out
 135        patch hunk headers (see 'Defining a custom hunk-header' in
 136        linkgit:gitattributes[5]).
 137
 138-f <file>::
 139        Read patterns from <file>, one per line.
 140
 141-e::
 142        The next parameter is the pattern. This option has to be
 143        used for patterns starting with - and should be used in
 144        scripts passing user input to grep.  Multiple patterns are
 145        combined by 'or'.
 146
 147--and::
 148--or::
 149--not::
 150( ... )::
 151        Specify how multiple patterns are combined using Boolean
 152        expressions.  `--or` is the default operator.  `--and` has
 153        higher precedence than `--or`.  `-e` has to be used for all
 154        patterns.
 155
 156--all-match::
 157        When giving multiple pattern expressions combined with `--or`,
 158        this flag is specified to limit the match to files that
 159        have lines to match all of them.
 160
 161`<tree>...`::
 162        Search blobs in the trees for specified patterns.
 163
 164\--::
 165        Signals the end of options; the rest of the parameters
 166        are <path> limiters.
 167
 168
 169Example
 170-------
 171
 172git grep -e \'#define\' --and \( -e MAX_PATH -e PATH_MAX \)::
 173        Looks for a line that has `#define` and either `MAX_PATH` or
 174        `PATH_MAX`.
 175
 176git grep --all-match -e NODE -e Unexpected::
 177        Looks for a line that has `NODE` or `Unexpected` in
 178        files that have lines that match both.
 179
 180Author
 181------
 182Originally written by Linus Torvalds <torvalds@osdl.org>, later
 183revamped by Junio C Hamano.
 184
 185
 186Documentation
 187--------------
 188Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 189
 190GIT
 191---
 192Part of the linkgit:git[1] suite