]> 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:

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