diff --git a/vcsh.1 b/vcsh.1 index 9f8e6e222c5b1dcca049259e12118e13cf394400..9f2484227fed749eb88fb450ca1b8d0e8d63e322 100644 --- a/vcsh.1 +++ b/vcsh.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "VCSH" "1" "May 2014" "" "" +.TH "VCSH" "1" "October 2014" "" "" . .SH "NAME" \fBvcsh\fR \- Version Control System for $HOME \- multiple Git repositories in $HOME @@ -10,7 +10,7 @@ \fBvcsh\fR [\fIoptions\fR] \fIcommand\fR . .P -\fBvcsh\fR clone \fIurl\fR [\fIrepo\fR] +\fBvcsh\fR clone [\-b \fIbranch\fR] \fIurl\fR [\fIrepo\fR] . .P \fBvcsh\fR delete \fIrepo\fR @@ -28,10 +28,10 @@ \fBvcsh\fR list . .P -\fBvcsh\fR list\-tracked +\fBvcsh\fR list\-tracked [\fIrpoe\fR] . .P -\fBvcsh\fR list\-tracked\-by \fIrepo\fR +\fBvcsh\fR list\-untracked [\fI\-r\fR] [\fIrepo\fR] . .P \fBvcsh\fR pull @@ -107,6 +107,9 @@ Clone an existing repository\. .IP If you need to clone a bundle of repositories, look into the \fBpost\-clone\-retired\fR hook\. . +.IP +You can also use a single git repository with several branches\. Use the \fB\-b\fR option to specify a branch at clone time, the default is \fBmaster\fR\. +. .TP commit Commit in all repositories @@ -135,10 +138,26 @@ List all local vcsh repositories\. list\-tracked List all files tracked by vcsh\. . +.IP +If you want to list files tracked by a specific repository, simply append the repository\'s name last\. +. .TP list\-tracked\-by List files tracked by a repository\. . +.IP +This is a legacy command; you should use \fBlist\-tracked <repo>\fR instead\. +. +.TP +list\-untracked +List all files NOT tracked by vcsh\. +. +.IP +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 \fB\-r\fR for recursive mode\. +. +.IP +If you want to list files not tracked by a specific repository, simply append the repository\'s name last\. +. .TP pull Pull from all vcsh remotes\. @@ -301,6 +320,18 @@ If you want to create hooks for a specific \fIvcsh\fR repository, simply prepend .P Available hooks are \fIpre\-clone\fR, \fIpost\-clone\fR, \fIpost\-clone\-retired\fR, \fIpre\-command\fR, \fIpost\-command\fR, \fIpre\-enter\fR, \fIpost\-enter\fR, \fIpre\-init\fR, \fIpost\-init\fR, \fIpre\-pull\fR, \fIpost\-pull\fR, \fIpre\-push\fR, \fIpost\-push\fR, \fIpre\-run\fR, \fIpost\-run\fR, \fIpre\-upgrade\fR, and \fIpost\-upgrade\fR\. If you need more, vcsh is trivial to patch, but please let upstream know so we can ship them by default\. . +.SH "OVERLAY SYSTEM" +\fBvcsh\fR 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>\. +. +.P +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>\. +. +.P +Please note that nothing stops you from, e\.g\. overwriting \fBstatus()\fR 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\. +. +.P +You have been warned\. +. .SH "DETAILED HOWTO AND FURTHER READING" Manpages are often short and sometimes useless to glean best practices from\. While the author tried to avoid this in this case, manpages can not cover detailed howtos\. .