1git-check-ignore(1) 2=================== 3 4NAME 5---- 6git-check-ignore - Debug gitignore / exclude files 7 8 9SYNOPSIS 10-------- 11[verse] 12'git check-ignore' [options] pathname... 13'git check-ignore' [options] --stdin < <list-of-paths> 14 15DESCRIPTION 16----------- 17 18For each pathname given via the command-line or from a file via 19`--stdin`, show the pattern from .gitignore (or other input files to 20the exclude mechanism) that decides if the pathname is excluded or 21included. Later patterns within a file take precedence over earlier 22ones. 23 24OPTIONS 25------- 26-q, --quiet:: 27 Don't output anything, just set exit status. This is only 28 valid with a single pathname. 29 30-v, --verbose:: 31 Also output details about the matching pattern (if any) 32 for each given pathname. 33 34--stdin:: 35 Read file names from stdin instead of from the command-line. 36 37-z:: 38 The output format is modified to be machine-parseable (see 39 below). If `--stdin` is also given, input paths are separated 40 with a NUL character instead of a linefeed character. 41 42OUTPUT 43------ 44 45By default, any of the given pathnames which match an ignore pattern 46will be output, one per line. If no pattern matches a given path, 47nothing will be output for that path; this means that path will not be 48ignored. 49 50If `--verbose` is specified, the output is a series of lines of the form: 51 52<source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname> 53 54<pathname> is the path of a file being queried, <pattern> is the 55matching pattern, <source> is the pattern's source file, and <linenum> 56is the line number of the pattern within that source. If the pattern 57contained a `!` prefix or `/` suffix, it will be preserved in the 58output. <source> will be an absolute path when referring to the file 59configured by `core.excludesfile`, or relative to the repository root 60when referring to `.git/info/exclude` or a per-directory exclude file. 61 62If `-z` is specified, the pathnames in the output are delimited by the 63null character; if `--verbose` is also specified then null characters 64are also used instead of colons and hard tabs: 65 66<source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL> 67 68 69EXIT STATUS 70----------- 71 720:: 73 One or more of the provided paths is ignored. 74 751:: 76 None of the provided paths are ignored. 77 78128:: 79 A fatal error was encountered. 80 81SEE ALSO 82-------- 83linkgit:gitignore[5] 84linkgit:gitconfig[5] 85linkgit:git-ls-files[1] 86 87GIT 88--- 89Part of the linkgit:git[1] suite