Add recursive option (-r)

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index a1982317097d01df21cc2dd4a3ce2d598cf4eb1a..05da4fad8bfe18dce47ab8aaa2c3dc9f9c619275 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -29,7 +29,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` run <repo> <shell command>
 
 
 `vcsh` run <repo> <shell command>
 

-`vcsh` status
+`vcsh` status [<repo>]

 
 `vcsh` upgrade <repo>
 
 
 `vcsh` upgrade <repo>
 


@@ -131,7 +131,7 @@ an interactive user.
   an interactive user.
 
 * status:
   an interactive user.
 
 * status:

-  Show statuses of all vcsh repositories.
+  Show statuses of all/one vcsh repositories.

 
 * upgrade:
   Upgrade repository to currently recommended settings.
 
 * upgrade:
   Upgrade repository to currently recommended settings.


@@ -171,6 +171,15 @@ executed in the context of your shell.
 
 Interesting knobs you can turn:
 
 
 Interesting knobs you can turn:
 

+* <$VCSH_GITATTRIBUTES>:
+  Can be <none>, or any other value.
+
+  <none> will not maintain Git attributes in a special location.
+
+  If set to any other value, repo-specific gitattributes files will be maintained.
+
+  Defaults to <none>.
+

 * <$VCSH_GITIGNORE>:
   Can be <exact>, <none>, or <recursive>.
 
 * <$VCSH_GITIGNORE>:
   Can be <exact>, <none>, or <recursive>.
 


@@ -184,6 +193,15 @@ Interesting knobs you can turn:
 
   Defaults to <exact>.
 
 
   Defaults to <exact>.
 

+* <$VCSH_VCSH_WORKTREE>:
+  Can be <absolute>, or <relative>.
+
+  <absolute> will set an absolute path; defaulting to <$HOME>.
+
+  <relative> will set a path relative to <$GIT_DIR>.
+
+  Defaults to <absolute>.
+

 Less interesting knobs you could turn:
 
 * <$VCSH_DEBUG>:
 Less interesting knobs you could turn:
 
 * <$VCSH_DEBUG>: