]> 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:

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