]> git.vpit.fr Git - perl/modules/rgit.git/blob - README
This is 0.02
[perl/modules/rgit.git] / README
1 NAME
2     rgit - Recursively execute a command on all the git repositories in a
3     directory tree.
4
5 VERSION
6     Version 0.02
7
8 SYNOPSIS
9         rgit [GIT_OPTIONS] COMMAND [COMMAND_ARGS]
10
11 DESCRIPTION
12     This utility recursively searches in the current directory (or in the
13     directory given by the "GIT_DIR" environment variable if it's set) for
14     all git repositories, "chdir" into each of them, and executes the
15     specified git command. Moreover, those formats are substuted in the
16     arguments before running the command :
17
18     *   "^n" with the current repository name.
19
20     *   "^g" with the relative path to the current repository.
21
22     *   "^G" with the absolute path to the current repository.
23
24     *   "^w" with the relative path to the current repository's working
25         directory.
26
27     *   "^W" with the absolute path to the current repository's working
28         directory.
29
30     *   "^b" with a "bareified" relative path, i.e. "^g" if this is a bare
31         repository, and "^w.git" otherwise.
32
33     *   "^B" is the absolute version of the "bareified" path.
34
35     *   "^R" with the absolute path to the current root directory.
36
37     *   "^^" with a bare "^".
38
39     There are actually a few commands that are only executed once in the
40     current directory : "version", "help", "daemon" and "init". For any of
41     those, no format substitution is done.
42
43     You can specify which "git" executable to use with the "GIT_EXEC_PATH"
44     environment variable.
45
46 EXAMPLES
47     Execute "git gc" on all the repositories below the current directory :
48
49         rgit gc
50
51     Tag all the repositories with their name :
52
53         rgit tag ^n
54
55     Add a remote to all repositories in "/foo/bar" to their bare counterpart
56     in "qux" on host :
57
58         GIT_DIR="/foo/bar" rgit remote add host git://host/qux/^b
59
60 DEPENDENCIES
61     The core modules Carp, Cwd, Exporter, File::Find, File::Spec::Functions
62     and List::Util.
63
64     Object::Tiny.
65
66 AUTHOR
67     Vincent Pit, "<perl at profvince.com>", <http://profvince.com>.
68
69     You can contact me by mail or on "irc.perl.org" (vincent).
70
71 BUGS
72     Please report any bugs or feature requests to "bug-rgit at rt.cpan.org",
73     or through the web interface at
74     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>. I will be
75     notified, and then you'll automatically be notified of progress on your
76     bug as I make changes.
77
78 SUPPORT
79     You can find documentation for this module with the perldoc command.
80
81         perldoc rgit
82
83     Tests code coverage report is available at
84     <http://www.profvince.com/perl/cover/rgit>.
85
86 COPYRIGHT & LICENSE
87     Copyright 2008 Vincent Pit, all rights reserved.
88
89     This program is free software; you can redistribute it and/or modify it
90     under the same terms as Perl itself.
91