Skip to content
Snippets Groups Projects
Commit 10c7871c authored by Richard Hartmann's avatar Richard Hartmann
Browse files

Update manpage

* Refer to README.md
* Add note about config file being a potential security issue
parent 3768fe91
No related branches found
No related tags found
No related merge requests found
...@@ -111,10 +111,22 @@ an interactive user. ...@@ -111,10 +111,22 @@ an interactive user.
As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
appropriate values for fake bare git repositories. 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 ## SECURITY CONSIDERATIONS
`vcsh` allows you to execute arbitrary commands via `vcsh` run. For example, `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 ## BUGS
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment