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