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

Remove stale code
[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` help
13
14 `vcsh` init <repo>
15
16 `vcsh` list
17
18 `vcsh` rename <repo> <newname>
19
20 `vcsh` run <repo> <command>
21
22 `vcsh` seed-gitignore <repo>
23
24 `vcsh` setup <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 * help:
59   Display help.
60
61 * init:
62   Initialize an empty repository.
63
64 * list:
65   List all local vcsh repositories.
66
67 * rename:
68   Rename a repository.
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   Please note that there is a somewhat magic feature for run. Instead of <repo>
75   it accepts <path>, as well. Anything that has a slash in it will be assumed to
76   be a path. `vcsh run` will then operate on this directory instead of the one
77   normally generated from the repository's name.
78   This is needed to support mr and other scripts properly and of no concern to
79   an interactive user.
80
81 * seed-gitignore:
82   Seed .gitignore.d/<repo> from git ls-files.
83
84 * setup:
85   Set up repository with recommended settings.
86
87 * <repo> <gitcommand>:
88   Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself.
89
90 ## ENVIRONMENT
91
92 As noted earlier, `vcsh` will set <$GIT_DIR> and <$GIT_WORK_TREE> to the
93 appropriate values for fake bare git repositories.
94
95 ## SECURITY CONSIDERATIONS
96
97 `vcsh` allows you to execute arbitrary commands via `vcsh` run. For example,
98 speaking, adding a `sudo`(8) rule for `vcsh` would be pretty stupid.
99
100 ## BUGS
101
102 None are known at this time, but reports and/or patches are more than welcome.
103
104 ## HISTORY
105
106 Like most people, the author initially made do with a single repository for all
107 config files, all of which were soft-linked into <$HOME>.
108
109 Martin F. Krafft aka madduck came up with the concept of fake bare git
110 repositories.
111
112 vcsh was initally written by madduck. This version is a re-implementation from
113 scratch with a lot more features. madduck graciously agreed to let the author
114 take over the name.
115
116 ## AUTHOR
117
118 This manpage and `vcsh` itself were written by Richard "RichiH" Hartmann.
119
120 ## COPYRIGHT
121
122 Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
123
124 Licensed under the GNU GPL version 3 or higher.
125
126 https://github.com/RichiH/vcsh
127
128 ## SEE ALSO
129
130 `git`(1), `mr`(1)