2011-06-19 19:55:28 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
|
|
|
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
|
|
|
<title>guard(1) - Guard keeps an eye on your file modifications.</title>
|
|
|
|
|
<style type='text/css' media='all'>
|
|
|
|
|
/* style: man */
|
|
|
|
|
body#manpage {margin:0}
|
|
|
|
|
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
|
|
|
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
|
|
|
.mp h2 {margin:10px 0 0 0}
|
|
|
|
|
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
|
|
|
.mp h3 {margin:0 0 0 4ex}
|
|
|
|
|
.mp dt {margin:0;clear:left}
|
|
|
|
|
.mp dt.flush {float:left;width:8ex}
|
|
|
|
|
.mp dd {margin:0 0 0 9ex}
|
|
|
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
|
|
|
.mp pre {margin-bottom:20px}
|
|
|
|
|
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
|
|
|
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
|
|
|
.mp img {display:block;margin:auto}
|
|
|
|
|
.mp h1.man-title {display:none}
|
|
|
|
|
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
|
|
|
.mp h2 {font-size:16px;line-height:1.25}
|
|
|
|
|
.mp h1 {font-size:20px;line-height:2}
|
|
|
|
|
.mp {text-align:justify;background:#fff}
|
|
|
|
|
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
|
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
|
|
|
.mp u {text-decoration:underline}
|
|
|
|
|
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
|
|
|
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
|
|
|
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
|
|
|
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
|
|
|
.mp pre {padding:0 4ex}
|
|
|
|
|
.mp pre code {font-weight:normal;color:#434241}
|
|
|
|
|
.mp h2+pre,h3+pre {padding-left:0}
|
|
|
|
|
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
|
|
|
ol.man-decor {width:100%}
|
|
|
|
|
ol.man-decor li.tl {text-align:left}
|
|
|
|
|
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
|
|
|
ol.man-decor li.tr {text-align:right;float:right}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<!--
|
|
|
|
|
The following styles are deprecated and will be removed at some point:
|
|
|
|
|
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
|
|
|
|
|
|
|
|
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
|
|
|
.man-navigation should be used instead.
|
|
|
|
|
-->
|
|
|
|
|
<body id='manpage'>
|
|
|
|
|
<div class='mp' id='man'>
|
|
|
|
|
|
|
|
|
|
<div class='man-navigation' style='display:none'>
|
|
|
|
|
<a href="#NAME">NAME</a>
|
|
|
|
|
<a href="#DESCRIPTION">DESCRIPTION</a>
|
2011-08-09 23:16:31 +00:00
|
|
|
<a href="#SYNOPSIS">SYNOPSIS</a>
|
2011-06-21 15:00:00 +00:00
|
|
|
<a href="#COMMANDS">COMMANDS</a>
|
2011-08-09 23:16:31 +00:00
|
|
|
<a href="#OPTIONS">OPTIONS</a>
|
2011-06-19 19:55:28 +00:00
|
|
|
<a href="#EXAMPLES">EXAMPLES</a>
|
|
|
|
|
<a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
|
2011-08-09 23:16:31 +00:00
|
|
|
<a href="#WWW">WWW</a>
|
2011-06-21 15:00:00 +00:00
|
|
|
</div>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
|
|
|
|
<ol class='man-decor man-head man head'>
|
|
|
|
|
<li class='tl'>guard(1)</li>
|
|
|
|
|
<li class='tc'></li>
|
|
|
|
|
<li class='tr'>guard(1)</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<h2 id="NAME">NAME</h2>
|
|
|
|
|
<p class="man-name">
|
|
|
|
|
<code>guard</code> - <span class="man-whatis">Guard keeps an eye on your file modifications.</span>
|
|
|
|
|
</p>
|
|
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
|
|
|
|
|
|
|
|
<p>Guard is a command line tool that easily handle events on files modifications.</p>
|
|
|
|
|
|
2011-06-19 19:55:28 +00:00
|
|
|
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
|
|
|
|
2011-06-21 15:00:00 +00:00
|
|
|
<p>guard <var>command</var> <var>options</var></p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<h2 id="COMMANDS">COMMANDS</h2>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<h3 id="start">start</h3>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p> Starts Guard. This is the default command if none is provided.</p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p>The following options are available:</p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p> <code>-c</code>/<code>--clear</code></p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<pre><code> Clears the Shell after each change.
|
|
|
|
|
</code></pre>
|
2011-06-21 15:00:00 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p> <code>-n</code>/<code>--notify</code> <var>flag</var></p>
|
2011-06-21 15:00:00 +00:00
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<pre><code> 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 <flag> part can be passed to guard using true/false or t/f.
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<p> <code>-d</code>/<code>--debug</code></p>
|
|
|
|
|
|
|
|
|
|
<pre><code> Runs Guard in debug mode.
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<p> <code>-g</code>/<code>--group</code> <var>group</var> ...</p>
|
|
|
|
|
|
|
|
|
|
<pre><code> Runs only the groups specified.
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<p> <code>-w</code>/<code>--watchdir</code> <var>folder</var></p>
|
|
|
|
|
|
|
|
|
|
<pre><code> Specify the directory to watch.
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<p> <code>-G</code>/<code>--guardfile</code> <var>file</var></p>
|
|
|
|
|
|
|
|
|
|
<pre><code> Specify a Guardfile by giving its path.
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<h3 id="init-guard-">init [guard]</h3>
|
|
|
|
|
|
|
|
|
|
<p> Add the requested guard's default Guardfile configuration to the current Guardfile.</p>
|
|
|
|
|
|
|
|
|
|
<h3 id="list">list</h3>
|
|
|
|
|
|
|
|
|
|
<p> Lists guards that can be used with the <code>init</code> command.</p>
|
|
|
|
|
|
|
|
|
|
<h3 id="-T-show">-T/show</h3>
|
|
|
|
|
|
|
|
|
|
<p> List defined groups and guards for the current Guardfile.</p>
|
|
|
|
|
|
|
|
|
|
<h2 id="OPTIONS">OPTIONS</h2>
|
2011-06-21 15:00:00 +00:00
|
|
|
|
|
|
|
|
<dl>
|
2011-08-09 23:16:31 +00:00
|
|
|
<dt class="flush"><code>-h</code></dt><dd>List all of Guard's available commands.</dd>
|
2011-06-19 19:55:28 +00:00
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<h3 id="start">start</h3>
|
|
|
|
|
|
2011-06-19 19:55:28 +00:00
|
|
|
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p><code>[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile --clear --group backend frontend --notify false --debug</code></p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
|
|
|
|
<p>or in a more concise way:</p>
|
|
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p><code>[bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c -g backend frontend -n f -d</code></p>
|
2011-06-19 19:55:28 +00:00
|
|
|
|
|
|
|
|
<h2 id="AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</h2>
|
|
|
|
|
|
|
|
|
|
<p>Thibaud Guillaume-Gentil is the main author.</p>
|
|
|
|
|
|
|
|
|
|
<p>A list of contributors based on all commits can be found here:
|
|
|
|
|
https://github.com/guard/guard/contributors</p>
|
|
|
|
|
|
|
|
|
|
<p>For an exhaustive list of all the contributors, please see the CHANGELOG:
|
|
|
|
|
https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
|
|
|
|
|
|
2011-08-09 23:16:31 +00:00
|
|
|
<p>This manual has been written by Remy Coutable.</p>
|
|
|
|
|
|
|
|
|
|
<h2 id="WWW">WWW</h2>
|
|
|
|
|
|
|
|
|
|
<p>https://github.com/guard/guard</p>
|
|
|
|
|
|
2011-06-19 19:55:28 +00:00
|
|
|
|
|
|
|
|
<ol class='man-decor man-foot man foot'>
|
|
|
|
|
<li class='tl'></li>
|
2011-08-09 23:16:31 +00:00
|
|
|
<li class='tc'>August 2011</li>
|
2011-06-19 19:55:28 +00:00
|
|
|
<li class='tr'>guard(1)</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
