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