X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/807ddaaed8d86a117871c41895346f25f6f93890..980fcd4e555f9d7508db067b424aa84258c2ec83:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index efb5ba5..4ec9548 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -25,7 +25,9 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories `vcsh` run -`vcsh` setup +`vcsh` upgrade + +`vcsh` version `vcsh` which @@ -110,8 +112,11 @@ an interactive user. This is needed to support mr and other scripts properly and of no concern to an interactive user. -* setup: - Set up repository with recommended settings. +* upgrade: + Upgrade repository to currently recommended settings. + +* version: + Print version information. * which : Find in name of any tracked file. @@ -202,14 +207,17 @@ same rules as above apply. The dot between the repository's name and the hook is mandatory, though. Available hooks are , , , , -, and . If you need more, vcsh is trivial to patch, +, and . If you need more, vcsh is trivial to patch, but please let upstream know so we can ship them by default. ## DETAILED HOWTO AND FURTHER READING -Man pages are intended to be short and thus often useless to glean best -practices from. This software comes with a file called . It contains -various approaches to setting up and using vcsh. You can view the file it as +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. + +This software also comes with a file called . It contains various +approaches to setting up and using vcsh. You can view the file it as plain text or render it into various other formats via Markdown. On Debian-based systems, this file can be found in . @@ -229,8 +237,9 @@ None are known at this time, but reports and/or patches are more than welcome. ## INTEROPERABILITY -If you rely on `git submodule`, use `git` 1.7.12 or later. Earlier versions -do not clean internal variables properly before descending into a submodule. +If you rely on `git submodule` use `git` 1.7.12 or later. Earlier versions +do not clean internal variables properly before descending into submodules, +resulting in unhappy end users. ## HISTORY