git-check-ignore(1) Manual Page

コマンドラインまたは --stdin を介してファイルから指定されたパス名ごとに、ファイルが .gitignore (またはexcludeメカニズムへの他の入力ファイル)によって除外されているかどうかを確認し、除外されている場合はそのパスを出力します。

デフォルトでは、追跡中のファイル(tracked files)は除外ルールの対象ではないため、まったく表示されません。但し、 ‘--no-index’ もご覧下さい。

デフォルトでは、指定されたパス名のうち無視パターンに一致するパスが1行に1つずつ出力されます。特定のパスに一致する無視パターンがない場合、そのパスについては何も出力されません。これは、そのパスが無視されないことを意味します。

--verbose が指定されている場合、出力の各行は以下の形式になります:

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

<pathname> はクエリ対象のファイルのパス、 <pattern> は一致するパターン、 <source> はパターンのソースファイル、 <linenum> はそのソース内のパターンの行番号です。 パターンに "!" 接頭辞または "/" 接尾辞が含まれている場合、 それは出力でも保持されます。 <source> は、 core.excludesFile で構成されたファイルを参照する場合は絶対パス、 .git/info/exclude またはディレクトリごとの除外ファイルを参照する場合はリポジトリルートを基準とします。

-z が指定されている場合、出力のパス名はヌル文字で区切られます。 --verbose も指定されている場合、コロンとハードタブの代わりにヌル文字も使用されます:

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

-n または --non-matching が指定されている場合、一致しないパス名も出力されます。その場合、 <pathname> を除く各出力レコードのすべてのフィールドが空になります。これは、非対話的に実行する場合に役立ちます。これにより、ファイル達を長時間実行されるチェック無視プロセスのSTDINに段階的にストリーミングでき、これらのファイルごとに、STDOUTはそのファイルがパターンに一致するかどうかを示します。 (このオプションがないと、特定のファイルの出力がないということは、どのパターンとも一致しなかったのか、出力がまだ生成されていないのかを判断することはできません。)

バッファリングは、 git(1) の GIT_FLUSH オプションに記載されているように行われます。呼び出し元は、入力バッファーのオーバーフィルまたは空の出力バッファーからの読み取りによって引き起こされるデッドロックを回避する責任があります。

gitignore(5) git-config(1) git-ls-files(1)

Part of the git(1) suite