X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/09eef208e8d62408b0b7a1fd5d4cb04715b49358..7161ee4adc3f462f20ab9b55404ecf6968f2753f:/doc/vcsh.1.ronn?ds=sidebyside

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 2d0a7ab..c91f646 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -17,11 +17,9 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` list
 
-`vcsh` list-tracked
+`vcsh` list-tracked [<rpoe>]
 
-`vcsh` list-tracked-by <repo>
-
-`vcsh` list-untracked
+`vcsh` list-untracked [<-r>] [<repo>]
 
 `vcsh` pull
 
@@ -109,9 +107,14 @@ an interactive user.
 * list-tracked:
   List all files tracked by vcsh.
 
+  If you want to list files tracked by a specific repository, simply
+  append the repository's name last.
+
 * list-tracked-by:
   List files tracked by a repository.
 
+  This is a legacy command; you should use `list-tracked <repo>` instead.
+
 * list-untracked:
   List all files NOT tracked by vcsh.
 
@@ -119,6 +122,9 @@ an interactive user.
   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.
 
@@ -263,6 +269,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.