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

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