Merge pull request #232 from rhopfer/feature-bash-completion

[code/vcsh.git] / doc / vcsh.1.ronn

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index c91f6466e5b0706cdedeb1864aa6d3e5b9f5a517..45b8c831c0b913ad170eabbebbb9af4996a3ff6f 100644 (file)
--- 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 [<rpoe>]
+`vcsh` list-tracked [<repo>]
 
-`vcsh` list-untracked [<-r>] [<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.
 
@@ -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/<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>`.
@@ -336,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.