X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/9f943527a41af4e68dd05ef208ba05666a37e2da..5b1b551418efe890bec37aa79d3d16346d96d0f0:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index ebc9896..45b8c83 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` [<options>] <command> -`vcsh` clone <url> [<repo>] +`vcsh` clone [-b <branch>] <url> [<repo>] `vcsh` delete <repo> `vcsh` enter <repo> +`vcsh` foreach [-g] <git command> + `vcsh` help `vcsh` init <repo> `vcsh` list -`vcsh` list-tracked +`vcsh` list-tracked [<repo>] -`vcsh` list-tracked-by <repo> +`vcsh` list-untracked [<-a>] [<-r>] [<repo>] `vcsh` pull @@ -39,7 +41,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` write-gitignore <repo> -`vcsh` <repo> <git command> +`vcsh` <repo> <gitcommand> `vcsh` <repo> @@ -86,6 +88,9 @@ 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 @@ -95,6 +100,11 @@ an interactive user. * enter: Enter repository; spawn new <$SHELL>. +* foreach: + Execute git command for every vcsh repository. + + `-g`: Execute in general context. + * help: Display help. @@ -107,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 <repo>` 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. @@ -146,7 +173,7 @@ an interactive user. Write .gitignore.d/<repo> via `git ls-files`. * <repo> <gitcommand>: - Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>. + Shortcut to run `git` commands on a repo. Will prepend `git` to <gitcommand>. * <repo>: Shortcut to run `vcsh enter <repo>`. @@ -261,9 +288,16 @@ 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. +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 @@ -314,7 +348,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011-2013 Richard Hartmann <richih@debian.org> +Copyright 2011-2015 Richard Hartmann <richih@debian.org> Licensed under the GNU GPL version 2 or higher.