Complete on git subcommands

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index f286dc0b4f57ccb6815b5c91718daadd0815d7df..08e8c04a08df4964e64a224714c47f9e02d815ee 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -1,5 +1,5 @@
-vcsh(1) - manage config files in $HOME via fake bare git repositories
-=====================================================================
+vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
+===============================================================================
 
 ## SYNOPSIS
 
@@ -25,7 +25,9 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 `vcsh` run <repo> <shell command>
 
-`vcsh` setup <repo>
+`vcsh` upgrade <repo>
+
+`vcsh` version
 
 `vcsh` which <substring>
 
@@ -43,7 +45,7 @@ working trees in $HOME without clobbering each other. That, in turn, means you
 can have one repository per config set (zsh, vim, ssh, etc), picking and
 choosing which configs you want to use on which machine.
 
-`vcsh` is using a technique called fake bare git repositories, keeping <$GIT_DIR>
+`vcsh` is using a technique called fake bare Git repositories, keeping <$GIT_DIR>
 in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>.
 
 The use of symlinks is not needed in this setup, making for a cleaner setup.
@@ -110,14 +112,17 @@ 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.
 
 * write-gitignore:
-  Write .gitignore.d/<repo> via git ls-files.
+  Write .gitignore.d/<repo> via `git ls-files`.
 
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>.
@@ -128,7 +133,7 @@ an interactive user.
 ## ENVIRONMENT
 
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
-appropriate values for fake bare git repositories.
+appropriate values for fake bare Git repositories.
 
 ## CONFIG
 
@@ -202,7 +207,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>,
-<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
@@ -232,15 +237,16 @@ None are known at this time, but reports and/or patches are more than welcome.
 
 ## INTEROPERABILITY
 
-If you rely on `git submodule`, use `git` 1.7.12 or later. Earlier versions
-do not clean internal variables properly before descending into a submodule.
+If you rely on `git submodule` use `git` 1.7.12 or later. Earlier versions
+do not clean internal variables properly before descending into submodules,
+resulting in unhappy end users.
 
 ## HISTORY
 
 Like most people, the author initially made do with a single repository for all
 config files, all of which were soft-linked into <$HOME>.
 
-Martin F. Krafft aka madduck came up with the concept of fake bare git
+Martin F. Krafft aka madduck came up with the concept of fake bare Git
 repositories.
 
 vcsh was initally written by madduck. This version is a re-implementation from