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