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