Use explicit variable names and improve quoting

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 2b5cb36bceaa0e06a11d8da1a438e23a32da05b5..b348f923d918a208f6f80ff4d6f1ae314089416a 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -5,17 +5,23 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` clone <url> [<location>]
 
-`vcsh` help
+`vcsh` delete <repo>
+
+`vcsh` enter <repo>
 
-`vcsh` delete
+`vcsh` help
 
-`vcsh` init <foo>
+`vcsh` init <repo>
 
 `vcsh` list
 
-`vcsh` run <foo> git command
+`vcsh` run <repo> <command>
+
+`vcsh` seed-gitignore <repo>
 
-`vcsh` seed-gitignore
+`vcsh` setup <repo>
+
+`vcsh` <repo> <gitcommand>
 
 
 ## DESCRIPTION
@@ -41,12 +47,15 @@ A sample configuration for `vcsh` and `mr` can be found at
 * clone:
   Clone an existing repository.
 
-* help:
-  Display help.
-
 * delete:
   Delete an existing repository.
 
+* enter:
+  Enter repository; spawn new <$SHELL>.
+
+* help:
+  Display help.
+
 * init:
   Initialize an empty repository.
 
@@ -60,6 +69,12 @@ A sample configuration for `vcsh` and `mr` can be found at
 * seed-gitignore:
   Seed .gitignore.d/<repo> from git ls-files.
 
+* setup:
+  Set up repository with recommended settings.
+
+* <repo> <gitcommand>:
+  Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
+
 ## ENVIRONMENT
 
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the