The twelfth batch
[git.git] / Documentation / git-hook.txt
blobf6cc72d2ca9c7090c5391618d67abbfe1a1dd8e6
1 git-hook(1)
2 ===========
4 NAME
5 ----
6 git-hook - Run git hooks
8 SYNOPSIS
9 --------
10 [verse]
11 'git hook' run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]
13 DESCRIPTION
14 -----------
16 A command interface for running git hooks (see linkgit:githooks[5]),
17 for use by other scripted git commands.
19 SUBCOMMANDS
20 -----------
22 run::
23         Run the `<hook-name>` hook. See linkgit:githooks[5] for
24         supported hook names.
27 Any positional arguments to the hook should be passed after a
28 mandatory `--` (or `--end-of-options`, see linkgit:gitcli[7]). See
29 linkgit:githooks[5] for arguments hooks might expect (if any).
31 OPTIONS
32 -------
34 --to-stdin::
35         For "run"; specify a file which will be streamed into the
36         hook's stdin. The hook will receive the entire file from
37         beginning to EOF.
39 --ignore-missing::
40         Ignore any missing hook by quietly returning zero. Used for
41         tools that want to do a blind one-shot run of a hook that may
42         or may not be present.
44 SEE ALSO
45 --------
46 linkgit:githooks[5]
48 GIT
49 ---
50 Part of the linkgit:git[1] suite