X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/c189913f6c8eebaa6f2dcfcd666ccc4b17ec6c26..23b0d9f461ddd6627c580c0fad9c870d05bb3660:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index c6e0152..6a04b13 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -113,18 +113,25 @@ 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>. +`vcsh` provides a hook system. Hook scripts must be executable and should be +placed in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they can be +soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only +execute hooks that are in this directory. -Hooks follow a simple format. `pre-run` will be run before anything is run. +Hooks follow a simple format. 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. +any kind of string to order them. A system of , , + etc is suggested; other options would be or +. A dot after the hook name is optional. + +If you want to create hooks for a specific repository, simply prepend +the repository's name, followed by a dot, i.e. . Otherwise, the +same rules as above apply. The dot between the repository's name and the hook +is mandatory, though. + +Available hooks are , , , , +, and . If you need more, vcsh is trivial to patch, +but please let upstream know so we can ship them by default. ## DETAILED HOWTO AND FURTHER READING