]> git.madduck.net Git - code/vcsh.git/blob - 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:

ee13b7f4005d5b34360fd14980a6606511eb0db1
[code/vcsh.git] / doc / vcsh.1.ronn
1 vcsh(1) - Version Control System for $HOME - multiple Git repositories in $HOME
2 ===============================================================================
3
4 ## SYNOPSIS
5
6 `vcsh` [<options>] <command>
7
8 `vcsh` clone <url> [<repo>]
9
10 `vcsh` delete <repo>
11
12 `vcsh` enter <repo>
13
14 `vcsh` help
15
16 `vcsh` init <repo>
17
18 `vcsh` list
19
20 `vcsh` list-tracked
21
22 `vcsh` list-tracked-by <repo>
23
24 `vcsh` pull
25
26 `vcsh` push
27
28 `vcsh` rename <repo> <newname>
29
30 `vcsh` run <repo> <shell command>
31
32 `vcsh` upgrade <repo>
33
34 `vcsh` version
35
36 `vcsh` which <substring>
37
38 `vcsh` write-gitignore <repo>
39
40 `vcsh` <repo> <git command>
41
42 `vcsh` <repo>
43
44
45 ## DESCRIPTION
46
47 `vcsh` allows you to have several `git`(1) repositories, all maintaining their
48 working trees in $HOME without clobbering each other. That, in turn, means you
49 can have one repository per config set (zsh, vim, ssh, etc), picking and
50 choosing which configs you want to use on which machine.
51
52 `vcsh` is using a technique called fake bare Git repositories, keeping <$GIT_DIR>
53 in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>.
54
55 The use of symlinks is not needed in this setup, making for a cleaner setup.
56
57 `vcsh` was designed with `mr`(1) in mind so you might want to install it alongside
58 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
59
60 A sample configuration for `vcsh` and `mr` can be found at
61 *https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone
62 https://github.com/RichiH/vcsh_mr_template mr`.
63
64 Please note that you can always use a path instead of a name for <repo>.
65 This is needed to support mr and other scripts properly and of no concern to
66 an interactive user.
67
68 ## OPTIONS
69
70 * -c:
71   Source <file> prior to other configuration files
72
73 * -d:
74   Enable debug mode
75
76 * -v:
77   Enable verbose mode
78
79 ## COMMANDS
80
81 * clone:
82   Clone an existing repository.
83
84 * delete:
85   Delete an existing repository.
86
87 * enter:
88   Enter repository; spawn new <$SHELL>.
89
90 * help:
91   Display help.
92
93 * init:
94   Initialize an empty repository.
95
96 * list:
97   List all local vcsh repositories.
98
99 * list-tracked:
100   List all files tracked by vcsh.
101
102 * list-tracked-by:
103   List files tracked by a repository.
104
105 * pull:
106   Pull from all vcsh remotes.
107
108 * push:
109   Push to all vcsh remotes.
110
111 * rename:
112   Rename a repository.
113
114 * run:
115   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
116   and all commands without any restrictions. Use with care.
117
118   Please note that there is a somewhat magic feature for run. Instead of <repo>
119   it accepts <path>, as well. Anything that has a slash in it will be assumed to
120   be a path. `vcsh run` will then operate on this directory instead of the one
121   normally generated from the repository's name.
122   This is needed to support mr and other scripts properly and of no concern to
123   an interactive user.
124
125 * upgrade:
126   Upgrade repository to currently recommended settings.
127
128 * version:
129   Print version information.
130
131 * which <substring>:
132   Find <substring> in name of any tracked file.
133
134 * write-gitignore:
135   Write .gitignore.d/<repo> via `git ls-files`.
136
137 * <repo> <gitcommand>:
138   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>.
139
140 * <repo>:
141   Shortcut to run `vcsh enter <repo>`.
142
143 ## ENVIRONMENT
144
145 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
146 appropriate values for fake bare Git repositories.
147
148 ## CONFIG
149
150 There are several ways to turn the various knobs on `vcsh`. In order of
151 ascending precedence, they are:
152
153 * `VARIABLE=foo vcsh`
154 * </etc/vcsh/config>
155 * <$XDG_CONFIG_HOME/vcsh/config>
156 * `vcsh -c <file>`
157
158 Please note that those files are sourced. Any and all commands will be
159 executed in the context of your shell.
160
161 Interesting knobs you can turn:
162
163 * <$VCSH_GITIGNORE>:
164   Can be either <exact> or <recursive>.
165
166   <exact> will seed the repo-specific <.gitignore> with all file and directory
167   names which `git ls-files` returns.
168
169   <recursive> will descend through all directories recursively additionally to
170   the above.
171
172   Defaults to <exact>.
173
174 Less interesting knobs you could turn:
175
176 * <$VCSH_DEBUG>:
177   Enter debug mode.
178
179 * <$XDG_CONFIG_HOME>:
180   As specified in the 'XDG Base Directory Specification', see
181   <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>
182
183   Defaults to <$HOME/.config>.
184
185 * <$VCSH_REPO_D>:
186   The directory where repositories are read from and stored.
187
188   Defaults to <$XDG_CONFIG_HOME/vcsh/repo.d>.
189
190 * <$VCSH_HOOK_D>:
191   The directory where hooks are read from.
192
193   Defaults to <$XDG_CONFIG_HOME/vcsh/hooks-enabled>.
194
195 * <$VCSH_BASE>:
196   The directory where repositories are checked out to.
197
198   Defaults to <$HOME>.
199
200
201 ## HOOK SYSTEM
202
203 `vcsh` provides a hook system. Hook scripts must be executable and should be
204 placed in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they can be
205 soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
206 execute hooks that are in this directory.
207
208 Hooks follow a simple format. <pre-run> will be run before anything is run.
209 If you want to have more than one script for a certain hook, just append
210 any kind of string to order them. A system of <pre-run>, <pre-run.10>,
211 <pre-run.20> etc is suggested; other options would be <pre-run-10> or
212 <pre-run.sh>. A dot after the hook name is optional.
213
214 If you want to create hooks for a specific <vcsh> repository, simply prepend
215 the repository's name, followed by a dot, i.e. <zsh.pre-run>. Otherwise, the
216 same rules as above apply. The dot between the repository's name and the hook
217 is mandatory, though.
218
219 Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,
220 <pre-upgrade>, and <post-upgrade>. If you need more, vcsh is trivial to patch,
221 but please let upstream know so we can ship them by default.
222
223 ## DETAILED HOWTO AND FURTHER READING
224
225 Manpages are often short and sometimes useless to glean best practices from.
226 While the author tried to avoid this in this case, manpages can not cover
227 detailed howtos.
228
229 This software also comes with a file called <README.md>. It contains various
230 approaches to setting up and using vcsh. You can view the file it as
231 plain text or render it into various other formats via Markdown.
232
233 On Debian-based systems, this file can be found in </usr/share/doc/vcsh>.
234
235 ## SECURITY CONSIDERATIONS
236
237 `vcsh` allows you to execute arbitrary commands via `vcsh run`. For example,
238 adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
239
240 Additionally, vcsh will source, i.e. execute, all files listed in <CONFIG>.
241 You can put any and all commands into these config files and they will be
242 executed.
243
244 ## BUGS
245
246 None are known at this time, but reports and/or patches are more than welcome.
247
248 ## INTEROPERABILITY
249
250 If you rely on `git submodule` use `git` 1.7.12 or later. Earlier versions
251 do not clean internal variables properly before descending into submodules,
252 resulting in unhappy end users.
253
254 ## HISTORY
255
256 Like most people, the author initially made do with a single repository for all
257 config files, all of which were soft-linked into <$HOME>.
258
259 Martin F. Krafft aka madduck came up with the concept of fake bare Git
260 repositories.
261
262 vcsh was initally written by madduck. This version is a re-implementation from
263 scratch with a lot more features. madduck graciously agreed to let the author
264 take over the name.
265
266 ## AUTHOR
267
268 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
269
270 ## COPYRIGHT
271
272 Copyright 2011-2013 Richard Hartmann <richih.mailinglist@gmail.com>
273
274 Licensed under the GNU GPL version 2 or higher.
275
276 https://github.com/RichiH/vcsh
277
278 ## SEE ALSO
279
280 `git`(1), `mr`(1)