Merge branch 'feature/foreach'

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 4138c23d53c4fbcd73ee87e86dbff70ceec57cc9..d5ee0dc53861d6346b74a64e8932d6e97c375076 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
+`vcsh` list-tracked [<repo>]
 
-`vcsh` list-tracked-by <repo>
+`vcsh` list-untracked [<-a>] [<-r>] [<repo>]
 
 `vcsh` pull
 
@@ -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.
 
@@ -321,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.