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 038cc2b2d6113e220f9cc68ddd66473ffc01b926..ee13b7f4005d5b34360fd14980a6606511eb0db1 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
 
 
 ## SYNOPSIS
 


@@ -21,11 +21,17 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 `vcsh` list-tracked-by <repo>
 
 
 `vcsh` list-tracked-by <repo>
 

+`vcsh` pull
+
+`vcsh` push
+

 `vcsh` rename <repo> <newname>
 
 `vcsh` run <repo> <shell command>
 
 `vcsh` rename <repo> <newname>
 
 `vcsh` run <repo> <shell command>
 

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

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


@@ -43,7 +49,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.
 
 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.
 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.


@@ -96,6 +102,12 @@ an interactive user.
 * list-tracked-by:
   List files tracked by a repository.
 
 * list-tracked-by:
   List files tracked by a repository.
 

+* pull:
+  Pull from all vcsh remotes.
+
+* push:
+  Push to all vcsh remotes.
+

 * rename:
   Rename a repository.
 
 * rename:
   Rename a repository.
 


@@ -110,14 +122,17 @@ 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.
 
 * write-gitignore:
 
 * 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>.
 
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>.


@@ -128,7 +143,7 @@ an interactive user.
 ## ENVIRONMENT
 
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
 ## 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
 
 
 ## CONFIG
 


@@ -202,7 +217,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


@@ -241,7 +256,7 @@ resulting in unhappy end users.
 Like most people, the author initially made do with a single repository for all
 config files, all of which were soft-linked into <$HOME>.
 
 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
 repositories.
 
 vcsh was initally written by madduck. This version is a re-implementation from


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

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

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