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.
1 vcsh(1) - manage config files in $HOME via fake bare git repositories
2 =====================================================================
6 `vcsh` clone <url> [<repo>]
20 `vcsh` list-tracked-by <repo>
22 `vcsh` rename <repo> <newname>
24 `vcsh` run <repo> <command>
28 `vcsh` write-gitignore <repo>
30 `vcsh` <repo> <gitcommand>
37 `vcsh` allows you to have several `git`(1) repositories, all maintaining their
38 working trees in $HOME without clobbering each other. That, in turn, means you
39 can have one repository per config set (zsh, vim, ssh, etc), picking and
40 choosing which configs you want to use on which machine.
42 `vcsh` is using a technique called fake bare git repositories, keeping <$GIT_DIR>
43 in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>.
45 The use of symlinks is not needed in this setup, making for a cleaner setup.
47 `vcsh` was designed with `mr`(1) in mind so you might want to install it alongside
48 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
50 A sample configuration for `vcsh` and `mr` can be found at
51 *https://github.com/RichiH/vcsh_mr_template*
53 Please note that you can always use a path instead of a name for <repo>.
54 This is needed to support mr and other scripts properly and of no concern to
60 Clone an existing repository.
63 Delete an existing repository.
66 Enter repository; spawn new <$SHELL>.
72 Initialize an empty repository.
75 List all local vcsh repositories.
78 List all files tracked by vcsh.
81 List files tracked by a repository.
87 Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
88 and all commands without any restrictions. Use with care.
90 Please note that there is a somewhat magic feature for run. Instead of <repo>
91 it accepts <path>, as well. Anything that has a slash in it will be assumed to
92 be a path. `vcsh run` will then operate on this directory instead of the one
93 normally generated from the repository's name.
94 This is needed to support mr and other scripts properly and of no concern to
98 Set up repository with recommended settings.
101 Write .gitignore.d/<repo> via git ls-files.
103 * <repo> <gitcommand>:
104 Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
107 Shortcut to run `vcsh enter <repo>`.
111 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
112 appropriate values for fake bare git repositories.
114 ## SECURITY CONSIDERATIONS
116 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
117 speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
121 None are known at this time, but reports and/or patches are more than welcome.
125 Like most people, the author initially made do with a single repository for all
126 config files, all of which were soft-linked into <$HOME>.
128 Martin F. Krafft aka madduck came up with the concept of fake bare git
131 vcsh was initally written by madduck. This version is a re-implementation from
132 scratch with a lot more features. madduck graciously agreed to let the author
137 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
141 Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
143 Licensed under the GNU GPL version 3 or higher.
145 https://github.com/RichiH/vcsh