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

Re-arrange functions
[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 <repo>
9
10 `vcsh` enter <repo>
11
12 `vcsh` exit
13
14 `vcsh` help
15
16 `vcsh` init <repo>
17
18 `vcsh` list
19
20 `vcsh` run <repo> <command>
21
22 `vcsh` seed-gitignore <repo>
23
24 `vcsh` use <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 ## OPTIONS
48
49 * clone:
50   Clone an existing repository.
51
52 * delete:
53   Delete an existing repository.
54
55 * enter:
56   Enter repository; spawn new <$SHELL>.
57
58 * exit:
59   Exit repository; unset ENV.
60
61 * help:
62   Display help.
63
64 * init:
65   Initialize an empty repository.
66
67 * list:
68   List all local vcsh repositories.
69
70 * run:
71   Run command with <$GIT_DIR> and <$GIT_WORK_TREE> set. Allows you to run any
72   and all commands without any restrictions. Use with care.
73
74 * seed-gitignore:
75   Seed .gitignore.d/<repo> from git ls-files.
76
77 * use:
78   Use repository; set ENV.
79
80 * <repo> <gitcommand>:
81   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
82
83 ## ENVIRONMENT
84
85 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
86 appropriate values for fake bare git repositories.
87
88 ## SECURITY CONSIDERATIONS
89
90 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
91 speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
92
93 ## BUGS
94
95 None are known at this time, but reports and/or patches are more than welcome.
96
97 ## HISTORY
98
99 Like most people, the author initially made do with a single repository for all
100 config files, all of which were soft-linked into <$HOME>.
101
102 Martin F. Krafft aka madduck came up with the concept of fake bare git
103 repositories.
104
105 vcsh was initally written by madduck. This version is a re-implementation from
106 scratch with a lot more features. madduck graciously agreed to let the author
107 take over the name.
108
109 ## AUTHOR
110
111 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
112
113 ## COPYRIGHT
114
115 Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
116
117 Licensed under the GNU GPL version 3 or higher.
118
119 https://github.com/RichiH/vcsh
120
121 ## SEE ALSO
122
123 `git`(1), `mr`(1)