X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/e3786815cbfb687f4fe6d6ac95ba8daa46e11db2..e4f0f9161a542e9c802e7d98b55119b6d3324ea1:/doc/vcsh.1.ronn

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index e434b3c..9e37ca1 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -1,5 +1,5 @@
-vcsh(1) - manage and sync config files via git
-==============================================
+vcsh(1) - manage config files in $HOME via fake bare git repositories
+=====================================================================
 
 ## SYNOPSIS
 
@@ -23,12 +23,14 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` run <repo> <command>
 
-`vcsh` seed-gitignore <repo>
-
 `vcsh` setup <repo>
 
+`vcsh` write-gitignore <repo>
+
 `vcsh` <repo> <gitcommand>
 
+`vcsh` <repo>
+
 
 ## DESCRIPTION
 
@@ -92,24 +94,39 @@ an interactive user.
   This is needed to support mr and other scripts properly and of no concern to
   an interactive user.
 
-* seed-gitignore:
-  Seed .gitignore.d/<repo> from git ls-files.
-
 * setup:
   Set up repository with recommended settings.
 
+* write-gitignore:
+  Write .gitignore.d/<repo> via git ls-files.
+
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
 
+* <repo>:
+  Shortcut to run `vcsh enter <repo>`.
+
 ## ENVIRONMENT
 
 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
 appropriate values for fake bare git repositories.
 
+## 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
+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>.
+
 ## SECURITY CONSIDERATIONS
 
 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
-speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
+adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
+
+Additionally, vcsh will source, i.e. execute, <$XDG_CONFIG_HOME/vcsh/config>.
+You can put any and all commands into this config file and they will be executed.
 
 ## BUGS