From 7ba4819d3bb62d27ced62991fea8f46b034263ba Mon Sep 17 00:00:00 2001
From: John Bintz <john@coswellproductions.com>
Date: Tue, 21 Jun 2011 11:00:00 -0400
Subject: [PATCH] documentation and man page updates

---
 README.md        | 17 +++++++++++++++++
 man/guard.1      | 22 ++++++++++++++++++++--
 man/guard.1.html | 17 ++++++++++++++---
 man/guard.md     | 18 ++++++++++++++++--
 4 files changed, 67 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 56eb228..1979ed8 100644
--- a/README.md
+++ b/README.md
@@ -273,6 +273,23 @@ Guard::Dsl.evaluate_guardfile(:guardfile_contents => "
 ")
 ```
 
+### Listing defined guards/groups for the current project
+
+You can list the defined groups and guards for the current Guardfile from the command line using `guard show` or `guard -T`:
+
+``` bash
+# guard -T
+
+(global):
+  shell
+Group backend:
+  bundler
+  rspec: cli => "--color --format doc'
+Group frontend:
+  coffeescript: output => "public/javascripts/compiled"
+  livereload
+```
+
 Create a new guard
 ------------------
 
diff --git a/man/guard.1 b/man/guard.1
index 69de2c5..5e5f92e 100644
--- a/man/guard.1
+++ b/man/guard.1
@@ -7,7 +7,7 @@
 \fBguard\fR \- Guard keeps an eye on your file modifications\.
 .
 .SH "SYNOPSIS"
-guard \fIoptions\fR
+guard \fIcommand\fR \fIoptions\fR
 .
 .SH "DESCRIPTION"
 Guard is a command line tool that easily handle events on files modifications\.
@@ -26,13 +26,31 @@ Clears the Shell after each change\.
 Disable notifications (Growl or Libnotify depending on your system)\. Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false\. The \fIflag\fR part can be passed to guard using true/false or t/f\.
 .
 .TP
-\fB\-g\fR \fIlist of groups\fR, \fB\-\-group\fR \fIlist of groups\fR
+\fB\-g\fR \fIgroup\fR \.\.\., \fB\-\-group\fR \fIgroup\fR \.\.\.
 Runs only the groups specified\.
 .
 .TP
 \fB\-d\fR, \fB\-\-debug\fR
 Runs Guard in debug mode\.
 .
+.TP
+\fB\-h\fR
+List all of Guard\'s available commands\.
+.
+.SH "COMMANDS"
+.
+.TP
+\fBstart\fR
+Starts Guard\. This is the default command if none is provided\.
+.
+.TP
+\fBinit\fR [guard]
+Add the requested guard\'s default Guardfile configuration to the current Guardfile\.
+.
+.TP
+\fBshow\fR, \fB\-T\fR
+List defined groups and guards for the current Guardfile\.
+.
 .SH "EXAMPLES"
 \fB[bundle exec] guard \-\-clear \-\-group backend frontend \-\-notify false \-\-debug\fR
 .
diff --git a/man/guard.1.html b/man/guard.1.html
index 41e6181..538feea 100644
--- a/man/guard.1.html
+++ b/man/guard.1.html
@@ -58,9 +58,10 @@
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#HOMEPAGE">HOMEPAGE</a>
     <a href="#OPTIONS">OPTIONS</a>
+    <a href="#COMMANDS">COMMANDS</a>
     <a href="#EXAMPLES">EXAMPLES</a>
     <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>guard(1)</li>
@@ -75,7 +76,7 @@
 
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
-<p>guard <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a></p>
+<p>guard <var>command</var> <var>options</var></p>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
@@ -92,8 +93,18 @@
 <dt><code>-n</code> <var>flag</var>, <code>--notify</code> <var>flag</var></dt><dd><p>Disable notifications (Growl or Libnotify depending on your system).
 Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false.
 The <var>flag</var> part can be passed to guard using true/false or t/f.</p></dd>
-<dt><code>-g</code> <var>list of groups</var>, <code>--group</code> <var>list of groups</var></dt><dd><p>Runs only the groups specified.</p></dd>
+<dt><code>-g</code> <var>group</var> ..., <code>--group</code> <var>group</var> ...</dt><dd><p>Runs only the groups specified.</p></dd>
 <dt><code>-d</code>, <code>--debug</code></dt><dd><p>Runs Guard in debug mode.</p></dd>
+<dt class="flush"><code>-h</code></dt><dd><p>List all of Guard's available commands.</p></dd>
+</dl>
+
+
+<h2 id="COMMANDS">COMMANDS</h2>
+
+<dl>
+<dt class="flush"><code>start</code></dt><dd><p>Starts Guard. This is the default command if none is provided.</p></dd>
+<dt><code>init</code> [guard]</dt><dd><p>Add the requested guard's default Guardfile configuration to the current Guardfile.</p></dd>
+<dt><code>show</code>, <code>-T</code></dt><dd><p>List defined groups and guards for the current Guardfile.</p></dd>
 </dl>
 
 
diff --git a/man/guard.md b/man/guard.md
index 723ab6b..43c6780 100644
--- a/man/guard.md
+++ b/man/guard.md
@@ -3,7 +3,7 @@ guard(1) -- Guard keeps an eye on your file modifications.
 
 ## SYNOPSIS
 
-guard [options]
+guard <command> <options>
 
 ## DESCRIPTION
 
@@ -23,12 +23,26 @@ https://github.com/guard/guard
   Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false.
   The <flag> part can be passed to guard using true/false or t/f.
 
-* `-g` <list of groups>, `--group` <list of groups>:
+* `-g` <group> ..., `--group` <group> ...:
   Runs only the groups specified.
 
 * `-d`, `--debug`:
   Runs Guard in debug mode.
 
+* `-h`:
+  List all of Guard's available commands.
+
+## COMMANDS
+
+* `start`:
+  Starts Guard. This is the default command if none is provided.
+
+* `init` [guard]:
+  Add the requested guard's default Guardfile configuration to the current Guardfile.
+
+* `show`, `-T`:
+  List defined groups and guards for the current Guardfile.
+
 ## EXAMPLES
 
 `[bundle exec] guard --clear --group backend frontend --notify false --debug`