X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/935df7b27742bd2677fe8b74586ece85e138de68..881deb41fb7c5af8c5feedd075c780f3ce94df99:/doc/vcsh.1.ronn?ds=inline

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 21ded83..0ea9428 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,7 +3,7 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
-`vcsh` clone <url> [<location>]
+`vcsh` clone <url> [<repo>]
 
 `vcsh` delete <repo>
 
@@ -44,6 +44,10 @@ 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*
 
+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
+an interactive user.
+
 ## OPTIONS
 
 * clone:
@@ -71,6 +75,13 @@ A sample configuration for `vcsh` and `mr` can be found at
   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
   and all commands without any restrictions. Use with care.
 
+  Please note that there is a somewhat magic feature for run. Instead of <repo>
+  it accepts <path>, as well. Anything that has a slash in it will be assumed to
+  be a path. `vcsh run` will then operate on this directory instead of the one
+  normally generated from the repository's name.
+  This is needed to support mr and other scripts properly and of no concern to
+  an interactive user.
+
 * seed-gitignore:
   Seed .gitignore.d/<repo> from git ls-files.