X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/c189913f6c8eebaa6f2dcfcd666ccc4b17ec6c26..fd1e40043c417a0c6f352016899bccebbf2b708a:/doc/vcsh.1.ronn?ds=sidebyside

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index c6e0152..bab8bcd 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,6 +3,8 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 ## SYNOPSIS
 
+`vcsh` [<options>] <command>
+
 `vcsh` clone <url> [<repo>]
 
 `vcsh` delete <repo>
@@ -21,13 +23,15 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 `vcsh` rename <repo> <newname>
 
-`vcsh` run <repo> <command>
+`vcsh` run <repo> <shell command>
 
 `vcsh` setup <repo>
 
+`vcsh` which <substring>
+
 `vcsh` write-gitignore <repo>
 
-`vcsh` <repo> <gitcommand>
+`vcsh` <repo> <git command>
 
 `vcsh` <repo>
 
@@ -48,7 +52,8 @@ The use of symlinks is not needed in this setup, making for a cleaner setup.
 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
 
 A sample configuration for `vcsh` and `mr` can be found at
-*https://github.com/RichiH/vcsh_mr_template*
+*https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone
+https://github.com/RichiH/vcsh_mr_template mr`.
 
 Please note that you can always use a path instead of a name for <repo>.
 This is needed to support mr and other scripts properly and of no concern to
@@ -56,6 +61,17 @@ an interactive user.
 
 ## OPTIONS
 
+* -c:
+  Source <file> prior to other configuration files
+
+* -d:
+  Enable debug mode
+
+* -v:
+  Enable verbose mode
+
+## COMMANDS
+
 * clone:
   Clone an existing repository.
 
@@ -97,11 +113,14 @@ an interactive user.
 * setup:
   Set up repository with recommended settings.
 
+* which <substring>:
+  Find <substring> in name of any tracked file.
+
 * write-gitignore:
   Write .gitignore.d/<repo> via git ls-files.
 
 * <repo> <gitcommand>:
-  Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
+  Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>.
 
 * <repo>:
   Shortcut to run `vcsh enter <repo>`.
@@ -113,18 +132,25 @@ appropriate values for fake bare git repositories.
 
 ## HOOK SYSTEM
 
-`vcsh` provides a hook system. Hook scripts need to be executable and placed
-in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they should be
-soft-linked <$XDG_CONFIG_HOME/vcsh/hooks-enabled>.
+`vcsh` provides a hook system. Hook scripts must be executable and should be
+placed in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they can be
+soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
+execute hooks that are in this directory.
 
-Hooks follow a simple format. `pre-run` will be run before anything is run.
+Hooks follow a simple format. <pre-run> will be run before anything is run.
 If you want to have more than one script for a certain hook, just append
-strings to order them. A system of `pre-run`, `pre-run.10`, `pre-run.20` etc
-is suggested. The dot it optional.
+any kind of string to order them. A system of <pre-run>, <pre-run.10>,
+<pre-run.20> etc is suggested; other options would be <pre-run-10> or
+<pre-run.sh>. A dot after the hook name is optional.
+
+If you want to create hooks for a specific <vcsh> repository, simply prepend
+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.
 
-If you want to create hooks for a specific `vcsh` repository, simply prepend
-the repository's name, followed by a dot, i.e. `zsh.pre-run`. This dot is
-mandatory.
+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.
 
 ## DETAILED HOWTO AND FURTHER READING
 
@@ -147,6 +173,11 @@ You can put any and all commands into this config file and they will be executed
 
 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.
+
 ## HISTORY
 
 Like most people, the author initially made do with a single repository for all
@@ -165,9 +196,9 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
 
 ## COPYRIGHT
 
-Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
+Copyright 2011-2012 Richard Hartmann <richih.mailinglist@gmail.com>
 
-Licensed under the GNU GPL version 3 or higher.
+Licensed under the GNU GPL version 2 or higher.
 
 https://github.com/RichiH/vcsh