Merge pull request #128 from tfnico/patch-4

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 038cc2b2d6113e220f9cc68ddd66473ffc01b926..05da4fad8bfe18dce47ab8aaa2c3dc9f9c619275 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,19 @@ 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` status [<repo>]
+
+`vcsh` upgrade <repo>
+
+`vcsh` version

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


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


@@ -75,6 +83,12 @@ 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
+

 * delete:
   Delete an existing repository.
 
 * delete:
   Delete an existing repository.
 


@@ -96,6 +110,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 +130,20 @@ 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.
+* status:
+  Show statuses of all/one vcsh repositories.
+
+* 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 +154,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
 


@@ -145,17 +171,37 @@ executed in the context of your shell.
 
 Interesting knobs you can turn:
 
 
 Interesting knobs you can turn:
 

+* <$VCSH_GITATTRIBUTES>:
+  Can be <none>, or any other value.
+
+  <none> will not maintain Git attributes in a special location.
+
+  If set to any other value, repo-specific gitattributes files will be maintained.
+
+  Defaults to <none>.
+

 * <$VCSH_GITIGNORE>:
 * <$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>:


@@ -201,9 +247,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-setup>, and <post-setup>. 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
 


@@ -241,7 +290,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 +303,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@debian.org>

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