Autogenerated HTML docs for v1.3.3-g288c
[git.git] / git-grep.html
index 4fb85d5..411e995 100644 (file)
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 7.0.1" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
 <style type="text/css">\r
 /* Debug borders */\r
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
@@ -266,74 +266,153 @@ git-grep(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>git-grep -\r
-   print lines matching a pattern\r
+   Print lines matching a pattern\r
 </p>\r
 </div>\r
 </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
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>The following are the specific `git-ls-files` options\r
-that may be given: `-o`, `--cached`, `--deleted`, `--others`,\r
-`--killed`, `--ignored`, `--modified`, `--exclude=*`,\r
-`--exclude-from=*`, and `--exclude-per-directory=*`.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>All other options will be passed to `grep`.</tt></pre>\r
-</div></div>\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
@@ -345,7 +424,7 @@ that may be given: `-o`, `--cached`, `--deleted`, `--others`,
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 21-Jan-2006 23:50:17 PDT\r
+Last updated 16-May-2006 02:14:10 UTC\r
 </div>\r
 </div>\r
 </body>\r