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