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