From: Richard Hartmann <richih.mailinglist@gmail.com>
Date: Tue, 27 Dec 2011 13:38:02 +0000 (+0100)
Subject: Update manpage
X-Git-Url: https://git.madduck.net/code/vcsh.git/commitdiff_plain/10c7871c75b7e5406ec2126ef372d9af9a9fa823?hp=3768fe91680ba80f5715edf19399261a2dd524aa

Update manpage

* Refer to README.md
* Add note about config file being a potential security issue
---

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index fbc961d..9e37ca1 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -111,10 +111,22 @@ an interactive user.
 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