README.md: Add Travis CI build state

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index f82a8776940167d6d13073906a7d743035c0f02c..cd73ca8b04a8d2cb0d365c552d26965d6ab09983 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -5,7 +5,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` [<options>] <command>
 
 
 `vcsh` [<options>] <command>
 

-`vcsh` clone <url> [<repo>]
+`vcsh` clone [-b <branch>] <url> [<repo>]

 
 `vcsh` delete <repo>
 
 
 `vcsh` delete <repo>
 


@@ -17,9 +17,7 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` list
 
 
 `vcsh` list
 

-`vcsh` list-tracked
-
-`vcsh` list-tracked-by <repo>
+`vcsh` list-tracked [<repo>]

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


@@ -88,6 +86,9 @@ an interactive user.
   If you need to clone a bundle of repositories, look into the
   `post-clone-retired` hook.
 
   If you need to clone a bundle of repositories, look into the
   `post-clone-retired` hook.
 

+  You can also use a single git repository with several branches. Use the `-b`
+  option to specify a branch at clone time, the default is `master`.
+

 * commit:
   Commit in all repositories
 
 * commit:
   Commit in all repositories
 


@@ -109,9 +110,14 @@ an interactive user.
 * list-tracked:
   List all files tracked by vcsh.
 
 * 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.
 
 * 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.
 
 * list-untracked:
   List all files NOT tracked by vcsh.
 


@@ -266,6 +272,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.
 
 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.
 ## DETAILED HOWTO AND FURTHER READING
 
 Manpages are often short and sometimes useless to glean best practices from.