blob: 10734aa2f407bda443359e86759e57523e5901d5 [file] [log] [blame]
Junio C Hamanob9d9d902018-05-23 07:07:421<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:232<!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>
Junio C Hamano9d971152012-12-19 00:43:116<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:217<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano103b5722011-01-31 05:03:458<title>git-grep(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:239<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:1110/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:2325}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:3131a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:2338
39em {
40 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4541 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2342}
43
44strong {
45 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4546 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:2347}
48
Junio C Hamano1a4e8412005-12-27 08:17:2349h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:2351 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:3156h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2357 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2360 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:3162h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:1168h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:2371
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:2373 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano103b5722011-01-31 05:03:4585ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:1188ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:4590
Junio C Hamanoc14e6ad2014-10-31 20:25:5391.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2395 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:5398pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23101
Junio C Hamano9d971152012-12-19 00:43:11102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23106}
Junio C Hamano9d971152012-12-19 00:43:11107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23108}
Junio C Hamano9d971152012-12-19 00:43:11109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23110}
111
Junio C Hamano9d971152012-12-19 00:43:11112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11127#preamble {
Junio C Hamano103b5722011-01-31 05:03:45128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23190}
Junio C Hamano7bd050f2011-09-22 06:32:22191
Junio C Hamano103b5722011-01-31 05:03:45192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23194 text-align: right;
195}
Junio C Hamano103b5722011-01-31 05:03:45196
Junio C Hamano9d971152012-12-19 00:43:11197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23209
210div.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}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23241}
242dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano103b5722011-01-31 05:03:45249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23253 list-style-type: lower-alpha;
254}
Junio C Hamano103b5722011-01-31 05:03:45255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23271
Junio C Hamano1a4e8412005-12-27 08:17:23272tfoot {
273 font-weight: bold;
274}
Junio C Hamano103b5722011-01-31 05:03:45275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano103b5722011-01-31 05:03:45278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano103b5722011-01-31 05:03:45283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31285}
Junio C Hamano103b5722011-01-31 05:03:45286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23290 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23292 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23294}
Junio C Hamano103b5722011-01-31 05:03:45295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23296 vertical-align: top;
297}
Junio C Hamano103b5722011-01-31 05:03:45298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23306
Junio C Hamano7bd050f2011-09-22 06:32:22307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.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
Junio C Hamano9d971152012-12-19 00:43:11334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23341}
Junio C Hamanoba4b9282008-07-06 05:20:31342
Junio C Hamano9d971152012-12-19 00:43:11343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano103b5722011-01-31 05:03:45522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11527body.manpage h2 {
Junio C Hamano103b5722011-01-31 05:03:45528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano103b5722011-01-31 05:03:45532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11535 body.manpage div#toc { display: none; }
Junio C Hamano103b5722011-01-31 05:03:45536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53537
538
Junio C Hamano1a4e8412005-12-27 08:17:23539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31542var 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.
562toc: 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
648footnotes: 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
708install: 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}
Junio C Hamano9d971152012-12-19 00:43:11731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23734</head>
Junio C Hamano9d971152012-12-19 00:43:11735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23736<div id="header">
737<h1>
738git-grep(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-grep -
Junio C Hamano01078922006-03-10 00:31:47743 Print lines matching a pattern
Junio C Hamano1a4e8412005-12-27 08:17:23744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11748<div class="sect1">
Junio C Hamano103b5722011-01-31 05:03:45749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23750<div class="sectionbody">
Junio C Hamano617fdb82006-05-16 02:14:21751<div class="verseblock">
Junio C Hamano238ce9c2013-10-23 21:56:38752<pre class="content"><em>git grep</em> [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
Junio C Hamano97efb002006-09-16 18:16:04753 [-v | --invert-match] [-h|-H] [--full-name]
Junio C Hamano9882a522007-04-27 08:22:22754 [-E | --extended-regexp] [-G | --basic-regexp]
Junio C Hamano084228c2011-05-30 08:13:52755 [-P | --perl-regexp]
Junio C Hamanoea1ac8d2018-07-18 20:16:48756 [-F | --fixed-strings] [-n | --line-number] [--column]
Junio C Hamano9882a522007-04-27 08:22:22757 [-l | --files-with-matches] [-L | --files-without-match]
Junio C Hamano7d449522010-07-01 00:08:51758 [(-O | --open-files-in-pager) [&lt;pager&gt;]]
Junio C Hamanoa476efa2008-10-10 15:31:42759 [-z | --null]
Junio C Hamanof09b7cd2018-08-02 23:01:45760 [ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
Junio C Hamanoabe2c592018-10-19 05:42:53761 [--max-depth &lt;depth&gt;] [--[no-]recursive]
Junio C Hamano4aa0bcc2010-03-03 05:13:12762 [--color[=&lt;when&gt;] | --no-color]
Junio C Hamano0ff98162012-03-31 18:19:09763 [--break] [--heading] [-p | --show-function]
Junio C Hamano617fdb82006-05-16 02:14:21764 [-A &lt;post-context&gt;] [-B &lt;pre-context&gt;] [-C &lt;context&gt;]
Junio C Hamano0ff98162012-03-31 18:19:09765 [-W | --function-context]
Junio C Hamano9766dd32022-07-18 20:40:32766 [(-m | --max-count) &lt;num&gt;]
Junio C Hamanoa7da1ba2016-01-13 00:19:45767 [--threads &lt;num&gt;]
Junio C Hamano9882a522007-04-27 08:22:22768 [-f &lt;file&gt;] [-e] &lt;pattern&gt;
Junio C Hamano636c8b22010-03-07 22:25:17769 [--and|--or|--not|(|)|-e &lt;pattern&gt;&#8230;]
Junio C Hamanodda5d0f2017-01-19 23:33:31770 [--recurse-submodules] [--parent-basename &lt;basename&gt;]
Junio C Hamano3d1b5a12013-05-17 23:34:02771 [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | &lt;tree&gt;&#8230;]
Junio C Hamano9d971152012-12-19 00:43:11772 [--] [&lt;pathspec&gt;&#8230;]</pre>
773<div class="attribution">
Junio C Hamano103b5722011-01-31 05:03:45774</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23775</div>
Junio C Hamano9d971152012-12-19 00:43:11776</div>
777<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31778<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23779<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45780<div class="paragraph"><p>Look for specified patterns in the tracked files in the work tree, blobs
Junio C Hamano0364a712012-05-25 20:02:36781registered in the index file, or blobs in given tree objects. Patterns
782are lists of one or more search expressions separated by newline
783characters. An empty string as search expression matches all lines.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23784</div>
Junio C Hamano9d971152012-12-19 00:43:11785</div>
786<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31787<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23788<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45789<div class="dlist"><dl>
790<dt class="hdlist1">
Junio C Hamano617fdb82006-05-16 02:14:21791--cached
792</dt>
793<dd>
794<p>
Junio C Hamano636c8b22010-03-07 22:25:17795 Instead of searching tracked files in the working tree, search
796 blobs registered in the index file.
797</p>
798</dd>
Junio C Hamano103b5722011-01-31 05:03:45799<dt class="hdlist1">
Junio C Hamano636c8b22010-03-07 22:25:17800--no-index
801</dt>
802<dd>
803<p>
Junio C Hamano076ffcc2013-02-06 05:13:21804 Search files in the current directory that is not managed by Git.
Junio C Hamano5a73f302011-10-14 05:58:34805</p>
806</dd>
807<dt class="hdlist1">
808--untracked
809</dt>
810<dd>
811<p>
812 In addition to searching in the tracked files in the working
813 tree, search also in untracked files.
814</p>
815</dd>
816<dt class="hdlist1">
817--no-exclude-standard
818</dt>
819<dd>
820<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53821 Also search in ignored files by not honoring the <code>.gitignore</code>
822 mechanism. Only useful with <code>--untracked</code>.
Junio C Hamano5a73f302011-10-14 05:58:34823</p>
824</dd>
825<dt class="hdlist1">
826--exclude-standard
827</dt>
828<dd>
829<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53830 Do not pay attention to ignored files specified via the <code>.gitignore</code>
Junio C Hamano5a73f302011-10-14 05:58:34831 mechanism. Only useful when searching files in the current directory
Junio C Hamanoc14e6ad2014-10-31 20:25:53832 with <code>--no-index</code>.
Junio C Hamano617fdb82006-05-16 02:14:21833</p>
834</dd>
Junio C Hamano103b5722011-01-31 05:03:45835<dt class="hdlist1">
Junio C Hamanodda5d0f2017-01-19 23:33:31836--recurse-submodules
837</dt>
838<dd>
839<p>
Junio C Hamano0dd50942020-04-29 21:21:05840 Recursively search in each submodule that is active and
Junio C Hamanodda5d0f2017-01-19 23:33:31841 checked out in the repository. When used in combination with the
842 &lt;tree&gt; option the prefix of all submodule output will be the name of
Junio C Hamanob7e497f2020-02-12 21:41:37843 the parent project&#8217;s &lt;tree&gt; object. This option has no effect
844 if <code>--no-index</code> is given.
Junio C Hamanodda5d0f2017-01-19 23:33:31845</p>
846</dd>
847<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47848-a
849</dt>
Junio C Hamano103b5722011-01-31 05:03:45850<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47851--text
Junio C Hamano617fdb82006-05-16 02:14:21852</dt>
853<dd>
854<p>
855 Process binary files as if they were text.
856</p>
857</dd>
Junio C Hamano103b5722011-01-31 05:03:45858<dt class="hdlist1">
Junio C Hamano238ce9c2013-10-23 21:56:38859--textconv
860</dt>
861<dd>
862<p>
863 Honor textconv filter settings.
864</p>
865</dd>
866<dt class="hdlist1">
867--no-textconv
868</dt>
869<dd>
870<p>
871 Do not honor textconv filter settings.
872 This is the default.
873</p>
874</dd>
875<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47876-i
877</dt>
Junio C Hamano103b5722011-01-31 05:03:45878<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47879--ignore-case
Junio C Hamano617fdb82006-05-16 02:14:21880</dt>
881<dd>
882<p>
883 Ignore case differences between the patterns and the
884 files.
885</p>
886</dd>
Junio C Hamano103b5722011-01-31 05:03:45887<dt class="hdlist1">
Junio C Hamano9882a522007-04-27 08:22:22888-I
889</dt>
890<dd>
891<p>
Junio C Hamano103b5722011-01-31 05:03:45892 Don&#8217;t match the pattern in binary files.
Junio C Hamano9882a522007-04-27 08:22:22893</p>
894</dd>
Junio C Hamano103b5722011-01-31 05:03:45895<dt class="hdlist1">
Junio C Hamano9f883862009-08-11 06:23:52896--max-depth &lt;depth&gt;
897</dt>
898<dd>
899<p>
Junio C Hamano74a198f2010-02-22 00:13:31900 For each &lt;pathspec&gt; given on command line, descend at most &lt;depth&gt;
Junio C Hamanoabe2c592018-10-19 05:42:53901 levels of directories. A value of -1 means no limit.
Junio C Hamanobfeab4e2012-01-19 00:51:27902 This option is ignored if &lt;pathspec&gt; contains active wildcards.
903 In other words if "a*" matches a directory named "a*",
904 "*" is matched literally so --max-depth is still effective.
Junio C Hamano9f883862009-08-11 06:23:52905</p>
906</dd>
Junio C Hamano103b5722011-01-31 05:03:45907<dt class="hdlist1">
Junio C Hamanoabe2c592018-10-19 05:42:53908-r
909</dt>
910<dt class="hdlist1">
911--recursive
912</dt>
913<dd>
914<p>
915 Same as <code>--max-depth=-1</code>; this is the default.
916</p>
917</dd>
918<dt class="hdlist1">
919--no-recursive
920</dt>
921<dd>
922<p>
923 Same as <code>--max-depth=0</code>.
924</p>
925</dd>
926<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47927-w
928</dt>
Junio C Hamano103b5722011-01-31 05:03:45929<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47930--word-regexp
Junio C Hamano617fdb82006-05-16 02:14:21931</dt>
932<dd>
933<p>
934 Match the pattern only at word boundary (either begin at the
935 beginning of a line, or preceded by a non-word character; end at
936 the end of a line or followed by a non-word character).
937</p>
938</dd>
Junio C Hamano103b5722011-01-31 05:03:45939<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47940-v
941</dt>
Junio C Hamano103b5722011-01-31 05:03:45942<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47943--invert-match
Junio C Hamano617fdb82006-05-16 02:14:21944</dt>
945<dd>
946<p>
947 Select non-matching lines.
948</p>
949</dd>
Junio C Hamano103b5722011-01-31 05:03:45950<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47951-h
952</dt>
Junio C Hamano103b5722011-01-31 05:03:45953<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47954-H
Junio C Hamano97efb002006-09-16 18:16:04955</dt>
956<dd>
957<p>
958 By default, the command shows the filename for each
Junio C Hamanoc14e6ad2014-10-31 20:25:53959 match. <code>-h</code> option is used to suppress this output.
960 <code>-H</code> is there for completeness and does not do anything
961 except it overrides <code>-h</code> given earlier on the command
Junio C Hamano97efb002006-09-16 18:16:04962 line.
963</p>
964</dd>
Junio C Hamano103b5722011-01-31 05:03:45965<dt class="hdlist1">
Junio C Hamano85e45fa2006-08-13 07:47:41966--full-name
967</dt>
968<dd>
969<p>
970 When run from a subdirectory, the command usually
971 outputs paths relative to the current directory. This
972 option forces paths to be output relative to the project
973 top directory.
974</p>
975</dd>
Junio C Hamano103b5722011-01-31 05:03:45976<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47977-E
978</dt>
Junio C Hamano103b5722011-01-31 05:03:45979<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47980--extended-regexp
981</dt>
Junio C Hamano103b5722011-01-31 05:03:45982<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47983-G
984</dt>
Junio C Hamano103b5722011-01-31 05:03:45985<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47986--basic-regexp
Junio C Hamano617fdb82006-05-16 02:14:21987</dt>
988<dd>
989<p>
990 Use POSIX extended/basic regexp for patterns. Default
991 is to use basic regexp.
992</p>
993</dd>
Junio C Hamano103b5722011-01-31 05:03:45994<dt class="hdlist1">
Junio C Hamano084228c2011-05-30 08:13:52995-P
996</dt>
997<dt class="hdlist1">
998--perl-regexp
999</dt>
1000<dd>
1001<p>
Junio C Hamano222ed822017-06-02 06:24:061002 Use Perl-compatible regular expressions for patterns.
Junio C Hamano084228c2011-05-30 08:13:521003</p>
Junio C Hamano222ed822017-06-02 06:24:061004<div class="paragraph"><p>Support for these types of regular expressions is an optional
1005compile-time dependency. If Git wasn&#8217;t compiled with support for them
1006providing this option will cause it to die.</p></div>
Junio C Hamano084228c2011-05-30 08:13:521007</dd>
1008<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471009-F
1010</dt>
Junio C Hamano103b5722011-01-31 05:03:451011<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471012--fixed-strings
Junio C Hamano9882a522007-04-27 08:22:221013</dt>
1014<dd>
1015<p>
Junio C Hamano103b5722011-01-31 05:03:451016 Use fixed strings for patterns (don&#8217;t interpret pattern
Junio C Hamano9882a522007-04-27 08:22:221017 as a regex).
1018</p>
1019</dd>
Junio C Hamano103b5722011-01-31 05:03:451020<dt class="hdlist1">
Junio C Hamano617fdb82006-05-16 02:14:211021-n
1022</dt>
Junio C Hamano2906d342011-03-29 02:19:171023<dt class="hdlist1">
1024--line-number
1025</dt>
Junio C Hamano617fdb82006-05-16 02:14:211026<dd>
1027<p>
1028 Prefix the line number to matching lines.
1029</p>
1030</dd>
Junio C Hamano103b5722011-01-31 05:03:451031<dt class="hdlist1">
Junio C Hamanoea1ac8d2018-07-18 20:16:481032--column
1033</dt>
1034<dd>
1035<p>
1036 Prefix the 1-indexed byte-offset of the first match from the start of the
1037 matching line.
1038</p>
1039</dd>
1040<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471041-l
1042</dt>
Junio C Hamano103b5722011-01-31 05:03:451043<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471044--files-with-matches
1045</dt>
Junio C Hamano103b5722011-01-31 05:03:451046<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471047--name-only
1048</dt>
Junio C Hamano103b5722011-01-31 05:03:451049<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471050-L
1051</dt>
Junio C Hamano103b5722011-01-31 05:03:451052<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471053--files-without-match
Junio C Hamano617fdb82006-05-16 02:14:211054</dt>
1055<dd>
1056<p>
1057 Instead of showing every matched line, show only the
1058 names of files that contain (or do not contain) matches.
Junio C Hamanoc14e6ad2014-10-31 20:25:531059 For better compatibility with <em>git diff</em>, <code>--name-only</code> is a
1060 synonym for <code>--files-with-matches</code>.
Junio C Hamano617fdb82006-05-16 02:14:211061</p>
1062</dd>
Junio C Hamano103b5722011-01-31 05:03:451063<dt class="hdlist1">
Junio C Hamano1eb56092015-10-05 20:39:531064-O[&lt;pager&gt;]
Junio C Hamano7d449522010-07-01 00:08:511065</dt>
Junio C Hamano103b5722011-01-31 05:03:451066<dt class="hdlist1">
Junio C Hamano1eb56092015-10-05 20:39:531067--open-files-in-pager[=&lt;pager&gt;]
Junio C Hamano7d449522010-07-01 00:08:511068</dt>
1069<dd>
1070<p>
1071 Open the matching files in the pager (not the output of <em>grep</em>).
1072 If the pager happens to be "less" or "vi", and the user
1073 specified only one pattern, the first file is positioned at
Junio C Hamano1eb56092015-10-05 20:39:531074 the first match automatically. The <code>pager</code> argument is
1075 optional; if specified, it must be stuck to the option
1076 without a space. If <code>pager</code> is unspecified, the default pager
1077 will be used (see <code>core.pager</code> in <a href="git-config.html">git-config(1)</a>).
Junio C Hamano7d449522010-07-01 00:08:511078</p>
1079</dd>
Junio C Hamano103b5722011-01-31 05:03:451080<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:421081-z
1082</dt>
Junio C Hamano103b5722011-01-31 05:03:451083<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:421084--null
1085</dt>
1086<dd>
1087<p>
Junio C Hamano0dd50942020-04-29 21:21:051088 Use \0 as the delimiter for pathnames in the output, and print
1089 them verbatim. Without this option, pathnames with "unusual"
1090 characters are quoted as explained for the configuration
Junio C Hamanocba446b2020-10-09 15:51:151091 variable core.quotePath (see <a href="git-config.html">git-config(1)</a>).
Junio C Hamanoa476efa2008-10-10 15:31:421092</p>
1093</dd>
Junio C Hamano103b5722011-01-31 05:03:451094<dt class="hdlist1">
Junio C Hamanof09b7cd2018-08-02 23:01:451095-o
1096</dt>
1097<dt class="hdlist1">
1098--only-matching
1099</dt>
1100<dd>
1101<p>
1102 Print only the matched (non-empty) parts of a matching line, with each such
1103 part on a separate output line.
1104</p>
1105</dd>
1106<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471107-c
1108</dt>
Junio C Hamano103b5722011-01-31 05:03:451109<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471110--count
Junio C Hamano617fdb82006-05-16 02:14:211111</dt>
1112<dd>
1113<p>
1114 Instead of showing every matched line, show the number of
1115 lines that match.
1116</p>
1117</dd>
Junio C Hamano103b5722011-01-31 05:03:451118<dt class="hdlist1">
Junio C Hamano4aa0bcc2010-03-03 05:13:121119--color[=&lt;when&gt;]
Junio C Hamanod257cff2009-03-18 05:27:161120</dt>
1121<dd>
1122<p>
1123 Show colored matches.
Junio C Hamano4aa0bcc2010-03-03 05:13:121124 The value must be always (the default), never, or auto.
Junio C Hamanod257cff2009-03-18 05:27:161125</p>
1126</dd>
Junio C Hamano103b5722011-01-31 05:03:451127<dt class="hdlist1">
Junio C Hamanod257cff2009-03-18 05:27:161128--no-color
1129</dt>
1130<dd>
1131<p>
1132 Turn off match highlighting, even when the configuration file
1133 gives the default to color output.
Junio C Hamanoc14e6ad2014-10-31 20:25:531134 Same as <code>--color=never</code>.
Junio C Hamanod257cff2009-03-18 05:27:161135</p>
1136</dd>
Junio C Hamano103b5722011-01-31 05:03:451137<dt class="hdlist1">
Junio C Hamano4c4b0122011-06-30 01:19:321138--break
1139</dt>
1140<dd>
1141<p>
1142 Print an empty line between matches from different files.
1143</p>
1144</dd>
1145<dt class="hdlist1">
1146--heading
1147</dt>
1148<dd>
1149<p>
1150 Show the filename above the matches in that file instead of
1151 at the start of each shown line.
1152</p>
1153</dd>
1154<dt class="hdlist1">
Junio C Hamano48bc1ce2009-07-09 16:49:191155-p
1156</dt>
Junio C Hamano103b5722011-01-31 05:03:451157<dt class="hdlist1">
Junio C Hamano48bc1ce2009-07-09 16:49:191158--show-function
1159</dt>
1160<dd>
1161<p>
1162 Show the preceding line that contains the function name of
1163 the match, unless the matching line is a function name itself.
Junio C Hamanob7676d52020-11-18 22:15:081164 The name is determined in the same way as <code>git diff</code> works out
Junio C Hamano48bc1ce2009-07-09 16:49:191165 patch hunk headers (see <em>Defining a custom hunk-header</em> in
Junio C Hamanoa28a9202012-06-21 07:08:231166 <a href="gitattributes.html">gitattributes(5)</a>).
Junio C Hamano48bc1ce2009-07-09 16:49:191167</p>
1168</dd>
Junio C Hamano103b5722011-01-31 05:03:451169<dt class="hdlist1">
Junio C Hamano9775d402011-08-11 22:27:201170-&lt;num&gt;
1171</dt>
1172<dt class="hdlist1">
1173-C &lt;num&gt;
1174</dt>
1175<dt class="hdlist1">
1176--context &lt;num&gt;
1177</dt>
1178<dd>
1179<p>
1180 Show &lt;num&gt; leading and trailing lines, and place a line
Junio C Hamanoc14e6ad2014-10-31 20:25:531181 containing <code>--</code> between contiguous groups of matches.
Junio C Hamano9775d402011-08-11 22:27:201182</p>
1183</dd>
1184<dt class="hdlist1">
1185-A &lt;num&gt;
1186</dt>
1187<dt class="hdlist1">
1188--after-context &lt;num&gt;
1189</dt>
1190<dd>
1191<p>
1192 Show &lt;num&gt; trailing lines, and place a line containing
Junio C Hamanoc14e6ad2014-10-31 20:25:531193 <code>--</code> between contiguous groups of matches.
Junio C Hamano9775d402011-08-11 22:27:201194</p>
1195</dd>
1196<dt class="hdlist1">
1197-B &lt;num&gt;
1198</dt>
1199<dt class="hdlist1">
1200--before-context &lt;num&gt;
1201</dt>
1202<dd>
1203<p>
1204 Show &lt;num&gt; leading lines, and place a line containing
Junio C Hamanoc14e6ad2014-10-31 20:25:531205 <code>--</code> between contiguous groups of matches.
Junio C Hamano9775d402011-08-11 22:27:201206</p>
1207</dd>
1208<dt class="hdlist1">
1209-W
1210</dt>
1211<dt class="hdlist1">
1212--function-context
1213</dt>
1214<dd>
1215<p>
1216 Show the surrounding text from the previous line containing a
1217 function name up to the one before the next function name,
1218 effectively showing the whole function in which the match was
Junio C Hamanob7676d52020-11-18 22:15:081219 found. The function names are determined in the same way as
1220 <code>git diff</code> works out patch hunk headers (see <em>Defining a
1221 custom hunk-header</em> in <a href="gitattributes.html">gitattributes(5)</a>).
Junio C Hamano9775d402011-08-11 22:27:201222</p>
1223</dd>
1224<dt class="hdlist1">
Junio C Hamano9766dd32022-07-18 20:40:321225-m &lt;num&gt;
1226</dt>
1227<dt class="hdlist1">
1228--max-count &lt;num&gt;
1229</dt>
1230<dd>
1231<p>
1232 Limit the amount of matches per file. When using the <code>-v</code> or
1233 <code>--invert-match</code> option, the search stops after the specified
1234 number of non-matches. A value of -1 will return unlimited
1235 results (the default). A value of 0 will exit immediately with
1236 a non-zero status.
1237</p>
1238</dd>
1239<dt class="hdlist1">
Junio C Hamanoa7da1ba2016-01-13 00:19:451240--threads &lt;num&gt;
1241</dt>
1242<dd>
1243<p>
1244 Number of grep worker threads to use.
1245 See <code>grep.threads</code> in <em>CONFIGURATION</em> for more information.
1246</p>
1247</dd>
1248<dt class="hdlist1">
Junio C Hamano617fdb82006-05-16 02:14:211249-f &lt;file&gt;
1250</dt>
1251<dd>
1252<p>
1253 Read patterns from &lt;file&gt;, one per line.
1254</p>
Junio C Hamano6c6b0e52019-10-11 07:28:251255<div class="paragraph"><p>Passing the pattern via &lt;file&gt; allows for providing a search pattern
1256containing a \0.</p></div>
1257<div class="paragraph"><p>Not all pattern types support patterns containing \0. Git will error
1258out if a given pattern type can&#8217;t support such a pattern. The
1259<code>--perl-regexp</code> pattern type when compiled against the PCRE v2 backend
1260has the widest support for these types of patterns.</p></div>
1261<div class="paragraph"><p>In versions of Git before 2.23.0 patterns containing \0 would be
1262silently considered fixed. This was never documented, there were also
1263odd and undocumented interactions between e.g. non-ASCII patterns
1264containing \0 and <code>--ignore-case</code>.</p></div>
1265<div class="paragraph"><p>In future versions we may learn to support patterns containing \0 for
1266more search backends, until then we&#8217;ll die when the pattern type in
1267question doesn&#8217;t support them.</p></div>
Junio C Hamano617fdb82006-05-16 02:14:211268</dd>
Junio C Hamano103b5722011-01-31 05:03:451269<dt class="hdlist1">
Junio C Hamano3901ffb2006-06-26 23:46:531270-e
1271</dt>
1272<dd>
1273<p>
1274 The next parameter is the pattern. This option has to be
Junio C Hamanoc14e6ad2014-10-31 20:25:531275 used for patterns starting with <code>-</code> and should be used in
Junio C Hamano00442022006-08-03 00:29:361276 scripts passing user input to grep. Multiple patterns are
1277 combined by <em>or</em>.
1278</p>
1279</dd>
Junio C Hamano103b5722011-01-31 05:03:451280<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471281--and
1282</dt>
Junio C Hamano103b5722011-01-31 05:03:451283<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471284--or
1285</dt>
Junio C Hamano103b5722011-01-31 05:03:451286<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471287--not
1288</dt>
Junio C Hamano103b5722011-01-31 05:03:451289<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471290( &#8230; )
Junio C Hamano00442022006-08-03 00:29:361291</dt>
1292<dd>
1293<p>
Junio C Hamanof9771f62007-01-17 17:42:301294 Specify how multiple patterns are combined using Boolean
Junio C Hamanoc14e6ad2014-10-31 20:25:531295 expressions. <code>--or</code> is the default operator. <code>--and</code> has
1296 higher precedence than <code>--or</code>. <code>-e</code> has to be used for all
Junio C Hamano00442022006-08-03 00:29:361297 patterns.
Junio C Hamano3901ffb2006-06-26 23:46:531298</p>
1299</dd>
Junio C Hamano103b5722011-01-31 05:03:451300<dt class="hdlist1">
Junio C Hamanofbe00522006-10-19 05:58:481301--all-match
1302</dt>
1303<dd>
1304<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531305 When giving multiple pattern expressions combined with <code>--or</code>,
Junio C Hamanofbe00522006-10-19 05:58:481306 this flag is specified to limit the match to files that
1307 have lines to match all of them.
1308</p>
1309</dd>
Junio C Hamano103b5722011-01-31 05:03:451310<dt class="hdlist1">
Junio C Hamano83b35472010-01-29 05:02:131311-q
1312</dt>
Junio C Hamano103b5722011-01-31 05:03:451313<dt class="hdlist1">
Junio C Hamano83b35472010-01-29 05:02:131314--quiet
1315</dt>
1316<dd>
1317<p>
1318 Do not output matched lines; instead, exit with status 0 when
Junio C Hamano103b5722011-01-31 05:03:451319 there is a match and with non-zero status when there isn&#8217;t.
Junio C Hamano83b35472010-01-29 05:02:131320</p>
1321</dd>
Junio C Hamano103b5722011-01-31 05:03:451322<dt class="hdlist1">
Junio C Hamano636c8b22010-03-07 22:25:171323&lt;tree&gt;&#8230;
Junio C Hamano617fdb82006-05-16 02:14:211324</dt>
1325<dd>
1326<p>
Junio C Hamano636c8b22010-03-07 22:25:171327 Instead of searching tracked files in the working tree, search
1328 blobs in the given trees.
Junio C Hamano617fdb82006-05-16 02:14:211329</p>
1330</dd>
Junio C Hamano103b5722011-01-31 05:03:451331<dt class="hdlist1">
Junio C Hamano00442022006-08-03 00:29:361332--
Junio C Hamanoa6331a82006-01-22 07:50:331333</dt>
1334<dd>
1335<p>
1336 Signals the end of options; the rest of the parameters
Junio C Hamano74a198f2010-02-22 00:13:311337 are &lt;pathspec&gt; limiters.
1338</p>
1339</dd>
Junio C Hamano103b5722011-01-31 05:03:451340<dt class="hdlist1">
Junio C Hamano74a198f2010-02-22 00:13:311341&lt;pathspec&gt;&#8230;
1342</dt>
1343<dd>
1344<p>
1345 If given, limit the search to paths matching at least one pattern.
1346 Both leading paths match and glob(7) patterns are supported.
Junio C Hamanoa6331a82006-01-22 07:50:331347</p>
Junio C Hamano139b7d12017-10-03 07:10:591348<div class="paragraph"><p>For more details about the &lt;pathspec&gt; syntax, see the <em>pathspec</em> entry
1349in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
Junio C Hamanoa6331a82006-01-22 07:50:331350</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311351</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:231352</div>
Junio C Hamano9d971152012-12-19 00:43:111353</div>
1354<div class="sect1">
Junio C Hamanob9d9d902018-05-23 07:07:421355<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano00442022006-08-03 00:29:361356<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:451357<div class="dlist"><dl>
1358<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531359<code>git grep 'time_t' -- '*.[ch]'</code>
Junio C Hamano74a198f2010-02-22 00:13:311360</dt>
1361<dd>
1362<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531363 Looks for <code>time_t</code> in all tracked .c and .h files in the working
Junio C Hamano74a198f2010-02-22 00:13:311364 directory and its subdirectories.
1365</p>
1366</dd>
Junio C Hamano103b5722011-01-31 05:03:451367<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531368<code>git grep -e '#define' --and \( -e MAX_PATH -e PATH_MAX \)</code>
Junio C Hamano00442022006-08-03 00:29:361369</dt>
1370<dd>
1371<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531372 Looks for a line that has <code>#define</code> and either <code>MAX_PATH</code> or
1373 <code>PATH_MAX</code>.
Junio C Hamano00442022006-08-03 00:29:361374</p>
1375</dd>
Junio C Hamano103b5722011-01-31 05:03:451376<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531377<code>git grep --all-match -e NODE -e Unexpected</code>
Junio C Hamanofbe00522006-10-19 05:58:481378</dt>
1379<dd>
1380<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531381 Looks for a line that has <code>NODE</code> or <code>Unexpected</code> in
Junio C Hamanofbe00522006-10-19 05:58:481382 files that have lines that match both.
1383</p>
1384</dd>
Junio C Hamano139b7d12017-10-03 07:10:591385<dt class="hdlist1">
1386<code>git grep solution -- :^Documentation</code>
1387</dt>
1388<dd>
1389<p>
1390 Looks for <code>solution</code>, excluding files in <code>Documentation</code>.
1391</p>
1392</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311393</dl></div>
Junio C Hamano00442022006-08-03 00:29:361394</div>
Junio C Hamano9d971152012-12-19 00:43:111395</div>
1396<div class="sect1">
Junio C Hamanofc6646b2020-02-14 23:35:161397<h2 id="_notes_on_threads">NOTES ON THREADS</h2>
1398<div class="sectionbody">
1399<div class="paragraph"><p>The <code>--threads</code> option (and the grep.threads configuration) will be ignored when
1400<code>--open-files-in-pager</code> is used, forcing a single-threaded execution.</p></div>
1401<div class="paragraph"><p>When grepping the object store (with <code>--cached</code> or giving tree objects), running
1402with multiple threads might perform slower than single threaded if <code>--textconv</code>
1403is given and there&#8217;re too many text conversions. So if you experience low
1404performance in this case, it might be desirable to use <code>--threads=1</code>.</p></div>
1405</div>
1406</div>
1407<div class="sect1">
Junio C Hamanobe601db2021-05-07 04:20:281408<h2 id="_configuration">CONFIGURATION</h2>
1409<div class="sectionbody">
Junio C Hamanoba8baee2022-09-14 20:25:231410<div class="paragraph"><p>Everything below this line in this section is selectively included
1411from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1412as what&#8217;s found there:</p></div>
Junio C Hamanobe601db2021-05-07 04:20:281413<div class="dlist"><dl>
1414<dt class="hdlist1">
1415grep.lineNumber
1416</dt>
1417<dd>
1418<p>
1419 If set to true, enable <code>-n</code> option by default.
1420</p>
1421</dd>
1422<dt class="hdlist1">
1423grep.column
1424</dt>
1425<dd>
1426<p>
1427 If set to true, enable the <code>--column</code> option by default.
1428</p>
1429</dd>
1430<dt class="hdlist1">
1431grep.patternType
1432</dt>
1433<dd>
1434<p>
1435 Set the default matching behavior. Using a value of <em>basic</em>, <em>extended</em>,
1436 <em>fixed</em>, or <em>perl</em> will enable the <code>--basic-regexp</code>, <code>--extended-regexp</code>,
1437 <code>--fixed-strings</code>, or <code>--perl-regexp</code> option accordingly, while the
Junio C Hamanoba8baee2022-09-14 20:25:231438 value <em>default</em> will use the <code>grep.extendedRegexp</code> option to choose
1439 between <em>basic</em> and <em>extended</em>.
Junio C Hamanobe601db2021-05-07 04:20:281440</p>
1441</dd>
1442<dt class="hdlist1">
1443grep.extendedRegexp
1444</dt>
1445<dd>
1446<p>
1447 If set to true, enable <code>--extended-regexp</code> option by default. This
1448 option is ignored when the <code>grep.patternType</code> option is set to a value
1449 other than <em>default</em>.
1450</p>
1451</dd>
1452<dt class="hdlist1">
1453grep.threads
1454</dt>
1455<dd>
1456<p>
1457 Number of grep worker threads to use. If unset (or set to 0), Git will
1458 use as many threads as the number of logical cores available.
1459</p>
1460</dd>
1461<dt class="hdlist1">
1462grep.fullName
1463</dt>
1464<dd>
1465<p>
1466 If set to true, enable <code>--full-name</code> option by default.
1467</p>
1468</dd>
1469<dt class="hdlist1">
1470grep.fallbackToNoIndex
1471</dt>
1472<dd>
1473<p>
1474 If set to true, fall back to git grep --no-index if git grep
1475 is executed outside of a git repository. Defaults to false.
1476</p>
1477</dd>
1478</dl></div>
1479</div>
1480</div>
1481<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311482<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:231483<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:231484<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:231485</div>
Junio C Hamano7bd050f2011-09-22 06:32:221486</div>
Junio C Hamano9d971152012-12-19 00:43:111487</div>
Junio C Hamano7bd050f2011-09-22 06:32:221488<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:231489<div id="footer">
1490<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:531491Last updated
Junio C Hamanoe6dbd552023-05-19 20:40:501492 2022-09-15 05:23:11 JST
Junio C Hamano1a4e8412005-12-27 08:17:231493</div>
1494</div>
1495</body>
1496</html>