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.08
   7
   8 SYNOPSIS
   9         rgit [-K|-I|-D|-V] [GIT_OPTIONS] COMMAND [COMMAND_ARGS]
  10
  11 DESCRIPTION
  12     This utility recursively searches in a root directory (which may be the
  13     current working directory or - if it has been set - the directory given
  14     by the "GIT_DIR" environment variable) for all git repositories, sort
  15     this list by the repository path, "chdir" into each of them, and
  16     executes the specified git command. For efficiency reasons, repositories
  17     located inside a bare repository or under the .git directory of a work
  18     repository won't be searched for.
  19
  20     Moreover, those formats are substituted in the arguments before running
  21     the command :
  22
  23     *   %n with the current repository name.
  24
  25     *   %g with the relative path (based from the root directory) to the
  26         current repository.
  27
  28     *   %G with the absolute path to the current repository.
  29
  30     *   %w with the relative path (based from the root directory) to the
  31         current repository's working directory.
  32
  33     *   %W with the absolute path to the current repository's working
  34         directory.
  35
  36     *   %b with a "bareified" relative path, i.e. %g if this is a bare
  37         repository, and "%w.git" otherwise.
  38
  39     *   %B with an absolute version of the "bareified" path.
  40
  41     *   %R with the absolute path to the root directory.
  42
  43     *   "%%" with a bare "%".
  44
  45     There are actually a few commands that are only executed once in the
  46     root directory : "daemon", "gui", "help", "init" and "version". For any
  47     of those, no format substitution is done.
  48
  49     You can specify which "git" executable to use with the "GIT_EXEC_PATH"
  50     environment variable.
  51
  52 COMMAND LINE SWITCHES
  53     "rgit" takes its options as the capital switches that comes before the
  54     git command. It's possible to bundle them together. They are removed
  55     from the argument list before calling "git".
  56
  57     *   "-K"
  58
  59         Keep processing on error. The default policy is to stop whenever an
  60         error occured.
  61
  62     *   "-I"
  63
  64         Enables interactive mode when the standard input is a tty. Requires
  65         Term::ReadKey to be installed. This lets you choose interactively
  66         what to do when one of the commands returns a non-zero status.
  67
  68     *   "-D"
  69
  70         Outputs diagnostics.
  71
  72     *   "-V"
  73
  74         Outputs the version.
  75
  76 EXAMPLES
  77     Execute "git gc" on all the repositories below the current directory :
  78
  79         rgit gc
  80
  81     Tag all the repositories with their name :
  82
  83         rgit tag %n
  84
  85     Add a remote to all repositories in "/foo/bar" to their bare counterpart
  86     in "qux" on host :
  87
  88         GIT_DIR="/foo/bar" rgit remote add host git://host/qux/%b
  89
  90 DEPENDENCIES
  91     The core modules Carp, Config, Cwd, Exporter, File::Find, File::Spec and
  92     POSIX.
  93
  94 AUTHOR
  95     Vincent Pit, "<perl at profvince.com>", <http://profvince.com>.
  96
  97     You can contact me by mail or on "irc.perl.org" (vincent).
  98
  99 BUGS
 100     Please report any bugs or feature requests to "bug-rgit at rt.cpan.org",
 101     or through the web interface at
 102     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>. I will be
 103     notified, and then you'll automatically be notified of progress on your
 104     bug as I make changes.
 105
 106 SUPPORT
 107     You can find documentation for this module with the perldoc command.
 108
 109         perldoc rgit
 110
 111     Tests code coverage report is available at
 112     <http://www.profvince.com/perl/cover/rgit>.
 113
 114 COPYRIGHT & LICENSE
 115     Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
 116
 117     This program is free software; you can redistribute it and/or modify it
 118     under the same terms as Perl itself.
 119