X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/11c5bff1b54788729e2e6885b27c8a04eb92136f..daa46bd203cd55fde09383f0c8c13440853d7ef7:/doc/vcsh.1.ronn?ds=inline diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index 4ec9548..d5f0705 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -1,5 +1,5 @@ -vcsh(1) - manage config files in $HOME via fake bare git repositories -===================================================================== +vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME +=============================================================================== ## SYNOPSIS @@ -21,10 +21,16 @@ vcsh(1) - manage config files in $HOME via fake bare git repositories `vcsh` list-tracked-by +`vcsh` pull + +`vcsh` push + `vcsh` rename `vcsh` run +`vcsh` status + `vcsh` upgrade `vcsh` version @@ -45,7 +51,7 @@ working trees in $HOME without clobbering each other. That, in turn, means you can have one repository per config set (zsh, vim, ssh, etc), picking and choosing which configs you want to use on which machine. -`vcsh` is using a technique called fake bare git repositories, keeping <$GIT_DIR> +`vcsh` is using a technique called fake bare Git repositories, keeping <$GIT_DIR> in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>. The use of symlinks is not needed in this setup, making for a cleaner setup. @@ -77,6 +83,12 @@ an interactive user. * clone: Clone an existing repository. + If you need to clone a bundle of repositories, look into the + `post-clone-retired` hook. + +* commit: + Commit in all repositories + * delete: Delete an existing repository. @@ -98,6 +110,12 @@ an interactive user. * list-tracked-by: List files tracked by a repository. +* pull: + Pull from all vcsh remotes. + +* push: + Push to all vcsh remotes. + * rename: Rename a repository. @@ -112,6 +130,9 @@ an interactive user. This is needed to support mr and other scripts properly and of no concern to an interactive user. +* status: + Show statuses of all vcsh repositories. + * upgrade: Upgrade repository to currently recommended settings. @@ -122,7 +143,7 @@ an interactive user. Find in name of any tracked file. * write-gitignore: - Write .gitignore.d/ via git ls-files. + Write .gitignore.d/ via `git ls-files`. * : Shortcut to run `vcsh` on a repo. Will prepend `git` to . @@ -133,7 +154,7 @@ an interactive user. ## ENVIRONMENT As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the -appropriate values for fake bare git repositories. +appropriate values for fake bare Git repositories. ## CONFIG @@ -151,11 +172,13 @@ executed in the context of your shell. Interesting knobs you can turn: * <$VCSH_GITIGNORE>: - Can be either or . + Can be , , or . - will seed the repo-specific <.gitignore> with all file and directory + will seed the repo-specific ignore file with all file and directory names which `git ls-files` returns. + will not write any ignore file. + will descend through all directories recursively additionally to the above. @@ -246,7 +269,7 @@ resulting in unhappy end users. Like most people, the author initially made do with a single repository for all config files, all of which were soft-linked into <$HOME>. -Martin F. Krafft aka madduck came up with the concept of fake bare git +Martin F. Krafft aka madduck came up with the concept of fake bare Git repositories. vcsh was initally written by madduck. This version is a re-implementation from @@ -259,7 +282,7 @@ This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann. ## COPYRIGHT -Copyright 2011-2012 Richard Hartmann +Copyright 2011-2013 Richard Hartmann Licensed under the GNU GPL version 2 or higher.