vcsh: Allow `vcsh list-untracked <repo>`

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 56df4ed26e74cdbb7a4109056b8415570843d846..f82a8776940167d6d13073906a7d743035c0f02c 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -21,6 +21,8 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` list-tracked-by <repo>
 
 
 `vcsh` list-tracked-by <repo>
 

+`vcsh` list-untracked [<-r>] [<repo>]
+

 `vcsh` pull
 
 `vcsh` push
 `vcsh` pull
 
 `vcsh` push


@@ -110,6 +112,16 @@ an interactive user.
 * list-tracked-by:
   List files tracked by a repository.
 
 * list-tracked-by:
   List files tracked by a repository.
 

+* list-untracked:
+  List all files NOT tracked by vcsh.
+
+  By default, the file list is shallow and stops at directory levels where
+  possible. If you prefer to get a list of all files, append `-r` for
+  recursive mode.
+
+  If you want to list files not tracked by a specific repository, simply
+  append the repository's name last.
+

 * pull:
   Pull from all vcsh remotes.
 
 * pull:
   Pull from all vcsh remotes.
 


@@ -171,6 +183,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>.