]> 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:

Add license information, all authors to date agreed upon GPL 2+
[code/vcsh.git] / doc / vcsh.1.ronn
index 270537785fd99bd5eda6601d1aa1186c2a189323..67557682bd3dc6690d64f6597cb2cb8a284b0351 100644 (file)
@@ -3,17 +3,34 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
 
 ## SYNOPSIS
 
-`vcsh` init <foo>
+`vcsh` clone <url> [<repo>]
 
 
-`vcsh` clone <url> [<location>]
+`vcsh` delete <repo>
 
 
-`vcsh` run <foo> git command
+`vcsh` enter <repo>
+
+`vcsh` help
+
+`vcsh` init <repo>
 
 `vcsh` list
 
 
 `vcsh` list
 
-`vcsh` seed-gitignore
+`vcsh` list-tracked
+
+`vcsh` list-tracked-by <repo>
+
+`vcsh` rename <repo> <newname>
+
+`vcsh` run <repo> <command>
+
+`vcsh` setup <repo>
+
+`vcsh` write-gitignore <repo>
+
+`vcsh` <repo> <gitcommand>
+
+`vcsh` <repo>
 
 
-`vcsh` help
 
 ## DESCRIPTION
 
 
 ## DESCRIPTION
 
@@ -33,26 +50,61 @@ 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
 
 ## OPTIONS
 
+* clone:
+  Clone an existing repository.
+
+* delete:
+  Delete an existing repository.
+
+* enter:
+  Enter repository; spawn new <$SHELL>.
+
+* help:
+  Display help.
+
 * init:
   Initialize an empty repository.
 
 * init:
   Initialize an empty repository.
 
-* clone:
-  Clone an existing repository.
+* 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.
 
-* list:
-  List all local vcsh repositories.
+  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.
 
 
-* seed-gitignore:
-  Seed .gitignore.d/<repo> from git ls-files.
+* setup:
+  Set up repository with recommended settings.
 
 
-* help:
-  Display help.
+* 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
 
 
 ## ENVIRONMENT