git-grep.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-grep(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-grep(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-grep -
 743    Print lines matching a pattern
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git grep</em> [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
 753            [-v | --invert-match] [-h|-H] [--full-name]
 754            [-E | --extended-regexp] [-G | --basic-regexp]
 755            [-P | --perl-regexp]
 756            [-F | --fixed-strings] [-n | --line-number] [--column]
 757            [-l | --files-with-matches] [-L | --files-without-match]
 758            [(-O | --open-files-in-pager) [&lt;pager&gt;]]
 759            [-z | --null]
 760            [ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
 761            [--max-depth &lt;depth&gt;] [--[no-]recursive]
 762            [--color[=&lt;when&gt;] | --no-color]
 763            [--break] [--heading] [-p | --show-function]
 764            [-A &lt;post-context&gt;] [-B &lt;pre-context&gt;] [-C &lt;context&gt;]
 765            [-W | --function-context]
 766            [(-m | --max-count) &lt;num&gt;]
 767            [--threads &lt;num&gt;]
 768            [-f &lt;file&gt;] [-e] &lt;pattern&gt;
 769            [--and|--or|--not|(|)|-e &lt;pattern&gt;&#8230;]
 770            [--recurse-submodules] [--parent-basename &lt;basename&gt;]
 771            [ [--[no-]exclude-standard] [--cached | --untracked | --no-index] | &lt;tree&gt;&#8230;]
 772            [--] [&lt;pathspec&gt;&#8230;]</pre>
 773 <div class="attribution">
 774 </div></div>
 775 </div>
 776 </div>
 777 <div class="sect1">
 778 <h2 id="_description">DESCRIPTION</h2>
 779 <div class="sectionbody">
 780 <div class="paragraph"><p>Look for specified patterns in the tracked files in the work tree, blobs
 781 registered in the index file, or blobs in given tree objects.  Patterns
 782 are lists of one or more search expressions separated by newline
 783 characters.  An empty string as search expression matches all lines.</p></div>
 784 </div>
 785 </div>
 786 <div class="sect1">
 787 <h2 id="_options">OPTIONS</h2>
 788 <div class="sectionbody">
 789 <div class="dlist"><dl>
 790 <dt class="hdlist1">
 791 --cached
 792 </dt>
 793 <dd>
 794 <p>
 795         Instead of searching tracked files in the working tree, search
 796         blobs registered in the index file.
 797 </p>
 798 </dd>
 799 <dt class="hdlist1">
 800 --untracked
 801 </dt>
 802 <dd>
 803 <p>
 804         In addition to searching in the tracked files in the working
 805         tree, search also in untracked files.
 806 </p>
 807 </dd>
 808 <dt class="hdlist1">
 809 --no-index
 810 </dt>
 811 <dd>
 812 <p>
 813         Search files in the current directory that is not managed by Git,
 814         or by ignoring that the current directory is managed by Git.  This
 815         is rather similar to running the regular <code>grep(1)</code> utility with its
 816         <code>-r</code> option specified, but with some additional benefits, such as
 817         using pathspec patterns to limit paths;  see the <em>pathspec</em> entry
 818         in <a href="gitglossary.html">gitglossary(7)</a> for more information.
 819 </p>
 820 <div class="paragraph"><p>This option cannot be used together with <code>--cached</code> or <code>--untracked</code>.
 821 See also <code>grep.fallbackToNoIndex</code> in <em>CONFIGURATION</em> below.</p></div>
 822 </dd>
 823 <dt class="hdlist1">
 824 --no-exclude-standard
 825 </dt>
 826 <dd>
 827 <p>
 828         Also search in ignored files by not honoring the <code>.gitignore</code>
 829         mechanism. Only useful with <code>--untracked</code>.
 830 </p>
 831 </dd>
 832 <dt class="hdlist1">
 833 --exclude-standard
 834 </dt>
 835 <dd>
 836 <p>
 837         Do not pay attention to ignored files specified via the <code>.gitignore</code>
 838         mechanism.  Only useful when searching files in the current directory
 839         with <code>--no-index</code>.
 840 </p>
 841 </dd>
 842 <dt class="hdlist1">
 843 --recurse-submodules
 844 </dt>
 845 <dd>
 846 <p>
 847         Recursively search in each submodule that is active and
 848         checked out in the repository.  When used in combination with the
 849         <em>&lt;tree&gt;</em> option the prefix of all submodule output will be the name of
 850         the parent project&#8217;s <em>&lt;tree&gt;</em> object.  This option cannot be used together
 851         with <code>--untracked</code>, and it has no effect if <code>--no-index</code> is specified.
 852 </p>
 853 </dd>
 854 <dt class="hdlist1">
 855 -a
 856 </dt>
 857 <dt class="hdlist1">
 858 --text
 859 </dt>
 860 <dd>
 861 <p>
 862         Process binary files as if they were text.
 863 </p>
 864 </dd>
 865 <dt class="hdlist1">
 866 --textconv
 867 </dt>
 868 <dd>
 869 <p>
 870         Honor textconv filter settings.
 871 </p>
 872 </dd>
 873 <dt class="hdlist1">
 874 --no-textconv
 875 </dt>
 876 <dd>
 877 <p>
 878         Do not honor textconv filter settings.
 879         This is the default.
 880 </p>
 881 </dd>
 882 <dt class="hdlist1">
 883 -i
 884 </dt>
 885 <dt class="hdlist1">
 886 --ignore-case
 887 </dt>
 888 <dd>
 889 <p>
 890         Ignore case differences between the patterns and the
 891         files.
 892 </p>
 893 </dd>
 894 <dt class="hdlist1">
 895 -I
 896 </dt>
 897 <dd>
 898 <p>
 899         Don&#8217;t match the pattern in binary files.
 900 </p>
 901 </dd>
 902 <dt class="hdlist1">
 903 --max-depth &lt;depth&gt;
 904 </dt>
 905 <dd>
 906 <p>
 907         For each &lt;pathspec&gt; given on command line, descend at most &lt;depth&gt;
 908         levels of directories. A value of -1 means no limit.
 909         This option is ignored if &lt;pathspec&gt; contains active wildcards.
 910         In other words if "a*" matches a directory named "a*",
 911         "*" is matched literally so --max-depth is still effective.
 912 </p>
 913 </dd>
 914 <dt class="hdlist1">
 915 -r
 916 </dt>
 917 <dt class="hdlist1">
 918 --recursive
 919 </dt>
 920 <dd>
 921 <p>
 922         Same as <code>--max-depth=-1</code>; this is the default.
 923 </p>
 924 </dd>
 925 <dt class="hdlist1">
 926 --no-recursive
 927 </dt>
 928 <dd>
 929 <p>
 930         Same as <code>--max-depth=0</code>.
 931 </p>
 932 </dd>
 933 <dt class="hdlist1">
 934 -w
 935 </dt>
 936 <dt class="hdlist1">
 937 --word-regexp
 938 </dt>
 939 <dd>
 940 <p>
 941         Match the pattern only at word boundary (either begin at the
 942         beginning of a line, or preceded by a non-word character; end at
 943         the end of a line or followed by a non-word character).
 944 </p>
 945 </dd>
 946 <dt class="hdlist1">
 947 -v
 948 </dt>
 949 <dt class="hdlist1">
 950 --invert-match
 951 </dt>
 952 <dd>
 953 <p>
 954         Select non-matching lines.
 955 </p>
 956 </dd>
 957 <dt class="hdlist1">
 958 -h
 959 </dt>
 960 <dt class="hdlist1">
 961 -H
 962 </dt>
 963 <dd>
 964 <p>
 965         By default, the command shows the filename for each
 966         match.  <code>-h</code> option is used to suppress this output.
 967         <code>-H</code> is there for completeness and does not do anything
 968         except it overrides <code>-h</code> given earlier on the command
 969         line.
 970 </p>
 971 </dd>
 972 <dt class="hdlist1">
 973 --full-name
 974 </dt>
 975 <dd>
 976 <p>
 977         When run from a subdirectory, the command usually
 978         outputs paths relative to the current directory.  This
 979         option forces paths to be output relative to the project
 980         top directory.
 981 </p>
 982 </dd>
 983 <dt class="hdlist1">
 984 -E
 985 </dt>
 986 <dt class="hdlist1">
 987 --extended-regexp
 988 </dt>
 989 <dt class="hdlist1">
 990 -G
 991 </dt>
 992 <dt class="hdlist1">
 993 --basic-regexp
 994 </dt>
 995 <dd>
 996 <p>
 997         Use POSIX extended/basic regexp for patterns.  Default
 998         is to use basic regexp.
 999 </p>
1000 </dd>
1001 <dt class="hdlist1">
1002 -P
1003 </dt>
1004 <dt class="hdlist1">
1005 --perl-regexp
1006 </dt>
1007 <dd>
1008 <p>
1009         Use Perl-compatible regular expressions for patterns.
1010 </p>
1011 <div class="paragraph"><p>Support for these types of regular expressions is an optional
1012 compile-time dependency. If Git wasn&#8217;t compiled with support for them
1013 providing this option will cause it to die.</p></div>
1014 </dd>
1015 <dt class="hdlist1">
1016 -F
1017 </dt>
1018 <dt class="hdlist1">
1019 --fixed-strings
1020 </dt>
1021 <dd>
1022 <p>
1023         Use fixed strings for patterns (don&#8217;t interpret pattern
1024         as a regex).
1025 </p>
1026 </dd>
1027 <dt class="hdlist1">
1028 -n
1029 </dt>
1030 <dt class="hdlist1">
1031 --line-number
1032 </dt>
1033 <dd>
1034 <p>
1035         Prefix the line number to matching lines.
1036 </p>
1037 </dd>
1038 <dt class="hdlist1">
1039 --column
1040 </dt>
1041 <dd>
1042 <p>
1043         Prefix the 1-indexed byte-offset of the first match from the start of the
1044         matching line.
1045 </p>
1046 </dd>
1047 <dt class="hdlist1">
1048 -l
1049 </dt>
1050 <dt class="hdlist1">
1051 --files-with-matches
1052 </dt>
1053 <dt class="hdlist1">
1054 --name-only
1055 </dt>
1056 <dt class="hdlist1">
1057 -L
1058 </dt>
1059 <dt class="hdlist1">
1060 --files-without-match
1061 </dt>
1062 <dd>
1063 <p>
1064         Instead of showing every matched line, show only the
1065         names of files that contain (or do not contain) matches.
1066         For better compatibility with <em>git diff</em>, <code>--name-only</code> is a
1067         synonym for <code>--files-with-matches</code>.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 -O[&lt;pager&gt;]
1072 </dt>
1073 <dt class="hdlist1">
1074 --open-files-in-pager[=&lt;pager&gt;]
1075 </dt>
1076 <dd>
1077 <p>
1078         Open the matching files in the pager (not the output of <em>grep</em>).
1079         If the pager happens to be "less" or "vi", and the user
1080         specified only one pattern, the first file is positioned at
1081         the first match automatically. The <code>pager</code> argument is
1082         optional; if specified, it must be stuck to the option
1083         without a space. If <code>pager</code> is unspecified, the default pager
1084         will be used (see <code>core.pager</code> in <a href="git-config.html">git-config(1)</a>).
1085 </p>
1086 </dd>
1087 <dt class="hdlist1">
1088 -z
1089 </dt>
1090 <dt class="hdlist1">
1091 --null
1092 </dt>
1093 <dd>
1094 <p>
1095         Use \0 as the delimiter for pathnames in the output, and print
1096         them verbatim. Without this option, pathnames with "unusual"
1097         characters are quoted as explained for the configuration
1098         variable <code>core.quotePath</code> (see <a href="git-config.html">git-config(1)</a>).
1099 </p>
1100 </dd>
1101 <dt class="hdlist1">
1102 -o
1103 </dt>
1104 <dt class="hdlist1">
1105 --only-matching
1106 </dt>
1107 <dd>
1108 <p>
1109         Print only the matched (non-empty) parts of a matching line, with each such
1110         part on a separate output line.
1111 </p>
1112 </dd>
1113 <dt class="hdlist1">
1114 -c
1115 </dt>
1116 <dt class="hdlist1">
1117 --count
1118 </dt>
1119 <dd>
1120 <p>
1121         Instead of showing every matched line, show the number of
1122         lines that match.
1123 </p>
1124 </dd>
1125 <dt class="hdlist1">
1126 --color[=&lt;when&gt;]
1127 </dt>
1128 <dd>
1129 <p>
1130         Show colored matches.
1131         The value must be always (the default), never, or auto.
1132 </p>
1133 </dd>
1134 <dt class="hdlist1">
1135 --no-color
1136 </dt>
1137 <dd>
1138 <p>
1139         Turn off match highlighting, even when the configuration file
1140         gives the default to color output.
1141         Same as <code>--color=never</code>.
1142 </p>
1143 </dd>
1144 <dt class="hdlist1">
1145 --break
1146 </dt>
1147 <dd>
1148 <p>
1149         Print an empty line between matches from different files.
1150 </p>
1151 </dd>
1152 <dt class="hdlist1">
1153 --heading
1154 </dt>
1155 <dd>
1156 <p>
1157         Show the filename above the matches in that file instead of
1158         at the start of each shown line.
1159 </p>
1160 </dd>
1161 <dt class="hdlist1">
1162 -p
1163 </dt>
1164 <dt class="hdlist1">
1165 --show-function
1166 </dt>
1167 <dd>
1168 <p>
1169         Show the preceding line that contains the function name of
1170         the match, unless the matching line is a function name itself.
1171         The name is determined in the same way as <code>git diff</code> works out
1172         patch hunk headers (see <em>Defining a custom hunk-header</em> in
1173         <a href="gitattributes.html">gitattributes(5)</a>).
1174 </p>
1175 </dd>
1176 <dt class="hdlist1">
1177 -&lt;num&gt;
1178 </dt>
1179 <dt class="hdlist1">
1180 -C &lt;num&gt;
1181 </dt>
1182 <dt class="hdlist1">
1183 --context &lt;num&gt;
1184 </dt>
1185 <dd>
1186 <p>
1187         Show &lt;num&gt; leading and trailing lines, and place a line
1188         containing <code>--</code> between contiguous groups of matches.
1189 </p>
1190 </dd>
1191 <dt class="hdlist1">
1192 -A &lt;num&gt;
1193 </dt>
1194 <dt class="hdlist1">
1195 --after-context &lt;num&gt;
1196 </dt>
1197 <dd>
1198 <p>
1199         Show &lt;num&gt; trailing lines, and place a line containing
1200         <code>--</code> between contiguous groups of matches.
1201 </p>
1202 </dd>
1203 <dt class="hdlist1">
1204 -B &lt;num&gt;
1205 </dt>
1206 <dt class="hdlist1">
1207 --before-context &lt;num&gt;
1208 </dt>
1209 <dd>
1210 <p>
1211         Show &lt;num&gt; leading lines, and place a line containing
1212         <code>--</code> between contiguous groups of matches.
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 -W
1217 </dt>
1218 <dt class="hdlist1">
1219 --function-context
1220 </dt>
1221 <dd>
1222 <p>
1223         Show the surrounding text from the previous line containing a
1224         function name up to the one before the next function name,
1225         effectively showing the whole function in which the match was
1226         found. The function names are determined in the same way as
1227         <code>git diff</code> works out patch hunk headers (see <em>Defining a
1228         custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
1229 </p>
1230 </dd>
1231 <dt class="hdlist1">
1232 -m &lt;num&gt;
1233 </dt>
1234 <dt class="hdlist1">
1235 --max-count &lt;num&gt;
1236 </dt>
1237 <dd>
1238 <p>
1239         Limit the amount of matches per file. When using the <code>-v</code> or
1240         <code>--invert-match</code> option, the search stops after the specified
1241         number of non-matches. A value of -1 will return unlimited
1242         results (the default). A value of 0 will exit immediately with
1243         a non-zero status.
1244 </p>
1245 </dd>
1246 <dt class="hdlist1">
1247 --threads &lt;num&gt;
1248 </dt>
1249 <dd>
1250 <p>
1251         Number of <code>grep</code> worker threads to use.  See <em>NOTES ON THREADS</em>
1252         and <code>grep.threads</code> in <em>CONFIGURATION</em> for more information.
1253 </p>
1254 </dd>
1255 <dt class="hdlist1">
1256 -f &lt;file&gt;
1257 </dt>
1258 <dd>
1259 <p>
1260         Read patterns from &lt;file&gt;, one per line.
1261 </p>
1262 <div class="paragraph"><p>Passing the pattern via &lt;file&gt; allows for providing a search pattern
1263 containing a \0.</p></div>
1264 <div class="paragraph"><p>Not all pattern types support patterns containing \0. Git will error
1265 out if a given pattern type can&#8217;t support such a pattern. The
1266 <code>--perl-regexp</code> pattern type when compiled against the PCRE v2 backend
1267 has the widest support for these types of patterns.</p></div>
1268 <div class="paragraph"><p>In versions of Git before 2.23.0 patterns containing \0 would be
1269 silently considered fixed. This was never documented, there were also
1270 odd and undocumented interactions between e.g. non-ASCII patterns
1271 containing \0 and <code>--ignore-case</code>.</p></div>
1272 <div class="paragraph"><p>In future versions we may learn to support patterns containing \0 for
1273 more search backends, until then we&#8217;ll die when the pattern type in
1274 question doesn&#8217;t support them.</p></div>
1275 </dd>
1276 <dt class="hdlist1">
1277 -e
1278 </dt>
1279 <dd>
1280 <p>
1281         The next parameter is the pattern. This option has to be
1282         used for patterns starting with <code>-</code> and should be used in
1283         scripts passing user input to grep.  Multiple patterns are
1284         combined by <em>or</em>.
1285 </p>
1286 </dd>
1287 <dt class="hdlist1">
1288 --and
1289 </dt>
1290 <dt class="hdlist1">
1291 --or
1292 </dt>
1293 <dt class="hdlist1">
1294 --not
1295 </dt>
1296 <dt class="hdlist1">
1297 ( &#8230; )
1298 </dt>
1299 <dd>
1300 <p>
1301         Specify how multiple patterns are combined using Boolean
1302         expressions.  <code>--or</code> is the default operator.  <code>--and</code> has
1303         higher precedence than <code>--or</code>.  <code>-e</code> has to be used for all
1304         patterns.
1305 </p>
1306 </dd>
1307 <dt class="hdlist1">
1308 --all-match
1309 </dt>
1310 <dd>
1311 <p>
1312         When giving multiple pattern expressions combined with <code>--or</code>,
1313         this flag is specified to limit the match to files that
1314         have lines to match all of them.
1315 </p>
1316 </dd>
1317 <dt class="hdlist1">
1318 -q
1319 </dt>
1320 <dt class="hdlist1">
1321 --quiet
1322 </dt>
1323 <dd>
1324 <p>
1325         Do not output matched lines; instead, exit with status 0 when
1326         there is a match and with non-zero status when there isn&#8217;t.
1327 </p>
1328 </dd>
1329 <dt class="hdlist1">
1330 &lt;tree&gt;&#8230;
1331 </dt>
1332 <dd>
1333 <p>
1334         Instead of searching tracked files in the working tree, search
1335         blobs in the given trees.
1336 </p>
1337 </dd>
1338 <dt class="hdlist1">
1339 --
1340 </dt>
1341 <dd>
1342 <p>
1343         Signals the end of options; the rest of the parameters
1344         are &lt;pathspec&gt; limiters.
1345 </p>
1346 </dd>
1347 <dt class="hdlist1">
1348 &lt;pathspec&gt;&#8230;
1349 </dt>
1350 <dd>
1351 <p>
1352         If given, limit the search to paths matching at least one pattern.
1353         Both leading paths match and glob(7) patterns are supported.
1354 </p>
1355 <div class="paragraph"><p>For more details about the &lt;pathspec&gt; syntax, see the <em>pathspec</em> entry
1356 in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
1357 </dd>
1358 </dl></div>
1359 </div>
1360 </div>
1361 <div class="sect1">
1362 <h2 id="_examples">EXAMPLES</h2>
1363 <div class="sectionbody">
1364 <div class="dlist"><dl>
1365 <dt class="hdlist1">
1366 <code>git grep 'time_t' -- '*.[ch]'</code>
1367 </dt>
1368 <dd>
1369 <p>
1370         Looks for <code>time_t</code> in all tracked .c and .h files in the working
1371         directory and its subdirectories.
1372 </p>
1373 </dd>
1374 <dt class="hdlist1">
1375 <code>git grep -e '#define' --and \( -e MAX_PATH -e PATH_MAX \)</code>
1376 </dt>
1377 <dd>
1378 <p>
1379         Looks for a line that has <code>#define</code> and either <code>MAX_PATH</code> or
1380         <code>PATH_MAX</code>.
1381 </p>
1382 </dd>
1383 <dt class="hdlist1">
1384 <code>git grep --all-match -e NODE -e Unexpected</code>
1385 </dt>
1386 <dd>
1387 <p>
1388         Looks for a line that has <code>NODE</code> or <code>Unexpected</code> in
1389         files that have lines that match both.
1390 </p>
1391 </dd>
1392 <dt class="hdlist1">
1393 <code>git grep solution -- :^Documentation</code>
1394 </dt>
1395 <dd>
1396 <p>
1397         Looks for <code>solution</code>, excluding files in <code>Documentation</code>.
1398 </p>
1399 </dd>
1400 </dl></div>
1401 </div>
1402 </div>
1403 <div class="sect1">
1404 <h2 id="_notes_on_threads">NOTES ON THREADS</h2>
1405 <div class="sectionbody">
1406 <div class="paragraph"><p>The <code>--threads</code> option (and the <code>grep.threads</code> configuration) will be ignored when
1407 <code>--open-files-in-pager</code> is used, forcing a single-threaded execution.</p></div>
1408 <div class="paragraph"><p>When grepping the object store (with <code>--cached</code> or giving tree objects), running
1409 with multiple threads might perform slower than single-threaded if <code>--textconv</code>
1410 is given and there are too many text conversions.  Thus, if low performance is
1411 experienced in this case, it might be desirable to use <code>--threads=1</code>.</p></div>
1412 </div>
1413 </div>
1414 <div class="sect1">
1415 <h2 id="_configuration">CONFIGURATION</h2>
1416 <div class="sectionbody">
1417 <div class="paragraph"><p>Everything below this line in this section is selectively included
1418 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1419 as what&#8217;s found there:</p></div>
1420 <div class="dlist"><dl>
1421 <dt class="hdlist1">
1422 grep.lineNumber
1423 </dt>
1424 <dd>
1425 <p>
1426         If set to true, enable <code>-n</code> option by default.
1427 </p>
1428 </dd>
1429 <dt class="hdlist1">
1430 grep.column
1431 </dt>
1432 <dd>
1433 <p>
1434         If set to true, enable the <code>--column</code> option by default.
1435 </p>
1436 </dd>
1437 <dt class="hdlist1">
1438 grep.patternType
1439 </dt>
1440 <dd>
1441 <p>
1442         Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
1443         <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
1444         <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
1445         value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
1446         between <em>basic</em> and <em>extended</em>.
1447 </p>
1448 </dd>
1449 <dt class="hdlist1">
1450 grep.extendedRegexp
1451 </dt>
1452 <dd>
1453 <p>
1454         If set to true, enable <code>--extended-regexp</code> option by default. This
1455         option is ignored when the <code>grep.patternType</code> option is set to a value
1456         other than <em>default</em>.
1457 </p>
1458 </dd>
1459 <dt class="hdlist1">
1460 grep.threads
1461 </dt>
1462 <dd>
1463 <p>
1464         Number of grep worker threads to use. If unset (or set to 0), Git will
1465         use as many threads as the number of logical cores available.
1466 </p>
1467 </dd>
1468 <dt class="hdlist1">
1469 grep.fullName
1470 </dt>
1471 <dd>
1472 <p>
1473         If set to true, enable <code>--full-name</code> option by default.
1474 </p>
1475 </dd>
1476 <dt class="hdlist1">
1477 grep.fallbackToNoIndex
1478 </dt>
1479 <dd>
1480 <p>
1481         If set to true, fall back to <code>git grep --no-index</code> if <code>git grep</code>
1482         is executed outside of a git repository.  Defaults to false.
1483 </p>
1484 </dd>
1485 </dl></div>
1486 </div>
1487 </div>
1488 <div class="sect1">
1489 <h2 id="_git">GIT</h2>
1490 <div class="sectionbody">
1491 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1492 </div>
1493 </div>
1494 </div>
1495 <div id="footnotes"><hr /></div>
1496 <div id="footer">
1497 <div id="footer-text">
1498 Last updated
1499  2024-04-03 15:35:56 PDT
1500 </div>
1501 </div>
1502 </body>
1503 </html>