vcsh: Implement shortnames for commands

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index b1957078400381993313762d03449e68b1128790..89ebff5a161a60eb8a1b2857259392a7addf1133 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 [<repo>]
+

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


@@ -84,6 +86,9 @@ an interactive user.
   If you need to clone a bundle of repositories, look into the
   `post-clone-retired` hook.
 
   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.
 


@@ -125,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/one vcsh repositories.
+

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


@@ -164,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:


@@ -221,9 +229,12 @@ the repository's name, followed by a dot, i.e. <zsh.pre-run>. Otherwise, the
 same rules as above apply. The dot between the repository's name and the hook
 is mandatory, though.
 
 same rules as above apply. The dot between the repository's name and the hook
 is mandatory, though.
 

-Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,
-<pre-upgrade>, and <post-upgrade>. If you need more, vcsh is trivial to patch,
-but please let upstream know so we can ship them by default.
+Available hooks are <pre-clone>, <post-clone>, <post-clone-retired>,
+<pre-command>, <post-command>, <pre-enter>, <post-enter>, <pre-init>,
+<post-init>, <pre-pull>, <post-pull>, <pre-push>, <post-push>, <pre-run>,
+<post-run>, <pre-upgrade>, and <post-upgrade>.
+If you need more, vcsh is trivial to patch, but please let upstream know so
+we can ship them by default.

 
 ## DETAILED HOWTO AND FURTHER READING
 
 
 ## DETAILED HOWTO AND FURTHER READING
 


@@ -274,7 +285,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.