Update setup() to only add .gitignore/$repo if it exists

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 3ee97a469227f40c74f09ab6133ed6e236f5ffcb..e06c5f901a8a889c36e129ca755d4ae3ee2637a9 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -9,22 +9,20 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` enter <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` setup <repo>
 
 `vcsh` run <repo> <command>
 
 `vcsh` seed-gitignore <repo>
 
 `vcsh` setup <repo>
 

-`vcsh` use <repo>
-

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


@@ -57,9 +55,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.
 


@@ -69,19 +64,26 @@ 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.
 
 * setup:
   Set up repository with recommended settings.
 
 * seed-gitignore:
   Seed .gitignore.d/<repo> from git ls-files.
 
 * setup:
   Set up repository with recommended settings.
 

-* use:
-  Use repository; set ENV.
-

 * <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.