Mac Developer Library Developer
Search

 

This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



GIT-CHECK-IGNORE(1)                              Git Manual                              GIT-CHECK-IGNORE(1)



NAME
       git-check-ignore - Debug gitignore / exclude files

SYNOPSIS
       git check-ignore [options] pathname...
       git check-ignore [options] --stdin < <list-of-paths>


DESCRIPTION
       For each pathname given via the command-line or from a file via --stdin, show the pattern from
       .gitignore (or other input files to the exclude mechanism) that decides if the pathname is excluded
       or included. Later patterns within a file take precedence over earlier ones.

OPTIONS
       -q, --quiet
           Don't output anything, just set exit status. This is only valid with a single pathname.

       -v, --verbose
           Also output details about the matching pattern (if any) for each given pathname.

       --stdin
           Read file names from stdin instead of from the command-line.

       -z
           The output format is modified to be machine-parseable (see below). If --stdin is also given,
           input paths are separated with a NUL character instead of a linefeed character.

OUTPUT
       By default, any of the given pathnames which match an ignore pattern will be output, one per line. If
       no pattern matches a given path, nothing will be output for that path; this means that path will not
       be ignored.

       If --verbose is specified, the output is a series of lines of the form:

       <source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>

       <pathname> is the path of a file being queried, <pattern> is the matching pattern, <source> is the
       pattern's source file, and <linenum> is the line number of the pattern within that source. If the
       pattern contained a ! prefix or / suffix, it will be preserved in the output. <source> will be an
       absolute path when referring to the file configured by core.excludesfile, or relative to the
       repository root when referring to .git/info/exclude or a per-directory exclude file.

       If -z is specified, the pathnames in the output are delimited by the null character; if --verbose is
       also specified then null characters are also used instead of colons and hard tabs:

       <source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL>

EXIT STATUS
       0
           One or more of the provided paths is ignored.

       1
           None of the provided paths are ignored.

       128
           A fatal error was encountered.

SEE ALSO
       gitignore(5) gitconfig(5) git-ls-files(5)

GIT
       Part of the git(1) suite



Git 1.8.3                                        05/24/2013                              GIT-CHECK-IGNORE(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback