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 541dba0bbffd394f0e16e64e17f87455040a74c3..744a0b3c81bf50b6f4c0a519b4f4bd661e4f8ce0 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -3,16 +3,27 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
-`vcsh` init <foo>
-
 `vcsh` clone <url> [<location>]
 
-`vcsh` run <foo> git command
+`vcsh` delete
 
-`vcsh` list
+`vcsh` exit
 
 `vcsh` help
 
+`vcsh` init <repo>
+
+`vcsh` list
+
+`vcsh` run <repo> <command>
+
+`vcsh` seed-gitignore
+
+`vcsh` use <repo>
+
+`vcsh` <repo> <gitcommand>
+
+
 ## DESCRIPTION
 
 `vcsh` allows you to have several `git`(1) repositories, all maintaining their
@@ -33,21 +44,36 @@ A sample configuration for `vcsh` and `mr` can be found at
 
 ## OPTIONS
 
+* clone:
+  Clone an existing repository.
+
+* delete:
+  Delete an existing repository.
+
+* exit:
+  Exit repository; unset ENV
+
+* help:
+  Display help.
+
 * init:
-  Initialize an empty repository
+  Initialize an empty repository.
 
-* clone:
-  Clone an existing repository
+* list:
+  List all local vcsh repositories.
 
 * 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
+* use:
+  Use repository; set ENV
+
+* <repo> <gitcommand>:
+  Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
 
 ## ENVIRONMENT