Fix commit 96f74d26de89fa1e390e26d015208163f689629e

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 038cc2b2d6113e220f9cc68ddd66473ffc01b926..7ebf9f5d77cccdaf82804f88c25ce73dd0f2c6cd 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -25,7 +25,9 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 `vcsh` run <repo> <shell command>
 
 
 `vcsh` run <repo> <shell command>
 

-`vcsh` setup <repo>
+`vcsh` upgrade <repo>
+
+`vcsh` version

 
 `vcsh` which <substring>
 
 
 `vcsh` which <substring>
 


@@ -110,8 +112,11 @@ 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.
 

-* setup:
-  Set up repository with recommended settings.
+* upgrade:
+  Upgrade repository to currently recommended settings.
+
+* version:
+  Print version information.

 
 * which <substring>:
   Find <substring> in name of any tracked file.
 
 * which <substring>:
   Find <substring> in name of any tracked file.


@@ -146,14 +151,16 @@ 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>, <recursive>, or <none>.

 
 

-  <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.
 
   <recursive> will descend through all directories recursively additionally to
   the above.
 
   names which `git ls-files` returns.
 
   <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:


@@ -202,7 +209,7 @@ 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>,
 is mandatory, though.
 
 Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,

-<pre-setup>, and <post-setup>. If you need more, vcsh is trivial to patch,
+<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
 but please let upstream know so we can ship them by default.
 
 ## DETAILED HOWTO AND FURTHER READING