Make Makefile not install INSTALL.md

[code/vcsh.git] / doc / vcsh.1.ronn

diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index 015e76ed573ffc8acedd1e1ff22f02282fd95f8f..9e37ca131314f2e648278e35d0366c9c94439855 100644 (file)
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -1,13 +1,13 @@
-vcsh(1) - manage and sync config files via git
-==============================================
+vcsh(1) - manage config files in $HOME via fake bare git repositories
+=====================================================================

 
 ## SYNOPSIS
 
 
 ## SYNOPSIS
 

-`vcsh` clone <url> [<location>]
+`vcsh` clone <url> [<repo>]

 
 `vcsh` delete <repo>
 
 
 `vcsh` delete <repo>
 

-`vcsh` exit
+`vcsh` enter <repo>

 
 `vcsh` help
 
 
 `vcsh` help
 


@@ -15,14 +15,22 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` list
 
 
 `vcsh` list
 

+`vcsh` list-tracked
+
+`vcsh` list-tracked-by <repo>
+
+`vcsh` rename <repo> <newname>
+

 `vcsh` run <repo> <command>
 
 `vcsh` run <repo> <command>
 

-`vcsh` seed-gitignore <repo>
+`vcsh` setup <repo>

 
 

-`vcsh` use <repo>
+`vcsh` write-gitignore <repo>

 
 `vcsh` <repo> <gitcommand>
 
 
 `vcsh` <repo> <gitcommand>
 

+`vcsh` <repo>
+

 
 ## DESCRIPTION
 
 
 ## DESCRIPTION
 


@@ -42,6 +50,10 @@ vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
 A sample configuration for `vcsh` and `mr` can be found at
 *https://github.com/RichiH/vcsh_mr_template*
 
 A sample configuration for `vcsh` and `mr` can be found at
 *https://github.com/RichiH/vcsh_mr_template*
 

+Please note that you can always use a path instead of a name for <repo>.
+This is needed to support mr and other scripts properly and of no concern to
+an interactive user.
+

 ## OPTIONS
 
 * clone:
 ## OPTIONS
 
 * clone:


@@ -50,8 +62,8 @@ A sample configuration for `vcsh` and `mr` can be found at
 * delete:
   Delete an existing repository.
 
 * delete:
   Delete an existing repository.
 

-* exit:
-  Exit repository; unset ENV
+* enter:
+  Enter repository; spawn new <$SHELL>.

 
 * help:
   Display help.
 
 * help:
   Display help.


@@ -62,28 +74,59 @@ A sample configuration for `vcsh` and `mr` can be found at
 * list:
   List all local vcsh repositories.
 
 * list:
   List all local vcsh repositories.
 

+* list-tracked:
+  List all files tracked by vcsh.
+
+* list-tracked-by:
+  List files tracked by a repository.
+
+* rename:
+  Rename a repository.
+

 * run:
   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
   and all commands without any restrictions. Use with care.
 
 * run:
   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
   and all commands without any restrictions. Use with care.
 

-* seed-gitignore:
-  Seed .gitignore.d/<repo> from git ls-files.
+  Please note that there is a somewhat magic feature for run. Instead of <repo>
+  it accepts <path>, as well. Anything that has a slash in it will be assumed to
+  be a path. `vcsh run` will then operate on this directory instead of the one
+  normally generated from the repository's name.
+  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.

 
 

-* use:
-  Use repository; set ENV
+* 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> <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.
 
 ## 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,
 ## 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
 
 
 ## BUGS