X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/9fe9f7d5a182830bf4c71e2c1143cbba9ff12488..c1ec3331f1246f76261c9d41ee2a23b7557c83da:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 2b5cb36..77e3fec 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -3,19 +3,33 @@ vcsh(1) - manage and sync config files via git ## SYNOPSIS -`vcsh` clone [] +`vcsh` clone [] -`vcsh` help +`vcsh` delete + +`vcsh` enter -`vcsh` delete +`vcsh` help -`vcsh` init +`vcsh` init `vcsh` list -`vcsh` run git command +`vcsh` list-tracked + +`vcsh` list-tracked-by + +`vcsh` rename + +`vcsh` run -`vcsh` seed-gitignore +`vcsh` seed-gitignore + +`vcsh` setup + +`vcsh` + +`vcsh` ## DESCRIPTION @@ -36,30 +50,62 @@ 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 . +This is needed to support mr and other scripts properly and of no concern to +an interactive user. + ## OPTIONS * clone: Clone an existing repository. -* help: - Display help. - * delete: Delete an existing repository. +* enter: + Enter repository; spawn new <$SHELL>. + +* help: + Display help. + * init: Initialize an empty 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. + Please note that there is a somewhat magic feature for run. Instead of + it accepts , 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/ from git ls-files. +* setup: + Set up repository with recommended settings. + +* : + Shortcut to run `vcsh` on a repo. Will prepend `git` to by itself. + +* : + Shortcut to run `vcsh enter `. + ## ENVIRONMENT As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the