merge branch 'master' of github.com:RichiH/vcsh

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index b7f9725a9b454cf8cc6c023d595cd3ad9e5cb079..56df4ed26e74cdbb7a4109056b8415570843d846 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


@@ -81,6 +83,9 @@ 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
 
 * commit:
   Commit in all repositories
 


@@ -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,27 @@ executed in the context of your shell.
 Interesting knobs you can turn:
 
 * <$VCSH_GITIGNORE>:
 Interesting knobs you can turn:
 
 * <$VCSH_GITIGNORE>:

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

 
 

-  <exact> will seed the repo-specific <.gitignore> with all file and directory
+  <exact> will seed the repo-specific ignore file with all file and directory

   names which `git ls-files` returns.
 
   names which `git ls-files` returns.
 

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

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

+* <$VCSH_VCSH_WORKTREE>:
+  Can be <absolute>, or <relative>.
+
+  <absolute> will set an absolute path; defaulting to <$HOME>.
+
+  <relative> will set a path relative to <$GIT_DIR>.
+
+  Defaults to <absolute>.
+

 Less interesting knobs you could turn:
 
 * <$VCSH_DEBUG>:
 Less interesting knobs you could turn:
 
 * <$VCSH_DEBUG>:


@@ -219,9 +238,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
 


@@ -272,7 +294,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.