doc/vcsh.1.ronn

   1 vcsh(1) - manage and sync config files via git
   2 ==============================================
   3
   4 ## SYNOPSIS
   5
   6 `vcsh` init <foo>
   7
   8 `vcsh` clone <url> [<location>]
   9
  10 `vcsh` run <foo> git command
  11
  12 `vcsh` list
  13
  14 `vcsh` help
  15
  16 ## DESCRIPTION
  17
  18 `vcsh` allows you to have several `git`(1) repositories, all maintaining their
  19 working trees in $HOME without clobbering each other. That, in turn, means you
  20 can have one repository per config set (zsh, vim, ssh, etc), picking and
  21 choosing which configs you want to use on which machine.
  22
  23 `vcsh` is using a technique called fake bare git repositories, keeping <$GIT_DIR>
  24 in a different directory from <$GIT_WORK_TREE> which is pointed to <$HOME>.
  25
  26 The use of symlinks is not needed in this setup, making for a cleaner setup.
  27
  28 `vcsh` was designed with `mr`(1) in mind so you might want to install it alongside
  29 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
  30
  31 A sample configuration for `vcsh` and `mr` can be found at
  32 *https://github.com/RichiH/vcsh_mr_template*
  33
  34 ## OPTIONS
  35
  36 * init:
  37   Initialize an empty repository
  38
  39 * clone:
  40   Clone an existing repository
  41
  42 * run:
  43   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
  44   and all commands without any restrictions. Use with care.
  45
  46 * list:
  47   List all local vcsh repositories
  48
  49 * help:
  50   Display help
  51
  52 ## ENVIRONMENT
  53
  54 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
  55 appropriate values for fake bare git repositories.
  56
  57 ## SECURITY CONSIDERATIONS
  58
  59 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
  60 speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
  61
  62 ## BUGS
  63
  64 None are known at this time, but reports and/or patches are more than welcome.
  65
  66 ## HISTORY
  67
  68 Like most people, the author initially made do with a single repository for all
  69 config files, all of which were soft-linked into <$HOME>.
  70
  71 Martin F. Krafft aka madduck came up with the concept of fake bare git
  72 repositories.
  73
  74 vcsh was initally written by madduck. This version is a re-implementation from
  75 scratch with a lot more features. madduck graciously agreed to let the author
  76 take over the name.
  77
  78 ## AUTHOR
  79
  80 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
  81
  82 ## COPYRIGHT
  83
  84 Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
  85
  86 Licensed under the GNU GPL version 3 or higher.
  87
  88 https://github.com/RichiH/vcsh
  89
  90 ## SEE ALSO
  91
  92 `git`(1), `mr`(1)