X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/10c7871c75b7e5406ec2126ef372d9af9a9fa823..c189913f6c8eebaa6f2dcfcd666ccc4b17ec6c26:/doc/vcsh.1.ronn

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 9e37ca1..c6e0152 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -111,6 +111,21 @@ an interactive user.
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
 appropriate values for fake bare git repositories.
 
+## HOOK SYSTEM
+
+`vcsh` provides a hook system. Hook scripts need to be executable and placed
+in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they should be
+soft-linked <$XDG_CONFIG_HOME/vcsh/hooks-enabled>.
+
+Hooks follow a simple format. `pre-run` will be run before anything is run.
+If you want to have more than one script for a certain hook, just append
+strings to order them. A system of `pre-run`, `pre-run.10`, `pre-run.20` etc
+is suggested. The dot it optional.
+
+If you want to create hooks for a specific `vcsh` repository, simply prepend
+the repository's name, followed by a dot, i.e. `zsh.pre-run`. This dot is
+mandatory.
+
 ## DETAILED HOWTO AND FURTHER READING
 
 Man pages are intended to be short and thus often useless to glean best