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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-05-17
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.41.0.rc0.4.g004e0f790f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-GREP" "1" "2023\-05\-17" "Git 2\&.41\&.0\&.rc0\&.4\&.g00" "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 | \-\-no\-index | \-\-untracked] | <tree>\&...]
  55            [\-\-] [<pathspec>\&...]
  56 .fi
  57 .sp
  58 .SH "DESCRIPTION"
  59 .sp
  60 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\&.
  61 .SH "OPTIONS"
  62 .PP
  63 \-\-cached
  64 .RS 4
  65 Instead of searching tracked files in the working tree, search blobs registered in the index file\&.
  66 .RE
  67 .PP
  68 \-\-no\-index
  69 .RS 4
  70 Search files in the current directory that is not managed by Git\&.
  71 .RE
  72 .PP
  73 \-\-untracked
  74 .RS 4
  75 In addition to searching in the tracked files in the working tree, search also in untracked files\&.
  76 .RE
  77 .PP
  78 \-\-no\-exclude\-standard
  79 .RS 4
  80 Also search in ignored files by not honoring the
  81 \fB\&.gitignore\fR
  82 mechanism\&. Only useful with
  83 \fB\-\-untracked\fR\&.
  84 .RE
  85 .PP
  86 \-\-exclude\-standard
  87 .RS 4
  88 Do not pay attention to ignored files specified via the
  89 \fB\&.gitignore\fR
  90 mechanism\&. Only useful when searching files in the current directory with
  91 \fB\-\-no\-index\fR\&.
  92 .RE
  93 .PP
  94 \-\-recurse\-submodules
  95 .RS 4
  96 Recursively search in each submodule that is active and checked out in the repository\&. When used in combination with the <tree> option the prefix of all submodule output will be the name of the parent project\(cqs <tree> object\&. This option has no effect if
  97 \fB\-\-no\-index\fR
  98 is given\&.
  99 .RE
 100 .PP
 101 \-a, \-\-text
 102 .RS 4
 103 Process binary files as if they were text\&.
 104 .RE
 105 .PP
 106 \-\-textconv
 107 .RS 4
 108 Honor textconv filter settings\&.
 109 .RE
 110 .PP
 111 \-\-no\-textconv
 112 .RS 4
 113 Do not honor textconv filter settings\&. This is the default\&.
 114 .RE
 115 .PP
 116 \-i, \-\-ignore\-case
 117 .RS 4
 118 Ignore case differences between the patterns and the files\&.
 119 .RE
 120 .PP
 121 \-I
 122 .RS 4
 123 Don\(cqt match the pattern in binary files\&.
 124 .RE
 125 .PP
 126 \-\-max\-depth <depth>
 127 .RS 4
 128 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\&.
 129 .RE
 130 .PP
 131 \-r, \-\-recursive
 132 .RS 4
 133 Same as
 134 \fB\-\-max\-depth=\-1\fR; this is the default\&.
 135 .RE
 136 .PP
 137 \-\-no\-recursive
 138 .RS 4
 139 Same as
 140 \fB\-\-max\-depth=0\fR\&.
 141 .RE
 142 .PP
 143 \-w, \-\-word\-regexp
 144 .RS 4
 145 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)\&.
 146 .RE
 147 .PP
 148 \-v, \-\-invert\-match
 149 .RS 4
 150 Select non\-matching lines\&.
 151 .RE
 152 .PP
 153 \-h, \-H
 154 .RS 4
 155 By default, the command shows the filename for each match\&.
 156 \fB\-h\fR
 157 option is used to suppress this output\&.
 158 \fB\-H\fR
 159 is there for completeness and does not do anything except it overrides
 160 \fB\-h\fR
 161 given earlier on the command line\&.
 162 .RE
 163 .PP
 164 \-\-full\-name
 165 .RS 4
 166 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\&.
 167 .RE
 168 .PP
 169 \-E, \-\-extended\-regexp, \-G, \-\-basic\-regexp
 170 .RS 4
 171 Use POSIX extended/basic regexp for patterns\&. Default is to use basic regexp\&.
 172 .RE
 173 .PP
 174 \-P, \-\-perl\-regexp
 175 .RS 4
 176 Use Perl\-compatible regular expressions for patterns\&.
 177 .sp
 178 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\&.
 179 .RE
 180 .PP
 181 \-F, \-\-fixed\-strings
 182 .RS 4
 183 Use fixed strings for patterns (don\(cqt interpret pattern as a regex)\&.
 184 .RE
 185 .PP
 186 \-n, \-\-line\-number
 187 .RS 4
 188 Prefix the line number to matching lines\&.
 189 .RE
 190 .PP
 191 \-\-column
 192 .RS 4
 193 Prefix the 1\-indexed byte\-offset of the first match from the start of the matching line\&.
 194 .RE
 195 .PP
 196 \-l, \-\-files\-with\-matches, \-\-name\-only, \-L, \-\-files\-without\-match
 197 .RS 4
 198 Instead of showing every matched line, show only the names of files that contain (or do not contain) matches\&. For better compatibility with
 199 \fIgit diff\fR,
 200 \fB\-\-name\-only\fR
 201 is a synonym for
 202 \fB\-\-files\-with\-matches\fR\&.
 203 .RE
 204 .PP
 205 \-O[<pager>], \-\-open\-files\-in\-pager[=<pager>]
 206 .RS 4
 207 Open the matching files in the pager (not the output of
 208 \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
 209 \fBpager\fR
 210 argument is optional; if specified, it must be stuck to the option without a space\&. If
 211 \fBpager\fR
 212 is unspecified, the default pager will be used (see
 213 \fBcore\&.pager\fR
 214 in
 215 \fBgit-config\fR(1))\&.
 216 .RE
 217 .PP
 218 \-z, \-\-null
 219 .RS 4
 220 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 core\&.quotePath (see
 221 \fBgit-config\fR(1))\&.
 222 .RE
 223 .PP
 224 \-o, \-\-only\-matching
 225 .RS 4
 226 Print only the matched (non\-empty) parts of a matching line, with each such part on a separate output line\&.
 227 .RE
 228 .PP
 229 \-c, \-\-count
 230 .RS 4
 231 Instead of showing every matched line, show the number of lines that match\&.
 232 .RE
 233 .PP
 234 \-\-color[=<when>]
 235 .RS 4
 236 Show colored matches\&. The value must be always (the default), never, or auto\&.
 237 .RE
 238 .PP
 239 \-\-no\-color
 240 .RS 4
 241 Turn off match highlighting, even when the configuration file gives the default to color output\&. Same as
 242 \fB\-\-color=never\fR\&.
 243 .RE
 244 .PP
 245 \-\-break
 246 .RS 4
 247 Print an empty line between matches from different files\&.
 248 .RE
 249 .PP
 250 \-\-heading
 251 .RS 4
 252 Show the filename above the matches in that file instead of at the start of each shown line\&.
 253 .RE
 254 .PP
 255 \-p, \-\-show\-function
 256 .RS 4
 257 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
 258 \fBgit diff\fR
 259 works out patch hunk headers (see
 260 \fIDefining a custom hunk\-header\fR
 261 in
 262 \fBgitattributes\fR(5))\&.
 263 .RE
 264 .PP
 265 \-<num>, \-C <num>, \-\-context <num>
 266 .RS 4
 267 Show <num> leading and trailing lines, and place a line containing
 268 \fB\-\-\fR
 269 between contiguous groups of matches\&.
 270 .RE
 271 .PP
 272 \-A <num>, \-\-after\-context <num>
 273 .RS 4
 274 Show <num> trailing lines, and place a line containing
 275 \fB\-\-\fR
 276 between contiguous groups of matches\&.
 277 .RE
 278 .PP
 279 \-B <num>, \-\-before\-context <num>
 280 .RS 4
 281 Show <num> leading lines, and place a line containing
 282 \fB\-\-\fR
 283 between contiguous groups of matches\&.
 284 .RE
 285 .PP
 286 \-W, \-\-function\-context
 287 .RS 4
 288 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
 289 \fBgit diff\fR
 290 works out patch hunk headers (see
 291 \fIDefining a custom hunk\-header\fR
 292 in
 293 \fBgitattributes\fR(5))\&.
 294 .RE
 295 .PP
 296 \-m <num>, \-\-max\-count <num>
 297 .RS 4
 298 Limit the amount of matches per file\&. When using the
 299 \fB\-v\fR
 300 or
 301 \fB\-\-invert\-match\fR
 302 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\&.
 303 .RE
 304 .PP
 305 \-\-threads <num>
 306 .RS 4
 307 Number of grep worker threads to use\&. See
 308 \fBgrep\&.threads\fR
 309 in
 310 \fICONFIGURATION\fR
 311 for more information\&.
 312 .RE
 313 .PP
 314 \-f <file>
 315 .RS 4
 316 Read patterns from <file>, one per line\&.
 317 .sp
 318 Passing the pattern via <file> allows for providing a search pattern containing a \e0\&.
 319 .sp
 320 Not all pattern types support patterns containing \e0\&. Git will error out if a given pattern type can\(cqt support such a pattern\&. The
 321 \fB\-\-perl\-regexp\fR
 322 pattern type when compiled against the PCRE v2 backend has the widest support for these types of patterns\&.
 323 .sp
 324 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
 325 \fB\-\-ignore\-case\fR\&.
 326 .sp
 327 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\&.
 328 .RE
 329 .PP
 330 \-e
 331 .RS 4
 332 The next parameter is the pattern\&. This option has to be used for patterns starting with
 333 \fB\-\fR
 334 and should be used in scripts passing user input to grep\&. Multiple patterns are combined by
 335 \fIor\fR\&.
 336 .RE
 337 .PP
 338 \-\-and, \-\-or, \-\-not, ( \&... )
 339 .RS 4
 340 Specify how multiple patterns are combined using Boolean expressions\&.
 341 \fB\-\-or\fR
 342 is the default operator\&.
 343 \fB\-\-and\fR
 344 has higher precedence than
 345 \fB\-\-or\fR\&.
 346 \fB\-e\fR
 347 has to be used for all patterns\&.
 348 .RE
 349 .PP
 350 \-\-all\-match
 351 .RS 4
 352 When giving multiple pattern expressions combined with
 353 \fB\-\-or\fR, this flag is specified to limit the match to files that have lines to match all of them\&.
 354 .RE
 355 .PP
 356 \-q, \-\-quiet
 357 .RS 4
 358 Do not output matched lines; instead, exit with status 0 when there is a match and with non\-zero status when there isn\(cqt\&.
 359 .RE
 360 .PP
 361 <tree>\&...
 362 .RS 4
 363 Instead of searching tracked files in the working tree, search blobs in the given trees\&.
 364 .RE
 365 .PP
 366 \-\-
 367 .RS 4
 368 Signals the end of options; the rest of the parameters are <pathspec> limiters\&.
 369 .RE
 370 .PP
 371 <pathspec>\&...
 372 .RS 4
 373 If given, limit the search to paths matching at least one pattern\&. Both leading paths match and glob(7) patterns are supported\&.
 374 .sp
 375 For more details about the <pathspec> syntax, see the
 376 \fIpathspec\fR
 377 entry in
 378 \fBgitglossary\fR(7)\&.
 379 .RE
 380 .SH "EXAMPLES"
 381 .PP
 382 \fBgit grep \*(Aqtime_t\*(Aq \-\- \*(Aq*\&.[ch]\*(Aq\fR
 383 .RS 4
 384 Looks for
 385 \fBtime_t\fR
 386 in all tracked \&.c and \&.h files in the working directory and its subdirectories\&.
 387 .RE
 388 .PP
 389 \fBgit grep \-e \*(Aq#define\*(Aq \-\-and \e( \-e MAX_PATH \-e PATH_MAX \e)\fR
 390 .RS 4
 391 Looks for a line that has
 392 \fB#define\fR
 393 and either
 394 \fBMAX_PATH\fR
 395 or
 396 \fBPATH_MAX\fR\&.
 397 .RE
 398 .PP
 399 \fBgit grep \-\-all\-match \-e NODE \-e Unexpected\fR
 400 .RS 4
 401 Looks for a line that has
 402 \fBNODE\fR
 403 or
 404 \fBUnexpected\fR
 405 in files that have lines that match both\&.
 406 .RE
 407 .PP
 408 \fBgit grep solution \-\- :^Documentation\fR
 409 .RS 4
 410 Looks for
 411 \fBsolution\fR, excluding files in
 412 \fBDocumentation\fR\&.
 413 .RE
 414 .SH "NOTES ON THREADS"
 415 .sp
 416 The \fB\-\-threads\fR option (and the grep\&.threads configuration) will be ignored when \fB\-\-open\-files\-in\-pager\fR is used, forcing a single\-threaded execution\&.
 417 .sp
 418 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\(cqre too many text conversions\&. So if you experience low performance in this case, it might be desirable to use \fB\-\-threads=1\fR\&.
 419 .SH "CONFIGURATION"
 420 .sp
 421 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:
 422 .PP
 423 grep\&.lineNumber
 424 .RS 4
 425 If set to true, enable
 426 \fB\-n\fR
 427 option by default\&.
 428 .RE
 429 .PP
 430 grep\&.column
 431 .RS 4
 432 If set to true, enable the
 433 \fB\-\-column\fR
 434 option by default\&.
 435 .RE
 436 .PP
 437 grep\&.patternType
 438 .RS 4
 439 Set the default matching behavior\&. Using a value of
 440 \fIbasic\fR,
 441 \fIextended\fR,
 442 \fIfixed\fR, or
 443 \fIperl\fR
 444 will enable the
 445 \fB\-\-basic\-regexp\fR,
 446 \fB\-\-extended\-regexp\fR,
 447 \fB\-\-fixed\-strings\fR, or
 448 \fB\-\-perl\-regexp\fR
 449 option accordingly, while the value
 450 \fIdefault\fR
 451 will use the
 452 \fBgrep\&.extendedRegexp\fR
 453 option to choose between
 454 \fIbasic\fR
 455 and
 456 \fIextended\fR\&.
 457 .RE
 458 .PP
 459 grep\&.extendedRegexp
 460 .RS 4
 461 If set to true, enable
 462 \fB\-\-extended\-regexp\fR
 463 option by default\&. This option is ignored when the
 464 \fBgrep\&.patternType\fR
 465 option is set to a value other than
 466 \fIdefault\fR\&.
 467 .RE
 468 .PP
 469 grep\&.threads
 470 .RS 4
 471 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\&.
 472 .RE
 473 .PP
 474 grep\&.fullName
 475 .RS 4
 476 If set to true, enable
 477 \fB\-\-full\-name\fR
 478 option by default\&.
 479 .RE
 480 .PP
 481 grep\&.fallbackToNoIndex
 482 .RS 4
 483 If set to true, fall back to git grep \-\-no\-index if git grep is executed outside of a git repository\&. Defaults to false\&.
 484 .RE
 485 .SH "GIT"
 486 .sp
 487 Part of the \fBgit\fR(1) suite