X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/2a61549feb63117b5ffaa6fef5f80feb293b3dbe..034e25b7c4de8e60676f9a9ed7cd085a083083a9:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 2705377..6755768 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -3,17 +3,34 @@ vcsh(1) - manage and sync config files via git ## SYNOPSIS -`vcsh` init +`vcsh` clone [] -`vcsh` clone [] +`vcsh` delete -`vcsh` run git command +`vcsh` enter + +`vcsh` help + +`vcsh` init `vcsh` list -`vcsh` seed-gitignore +`vcsh` list-tracked + +`vcsh` list-tracked-by + +`vcsh` rename + +`vcsh` run + +`vcsh` setup + +`vcsh` write-gitignore + +`vcsh` + +`vcsh` -`vcsh` help ## 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* +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. + +* delete: + Delete an existing repository. + +* enter: + Enter repository; spawn new <$SHELL>. + +* help: + Display help. + * 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. -* list: - List all local vcsh repositories. + 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. -* help: - Display help. +* write-gitignore: + Write .gitignore.d/ via git ls-files. + +* : + Shortcut to run `vcsh` on a repo. Will prepend `git` to by itself. + +* : + Shortcut to run `vcsh enter `. ## ENVIRONMENT