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