]> 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 docs for list-tracked and list-tracked-by
[code/vcsh.git] / doc / vcsh.1.ronn
index 744a0b3c81bf50b6f4c0a519b4f4bd661e4f8ce0..e434b3c0f732e4b03e8d66c70173bf6ad16dc68c 100644 (file)
@@ -3,11 +3,11 @@ vcsh(1) - manage and sync config files via git
 
 ## SYNOPSIS
 
-`vcsh` clone <url> [<location>]
+`vcsh` clone <url> [<repo>]
 
-`vcsh` delete
+`vcsh` delete <repo>
 
-`vcsh` exit
+`vcsh` enter <repo>
 
 `vcsh` help
 
@@ -15,11 +15,17 @@ vcsh(1) - manage and sync config files via git
 
 `vcsh` list
 
+`vcsh` list-tracked
+
+`vcsh` list-tracked-by <repo>
+
+`vcsh` rename <repo> <newname>
+
 `vcsh` run <repo> <command>
 
-`vcsh` seed-gitignore
+`vcsh` seed-gitignore <repo>
 
-`vcsh` use <repo>
+`vcsh` setup <repo>
 
 `vcsh` <repo> <gitcommand>
 
@@ -42,6 +48,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*
 
+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:
@@ -50,8 +60,8 @@ A sample configuration for `vcsh` and `mr` can be found at
 * delete:
   Delete an existing repository.
 
-* exit:
-  Exit repository; unset ENV
+* enter:
+  Enter repository; spawn new <$SHELL>.
 
 * help:
   Display help.
@@ -62,15 +72,31 @@ A sample configuration for `vcsh` and `mr` can be found at
 * 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.
 
+  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.
 
-* use:
-  Use repository; set ENV
+* setup:
+  Set up repository with recommended settings.
 
 * <repo> <gitcommand>:
   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.