X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/a6abce3ce936e07c8416af474df69068b670d510..0ac61152fbc932395b73646df3d9eb76e73762a8:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 79a4063..05da4fa 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -29,6 +29,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` run <repo> <shell command> +`vcsh` status [<repo>] + `vcsh` upgrade <repo> `vcsh` version @@ -81,6 +83,12 @@ an interactive user. * clone: Clone an existing repository. + If you need to clone a bundle of repositories, look into the + `post-clone-retired` hook. + +* commit: + Commit in all repositories + * delete: Delete an existing repository. @@ -122,6 +130,9 @@ an interactive user. This is needed to support mr and other scripts properly and of no concern to an interactive user. +* status: + Show statuses of all/one vcsh repositories. + * upgrade: Upgrade repository to currently recommended settings. @@ -160,19 +171,37 @@ executed in the context of your shell. Interesting knobs you can turn: +* <$VCSH_GITATTRIBUTES>: + Can be <none>, or any other value. + + <none> will not maintain Git attributes in a special location. + + If set to any other value, repo-specific gitattributes files will be maintained. + + Defaults to <none>. + * <$VCSH_GITIGNORE>: - Can be <exact>, <recursive>, or <none>. + Can be <exact>, <none>, or <recursive>. <exact> will seed the repo-specific ignore file with all file and directory names which `git ls-files` returns. + <none> will not write any ignore file. + <recursive> will descend through all directories recursively additionally to the above. - <none> will not write any ignore file. - Defaults to <exact>. +* <$VCSH_VCSH_WORKTREE>: + Can be <absolute>, or <relative>. + + <absolute> will set an absolute path; defaulting to <$HOME>. + + <relative> will set a path relative to <$GIT_DIR>. + + Defaults to <absolute>. + Less interesting knobs you could turn: * <$VCSH_DEBUG>: @@ -218,9 +247,12 @@ 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-upgrade>, and <post-upgrade>. If you need more, vcsh is trivial to patch, -but please let upstream know so we can ship them by default. +Available hooks are <pre-clone>, <post-clone>, <post-clone-retired>, +<pre-command>, <post-command>, <pre-enter>, <post-enter>, <pre-init>, +<post-init>, <pre-pull>, <post-pull>, <pre-push>, <post-push>, <pre-run>, +<post-run>, <pre-upgrade>, and <post-upgrade>. +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 @@ -271,7 +303,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011-2013 Richard Hartmann <richih.mailinglist@gmail.com> +Copyright 2011-2013 Richard Hartmann <richih@debian.org> Licensed under the GNU GPL version 2 or higher.