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

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