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

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