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