man1/git-hook.1

   1 '\" t
   2 .\"     Title: git-hook
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-07-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.41.0.337.g830b4a04c4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HOOK" "1" "2023\-07\-14" "Git 2\&.41\&.0\&.337\&.g830b4a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-hook \- Run git hooks
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit hook\fR run [\-\-ignore\-missing] [\-\-to\-stdin=<path>] <hook\-name> [\-\- <hook\-args>]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 A command interface to running git hooks (see \fBgithooks\fR(5)), for use by other scripted git commands\&.
  41 .SH "SUBCOMMANDS"
  42 .PP
  43 run
  44 .RS 4
  45 Run the
  46 \fB<hook\-name>\fR
  47 hook\&. See
  48 \fBgithooks\fR(5)
  49 for supported hook names\&.
  50 .sp
  51 Any positional arguments to the hook should be passed after a mandatory
  52 \fB\-\-\fR
  53 (or
  54 \fB\-\-end\-of\-options\fR, see
  55 \fBgitcli\fR(7))\&. See
  56 \fBgithooks\fR(5)
  57 for arguments hooks might expect (if any)\&.
  58 .RE
  59 .SH "OPTIONS"
  60 .PP
  61 \-\-to\-stdin
  62 .RS 4
  63 For "run"; Specify a file which will be streamed into the hook\(cqs stdin\&. The hook will receive the entire file from beginning to EOF\&.
  64 .RE
  65 .PP
  66 \-\-ignore\-missing
  67 .RS 4
  68 Ignore any missing hook by quietly returning zero\&. Used for tools that want to do a blind one\-shot run of a hook that may or may not be present\&.
  69 .RE
  70 .SH "SEE ALSO"
  71 .sp
  72 \fBgithooks\fR(5)
  73 .SH "GIT"
  74 .sp
  75 Part of the \fBgit\fR(1) suite