Revert "t/100-init.t: Fix failure due to locale"

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

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index e76888258c46a0bf9f66c67096b0374b3ac6b96c..d5ee0dc53861d6346b74a64e8932d6e97c375076 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -11,15 +11,17 @@ vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
 
 `vcsh` enter <repo>
 
 
 `vcsh` enter <repo>
 

+`vcsh` foreach [-g] <git command>
+

 `vcsh` help
 
 `vcsh` init <repo>
 
 `vcsh` list
 
 `vcsh` help
 
 `vcsh` init <repo>
 
 `vcsh` list
 

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

 
 

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

 
 `vcsh` pull
 
 
 `vcsh` pull
 


@@ -98,6 +100,11 @@ an interactive user.
 * enter:
   Enter repository; spawn new <$SHELL>.
 
 * enter:
   Enter repository; spawn new <$SHELL>.
 

+* foreach:
+  Execute git command for every vcsh repository.
+
+  `-g`: Execute in general context.
+

 * help:
   Display help.
 
 * help:
   Display help.
 


@@ -110,9 +117,26 @@ 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.
+
+  `-a`: Show all files.
+  By default, the `git ls-files --exclude-standard` is called.
+
+  `-r`: Recursive mode.
+  By default, the file list is shallow and stops at directory levels where
+  possible.
+
+  `$repo`: List files not tracked by this specific repository.
+

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


@@ -257,6 +281,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.


@@ -306,7 +348,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
 
 ## COPYRIGHT
 
 
 ## COPYRIGHT
 

-Copyright 2011-2013 Richard Hartmann <richih@debian.org>
+Copyright 2011-2015 Richard Hartmann <richih@debian.org>

 
 Licensed under the GNU GPL version 2 or higher.
 
 
 Licensed under the GNU GPL version 2 or higher.