X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/36e44e04b656b084dbc0a5657041698f24752c4f..9f943527a41af4e68dd05ef208ba05666a37e2da:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 05da4fa..ebc9896 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -254,6 +254,17 @@ Available hooks are , , , If you need more, vcsh is trivial to patch, but please let upstream know so we can ship them by default. +## OVERLAY SYSTEM + +`vcsh` also provides an overlay system. Similar to hooks, the recommended +locations are <$XDG_CONFIG_HOME/vcsh/overlays-available> and +<$XDG_CONFIG_HOME/vcsh/overlays-enabled>. + +Overlays follow the same rules as hooks and you are free to overwrite any +and all functions. As the overlays will be sourced and you are replacing +arbitrary functions, any and all features may stop working, or you may even +lose data. You have been warned. + ## DETAILED HOWTO AND FURTHER READING Manpages are often short and sometimes useless to glean best practices from.