X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/1d8970fdb8d4adbfd5cdecc5d15da9db61efb39d..65b97e13fe2638f587c13521e2970a037d09eab2:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index ee13b7f..f82a877 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -21,6 +21,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` list-tracked-by +`vcsh` list-untracked [<-r>] [] + `vcsh` pull `vcsh` push @@ -29,6 +31,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` run +`vcsh` status [] + `vcsh` upgrade `vcsh` version @@ -81,6 +85,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. @@ -102,6 +112,16 @@ an interactive user. * list-tracked-by: List files tracked by a repository. +* list-untracked: + List all files NOT tracked by vcsh. + + By default, the file list is shallow and stops at directory levels where + possible. If you prefer to get a list of all files, append `-r` for + recursive mode. + + If you want to list files not tracked by a specific repository, simply + append the repository's name last. + * pull: Pull from all vcsh remotes. @@ -122,6 +142,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,17 +183,37 @@ executed in the context of your shell. Interesting knobs you can turn: +* <$VCSH_GITATTRIBUTES>: + Can be , or any other value. + + will not maintain Git attributes in a special location. + + If set to any other value, repo-specific gitattributes files will be maintained. + + Defaults to . + * <$VCSH_GITIGNORE>: - Can be either or . + Can be , , or . - will seed the repo-specific <.gitignore> with all file and directory + will seed the repo-specific ignore file with all file and directory names which `git ls-files` returns. + will not write any ignore file. + will descend through all directories recursively additionally to the above. Defaults to . +* <$VCSH_VCSH_WORKTREE>: + Can be , or . + + will set an absolute path; defaulting to <$HOME>. + + will set a path relative to <$GIT_DIR>. + + Defaults to . + Less interesting knobs you could turn: * <$VCSH_DEBUG>: @@ -216,9 +259,12 @@ 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. +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 @@ -269,7 +315,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011-2013 Richard Hartmann +Copyright 2011-2013 Richard Hartmann Licensed under the GNU GPL version 2 or higher.