This is 0.05

[perl/modules/rgit.git] / README

diff --git a/README b/README
index 2403748ae726f6022e3fbf4a20c581708ea219f4..bccfd0b92c7e9e6f82abff64890f0fd72c2c27d6 100644 (file)
--- a/README
+++ b/README
@@ -3,17 +3,18 @@ NAME
     directory tree.
 
 VERSION
-    Version 0.02
+    Version 0.05
 
 SYNOPSIS
-        rgit [GIT_OPTIONS] COMMAND [COMMAND_ARGS]
+        rgit [-K|-I|-D|-V] [GIT_OPTIONS] COMMAND [COMMAND_ARGS]
 
 DESCRIPTION
     This utility recursively searches in the current directory (or in the
     directory given by the "GIT_DIR" environment variable if it's set) for
-    all git repositories, "chdir" into each of them, and executes the
-    specified git command. Moreover, those formats are substuted in the
-    arguments before running the command :
+    all git repositories, sort this list by the repository path, "chdir"
+    into each of them, and executes the specified git command. Moreover,
+    those formats are substuted in the arguments before running the command
+    :
 
     *   "^n" with the current repository name.
 
@@ -30,19 +31,43 @@ DESCRIPTION
     *   "^b" with a "bareified" relative path, i.e. "^g" if this is a bare
         repository, and "^w.git" otherwise.
 
-    *   "^B" is the absolute version of the "bareified" path.
+    *   "^B" with an absolute version of the "bareified" path.
 
     *   "^R" with the absolute path to the current root directory.
 
     *   "^^" with a bare "^".
 
     There are actually a few commands that are only executed once in the
-    current directory : "version", "help", "daemon" and "init". For any of
-    those, no format substitution is done.
+    current directory : "daemon", "gui", "help", "init" and "version". For
+    any of those, no format substitution is done.
 
     You can specify which "git" executable to use with the "GIT_EXEC_PATH"
     environment variable.
 
+COMMAND LINE SWITCHES
+    "rgit" takes its options as the capital switches that comes before the
+    git command. It's possible to bundle them together. They are removed
+    from the argument list before calling "git".
+
+    *   "-K"
+
+        Keep processing on error. The default policy is to stop whenever an
+        error occured.
+
+    *   "-I"
+
+        Enables interactive mode when the standard input is a tty. Requires
+        Term::ReadKey to be installed. This lets you choose interactively
+        what to do when one of the commands returns a non-zero status.
+
+    *   "-D"
+
+        Outputs diagnostics.
+
+    *   "-V"
+
+        Outputs the version.
+
 EXAMPLES
     Execute "git gc" on all the repositories below the current directory :
 
@@ -58,8 +83,8 @@ EXAMPLES
         GIT_DIR="/foo/bar" rgit remote add host git://host/qux/^b
 
 DEPENDENCIES
-    The core modules Carp, Cwd, Exporter, File::Find, File::Spec::Functions
-    and List::Util.
+    The core modules Carp, Config, Cwd, Exporter, File::Find,
+    File::Spec::Functions and POSIX.
 
     Object::Tiny.