Merge pull request #229 from danielshahaf/document-enter-v1

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 19daed5f080bd98a0534c103f8dcbc7b8daca451..a25bf65b18c5ac5fecef303cae607e662a22d71c 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -11,6 +11,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` enter <repo>
 
 
 `vcsh` enter <repo>
 

+`vcsh` foreach [-g] <git command>
+

 `vcsh` help
 
 `vcsh` init <repo>
 `vcsh` help
 
 `vcsh` init <repo>


@@ -19,7 +21,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` list-tracked [<repo>]
 
 
 `vcsh` list-tracked [<repo>]
 

-`vcsh` list-untracked [<-r>] [<repo>]
+`vcsh` list-untracked [<-a>] [<-r>] [<repo>]

 
 `vcsh` pull
 
 
 `vcsh` pull
 


@@ -39,7 +41,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` write-gitignore <repo>
 
 
 `vcsh` write-gitignore <repo>
 

-`vcsh` <repo> <git command>
+`vcsh` <repo> <gitcommand>

 
 `vcsh` <repo>
 
 
 `vcsh` <repo>
 


@@ -96,7 +98,12 @@ an interactive user.
   Delete an existing repository.
 
 * enter:
   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.
 
 * help:
   Display help.


@@ -121,12 +128,14 @@ an interactive user.
 * list-untracked:
   List all files NOT tracked by vcsh.
 
 * 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
   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.
 
 * pull:
   Pull from all vcsh remotes.


@@ -164,7 +173,7 @@ an interactive user.
   Write .gitignore.d/<repo> via `git ls-files`.
 
 * <repo> <gitcommand>:
   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>`.
 
 * <repo>:
   Shortcut to run `vcsh enter <repo>`.