Autogenerated HTML docs for v1.3.3-g8701
authorJunio C Hamano <junio@hera.kernel.org>
Tue, 16 May 2006 02:14:21 +0000 (02:14 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Tue, 16 May 2006 02:14:21 +0000 (02:14 +0000)
git-grep.html
git-grep.txt

index 11f2f7e..411e995 100644 (file)
@@ -272,62 +272,147 @@ git-grep(1) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-grep</em> [&lt;option&gt;&#8230;] [-e] &lt;pattern&gt; [--] [&lt;path&gt;&#8230;]</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git-grep</em> [--cached]\r
+           [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]\r
+           [-v | --invert-match]\r
+           [-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings]\r
+           [-n] [-l | --files-with-matches] [-L | --files-without-match]\r
+           [-c | --count]\r
+           [-A &lt;post-context&gt;] [-B &lt;pre-context&gt;] [-C &lt;context&gt;]\r
+           [-f &lt;file&gt;] [-e &lt;pattern&gt;]\r
+           [&lt;tree&gt;&#8230;]\r
+           [--] [&lt;path&gt;&#8230;]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>Searches list of files <tt>git-ls-files</tt> produces for lines\r
-containing a match to the given pattern.</p>\r
+<p>Look for specified patterns in the working tree files, blobs\r
+registered in the index file, or given tree objects.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
 <dl>\r
 <dt>\r
-<tt>--</tt>\r
+--cached\r
 </dt>\r
 <dd>\r
 <p>\r
-        Signals the end of options; the rest of the parameters\r
-        are &lt;path&gt; limiters.\r
+        Instead of searching in the working tree files, check\r
+        the blobs registerd in the index file.\r
+</p>\r
+</dd>\r
+<dt>\r
+-a | --text\r
+</dt>\r
+<dd>\r
+<p>\r
+        Process binary files as if they were text.\r
+</p>\r
+</dd>\r
+<dt>\r
+-i | --ignore-case\r
+</dt>\r
+<dd>\r
+<p>\r
+        Ignore case differences between the patterns and the\r
+        files.\r
+</p>\r
+</dd>\r
+<dt>\r
+-w | --word-regexp\r
+</dt>\r
+<dd>\r
+<p>\r
+        Match the pattern only at word boundary (either begin at the\r
+        beginning of a line, or preceded by a non-word character; end at\r
+        the end of a line or followed by a non-word character).\r
+</p>\r
+</dd>\r
+<dt>\r
+-v | --invert-match\r
+</dt>\r
+<dd>\r
+<p>\r
+        Select non-matching lines.\r
+</p>\r
+</dd>\r
+<dt>\r
+-E | --extended-regexp | -G | --basic-regexp\r
+</dt>\r
+<dd>\r
+<p>\r
+        Use POSIX extended/basic regexp for patterns.  Default\r
+        is to use basic regexp.\r
+</p>\r
+</dd>\r
+<dt>\r
+-n\r
+</dt>\r
+<dd>\r
+<p>\r
+        Prefix the line number to matching lines.\r
+</p>\r
+</dd>\r
+<dt>\r
+-l | --files-with-matches | -L | --files-without-match\r
+</dt>\r
+<dd>\r
+<p>\r
+        Instead of showing every matched line, show only the\r
+        names of files that contain (or do not contain) matches.\r
 </p>\r
 </dd>\r
 <dt>\r
-&lt;option&gt;&#8230;\r
+-c | --count\r
 </dt>\r
 <dd>\r
 <p>\r
-        Either an option to pass to <tt>grep</tt> or <tt>git-ls-files</tt>.\r
+        Instead of showing every matched line, show the number of\r
+        lines that match.\r
 </p>\r
-<p>The following are the specific <tt>git-ls-files</tt> options\r
-that may be given: <tt>-o</tt>, <tt>--cached</tt>, <tt>--deleted</tt>, <tt>--others</tt>,\r
-<tt>--killed</tt>, <tt>--ignored</tt>, <tt>--modified</tt>, <tt>--exclude=*</tt>,\r
-<tt>--exclude-from=*</tt>, and <tt>--exclude-per-directory=*</tt>.</p>\r
-<p>All other options will be passed to <tt>grep</tt>.</p>\r
 </dd>\r
 <dt>\r
-&lt;pattern&gt;\r
+-[ABC] &lt;context&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
-        The pattern to look for.  The first non option is taken\r
-        as the pattern; if your pattern begins with a dash, use\r
-        <tt>-e &lt;pattern&gt;</tt>.\r
+        Show <tt>context</tt> trailing (<tt>A</tt> &#8212; after), or leading (<tt>B</tt>\r
+        &#8212; before), or both (<tt>C</tt> &#8212; context) lines, and place a\r
+        line containing <tt>--</tt> between continguous groups of\r
+        matches.\r
 </p>\r
 </dd>\r
 <dt>\r
-&lt;path&gt;&#8230;\r
+-f &lt;file&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
-        Optional paths to limit the set of files to be searched;\r
-        passed to <tt>git-ls-files</tt>.\r
+        Read patterns from &lt;file&gt;, one per line.\r
+</p>\r
+</dd>\r
+<dt>\r
+<tt>&lt;tree&gt;&#8230;</tt>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Search blobs in the trees for specified patterns.\r
+</p>\r
+</dd>\r
+<dt>\r
+<tt>--</tt>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Signals the end of options; the rest of the parameters\r
+        are &lt;path&gt; limiters.\r
 </p>\r
 </dd>\r
 </dl>\r
 </div>\r
 <h2>Author</h2>\r
 <div class="sectionbody">\r
-<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
+<p>Originally written by Linus Torvalds &lt;torvalds@osdl.org&gt;, later\r
+revamped by Junio C Hamano.</p>\r
 </div>\r
 <h2>Documentation</h2>\r
 <div class="sectionbody">\r
@@ -339,7 +424,7 @@ that may be given: <tt>-o</tt>, <tt>--cached</tt>, <tt>--deleted</tt>, <tt>--oth
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 24-Mar-2006 08:11:01 UTC\r
+Last updated 16-May-2006 02:14:10 UTC\r
 </div>\r
 </div>\r
 </body>\r
index d55456a..74102b7 100644 (file)
@@ -8,43 +8,82 @@ git-grep - Print lines matching a pattern
 
 SYNOPSIS
 --------
-'git-grep' [<option>...] [-e] <pattern> [--] [<path>...]
+[verse]
+'git-grep' [--cached]
+          [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
+          [-v | --invert-match]
+          [-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings]
+          [-n] [-l | --files-with-matches] [-L | --files-without-match]
+          [-c | --count]
+          [-A <post-context>] [-B <pre-context>] [-C <context>]
+          [-f <file>] [-e <pattern>]
+          [<tree>...]
+          [--] [<path>...]
 
 DESCRIPTION
 -----------
-Searches list of files `git-ls-files` produces for lines
-containing a match to the given pattern.
+Look for specified patterns in the working tree files, blobs
+registered in the index file, or given tree objects.
 
 
 OPTIONS
 -------
-`--`::
-       Signals the end of options; the rest of the parameters
-       are <path> limiters.
+--cached::
+       Instead of searching in the working tree files, check
+       the blobs registerd in the index file.
+
+-a | --text::
+       Process binary files as if they were text.
+
+-i | --ignore-case::
+       Ignore case differences between the patterns and the
+       files.
+
+-w | --word-regexp::
+       Match the pattern only at word boundary (either begin at the
+       beginning of a line, or preceded by a non-word character; end at
+       the end of a line or followed by a non-word character).
+
+-v | --invert-match::
+       Select non-matching lines.
+
+-E | --extended-regexp | -G | --basic-regexp::
+       Use POSIX extended/basic regexp for patterns.  Default
+       is to use basic regexp.
 
-<option>...::
-       Either an option to pass to `grep` or `git-ls-files`.
-+
-The following are the specific `git-ls-files` options
-that may be given: `-o`, `--cached`, `--deleted`, `--others`,
-`--killed`, `--ignored`, `--modified`, `--exclude=\*`,
-`--exclude-from=\*`, and `--exclude-per-directory=\*`.
-+
-All other options will be passed to `grep`.
+-n::
+       Prefix the line number to matching lines.
 
-<pattern>::
-       The pattern to look for.  The first non option is taken
-       as the pattern; if your pattern begins with a dash, use
-       `-e <pattern>`.
+-l | --files-with-matches | -L | --files-without-match::
+       Instead of showing every matched line, show only the
+       names of files that contain (or do not contain) matches.
 
-<path>...::
-       Optional paths to limit the set of files to be searched;
-       passed to `git-ls-files`.
+-c | --count::
+       Instead of showing every matched line, show the number of
+       lines that match.
+
+-[ABC] <context>::
+       Show `context` trailing (`A` -- after), or leading (`B`
+       -- before), or both (`C` -- context) lines, and place a
+       line containing `--` between continguous groups of
+       matches.
+
+-f <file>::
+       Read patterns from <file>, one per line.
+
+`<tree>...`::
+       Search blobs in the trees for specified patterns.
+
+`--`::
+       Signals the end of options; the rest of the parameters
+       are <path> limiters.
 
 
 Author
 ------
-Written by Linus Torvalds <torvalds@osdl.org>
+Originally written by Linus Torvalds <torvalds@osdl.org>, later
+revamped by Junio C Hamano.
+
 
 Documentation
 --------------