X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/a14137fd1d5f5ee32d38d5529d5e7bb471e97fb3..9d34717651df1d89b32257c5a74d7a16c955cbac:/doc/vcsh.1.ronn

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 56df4ed..9827d4f 100644
--- 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-untracked [<-r>] [<repo>]
+
 `vcsh` pull
 
 `vcsh` push
@@ -110,6 +112,16 @@ an interactive user.
 * 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.
 
@@ -171,6 +183,15 @@ executed in the context of your shell.
 
 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>.
 
@@ -245,6 +266,24 @@ Available hooks are <pre-clone>, <post-clone>, <post-clone-retired>,
 If you need more, vcsh is trivial to patch, but please let upstream know so
 we can ship them by default.
 
+## OVERLAY SYSTEM
+
+`vcsh` also provides an overlay system. Similar to hooks, the recommended
+locations are <$XDG_CONFIG_HOME/vcsh/overlays-available> and
+<$XDG_CONFIG_HOME/vcsh/overlays-enabled>.
+
+Overlays follow the same rules as hooks and you are free to overwrite any
+and all functions. Same as hooks, you can use global or repository-specific
+overlays by using either <$VCSH_OVERLAY_D/$VCSH_COMMAND> or
+<$VCSH_OVERLAY_D/$VCSH_REPO_NAME.$VCSH_COMMAND>.
+
+Please note that nothing stops you from, e.g. overwriting `status()` in
+<$VCSH_OVERLAY_D/commit>. As the overlays will be sourced and you are
+replacing arbitrary functions, any and all features may stop working, or you
+may even lose data.
+
+You have been warned.
+
 ## DETAILED HOWTO AND FURTHER READING
 
 Manpages are often short and sometimes useless to glean best practices from.