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