Add support for mr

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 270537785fd99bd5eda6601d1aa1186c2a189323..21ded83e85117c8752fee7fb22b22c586133f745 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,17 +3,28 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
-`vcsh` init <foo>
-
 `vcsh` clone <url> [<location>]
 
-`vcsh` run <foo> git command
+`vcsh` delete <repo>
+
+`vcsh` enter <repo>
+
+`vcsh` help
+
+`vcsh` init <repo>
 
 `vcsh` list
 
-`vcsh` seed-gitignore
+`vcsh` rename <repo> <newname>
+
+`vcsh` run <repo> <command>
+
+`vcsh` seed-gitignore <repo>
+
+`vcsh` setup <repo>
+
+`vcsh` <repo> <gitcommand>
 
-`vcsh` help
 
 ## DESCRIPTION
 
@@ -35,24 +46,39 @@ A sample configuration for `vcsh` and `mr` can be found at
 
 ## OPTIONS
 
+* clone:
+  Clone an existing repository.
+
+* delete:
+  Delete an existing repository.
+
+* enter:
+  Enter repository; spawn new <$SHELL>.
+
+* help:
+  Display help.
+
 * init:
   Initialize an empty repository.
 
-* clone:
-  Clone an existing repository.
+* list:
+  List all local vcsh repositories.
+
+* rename:
+  Rename a repository.
 
 * run:
   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
   and all commands without any restrictions. Use with care.
 
-* list:
-  List all local vcsh repositories.
-
 * seed-gitignore:
   Seed .gitignore.d/<repo> from git ls-files.
 
-* help:
-  Display help.
+* setup:
+  Set up repository with recommended settings.
+
+* <repo> <gitcommand>:
+  Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
 
 ## ENVIRONMENT