doc/vcsh.1.ronn

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