]> git.madduck.net Git - code/vcsh.git/blobdiff - doc/vcsh.1.ronn

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Remove extraneous space in getopt call
[code/vcsh.git] / doc / vcsh.1.ronn
index efb5ba5cdc19e671ba6c970bff6dd65ef68e0376..e12cf1599c175ee5c8c3be9b12a845a5e28a70e8 100644 (file)
@@ -27,6 +27,8 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories
 
 `vcsh` setup <repo>
 
+`vcsh` version
+
 `vcsh` which <substring>
 
 `vcsh` write-gitignore <repo>
@@ -113,6 +115,9 @@ an interactive user.
 * setup:
   Set up repository with recommended settings.
 
+* version:
+  Print version information.
+
 * which <substring>:
   Find <substring> in name of any tracked file.
 
@@ -207,9 +212,12 @@ 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 <README.md>. 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 <README.md>. 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 </usr/share/doc/vcsh>.
@@ -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