Documentation: add a couple of missing docs.
[git/jnareb-git/bp-gitweb.git] / Documentation / git-grep.txt
blobd55456ae93f2596717cc2468af066dce8c11f2c6
1 git-grep(1)
2 ===========
4 NAME
5 ----
6 git-grep - Print lines matching a pattern
9 SYNOPSIS
10 --------
11 'git-grep' [<option>...] [-e] <pattern> [--] [<path>...]
13 DESCRIPTION
14 -----------
15 Searches list of files `git-ls-files` produces for lines
16 containing a match to the given pattern.
19 OPTIONS
20 -------
21 `--`::
22         Signals the end of options; the rest of the parameters
23         are <path> limiters.
25 <option>...::
26         Either an option to pass to `grep` or `git-ls-files`.
28 The following are the specific `git-ls-files` options
29 that may be given: `-o`, `--cached`, `--deleted`, `--others`,
30 `--killed`, `--ignored`, `--modified`, `--exclude=\*`,
31 `--exclude-from=\*`, and `--exclude-per-directory=\*`.
33 All other options will be passed to `grep`.
35 <pattern>::
36         The pattern to look for.  The first non option is taken
37         as the pattern; if your pattern begins with a dash, use
38         `-e <pattern>`.
40 <path>...::
41         Optional paths to limit the set of files to be searched;
42         passed to `git-ls-files`.
45 Author
46 ------
47 Written by Linus Torvalds <torvalds@osdl.org>
49 Documentation
50 --------------
51 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
53 GIT
54 ---
55 Part of the gitlink:git[7] suite