Permalink
Browse files

Update man and README

  • Loading branch information...
1 parent e243872 commit 5d218f1aebce03d5a1240d6a05b9bd425ca6f4c2 @rymai rymai committed Jan 17, 2014
Showing with 24 additions and 12 deletions.
  1. +0 −1 Gemfile
  2. +4 −0 README.md
  3. +7 −4 man/guard.1
  4. +7 −4 man/guard.1.html
  5. +6 −3 man/guard.1.ronn
View
@@ -40,6 +40,5 @@ end
# installed on Travis CI
#
group :test do
- gem 'rspec', '3.0.0.beta1'
gem 'coveralls', require: false
end
View
@@ -253,6 +253,10 @@ $ bundle exec guard start -B
$ bundle exec guard start --no-bundler-warning
```
+#### `--show-deprecations`
+
+Turn on deprecation warnings.
+
#### `-l`/`--latency` option
Overwrite Listen's default latency, useful when your hard-drive / system is slow.
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "GUARD" "1" "September 2013" "" ""
+.TH "GUARD" "1" "January 2014" "" ""
.
.SH "NAME"
\fBguard\fR \- Guard keeps an eye on your file modifications\.
@@ -27,15 +27,15 @@ The following options are available:
\fB\-n\fR, \fB\-\-notify\fR \fIFLAG\fR Disable notifications (Growl or Libnotify depending on your system)\. Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false\. FLAG can be \fBtrue\fR/\fBfalse\fR or \fBt\fR/\fBf\fR\.
.
.P
-\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
-.
-.P
\fB\-g\fR, \fB\-\-group\fR \fIGROUP1\fR \fIGROUP2\fR\.\.\. Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc\. Group names should be separated by spaces\. Plugins that don\'t belong to a group are considered global and are always run\.
.
.P
\fB\-P\fR, \fB\-\-plugin\fR \fIPLUGIN1\fR \fIPLUGIN2\fR\.\.\. Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc\. Plugin names should be separated by spaces\.
.
.P
+\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
+.
+.P
\fB\-w\fR, \fB\-\-watchdir\fR \fIPATH\fR Tells Guard to watch PATH instead of \fB\./\fR\.
.
.P
@@ -56,6 +56,9 @@ The following options are available:
.P
\fB\-p\fR, \fB\-\-force\-polling\fR Force usage of the Listen polling listener\.
.
+.P
+\fB\-y\fR, \fB\-\-wait\-for\-delay\fR Overwrite Listen\'s default \fBwait_for_delay\fR, useful for kate\-like editors through ssh access\.
+.
.SS "init [GUARDS]"
If no Guardfile is present in the current directory, creates an empty Guardfile\.
.
View
@@ -98,9 +98,6 @@ <h3 id="start">start</h3>
Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false.
FLAG can be <code>true</code>/<code>false</code> or <code>t</code>/<code>f</code>.</p>
-<p><code>-d</code>, <code>--debug</code>
- Runs Guard in debug mode.</p>
-
<p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc.
Group names should be separated by spaces.
@@ -110,6 +107,9 @@ <h3 id="start">start</h3>
Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc.
Plugin names should be separated by spaces.</p>
+<p><code>-d</code>, <code>--debug</code>
+ Runs Guard in debug mode.</p>
+
<p><code>-w</code>, <code>--watchdir</code> <var>PATH</var>
Tells Guard to watch PATH instead of <code>./</code>.</p>
@@ -131,6 +131,9 @@ <h3 id="start">start</h3>
<p><code>-p</code>, <code>--force-polling</code>
Force usage of the Listen polling listener.</p>
+<p><code>-y</code>, <code>--wait-for-delay</code>
+ Overwrite Listen's default <code>wait_for_delay</code>, useful for kate-like editors through ssh access.</p>
+
<h3 id="init-GUARDS-">init [GUARDS]</h3>
<p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
@@ -187,7 +190,7 @@ <h2 id="WWW">WWW</h2>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
- <li class='tc'>September 2013</li>
+ <li class='tc'>January 2014</li>
<li class='tr'>guard(1)</li>
</ol>
View
@@ -25,9 +25,6 @@ The following options are available:
Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false.
FLAG can be `true`/`false` or `t`/`f`.
-`-d`, `--debug`
- Runs Guard in debug mode.
-
`-g`, `--group` <GROUP1> <GROUP2>...
Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc.
Group names should be separated by spaces.
@@ -37,6 +34,9 @@ The following options are available:
Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc.
Plugin names should be separated by spaces.
+`-d`, `--debug`
+ Runs Guard in debug mode.
+
`-w`, `--watchdir` <PATH>
Tells Guard to watch PATH instead of `./`.
@@ -58,6 +58,9 @@ The following options are available:
`-p`, `--force-polling`
Force usage of the Listen polling listener.
+`-y`, `--wait-for-delay`
+ Overwrite Listen's default `wait_for_delay`, useful for kate-like editors through ssh access.
+
### init [GUARDS]
If no Guardfile is present in the current directory, creates an empty Guardfile.

0 comments on commit 5d218f1

Please sign in to comment.