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

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