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