Add support for mr

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 2b5cb36bceaa0e06a11d8da1a438e23a32da05b5..21ded83e85117c8752fee7fb22b22c586133f745 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -5,17 +5,25 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` clone <url> [<location>]
 
 
 `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` list
 

-`vcsh` run <foo> git command
+`vcsh` rename <repo> <newname>
+
+`vcsh` run <repo> <command>

 
 

-`vcsh` seed-gitignore
+`vcsh` seed-gitignore <repo>
+
+`vcsh` setup <repo>
+
+`vcsh` <repo> <gitcommand>

 
 
 ## DESCRIPTION
 
 
 ## DESCRIPTION


@@ -41,18 +49,24 @@ A sample configuration for `vcsh` and `mr` can be found at
 * clone:
   Clone an existing repository.
 
 * clone:
   Clone an existing repository.
 

-* help:
-  Display help.
-

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

+* enter:
+  Enter repository; spawn new <$SHELL>.
+
+* help:
+  Display help.
+

 * init:
   Initialize an empty repository.
 
 * list:
   List all local vcsh repositories.
 
 * init:
   Initialize an empty 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.
 * 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.


@@ -60,6 +74,12 @@ A sample configuration for `vcsh` and `mr` can be found at
 * seed-gitignore:
   Seed .gitignore.d/<repo> from git ls-files.
 
 * 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
 ## ENVIRONMENT
 
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the