X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/e4bc54441966a1c4225d666a1de5e6df47410336..HEAD:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index c91f646..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-untracked [<-r>] [] +`vcsh` list-untracked [<-a>] [<-r>] [] `vcsh` pull @@ -39,7 +41,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME `vcsh` write-gitignore -`vcsh` +`vcsh` `vcsh` @@ -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 @@ -93,7 +98,12 @@ an interactive user. 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. @@ -118,12 +128,14 @@ an interactive user. * 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. If you prefer to get a list of all files, append `-r` for - recursive mode. + possible. - If you want to list files not tracked by a specific repository, simply - append the repository's name last. + `$repo`: List files not tracked by this specific repository. * pull: Pull from all vcsh remotes. @@ -161,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 `. @@ -208,7 +220,7 @@ Interesting knobs you can turn: Defaults to . -* <$VCSH_VCSH_WORKTREE>: +* <$VCSH_WORKTREE>: Can be , or . will set an absolute path; defaulting to <$HOME>. @@ -326,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. @@ -336,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.