]>
git.madduck.net Git - code/vcsh.git/blobdiff - 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:
+`vcsh` which <substring>
+
`vcsh` write-gitignore <repo>
`vcsh` <repo> <gitcommand>
`vcsh` write-gitignore <repo>
`vcsh` <repo> <gitcommand>
vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
A sample configuration for `vcsh` and `mr` can be found at
vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
A sample configuration for `vcsh` and `mr` can be found at
-*https://github.com/RichiH/vcsh_mr_template*
+*https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone
+https://github.com/RichiH/vcsh_mr_template mr`.
Please note that you can always use a path instead of a name for <repo>.
This is needed to support mr and other scripts properly and of no concern to
Please note that you can always use a path instead of a name for <repo>.
This is needed to support mr and other scripts properly and of no concern to
* setup:
Set up repository with recommended settings.
* setup:
Set up repository with recommended settings.
+* which <substring>:
+ Find <substring> in name of any tracked file.
+
* write-gitignore:
Write .gitignore.d/<repo> via git ls-files.
* <repo> <gitcommand>:
* write-gitignore:
Write .gitignore.d/<repo> via git ls-files.
* <repo> <gitcommand>:
- Shortcut to run `vcsh` on a repo. Will prepend `git` to <command> by itself .
+ Shortcut to run `vcsh` on a repo. Will prepend `git` to <command>.
* <repo>:
Shortcut to run `vcsh enter <repo>`.
* <repo>:
Shortcut to run `vcsh enter <repo>`.
soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
execute hooks that are in this directory.
soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
execute hooks that are in this directory.
-Hooks follow a simple format. `pre-run` will be run before anything is run.
+Hooks follow a simple format. <pre-run> will be run before anything is run.
If you want to have more than one script for a certain hook, just append
If you want to have more than one script for a certain hook, just append
-any kind of string to order them. A system of `pre-run`, `pre-run.10` ,
-`pre-run.20` etc is suggested; other options would be `pre-run-10` or
-`pre-run.sh` . A dot after the hook name is optional.
+any kind of string to order them. A system of <pre-run>, <pre-run.10> ,
+<pre-run.20> etc is suggested; other options would be <pre-run-10> or
+<pre-run.sh> . A dot after the hook name is optional.
-If you want to create hooks for a specific `vcsh` repository, simply prepend
-the repository's name, followed by a dot, i.e. `zsh.pre-run` . Otherwise, the
+If you want to create hooks for a specific <vcsh> repository, simply prepend
+the repository's name, followed by a dot, i.e. <zsh.pre-run> . Otherwise, the
same rules as above apply. The dot between the repository's name and the hook
is mandatory, though.
same rules as above apply. The dot between the repository's name and the hook
is mandatory, though.
+Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,
+<pre-setup>, and <post-setup>. If you need more, vcsh is trivial to patch,
+but please let upstream know so we can ship them by default.
+
## DETAILED HOWTO AND FURTHER READING
Man pages are intended to be short and thus often useless to glean best
## DETAILED HOWTO AND FURTHER READING
Man pages are intended to be short and thus often useless to glean best
None are known at this time, but reports and/or patches are more than welcome.
None are known at this time, but reports and/or patches are more than welcome.
+## KNOWN ISSUES
+
+As of this writing (June 2012), `vcsh` does not work with `git submodule` due
+to limitations within `git`. Depending on when you are reading this, you might
+want to consider upgrading.
+
## HISTORY
Like most people, the author initially made do with a single repository for all
## HISTORY
Like most people, the author initially made do with a single repository for all
-Copyright 2011 Richard Hartmann <richih.mailinglist@gmail.com>
+Copyright 2011-2012 Richard Hartmann <richih.mailinglist@gmail.com>
-Licensed under the GNU GPL version 3 or higher.
+Licensed under the GNU GPL version 2 or higher.
https://github.com/RichiH/vcsh
https://github.com/RichiH/vcsh
projects / code / vcsh.git / blobdiff