]>
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 JH |
11 | [verse] |
12 | 'git-grep' [--cached] | |
13 | [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp] | |
17fd965d | 14 | [-v | --invert-match] [-h|-H] [--full-name] |
cf0d720b AR |
15 | [-E | --extended-regexp] [-G | --basic-regexp] |
16 | [-F | --fixed-strings] [-n] | |
17 | [-l | --files-with-matches] [-L | --files-without-match] | |
0ab7befa | 18 | [-c | --count] [--all-match] |
1c57119c | 19 | [-A <post-context>] [-B <pre-context>] [-C <context>] |
cf0d720b AR |
20 | [-f <file>] [-e] <pattern> |
21 | [--and|--or|--not|(|)|-e <pattern>...] [<tree>...] | |
1c57119c | 22 | [--] [<path>...] |
2aba319a JH |
23 | |
24 | DESCRIPTION | |
25 | ----------- | |
1c57119c JH |
26 | Look for specified patterns in the working tree files, blobs |
27 | registered in the index file, or given tree objects. | |
2aba319a JH |
28 | |
29 | ||
30 | OPTIONS | |
31 | ------- | |
1c57119c JH |
32 | --cached:: |
33 | Instead of searching in the working tree files, check | |
abda1ef5 | 34 | the blobs registered in the index file. |
1c57119c JH |
35 | |
36 | -a | --text:: | |
37 | Process binary files as if they were text. | |
38 | ||
39 | -i | --ignore-case:: | |
40 | Ignore case differences between the patterns and the | |
41 | files. | |
42 | ||
cf0d720b AR |
43 | -I:: |
44 | Don't match the pattern in binary files. | |
45 | ||
1c57119c JH |
46 | -w | --word-regexp:: |
47 | Match the pattern only at word boundary (either begin at the | |
48 | beginning of a line, or preceded by a non-word character; end at | |
49 | the end of a line or followed by a non-word character). | |
50 | ||
51 | -v | --invert-match:: | |
52 | Select non-matching lines. | |
53 | ||
17fd965d JH |
54 | -h | -H:: |
55 | By default, the command shows the filename for each | |
56 | match. `-h` option is used to suppress this output. | |
57 | `-H` is there for completeness and does not do anything | |
58 | except it overrides `-h` given earlier on the command | |
59 | line. | |
60 | ||
0d042fec JH |
61 | --full-name:: |
62 | When run from a subdirectory, the command usually | |
63 | outputs paths relative to the current directory. This | |
64 | option forces paths to be output relative to the project | |
65 | top directory. | |
66 | ||
1c57119c JH |
67 | -E | --extended-regexp | -G | --basic-regexp:: |
68 | Use POSIX extended/basic regexp for patterns. Default | |
69 | is to use basic regexp. | |
5b2bcc7b | 70 | |
cf0d720b AR |
71 | -F | --fixed-strings:: |
72 | Use fixed strings for patterns (don't interpret pattern | |
73 | as a regex). | |
74 | ||
1c57119c JH |
75 | -n:: |
76 | Prefix the line number to matching lines. | |
2aba319a | 77 | |
1c57119c JH |
78 | -l | --files-with-matches | -L | --files-without-match:: |
79 | Instead of showing every matched line, show only the | |
80 | names of files that contain (or do not contain) matches. | |
2aba319a | 81 | |
1c57119c JH |
82 | -c | --count:: |
83 | Instead of showing every matched line, show the number of | |
84 | lines that match. | |
85 | ||
86 | -[ABC] <context>:: | |
87 | Show `context` trailing (`A` -- after), or leading (`B` | |
88 | -- before), or both (`C` -- context) lines, and place a | |
abda1ef5 | 89 | line containing `--` between contiguous groups of |
1c57119c JH |
90 | matches. |
91 | ||
cf0d720b AR |
92 | -<num>:: |
93 | A shortcut for specifying -C<num>. | |
94 | ||
1c57119c JH |
95 | -f <file>:: |
96 | Read patterns from <file>, one per line. | |
97 | ||
3acb27b6 ML |
98 | -e:: |
99 | The next parameter is the pattern. This option has to be | |
100 | used for patterns starting with - and should be used in | |
fba0cbd9 ML |
101 | scripts passing user input to grep. Multiple patterns are |
102 | combined by 'or'. | |
103 | ||
104 | --and | --or | --not | ( | ):: | |
23bfbb81 | 105 | Specify how multiple patterns are combined using Boolean |
fba0cbd9 ML |
106 | expressions. `--or` is the default operator. `--and` has |
107 | higher precedence than `--or`. `-e` has to be used for all | |
108 | patterns. | |
3acb27b6 | 109 | |
0ab7befa JH |
110 | --all-match:: |
111 | When giving multiple pattern expressions combined with `--or`, | |
112 | this flag is specified to limit the match to files that | |
113 | have lines to match all of them. | |
114 | ||
1c57119c JH |
115 | `<tree>...`:: |
116 | Search blobs in the trees for specified patterns. | |
117 | ||
fba0cbd9 | 118 | \--:: |
1c57119c JH |
119 | Signals the end of options; the rest of the parameters |
120 | are <path> limiters. | |
2aba319a JH |
121 | |
122 | ||
fba0cbd9 ML |
123 | Example |
124 | ------- | |
125 | ||
126 | git grep -e \'#define\' --and \( -e MAX_PATH -e PATH_MAX \):: | |
127 | Looks for a line that has `#define` and either `MAX_PATH` or | |
128 | `PATH_MAX`. | |
129 | ||
0ab7befa JH |
130 | git grep --all-match -e NODE -e Unexpected:: |
131 | Looks for a line that has `NODE` or `Unexpected` in | |
132 | files that have lines that match both. | |
133 | ||
2aba319a JH |
134 | Author |
135 | ------ | |
1c57119c JH |
136 | Originally written by Linus Torvalds <torvalds@osdl.org>, later |
137 | revamped by Junio C Hamano. | |
138 | ||
2aba319a JH |
139 | |
140 | Documentation | |
141 | -------------- | |
142 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
143 | ||
144 | GIT | |
145 | --- | |
a7154e91 | 146 | Part of the gitlink:git[7] suite |