git.oblomov.eu Git - git/blob - Documentation/git-grep.txt

   1 git-grep(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-grep - Print lines matching a pattern
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git grep' [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
  13            [-v | --invert-match] [-h|-H] [--full-name]
  14            [-E | --extended-regexp] [-G | --basic-regexp]
  15            [-P | --perl-regexp]
  16            [-F | --fixed-strings] [-n | --line-number]
  17            [-l | --files-with-matches] [-L | --files-without-match]
  18            [(-O | --open-files-in-pager) [<pager>]]
  19            [-z | --null]
  20            [-c | --count] [--all-match] [-q | --quiet]
  21            [--max-depth <depth>]
  22            [--color[=<when>] | --no-color]
  23            [--break] [--heading] [-p | --show-function]
  24            [-A <post-context>] [-B <pre-context>] [-C <context>]
  25            [-W | --function-context]
  26            [--threads <num>]
  27            [-f <file>] [-e] <pattern>
  28            [--and|--or|--not|(|)|-e <pattern>...]
  29            [--recurse-submodules]
  30            [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
  31            [--] [<pathspec>...]
  32
  33 DESCRIPTION
  34 -----------
  35 Look for specified patterns in the tracked files in the work tree, blobs
  36 registered in the index file, or blobs in given tree objects.  Patterns
  37 are lists of one or more search expressions separated by newline
  38 characters.  An empty string as search expression matches all lines.
  39
  40
  41 CONFIGURATION
  42 -------------
  43
  44 grep.lineNumber::
  45         If set to true, enable `-n` option by default.
  46
  47 grep.patternType::
  48         Set the default matching behavior. Using a value of 'basic', 'extended',
  49         'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
  50         `--fixed-strings`, or `--perl-regexp` option accordingly, while the
  51         value 'default' will return to the default matching behavior.
  52
  53 grep.extendedRegexp::
  54         If set to true, enable `--extended-regexp` option by default. This
  55         option is ignored when the `grep.patternType` option is set to a value
  56         other than 'default'.
  57
  58 grep.threads::
  59         Number of grep worker threads to use.  If unset (or set to 0),
  60         8 threads are used by default (for now).
  61
  62 grep.fullName::
  63         If set to true, enable `--full-name` option by default.
  64
  65 grep.fallbackToNoIndex::
  66         If set to true, fall back to git grep --no-index if git grep
  67         is executed outside of a git repository.  Defaults to false.
  68
  69
  70 OPTIONS
  71 -------
  72 --cached::
  73         Instead of searching tracked files in the working tree, search
  74         blobs registered in the index file.
  75
  76 --no-index::
  77         Search files in the current directory that is not managed by Git.
  78
  79 --untracked::
  80         In addition to searching in the tracked files in the working
  81         tree, search also in untracked files.
  82
  83 --no-exclude-standard::
  84         Also search in ignored files by not honoring the `.gitignore`
  85         mechanism. Only useful with `--untracked`.
  86
  87 --exclude-standard::
  88         Do not pay attention to ignored files specified via the `.gitignore`
  89         mechanism.  Only useful when searching files in the current directory
  90         with `--no-index`.
  91
  92 --recurse-submodules::
  93         Recursively search in each submodule that has been initialized and
  94         checked out in the repository.
  95
  96 -a::
  97 --text::
  98         Process binary files as if they were text.
  99
 100 --textconv::
 101         Honor textconv filter settings.
 102
 103 --no-textconv::
 104         Do not honor textconv filter settings.
 105         This is the default.
 106
 107 -i::
 108 --ignore-case::
 109         Ignore case differences between the patterns and the
 110         files.
 111
 112 -I::
 113         Don't match the pattern in binary files.
 114
 115 --max-depth <depth>::
 116         For each <pathspec> given on command line, descend at most <depth>
 117         levels of directories. A negative value means no limit.
 118         This option is ignored if <pathspec> contains active wildcards.
 119         In other words if "a*" matches a directory named "a*",
 120         "*" is matched literally so --max-depth is still effective.
 121
 122 -w::
 123 --word-regexp::
 124         Match the pattern only at word boundary (either begin at the
 125         beginning of a line, or preceded by a non-word character; end at
 126         the end of a line or followed by a non-word character).
 127
 128 -v::
 129 --invert-match::
 130         Select non-matching lines.
 131
 132 -h::
 133 -H::
 134         By default, the command shows the filename for each
 135         match.  `-h` option is used to suppress this output.
 136         `-H` is there for completeness and does not do anything
 137         except it overrides `-h` given earlier on the command
 138         line.
 139
 140 --full-name::
 141         When run from a subdirectory, the command usually
 142         outputs paths relative to the current directory.  This
 143         option forces paths to be output relative to the project
 144         top directory.
 145
 146 -E::
 147 --extended-regexp::
 148 -G::
 149 --basic-regexp::
 150         Use POSIX extended/basic regexp for patterns.  Default
 151         is to use basic regexp.
 152
 153 -P::
 154 --perl-regexp::
 155         Use Perl-compatible regexp for patterns. Requires libpcre to be
 156         compiled in.
 157
 158 -F::
 159 --fixed-strings::
 160         Use fixed strings for patterns (don't interpret pattern
 161         as a regex).
 162
 163 -n::
 164 --line-number::
 165         Prefix the line number to matching lines.
 166
 167 -l::
 168 --files-with-matches::
 169 --name-only::
 170 -L::
 171 --files-without-match::
 172         Instead of showing every matched line, show only the
 173         names of files that contain (or do not contain) matches.
 174         For better compatibility with 'git diff', `--name-only` is a
 175         synonym for `--files-with-matches`.
 176
 177 -O[<pager>]::
 178 --open-files-in-pager[=<pager>]::
 179         Open the matching files in the pager (not the output of 'grep').
 180         If the pager happens to be "less" or "vi", and the user
 181         specified only one pattern, the first file is positioned at
 182         the first match automatically. The `pager` argument is
 183         optional; if specified, it must be stuck to the option
 184         without a space. If `pager` is unspecified, the default pager
 185         will be used (see `core.pager` in linkgit:git-config[1]).
 186
 187 -z::
 188 --null::
 189         Output \0 instead of the character that normally follows a
 190         file name.
 191
 192 -c::
 193 --count::
 194         Instead of showing every matched line, show the number of
 195         lines that match.
 196
 197 --color[=<when>]::
 198         Show colored matches.
 199         The value must be always (the default), never, or auto.
 200
 201 --no-color::
 202         Turn off match highlighting, even when the configuration file
 203         gives the default to color output.
 204         Same as `--color=never`.
 205
 206 --break::
 207         Print an empty line between matches from different files.
 208
 209 --heading::
 210         Show the filename above the matches in that file instead of
 211         at the start of each shown line.
 212
 213 -p::
 214 --show-function::
 215         Show the preceding line that contains the function name of
 216         the match, unless the matching line is a function name itself.
 217         The name is determined in the same way as 'git diff' works out
 218         patch hunk headers (see 'Defining a custom hunk-header' in
 219         linkgit:gitattributes[5]).
 220
 221 -<num>::
 222 -C <num>::
 223 --context <num>::
 224         Show <num> leading and trailing lines, and place a line
 225         containing `--` between contiguous groups of matches.
 226
 227 -A <num>::
 228 --after-context <num>::
 229         Show <num> trailing lines, and place a line containing
 230         `--` between contiguous groups of matches.
 231
 232 -B <num>::
 233 --before-context <num>::
 234         Show <num> leading lines, and place a line containing
 235         `--` between contiguous groups of matches.
 236
 237 -W::
 238 --function-context::
 239         Show the surrounding text from the previous line containing a
 240         function name up to the one before the next function name,
 241         effectively showing the whole function in which the match was
 242         found.
 243
 244 --threads <num>::
 245         Number of grep worker threads to use.
 246         See `grep.threads` in 'CONFIGURATION' for more information.
 247
 248 -f <file>::
 249         Read patterns from <file>, one per line.
 250
 251 -e::
 252         The next parameter is the pattern. This option has to be
 253         used for patterns starting with `-` and should be used in
 254         scripts passing user input to grep.  Multiple patterns are
 255         combined by 'or'.
 256
 257 --and::
 258 --or::
 259 --not::
 260 ( ... )::
 261         Specify how multiple patterns are combined using Boolean
 262         expressions.  `--or` is the default operator.  `--and` has
 263         higher precedence than `--or`.  `-e` has to be used for all
 264         patterns.
 265
 266 --all-match::
 267         When giving multiple pattern expressions combined with `--or`,
 268         this flag is specified to limit the match to files that
 269         have lines to match all of them.
 270
 271 -q::
 272 --quiet::
 273         Do not output matched lines; instead, exit with status 0 when
 274         there is a match and with non-zero status when there isn't.
 275
 276 <tree>...::
 277         Instead of searching tracked files in the working tree, search
 278         blobs in the given trees.
 279
 280 \--::
 281         Signals the end of options; the rest of the parameters
 282         are <pathspec> limiters.
 283
 284 <pathspec>...::
 285         If given, limit the search to paths matching at least one pattern.
 286         Both leading paths match and glob(7) patterns are supported.
 287
 288 Examples
 289 --------
 290
 291 `git grep 'time_t' -- '*.[ch]'`::
 292         Looks for `time_t` in all tracked .c and .h files in the working
 293         directory and its subdirectories.
 294
 295 `git grep -e '#define' --and \( -e MAX_PATH -e PATH_MAX \)`::
 296         Looks for a line that has `#define` and either `MAX_PATH` or
 297         `PATH_MAX`.
 298
 299 `git grep --all-match -e NODE -e Unexpected`::
 300         Looks for a line that has `NODE` or `Unexpected` in
 301         files that have lines that match both.
 302
 303 GIT
 304 ---
 305 Part of the linkgit:git[1] suite