X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/41f68579e858270d2b97deed93927922d46dde6d..refs/heads/master:/doc/vcsh.1.ronn?ds=sidebyside diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index b195707..6e19ef8 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -5,21 +5,23 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` [] -`vcsh` clone [] +`vcsh` clone [-b ] [] `vcsh` delete `vcsh` enter +`vcsh` foreach [-g] + `vcsh` help `vcsh` init `vcsh` list -`vcsh` list-tracked +`vcsh` list-tracked [] -`vcsh` list-tracked-by +`vcsh` list-untracked [<-a>] [<-r>] [] `vcsh` pull @@ -29,6 +31,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` run +`vcsh` status [] + `vcsh` upgrade `vcsh` version @@ -37,7 +41,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` write-gitignore -`vcsh` +`vcsh` `vcsh` @@ -84,11 +88,22 @@ an interactive user. If you need to clone a bundle of repositories, look into the `post-clone-retired` hook. + You can also use a single git repository with several branches. Use the `-b` + option to specify a branch at clone time, the default is `master`. + +* commit: + Commit in all repositories + * delete: Delete an existing repository. * enter: - Enter repository; spawn new <$SHELL>. + Enter repository; spawn new <$SHELL> with <$GIT_DIR> set. + +* foreach: + Execute git command for every vcsh repository. + + `-g`: Execute in general context. * help: Display help. @@ -102,9 +117,26 @@ an interactive user. * list-tracked: List all files tracked by vcsh. + If you want to list files tracked by a specific repository, simply + append the repository's name last. + * list-tracked-by: List files tracked by a repository. + This is a legacy command; you should use `list-tracked ` instead. + +* list-untracked: + List all files NOT tracked by vcsh. + + `-a`: Show all files. + By default, the `git ls-files --exclude-standard` is called. + + `-r`: Recursive mode. + By default, the file list is shallow and stops at directory levels where + possible. + + `$repo`: List files not tracked by this specific repository. + * pull: Pull from all vcsh remotes. @@ -125,6 +157,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. @@ -138,7 +173,7 @@ an interactive user. Write .gitignore.d/ via `git ls-files`. * : - Shortcut to run `vcsh` on a repo. Will prepend `git` to . + Shortcut to run `git` commands on a repo. Will prepend `git` to . * : Shortcut to run `vcsh enter `. @@ -163,19 +198,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 , , or . + Can be , , or . 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. - will not write any ignore file. - Defaults to . +* <$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>: @@ -221,9 +274,30 @@ 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. + +## 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. Same as hooks, you can use global or repository-specific +overlays by using either <$VCSH_OVERLAY_D/$VCSH_COMMAND> or +<$VCSH_OVERLAY_D/$VCSH_REPO_NAME.$VCSH_COMMAND>. + +Please note that nothing stops you from, e.g. overwriting `status()` in +<$VCSH_OVERLAY_D/commit>. 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 @@ -264,7 +338,7 @@ config files, all of which were soft-linked into <$HOME>. Martin F. Krafft aka madduck came up with the concept of fake bare Git repositories. -vcsh was initally written by madduck. This version is a re-implementation from +vcsh was initially written by madduck. This version is a re-implementation from scratch with a lot more features. madduck graciously agreed to let the author take over the name. @@ -274,7 +348,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011-2013 Richard Hartmann +Copyright 2011-2015 Richard Hartmann Licensed under the GNU GPL version 2 or higher.