README.md: More use cases

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 79a4063ebad86d1a0391afb471680a713bcd905b..d5f070571d37e9aa3a7536e975a22c19b15fd541 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -29,6 +29,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` run <repo> <shell command>
 
 
 `vcsh` run <repo> <shell command>
 

+`vcsh` status
+

 `vcsh` upgrade <repo>
 
 `vcsh` version
 `vcsh` upgrade <repo>
 
 `vcsh` version


@@ -81,6 +83,12 @@ an interactive user.
 * clone:
   Clone an existing repository.
 
 * clone:
   Clone an existing repository.
 

+  If you need to clone a bundle of repositories, look into the
+  `post-clone-retired` hook.
+
+* commit:
+  Commit in all repositories
+

 * delete:
   Delete an existing repository.
 
 * delete:
   Delete an existing repository.
 


@@ -122,6 +130,9 @@ an interactive user.
   This is needed to support mr and other scripts properly and of no concern to
   an interactive user.
 
   This is needed to support mr and other scripts properly and of no concern to
   an interactive user.
 

+* status:
+  Show statuses of all vcsh repositories.
+

 * upgrade:
   Upgrade repository to currently recommended settings.
 
 * upgrade:
   Upgrade repository to currently recommended settings.
 


@@ -161,16 +172,16 @@ executed in the context of your shell.
 Interesting knobs you can turn:
 
 * <$VCSH_GITIGNORE>:
 Interesting knobs you can turn:
 
 * <$VCSH_GITIGNORE>:

-  Can be <exact>, <recursive>, or <none>.
+  Can be <exact>, <none>, or <recursive>.

 
   <exact> will seed the repo-specific ignore file with all file and directory
   names which `git ls-files` returns.
 
 
   <exact> will seed the repo-specific ignore file with all file and directory
   names which `git ls-files` returns.
 

+  <none> will not write any ignore file.
+

   <recursive> will descend through all directories recursively additionally to
   the above.
 
   <recursive> will descend through all directories recursively additionally to
   the above.
 

-  <none> will not write any ignore file.
-

   Defaults to <exact>.
 
 Less interesting knobs you could turn:
   Defaults to <exact>.
 
 Less interesting knobs you could turn:


@@ -271,7 +282,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
 
 ## COPYRIGHT
 
 
 ## COPYRIGHT
 

-Copyright 2011-2013 Richard Hartmann <richih.mailinglist@gmail.com>
+Copyright 2011-2013 Richard Hartmann <richih@debian.org>

 
 Licensed under the GNU GPL version 2 or higher.
 
 
 Licensed under the GNU GPL version 2 or higher.