doc/vcsh.1.ronn

   1 vcsh(1) - manage config files in $HOME via fake bare git repositories
   2 =====================================================================
   3
   4 ## SYNOPSIS
   5
   6 `vcsh` clone <url> [<repo>]
   7
   8 `vcsh` delete <repo>
   9
  10 `vcsh` enter <repo>
  11
  12 `vcsh` help
  13
  14 `vcsh` init <repo>
  15
  16 `vcsh` list
  17
  18 `vcsh` list-tracked
  19
  20 `vcsh` list-tracked-by <repo>
  21
  22 `vcsh` rename <repo> <newname>
  23
  24 `vcsh` run <repo> <command>
  25
  26 `vcsh` setup <repo>
  27
  28 `vcsh` write-gitignore <repo>
  29
  30 `vcsh` <repo> <gitcommand>
  31
  32 `vcsh` <repo>
  33
  34
  35 ## DESCRIPTION
  36
  37 `vcsh` allows you to have several `git`(1) repositories, all maintaining their
  38 working trees in $HOME without clobbering each other. That, in turn, means you
  39 can have one repository per config set (zsh, vim, ssh, etc), picking and
  40 choosing which configs you want to use on which machine.
  41
  42 `vcsh` is using a technique called fake bare git repositories, keeping <$GIT_DIR>
  43 in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>.
  44
  45 The use of symlinks is not needed in this setup, making for a cleaner setup.
  46
  47 `vcsh` was designed with `mr`(1) in mind so you might want to install it alongside
  48 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
  49
  50 A sample configuration for `vcsh` and `mr` can be found at
  51 *https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone
  52 https://github.com/RichiH/vcsh_mr_template mr`.
  53
  54 Please note that you can always use a path instead of a name for <repo>.
  55 This is needed to support mr and other scripts properly and of no concern to
  56 an interactive user.
  57
  58 ## OPTIONS
  59
  60 * clone:
  61   Clone an existing repository.
  62
  63 * delete:
  64   Delete an existing repository.
  65
  66 * enter:
  67   Enter repository; spawn new <$SHELL>.
  68
  69 * help:
  70   Display help.
  71
  72 * init:
  73   Initialize an empty repository.
  74
  75 * list:
  76   List all local vcsh repositories.
  77
  78 * list-tracked:
  79   List all files tracked by vcsh.
  80
  81 * list-tracked-by:
  82   List files tracked by a repository.
  83
  84 * rename:
  85   Rename a repository.
  86
  87 * run:
  88   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
  89   and all commands without any restrictions. Use with care.
  90
  91   Please note that there is a somewhat magic feature for run. Instead of <repo>
  92   it accepts <path>, as well. Anything that has a slash in it will be assumed to
  93   be a path. `vcsh run` will then operate on this directory instead of the one
  94   normally generated from the repository's name.
  95   This is needed to support mr and other scripts properly and of no concern to
  96   an interactive user.
  97
  98 * setup:
  99   Set up repository with recommended settings.
 100
 101 * write-gitignore:
 102   Write .gitignore.d/<repo> via git ls-files.
 103
 104 * <repo> <gitcommand>:
 105   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
 106
 107 * <repo>:
 108   Shortcut to run `vcsh enter <repo>`.
 109
 110 ## ENVIRONMENT
 111
 112 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
 113 appropriate values for fake bare git repositories.
 114
 115 ## HOOK SYSTEM
 116
 117 `vcsh` provides a hook system. Hook scripts must be executable and should be
 118 placed in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they can be
 119 soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
 120 execute hooks that are in this directory.
 121
 122 Hooks follow a simple format. <pre-run> will be run before anything is run.
 123 If you want to have more than one script for a certain hook, just append
 124 any kind of string to order them. A system of <pre-run>, <pre-run.10>,
 125 <pre-run.20> etc is suggested; other options would be <pre-run-10> or
 126 <pre-run.sh>. A dot after the hook name is optional.
 127
 128 If you want to create hooks for a specific <vcsh> repository, simply prepend
 129 the repository's name, followed by a dot, i.e. <zsh.pre-run>. Otherwise, the
 130 same rules as above apply. The dot between the repository's name and the hook
 131 is mandatory, though.
 132
 133 Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,
 134 <pre-setup>, and <post-setup>. If you need more, vcsh is trivial to patch,
 135 but please let upstream know so we can ship them by default.
 136
 137 ## DETAILED HOWTO AND FURTHER READING
 138
 139 Man pages are intended to be short and thus often useless to glean best
 140 practices from. This software comes with a file called <README.md>. It contains
 141 various approaches to setting up and using vcsh. You can view the file it as
 142 plain text or render it into various other formats via Markdown.
 143
 144 On Debian-based systems, this file can be found in </usr/share/doc/vcsh>.
 145
 146 ## SECURITY CONSIDERATIONS
 147
 148 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
 149 adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
 150
 151 Additionally, vcsh will source, i.e. execute, <$XDG_CONFIG_HOME/vcsh/config>.
 152 You can put any and all commands into this config file and they will be executed.
 153
 154 ## BUGS
 155
 156 None are known at this time, but reports and/or patches are more than welcome.
 157
 158 ## HISTORY
 159
 160 Like most people, the author initially made do with a single repository for all
 161 config files, all of which were soft-linked into <$HOME>.
 162
 163 Martin F. Krafft aka madduck came up with the concept of fake bare git
 164 repositories.
 165
 166 vcsh was initally written by madduck. This version is a re-implementation from
 167 scratch with a lot more features. madduck graciously agreed to let the author
 168 take over the name.
 169
 170 ## AUTHOR
 171
 172 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
 173
 174 ## COPYRIGHT
 175
 176 Copyright 2011-2012 Richard Hartmann <richih.mailinglist@gmail.com>
 177
 178 Licensed under the GNU GPL version 3 or higher.
 179
 180 https://github.com/RichiH/vcsh
 181
 182 ## SEE ALSO
 183
 184 `git`(1), `mr`(1)