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