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