man1/git-grep.1

   1 '\" t
   2 .\"     Title: git-grep
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.603.g94b60adee3
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-GREP" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-grep \- Print lines matching a pattern
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit grep\fR [\-a | \-\-text] [\-I] [\-\-textconv] [\-i | \-\-ignore\-case] [\-w | \-\-word\-regexp]
  36            [\-v | \-\-invert\-match] [\-h|\-H] [\-\-full\-name]
  37            [\-E | \-\-extended\-regexp] [\-G | \-\-basic\-regexp]
  38            [\-P | \-\-perl\-regexp]
  39            [\-F | \-\-fixed\-strings] [\-n | \-\-line\-number] [\-\-column]
  40            [\-l | \-\-files\-with\-matches] [\-L | \-\-files\-without\-match]
  41            [(\-O | \-\-open\-files\-in\-pager) [<pager>]]
  42            [\-z | \-\-null]
  43            [ \-o | \-\-only\-matching ] [\-c | \-\-count] [\-\-all\-match] [\-q | \-\-quiet]
  44            [\-\-max\-depth <depth>] [\-\-[no\-]recursive]
  45            [\-\-color[=<when>] | \-\-no\-color]
  46            [\-\-break] [\-\-heading] [\-p | \-\-show\-function]
  47            [\-A <post\-context>] [\-B <pre\-context>] [\-C <context>]
  48            [\-W | \-\-function\-context]
  49            [(\-m | \-\-max\-count) <num>]
  50            [\-\-threads <num>]
  51            [\-f <file>] [\-e] <pattern>
  52            [\-\-and|\-\-or|\-\-not|(|)|\-e <pattern>\&...\:]
  53            [\-\-recurse\-submodules] [\-\-parent\-basename <basename>]
  54            [ [\-\-[no\-]exclude\-standard] [\-\-cached | \-\-untracked | \-\-no\-index] | <tree>\&...\:]
  55            [\-\-] [<pathspec>\&...\:]
  56 .fi
  57 .SH "DESCRIPTION"
  58 .sp
  59 Look for specified patterns in the tracked files in the work tree, blobs registered in the index file, or blobs in given tree objects\&. Patterns are lists of one or more search expressions separated by newline characters\&. An empty string as search expression matches all lines\&.
  60 .SH "OPTIONS"
  61 .PP
  62 \-\-cached
  63 .RS 4
  64 Instead of searching tracked files in the working tree, search blobs registered in the index file\&.
  65 .RE
  66 .PP
  67 \-\-untracked
  68 .RS 4
  69 In addition to searching in the tracked files in the working tree, search also in untracked files\&.
  70 .RE
  71 .PP
  72 \-\-no\-index
  73 .RS 4
  74 Search files in the current directory that is not managed by Git, or by ignoring that the current directory is managed by Git\&. This is rather similar to running the regular
  75 \fBgrep(1)\fR
  76 utility with its
  77 \fB\-r\fR
  78 option specified, but with some additional benefits, such as using pathspec patterns to limit paths; see the
  79 \fIpathspec\fR
  80 entry in
  81 \fBgitglossary\fR(7)
  82 for more information\&.
  83 .sp
  84 This option cannot be used together with
  85 \fB\-\-cached\fR
  86 or
  87 \fB\-\-untracked\fR\&. See also
  88 \fBgrep\&.fallbackToNoIndex\fR
  89 in
  90 \fICONFIGURATION\fR
  91 below\&.
  92 .RE
  93 .PP
  94 \-\-no\-exclude\-standard
  95 .RS 4
  96 Also search in ignored files by not honoring the
  97 \fB\&.gitignore\fR
  98 mechanism\&. Only useful with
  99 \fB\-\-untracked\fR\&.
 100 .RE
 101 .PP
 102 \-\-exclude\-standard
 103 .RS 4
 104 Do not pay attention to ignored files specified via the
 105 \fB\&.gitignore\fR
 106 mechanism\&. Only useful when searching files in the current directory with
 107 \fB\-\-no\-index\fR\&.
 108 .RE
 109 .PP
 110 \-\-recurse\-submodules
 111 .RS 4
 112 Recursively search in each submodule that is active and checked out in the repository\&. When used in combination with the
 113 \fI<tree>\fR
 114 option the prefix of all submodule output will be the name of the parent project\(cqs
 115 \fI<tree>\fR
 116 object\&. This option cannot be used together with
 117 \fB\-\-untracked\fR, and it has no effect if
 118 \fB\-\-no\-index\fR
 119 is specified\&.
 120 .RE
 121 .PP
 122 \-a, \-\-text
 123 .RS 4
 124 Process binary files as if they were text\&.
 125 .RE
 126 .PP
 127 \-\-textconv
 128 .RS 4
 129 Honor textconv filter settings\&.
 130 .RE
 131 .PP
 132 \-\-no\-textconv
 133 .RS 4
 134 Do not honor textconv filter settings\&. This is the default\&.
 135 .RE
 136 .PP
 137 \-i, \-\-ignore\-case
 138 .RS 4
 139 Ignore case differences between the patterns and the files\&.
 140 .RE
 141 .PP
 142 \-I
 143 .RS 4
 144 Don\(cqt match the pattern in binary files\&.
 145 .RE
 146 .PP
 147 \-\-max\-depth <depth>
 148 .RS 4
 149 For each <pathspec> given on command line, descend at most <depth> levels of directories\&. A value of \-1 means no limit\&. This option is ignored if <pathspec> contains active wildcards\&. In other words if "a*" matches a directory named "a*", "*" is matched literally so \-\-max\-depth is still effective\&.
 150 .RE
 151 .PP
 152 \-r, \-\-recursive
 153 .RS 4
 154 Same as
 155 \fB\-\-max\-depth=\-1\fR; this is the default\&.
 156 .RE
 157 .PP
 158 \-\-no\-recursive
 159 .RS 4
 160 Same as
 161 \fB\-\-max\-depth=0\fR\&.
 162 .RE
 163 .PP
 164 \-w, \-\-word\-regexp
 165 .RS 4
 166 Match the pattern only at word boundary (either begin at the beginning of a line, or preceded by a non\-word character; end at the end of a line or followed by a non\-word character)\&.
 167 .RE
 168 .PP
 169 \-v, \-\-invert\-match
 170 .RS 4
 171 Select non\-matching lines\&.
 172 .RE
 173 .PP
 174 \-h, \-H
 175 .RS 4
 176 By default, the command shows the filename for each match\&.
 177 \fB\-h\fR
 178 option is used to suppress this output\&.
 179 \fB\-H\fR
 180 is there for completeness and does not do anything except it overrides
 181 \fB\-h\fR
 182 given earlier on the command line\&.
 183 .RE
 184 .PP
 185 \-\-full\-name
 186 .RS 4
 187 When run from a subdirectory, the command usually outputs paths relative to the current directory\&. This option forces paths to be output relative to the project top directory\&.
 188 .RE
 189 .PP
 190 \-E, \-\-extended\-regexp, \-G, \-\-basic\-regexp
 191 .RS 4
 192 Use POSIX extended/basic regexp for patterns\&. Default is to use basic regexp\&.
 193 .RE
 194 .PP
 195 \-P, \-\-perl\-regexp
 196 .RS 4
 197 Use Perl\-compatible regular expressions for patterns\&.
 198 .sp
 199 Support for these types of regular expressions is an optional compile\-time dependency\&. If Git wasn\(cqt compiled with support for them providing this option will cause it to die\&.
 200 .RE
 201 .PP
 202 \-F, \-\-fixed\-strings
 203 .RS 4
 204 Use fixed strings for patterns (don\(cqt interpret pattern as a regex)\&.
 205 .RE
 206 .PP
 207 \-n, \-\-line\-number
 208 .RS 4
 209 Prefix the line number to matching lines\&.
 210 .RE
 211 .PP
 212 \-\-column
 213 .RS 4
 214 Prefix the 1\-indexed byte\-offset of the first match from the start of the matching line\&.
 215 .RE
 216 .PP
 217 \-l, \-\-files\-with\-matches, \-\-name\-only, \-L, \-\-files\-without\-match
 218 .RS 4
 219 Instead of showing every matched line, show only the names of files that contain (or do not contain) matches\&. For better compatibility with
 220 \fIgit diff\fR,
 221 \fB\-\-name\-only\fR
 222 is a synonym for
 223 \fB\-\-files\-with\-matches\fR\&.
 224 .RE
 225 .PP
 226 \-O[<pager>], \-\-open\-files\-in\-pager[=<pager>]
 227 .RS 4
 228 Open the matching files in the pager (not the output of
 229 \fIgrep\fR)\&. If the pager happens to be "less" or "vi", and the user specified only one pattern, the first file is positioned at the first match automatically\&. The
 230 \fBpager\fR
 231 argument is optional; if specified, it must be stuck to the option without a space\&. If
 232 \fBpager\fR
 233 is unspecified, the default pager will be used (see
 234 \fBcore\&.pager\fR
 235 in
 236 \fBgit-config\fR(1))\&.
 237 .RE
 238 .PP
 239 \-z, \-\-null
 240 .RS 4
 241 Use \e0 as the delimiter for pathnames in the output, and print them verbatim\&. Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
 242 \fBcore\&.quotePath\fR
 243 (see
 244 \fBgit-config\fR(1))\&.
 245 .RE
 246 .PP
 247 \-o, \-\-only\-matching
 248 .RS 4
 249 Print only the matched (non\-empty) parts of a matching line, with each such part on a separate output line\&.
 250 .RE
 251 .PP
 252 \-c, \-\-count
 253 .RS 4
 254 Instead of showing every matched line, show the number of lines that match\&.
 255 .RE
 256 .PP
 257 \-\-color[=<when>]
 258 .RS 4
 259 Show colored matches\&. The value must be always (the default), never, or auto\&.
 260 .RE
 261 .PP
 262 \-\-no\-color
 263 .RS 4
 264 Turn off match highlighting, even when the configuration file gives the default to color output\&. Same as
 265 \fB\-\-color=never\fR\&.
 266 .RE
 267 .PP
 268 \-\-break
 269 .RS 4
 270 Print an empty line between matches from different files\&.
 271 .RE
 272 .PP
 273 \-\-heading
 274 .RS 4
 275 Show the filename above the matches in that file instead of at the start of each shown line\&.
 276 .RE
 277 .PP
 278 \-p, \-\-show\-function
 279 .RS 4
 280 Show the preceding line that contains the function name of the match, unless the matching line is a function name itself\&. The name is determined in the same way as
 281 \fBgit diff\fR
 282 works out patch hunk headers (see
 283 \fIDefining a custom hunk\-header\fR
 284 in
 285 \fBgitattributes\fR(5))\&.
 286 .RE
 287 .PP
 288 \-<num>, \-C <num>, \-\-context <num>
 289 .RS 4
 290 Show <num> leading and trailing lines, and place a line containing
 291 \fB\-\-\fR
 292 between contiguous groups of matches\&.
 293 .RE
 294 .PP
 295 \-A <num>, \-\-after\-context <num>
 296 .RS 4
 297 Show <num> trailing lines, and place a line containing
 298 \fB\-\-\fR
 299 between contiguous groups of matches\&.
 300 .RE
 301 .PP
 302 \-B <num>, \-\-before\-context <num>
 303 .RS 4
 304 Show <num> leading lines, and place a line containing
 305 \fB\-\-\fR
 306 between contiguous groups of matches\&.
 307 .RE
 308 .PP
 309 \-W, \-\-function\-context
 310 .RS 4
 311 Show the surrounding text from the previous line containing a function name up to the one before the next function name, effectively showing the whole function in which the match was found\&. The function names are determined in the same way as
 312 \fBgit diff\fR
 313 works out patch hunk headers (see
 314 \fIDefining a custom hunk\-header\fR
 315 in
 316 \fBgitattributes\fR(5))\&.
 317 .RE
 318 .PP
 319 \-m <num>, \-\-max\-count <num>
 320 .RS 4
 321 Limit the amount of matches per file\&. When using the
 322 \fB\-v\fR
 323 or
 324 \fB\-\-invert\-match\fR
 325 option, the search stops after the specified number of non\-matches\&. A value of \-1 will return unlimited results (the default)\&. A value of 0 will exit immediately with a non\-zero status\&.
 326 .RE
 327 .PP
 328 \-\-threads <num>
 329 .RS 4
 330 Number of
 331 \fBgrep\fR
 332 worker threads to use\&. See
 333 \fINOTES ON THREADS\fR
 334 and
 335 \fBgrep\&.threads\fR
 336 in
 337 \fICONFIGURATION\fR
 338 for more information\&.
 339 .RE
 340 .PP
 341 \-f <file>
 342 .RS 4
 343 Read patterns from <file>, one per line\&.
 344 .sp
 345 Passing the pattern via <file> allows for providing a search pattern containing a \e0\&.
 346 .sp
 347 Not all pattern types support patterns containing \e0\&. Git will error out if a given pattern type can\(cqt support such a pattern\&. The
 348 \fB\-\-perl\-regexp\fR
 349 pattern type when compiled against the PCRE v2 backend has the widest support for these types of patterns\&.
 350 .sp
 351 In versions of Git before 2\&.23\&.0 patterns containing \e0 would be silently considered fixed\&. This was never documented, there were also odd and undocumented interactions between e\&.g\&. non\-ASCII patterns containing \e0 and
 352 \fB\-\-ignore\-case\fR\&.
 353 .sp
 354 In future versions we may learn to support patterns containing \e0 for more search backends, until then we\(cqll die when the pattern type in question doesn\(cqt support them\&.
 355 .RE
 356 .PP
 357 \-e
 358 .RS 4
 359 The next parameter is the pattern\&. This option has to be used for patterns starting with
 360 \fB\-\fR
 361 and should be used in scripts passing user input to grep\&. Multiple patterns are combined by
 362 \fIor\fR\&.
 363 .RE
 364 .PP
 365 \-\-and, \-\-or, \-\-not, ( \&...\: )
 366 .RS 4
 367 Specify how multiple patterns are combined using Boolean expressions\&.
 368 \fB\-\-or\fR
 369 is the default operator\&.
 370 \fB\-\-and\fR
 371 has higher precedence than
 372 \fB\-\-or\fR\&.
 373 \fB\-e\fR
 374 has to be used for all patterns\&.
 375 .RE
 376 .PP
 377 \-\-all\-match
 378 .RS 4
 379 When giving multiple pattern expressions combined with
 380 \fB\-\-or\fR, this flag is specified to limit the match to files that have lines to match all of them\&.
 381 .RE
 382 .PP
 383 \-q, \-\-quiet
 384 .RS 4
 385 Do not output matched lines; instead, exit with status 0 when there is a match and with non\-zero status when there isn\(cqt\&.
 386 .RE
 387 .PP
 388 <tree>\&...\:
 389 .RS 4
 390 Instead of searching tracked files in the working tree, search blobs in the given trees\&.
 391 .RE
 392 .PP
 393 \-\-
 394 .RS 4
 395 Signals the end of options; the rest of the parameters are <pathspec> limiters\&.
 396 .RE
 397 .PP
 398 <pathspec>\&...\:
 399 .RS 4
 400 If given, limit the search to paths matching at least one pattern\&. Both leading paths match and glob(7) patterns are supported\&.
 401 .sp
 402 For more details about the <pathspec> syntax, see the
 403 \fIpathspec\fR
 404 entry in
 405 \fBgitglossary\fR(7)\&.
 406 .RE
 407 .SH "EXAMPLES"
 408 .PP
 409 \fBgit grep \*(Aqtime_t\*(Aq \-\- \*(Aq*\&.[ch]\*(Aq\fR
 410 .RS 4
 411 Looks for
 412 \fBtime_t\fR
 413 in all tracked \&.c and \&.h files in the working directory and its subdirectories\&.
 414 .RE
 415 .PP
 416 \fBgit grep \-e \*(Aq#define\*(Aq \-\-and \e( \-e MAX_PATH \-e PATH_MAX \e)\fR
 417 .RS 4
 418 Looks for a line that has
 419 \fB#define\fR
 420 and either
 421 \fBMAX_PATH\fR
 422 or
 423 \fBPATH_MAX\fR\&.
 424 .RE
 425 .PP
 426 \fBgit grep \-\-all\-match \-e NODE \-e Unexpected\fR
 427 .RS 4
 428 Looks for a line that has
 429 \fBNODE\fR
 430 or
 431 \fBUnexpected\fR
 432 in files that have lines that match both\&.
 433 .RE
 434 .PP
 435 \fBgit grep solution \-\- :^Documentation\fR
 436 .RS 4
 437 Looks for
 438 \fBsolution\fR, excluding files in
 439 \fBDocumentation\fR\&.
 440 .RE
 441 .SH "NOTES ON THREADS"
 442 .sp
 443 The \fB\-\-threads\fR option (and the \fBgrep\&.threads\fR configuration) will be ignored when \fB\-\-open\-files\-in\-pager\fR is used, forcing a single\-threaded execution\&.
 444 .sp
 445 When grepping the object store (with \fB\-\-cached\fR or giving tree objects), running with multiple threads might perform slower than single\-threaded if \fB\-\-textconv\fR is given and there are too many text conversions\&. Thus, if low performance is experienced in this case, it might be desirable to use \fB\-\-threads=1\fR\&.
 446 .SH "CONFIGURATION"
 447 .sp
 448 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
 449 .PP
 450 grep\&.lineNumber
 451 .RS 4
 452 If set to true, enable
 453 \fB\-n\fR
 454 option by default\&.
 455 .RE
 456 .PP
 457 grep\&.column
 458 .RS 4
 459 If set to true, enable the
 460 \fB\-\-column\fR
 461 option by default\&.
 462 .RE
 463 .PP
 464 grep\&.patternType
 465 .RS 4
 466 Set the default matching behavior\&. Using a value of
 467 \fIbasic\fR,
 468 \fIextended\fR,
 469 \fIfixed\fR, or
 470 \fIperl\fR
 471 will enable the
 472 \fB\-\-basic\-regexp\fR,
 473 \fB\-\-extended\-regexp\fR,
 474 \fB\-\-fixed\-strings\fR, or
 475 \fB\-\-perl\-regexp\fR
 476 option accordingly, while the value
 477 \fIdefault\fR
 478 will use the
 479 \fBgrep\&.extendedRegexp\fR
 480 option to choose between
 481 \fIbasic\fR
 482 and
 483 \fIextended\fR\&.
 484 .RE
 485 .PP
 486 grep\&.extendedRegexp
 487 .RS 4
 488 If set to true, enable
 489 \fB\-\-extended\-regexp\fR
 490 option by default\&. This option is ignored when the
 491 \fBgrep\&.patternType\fR
 492 option is set to a value other than
 493 \fIdefault\fR\&.
 494 .RE
 495 .PP
 496 grep\&.threads
 497 .RS 4
 498 Number of grep worker threads to use\&. If unset (or set to 0), Git will use as many threads as the number of logical cores available\&.
 499 .RE
 500 .PP
 501 grep\&.fullName
 502 .RS 4
 503 If set to true, enable
 504 \fB\-\-full\-name\fR
 505 option by default\&.
 506 .RE
 507 .PP
 508 grep\&.fallbackToNoIndex
 509 .RS 4
 510 If set to true, fall back to
 511 \fBgit grep \-\-no\-index\fR
 512 if
 513 \fBgit grep\fR
 514 is executed outside of a git repository\&. Defaults to false\&.
 515 .RE
 516 .SH "GIT"
 517 .sp
 518 Part of the \fBgit\fR(1) suite