]> git.madduck.net Git - code/vcsh.git/blob - doc/vcsh.1.ronn

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

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