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 71fbc6ac5a16104f593cd89d11c7d653c0c9dd22..0ea94286e26fc64ca2e8b4637dbd9b3976031b41 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,25 +3,25 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
 
 ## SYNOPSIS
 

-`vcsh` clone <url> [<location>]
+`vcsh` clone <url> [<repo>]

 
 `vcsh` delete <repo>
 
 `vcsh` enter <repo>
 
 
 `vcsh` delete <repo>
 
 `vcsh` enter <repo>
 

-`vcsh` exit
-

 `vcsh` help
 
 `vcsh` init <repo>
 
 `vcsh` list
 
 `vcsh` help
 
 `vcsh` init <repo>
 
 `vcsh` list
 

+`vcsh` rename <repo> <newname>
+

 `vcsh` run <repo> <command>
 
 `vcsh` seed-gitignore <repo>
 
 `vcsh` run <repo> <command>
 
 `vcsh` seed-gitignore <repo>
 

-`vcsh` use <repo>
+`vcsh` setup <repo>

 
 `vcsh` <repo> <gitcommand>
 
 
 `vcsh` <repo> <gitcommand>
 


@@ -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*
 
 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:
 ## OPTIONS
 
 * clone:


@@ -55,9 +59,6 @@ A sample configuration for `vcsh` and `mr` can be found at
 * enter:
   Enter repository; spawn new <$SHELL>.
 
 * enter:
   Enter repository; spawn new <$SHELL>.
 

-* exit:
-  Exit repository; unset ENV.
-

 * help:
   Display help.
 
 * help:
   Display help.
 


@@ -67,15 +68,25 @@ A sample configuration for `vcsh` and `mr` can be found at
 * list:
   List all local vcsh repositories.
 
 * 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.
 

+  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.
 
 * 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.
 
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.