Merge commit 'git/master'
[git/git-bigfiles.git] / Documentation / git-grep.txt
blobfccb82deb48ec75d25f948e7caa69a44e09f5832
1 git-grep(1)
2 ===========
4 NAME
5 ----
6 git-grep - Print lines matching a pattern
9 SYNOPSIS
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            [--color | --no-color]
21            [-A <post-context>] [-B <pre-context>] [-C <context>]
22            [-f <file>] [-e] <pattern>
23            [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
24            [--] [<path>...]
26 DESCRIPTION
27 -----------
28 Look for specified patterns in the working tree files, blobs
29 registered in the index file, or given tree objects.
32 OPTIONS
33 -------
34 --cached::
35         Instead of searching in the working tree files, check
36         the blobs registered in the index file.
38 -a::
39 --text::
40         Process binary files as if they were text.
42 -i::
43 --ignore-case::
44         Ignore case differences between the patterns and the
45         files.
47 -I::
48         Don't match the pattern in binary files.
50 -w::
51 --word-regexp::
52         Match the pattern only at word boundary (either begin at the
53         beginning of a line, or preceded by a non-word character; end at
54         the end of a line or followed by a non-word character).
56 -v::
57 --invert-match::
58         Select non-matching lines.
60 -h::
61 -H::
62         By default, the command shows the filename for each
63         match.  `-h` option is used to suppress this output.
64         `-H` is there for completeness and does not do anything
65         except it overrides `-h` given earlier on the command
66         line.
68 --full-name::
69         When run from a subdirectory, the command usually
70         outputs paths relative to the current directory.  This
71         option forces paths to be output relative to the project
72         top directory.
74 -E::
75 --extended-regexp::
76 -G::
77 --basic-regexp::
78         Use POSIX extended/basic regexp for patterns.  Default
79         is to use basic regexp.
81 -F::
82 --fixed-strings::
83         Use fixed strings for patterns (don't interpret pattern
84         as a regex).
86 -n::
87         Prefix the line number to matching lines.
89 -l::
90 --files-with-matches::
91 --name-only::
92 -L::
93 --files-without-match::
94         Instead of showing every matched line, show only the
95         names of files that contain (or do not contain) matches.
96         For better compatibility with 'git-diff', --name-only is a
97         synonym for --files-with-matches.
99 -z::
100 --null::
101         Output \0 instead of the character that normally follows a
102         file name.
104 -c::
105 --count::
106         Instead of showing every matched line, show the number of
107         lines that match.
109 --color::
110         Show colored matches.
112 --no-color::
113         Turn off match highlighting, even when the configuration file
114         gives the default to color output.
116 -[ABC] <context>::
117         Show `context` trailing (`A` -- after), or leading (`B`
118         -- before), or both (`C` -- context) lines, and place a
119         line containing `--` between contiguous groups of
120         matches.
122 -<num>::
123         A shortcut for specifying -C<num>.
125 -f <file>::
126         Read patterns from <file>, one per line.
128 -e::
129         The next parameter is the pattern. This option has to be
130         used for patterns starting with - and should be used in
131         scripts passing user input to grep.  Multiple patterns are
132         combined by 'or'.
134 --and::
135 --or::
136 --not::
137 ( ... )::
138         Specify how multiple patterns are combined using Boolean
139         expressions.  `--or` is the default operator.  `--and` has
140         higher precedence than `--or`.  `-e` has to be used for all
141         patterns.
143 --all-match::
144         When giving multiple pattern expressions combined with `--or`,
145         this flag is specified to limit the match to files that
146         have lines to match all of them.
148 `<tree>...`::
149         Search blobs in the trees for specified patterns.
151 \--::
152         Signals the end of options; the rest of the parameters
153         are <path> limiters.
156 Example
157 -------
159 git grep -e \'#define\' --and \( -e MAX_PATH -e PATH_MAX \)::
160         Looks for a line that has `#define` and either `MAX_PATH` or
161         `PATH_MAX`.
163 git grep --all-match -e NODE -e Unexpected::
164         Looks for a line that has `NODE` or `Unexpected` in
165         files that have lines that match both.
167 Author
168 ------
169 Originally written by Linus Torvalds <torvalds@osdl.org>, later
170 revamped by Junio C Hamano.
173 Documentation
174 --------------
175 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
179 Part of the linkgit:git[1] suite