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