doc/vcsh.1.ronn

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