X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/ab60947be1d3050fbdd22b0226e294d5361e2f9f..9cc2469e835cbe8c1642a7e732ce5478ec629c0e:/doc/vcsh.1.ronn?ds=inline diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index bcea71c..d68e886 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -118,17 +118,21 @@ 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. <pre-run> will be run before anything is run. If you want to have more than one script for a certain hook, just append -any kind of string to order them. A system of `pre-run`, `pre-run.10`, -`pre-run.20` etc is suggested; other options would be `pre-run-10` or -`pre-run.sh`. A dot after the hook name is optional. +any kind of string to order them. A system of <pre-run>, <pre-run.10>, +<pre-run.20> etc is suggested; other options would be <pre-run-10> or +<pre-run.sh>. A dot after the hook name is 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`. Otherwise, the +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>. Otherwise, the same rules as above apply. The dot between the repository's name and the hook is mandatory, though. +Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>, +<pre-setup>, and <post-setup>. 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 Man pages are intended to be short and thus often useless to glean best @@ -168,7 +172,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com> +Copyright 2011-2012 Richard Hartmann <richih.mailinglist@gmail.com> Licensed under the GNU GPL version 3 or higher.