X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/9428231232dc3238dad1791e1085342d7a40b82b..20e1e3ecbaadad56c0ac8678f1c1e3cc257e6d57:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index fbc961d..76ae2a5 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -25,6 +25,8 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories `vcsh` setup +`vcsh` which + `vcsh` write-gitignore `vcsh` @@ -48,7 +50,8 @@ The use of symlinks is not needed in this setup, making for a cleaner setup. vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer. A sample configuration for `vcsh` and `mr` can be found at -*https://github.com/RichiH/vcsh_mr_template* +*https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone +https://github.com/RichiH/vcsh_mr_template mr`. Please note that you can always use a path instead of a name for . This is needed to support mr and other scripts properly and of no concern to @@ -97,11 +100,14 @@ an interactive user. * setup: Set up repository with recommended settings. +* which : + Find in name of any tracked file. + * write-gitignore: Write .gitignore.d/ via git ls-files. * : - Shortcut to run `vcsh` on a repo. Will prepend `git` to by itself. + Shortcut to run `vcsh` on a repo. Will prepend `git` to . * : Shortcut to run `vcsh enter `. @@ -111,10 +117,44 @@ 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 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. 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 , , + 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 + +Man pages are intended to be short and thus often useless to glean best +practices from. This software comes with a file called . It contains +various approaches to setting up and using vcsh. You can view the file it as +plain text or render it into various other formats via Markdown. + +On Debian-based systems, this file can be found in . + ## SECURITY CONSIDERATIONS `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example, -speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid. +adding a `sudo`(8) rule for `vcsh` would be pretty stupid. + +Additionally, vcsh will source, i.e. execute, <$XDG_CONFIG_HOME/vcsh/config>. +You can put any and all commands into this config file and they will be executed. ## BUGS @@ -138,9 +178,9 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011 Richard Hartmann +Copyright 2011-2012 Richard Hartmann -Licensed under the GNU GPL version 3 or higher. +Licensed under the GNU GPL version 2 or higher. https://github.com/RichiH/vcsh