doc/vcsh.1.ronn

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