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