Merge branch 'master' of github.com:RichiH/vcsh

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 744a0b3c81bf50b6f4c0a519b4f4bd661e4f8ce0..0ea94286e26fc64ca2e8b4637dbd9b3976031b41 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,11 +3,11 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
-`vcsh` clone <url> [<location>]
+`vcsh` clone <url> [<repo>]
 
-`vcsh` delete
+`vcsh` delete <repo>
 
-`vcsh` exit
+`vcsh` enter <repo>
 
 `vcsh` help
 
@@ -15,11 +15,13 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` list
 
+`vcsh` rename <repo> <newname>
+
 `vcsh` run <repo> <command>
 
-`vcsh` seed-gitignore
+`vcsh` seed-gitignore <repo>
 
-`vcsh` use <repo>
+`vcsh` setup <repo>
 
 `vcsh` <repo> <gitcommand>
 
@@ -42,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:
@@ -50,8 +56,8 @@ A sample configuration for `vcsh` and `mr` can be found at
 * delete:
   Delete an existing repository.
 
-* exit:
-  Exit repository; unset ENV
+* enter:
+  Enter repository; spawn new <$SHELL>.
 
 * help:
   Display help.
@@ -62,15 +68,25 @@ A sample configuration for `vcsh` and `mr` can be found at
 * 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.
 
+  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.
 
-* use:
-  Use repository; set ENV
+* setup:
+  Set up repository with recommended settings.
 
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.