]>
Commit | Line | Data |
---|---|---|
2aba319a JH |
1 | git-grep(1) |
2 | =========== | |
2aba319a JH |
3 | |
4 | NAME | |
5 | ---- | |
5001422d | 6 | git-grep - Print lines matching a pattern |
2aba319a JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
1c57119c | 11 | [verse] |
335ec3bf | 12 | 'git grep' [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp] |
17fd965d | 13 | [-v | --invert-match] [-h|-H] [--full-name] |
cf0d720b | 14 | [-E | --extended-regexp] [-G | --basic-regexp] |
63e7e9d8 | 15 | [-P | --perl-regexp] |
d2355d76 | 16 | [-F | --fixed-strings] [-n | --line-number] |
cf0d720b | 17 | [-l | --files-with-matches] [-L | --files-without-match] |
0af88c15 | 18 | [(-O | --open-files-in-pager) [<pager>]] |
83caecca | 19 | [-z | --null] |
4ff61c21 | 20 | [-c | --count] [--all-match] [-q | --quiet] |
a91f453f | 21 | [--max-depth <depth>] |
73e9da01 | 22 | [--color[=<when>] | --no-color] |
a12c6b01 | 23 | [--break] [--heading] [-p | --show-function] |
1c57119c | 24 | [-A <post-context>] [-B <pre-context>] [-C <context>] |
a12c6b01 | 25 | [-W | --function-context] |
89f09dd3 | 26 | [--threads <num>] |
cf0d720b | 27 | [-f <file>] [-e] <pattern> |
ec2537be | 28 | [--and|--or|--not|(|)|-e <pattern>...] |
74ed4371 | 29 | [--recurse-submodules] [--parent-basename <basename>] |
0460ed2c | 30 | [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...] |
3ac44408 | 31 | [--] [<pathspec>...] |
2aba319a JH |
32 | |
33 | DESCRIPTION | |
34 | ----------- | |
3ac44408 | 35 | Look for specified patterns in the tracked files in the work tree, blobs |
526a858a RS |
36 | registered in the index file, or blobs in given tree objects. Patterns |
37 | are lists of one or more search expressions separated by newline | |
38 | characters. An empty string as search expression matches all lines. | |
2aba319a JH |
39 | |
40 | ||
b22520a3 JR |
41 | CONFIGURATION |
42 | ------------- | |
43 | ||
44 | grep.lineNumber:: | |
23f8239b | 45 | If set to true, enable `-n` option by default. |
b22520a3 | 46 | |
84befcd0 S |
47 | grep.patternType:: |
48 | Set the default matching behavior. Using a value of 'basic', 'extended', | |
bcf9626a MM |
49 | 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, |
50 | `--fixed-strings`, or `--perl-regexp` option accordingly, while the | |
84befcd0 S |
51 | value 'default' will return to the default matching behavior. |
52 | ||
b22520a3 | 53 | grep.extendedRegexp:: |
bcf9626a | 54 | If set to true, enable `--extended-regexp` option by default. This |
ae9f6311 | 55 | option is ignored when the `grep.patternType` option is set to a value |
84befcd0 | 56 | other than 'default'. |
b22520a3 | 57 | |
89f09dd3 VL |
58 | grep.threads:: |
59 | Number of grep worker threads to use. If unset (or set to 0), | |
60 | 8 threads are used by default (for now). | |
61 | ||
6453f7b3 | 62 | grep.fullName:: |
bcf9626a | 63 | If set to true, enable `--full-name` option by default. |
6453f7b3 | 64 | |
ecd9ba61 TG |
65 | grep.fallbackToNoIndex:: |
66 | If set to true, fall back to git grep --no-index if git grep | |
67 | is executed outside of a git repository. Defaults to false. | |
68 | ||
b22520a3 | 69 | |
2aba319a JH |
70 | OPTIONS |
71 | ------- | |
1c57119c | 72 | --cached:: |
2e48fcdb ML |
73 | Instead of searching tracked files in the working tree, search |
74 | blobs registered in the index file. | |
75 | ||
76 | --no-index:: | |
2de9b711 | 77 | Search files in the current directory that is not managed by Git. |
1c57119c | 78 | |
0a93fb8a JH |
79 | --untracked:: |
80 | In addition to searching in the tracked files in the working | |
81 | tree, search also in untracked files. | |
82 | ||
83 | --no-exclude-standard:: | |
84 | Also search in ignored files by not honoring the `.gitignore` | |
85 | mechanism. Only useful with `--untracked`. | |
86 | ||
87 | --exclude-standard:: | |
88 | Do not pay attention to ignored files specified via the `.gitignore` | |
89 | mechanism. Only useful when searching files in the current directory | |
90 | with `--no-index`. | |
1c57119c | 91 | |
0281e487 BW |
92 | --recurse-submodules:: |
93 | Recursively search in each submodule that has been initialized and | |
74ed4371 BW |
94 | checked out in the repository. When used in combination with the |
95 | <tree> option the prefix of all submodule output will be the name of | |
96 | the parent project's <tree> object. | |
97 | ||
3240240f SB |
98 | -a:: |
99 | --text:: | |
1c57119c JH |
100 | Process binary files as if they were text. |
101 | ||
335ec3bf JK |
102 | --textconv:: |
103 | Honor textconv filter settings. | |
104 | ||
105 | --no-textconv:: | |
106 | Do not honor textconv filter settings. | |
107 | This is the default. | |
108 | ||
3240240f SB |
109 | -i:: |
110 | --ignore-case:: | |
1c57119c JH |
111 | Ignore case differences between the patterns and the |
112 | files. | |
113 | ||
cf0d720b AR |
114 | -I:: |
115 | Don't match the pattern in binary files. | |
116 | ||
a91f453f | 117 | --max-depth <depth>:: |
3ac44408 | 118 | For each <pathspec> given on command line, descend at most <depth> |
a91f453f | 119 | levels of directories. A negative value means no limit. |
8c69c1f9 NTND |
120 | This option is ignored if <pathspec> contains active wildcards. |
121 | In other words if "a*" matches a directory named "a*", | |
122 | "*" is matched literally so --max-depth is still effective. | |
a91f453f | 123 | |
3240240f SB |
124 | -w:: |
125 | --word-regexp:: | |
1c57119c JH |
126 | Match the pattern only at word boundary (either begin at the |
127 | beginning of a line, or preceded by a non-word character; end at | |
128 | the end of a line or followed by a non-word character). | |
129 | ||
3240240f SB |
130 | -v:: |
131 | --invert-match:: | |
1c57119c JH |
132 | Select non-matching lines. |
133 | ||
3240240f SB |
134 | -h:: |
135 | -H:: | |
17fd965d JH |
136 | By default, the command shows the filename for each |
137 | match. `-h` option is used to suppress this output. | |
138 | `-H` is there for completeness and does not do anything | |
139 | except it overrides `-h` given earlier on the command | |
140 | line. | |
141 | ||
0d042fec JH |
142 | --full-name:: |
143 | When run from a subdirectory, the command usually | |
144 | outputs paths relative to the current directory. This | |
145 | option forces paths to be output relative to the project | |
146 | top directory. | |
147 | ||
3240240f SB |
148 | -E:: |
149 | --extended-regexp:: | |
150 | -G:: | |
151 | --basic-regexp:: | |
1c57119c JH |
152 | Use POSIX extended/basic regexp for patterns. Default |
153 | is to use basic regexp. | |
5b2bcc7b | 154 | |
63e7e9d8 MK |
155 | -P:: |
156 | --perl-regexp:: | |
d048cb13 ÆAB |
157 | Use Perl-compatible regular expressions for patterns. |
158 | + | |
159 | Support for these types of regular expressions is an optional | |
160 | compile-time dependency. If Git wasn't compiled with support for them | |
161 | providing this option will cause it to die. | |
63e7e9d8 | 162 | |
3240240f SB |
163 | -F:: |
164 | --fixed-strings:: | |
cf0d720b AR |
165 | Use fixed strings for patterns (don't interpret pattern |
166 | as a regex). | |
167 | ||
1c57119c | 168 | -n:: |
7d6cb10b | 169 | --line-number:: |
1c57119c | 170 | Prefix the line number to matching lines. |
2aba319a | 171 | |
3240240f SB |
172 | -l:: |
173 | --files-with-matches:: | |
174 | --name-only:: | |
175 | -L:: | |
176 | --files-without-match:: | |
1c57119c JH |
177 | Instead of showing every matched line, show only the |
178 | names of files that contain (or do not contain) matches. | |
bfb8306d ML |
179 | For better compatibility with 'git diff', `--name-only` is a |
180 | synonym for `--files-with-matches`. | |
2aba319a | 181 | |
318ca615 MM |
182 | -O[<pager>]:: |
183 | --open-files-in-pager[=<pager>]:: | |
678e484b JS |
184 | Open the matching files in the pager (not the output of 'grep'). |
185 | If the pager happens to be "less" or "vi", and the user | |
186 | specified only one pattern, the first file is positioned at | |
2b594bf9 MM |
187 | the first match automatically. The `pager` argument is |
188 | optional; if specified, it must be stuck to the option | |
189 | without a space. If `pager` is unspecified, the default pager | |
190 | will be used (see `core.pager` in linkgit:git-config[1]). | |
678e484b | 191 | |
83caecca RZ |
192 | -z:: |
193 | --null:: | |
194 | Output \0 instead of the character that normally follows a | |
195 | file name. | |
196 | ||
3240240f SB |
197 | -c:: |
198 | --count:: | |
1c57119c JH |
199 | Instead of showing every matched line, show the number of |
200 | lines that match. | |
201 | ||
73e9da01 | 202 | --color[=<when>]:: |
7e8f59d5 | 203 | Show colored matches. |
73e9da01 | 204 | The value must be always (the default), never, or auto. |
7e8f59d5 RS |
205 | |
206 | --no-color:: | |
207 | Turn off match highlighting, even when the configuration file | |
208 | gives the default to color output. | |
73e9da01 | 209 | Same as `--color=never`. |
7e8f59d5 | 210 | |
a8f0e764 RS |
211 | --break:: |
212 | Print an empty line between matches from different files. | |
213 | ||
1d84f72e RS |
214 | --heading:: |
215 | Show the filename above the matches in that file instead of | |
216 | at the start of each shown line. | |
217 | ||
2944e4e6 RS |
218 | -p:: |
219 | --show-function:: | |
220 | Show the preceding line that contains the function name of | |
221 | the match, unless the matching line is a function name itself. | |
60ecac98 RS |
222 | The name is determined in the same way as 'git diff' works out |
223 | patch hunk headers (see 'Defining a custom hunk-header' in | |
224 | linkgit:gitattributes[5]). | |
2944e4e6 | 225 | |
317f63c2 RS |
226 | -<num>:: |
227 | -C <num>:: | |
228 | --context <num>:: | |
229 | Show <num> leading and trailing lines, and place a line | |
230 | containing `--` between contiguous groups of matches. | |
231 | ||
232 | -A <num>:: | |
233 | --after-context <num>:: | |
234 | Show <num> trailing lines, and place a line containing | |
235 | `--` between contiguous groups of matches. | |
236 | ||
237 | -B <num>:: | |
238 | --before-context <num>:: | |
239 | Show <num> leading lines, and place a line containing | |
240 | `--` between contiguous groups of matches. | |
241 | ||
ba8ea749 | 242 | -W:: |
317f63c2 | 243 | --function-context:: |
ba8ea749 RS |
244 | Show the surrounding text from the previous line containing a |
245 | function name up to the one before the next function name, | |
246 | effectively showing the whole function in which the match was | |
247 | found. | |
248 | ||
89f09dd3 VL |
249 | --threads <num>:: |
250 | Number of grep worker threads to use. | |
251 | See `grep.threads` in 'CONFIGURATION' for more information. | |
252 | ||
1c57119c JH |
253 | -f <file>:: |
254 | Read patterns from <file>, one per line. | |
255 | ||
3acb27b6 ML |
256 | -e:: |
257 | The next parameter is the pattern. This option has to be | |
bfb8306d | 258 | used for patterns starting with `-` and should be used in |
fba0cbd9 ML |
259 | scripts passing user input to grep. Multiple patterns are |
260 | combined by 'or'. | |
261 | ||
3240240f SB |
262 | --and:: |
263 | --or:: | |
264 | --not:: | |
265 | ( ... ):: | |
23bfbb81 | 266 | Specify how multiple patterns are combined using Boolean |
fba0cbd9 ML |
267 | expressions. `--or` is the default operator. `--and` has |
268 | higher precedence than `--or`. `-e` has to be used for all | |
269 | patterns. | |
3acb27b6 | 270 | |
0ab7befa JH |
271 | --all-match:: |
272 | When giving multiple pattern expressions combined with `--or`, | |
273 | this flag is specified to limit the match to files that | |
274 | have lines to match all of them. | |
275 | ||
4ff61c21 JH |
276 | -q:: |
277 | --quiet:: | |
278 | Do not output matched lines; instead, exit with status 0 when | |
279 | there is a match and with non-zero status when there isn't. | |
280 | ||
bfb8306d | 281 | <tree>...:: |
2e48fcdb ML |
282 | Instead of searching tracked files in the working tree, search |
283 | blobs in the given trees. | |
1c57119c | 284 | |
fba0cbd9 | 285 | \--:: |
1c57119c | 286 | Signals the end of options; the rest of the parameters |
3ac44408 | 287 | are <pathspec> limiters. |
2aba319a | 288 | |
3ac44408 ML |
289 | <pathspec>...:: |
290 | If given, limit the search to paths matching at least one pattern. | |
291 | Both leading paths match and glob(7) patterns are supported. | |
93dbefb3 MR |
292 | + |
293 | For more details about the <pathspec> syntax, see the 'pathspec' entry | |
294 | in linkgit:gitglossary[7]. | |
2aba319a | 295 | |
76a8788c | 296 | EXAMPLES |
04416018 | 297 | -------- |
fba0cbd9 | 298 | |
6cf378f0 | 299 | `git grep 'time_t' -- '*.[ch]'`:: |
3ac44408 ML |
300 | Looks for `time_t` in all tracked .c and .h files in the working |
301 | directory and its subdirectories. | |
302 | ||
6cf378f0 | 303 | `git grep -e '#define' --and \( -e MAX_PATH -e PATH_MAX \)`:: |
fba0cbd9 ML |
304 | Looks for a line that has `#define` and either `MAX_PATH` or |
305 | `PATH_MAX`. | |
306 | ||
5d2fc913 | 307 | `git grep --all-match -e NODE -e Unexpected`:: |
0ab7befa JH |
308 | Looks for a line that has `NODE` or `Unexpected` in |
309 | files that have lines that match both. | |
310 | ||
93dbefb3 MR |
311 | `git grep solution -- :^Documentation`:: |
312 | Looks for `solution`, excluding files in `Documentation`. | |
313 | ||
2aba319a JH |
314 | GIT |
315 | --- | |
9e1f0a85 | 316 | Part of the linkgit:git[1] suite |