1<!DOCTYPE html> <html> <head>
2  <meta http‐equiv=’content‐type’ value=’text/html;charset=utf8’>
3  <meta            name=’generator’            value=’Ronn/v0.7.3
4(http://github.com/rtomayko/ronn/tree/0.7.3)’>
5  <title>guard(1) ‐ Guard keeps an eye  on  your  file  modifica‐
6tions.</title>
7  <style type=’text/css’ media=’all’>
8  /* style: man */
9  body#manpage {margin:0}
10  .mp {max‐width:100ex;padding:0 9ex 1ex 4ex}
11  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12  .mp h2 {margin:10px 0 0 0}
13  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin‐left:8ex}
14  .mp h3 {margin:0 0 0 4ex}
15  .mp dt {margin:0;clear:left}
16  .mp dt.flush {float:left;width:8ex}
17  .mp dd {margin:0 0 0 9ex}
18  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19  .mp pre {margin‐bottom:20px}
20  .mp pre+h2,.mp pre+h3 {margin‐top:22px}
21  .mp h2+pre,.mp h3+pre {margin‐top:5px}
22  .mp img {display:block;margin:auto}
23  .mp h1.man‐title {display:none}
24  .mp,.mp  code,.mp  pre,.mp  tt,.mp  kbd,.mp  samp,.mp h3,.mp h4
25{font‐family:monospace;font‐size:14px;line‐
26height:1.42857142857143}
27  .mp h2 {font‐size:16px;line‐height:1.25}
28  .mp h1 {font‐size:20px;line‐height:2}
29  .mp {text‐align:justify;background:#fff}
30  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {col‐
31or:#131211}
32  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
33  .mp u {text‐decoration:underline}
34  .mp code,.mp strong,.mp b {font‐weight:bold;color:#131211}
35  .mp  em,.mp  var  {font‐style:italic;color:#232221;text‐decora‐
36tion:none}
37  .mp  a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp
38a kbd,.mp a samp {color:#0000ff}
39  .mp b.man‐ref {font‐weight:normal;color:#434241}
40  .mp pre {padding:0 4ex}
41  .mp pre code {font‐weight:normal;color:#434241}
42  .mp h2+pre,h3+pre {padding‐left:0}
43  ol.man‐decor,ol.man‐decor  li   {margin:3px   0   10px   0;pad‐
44ding:0;float:left;width:33%;list‐style‐type:none;text‐trans‐
45form:uppercase;color:#999;letter‐spacing:1px}
46  ol.man‐decor {width:100%}
47  ol.man‐decor li.tl {text‐align:left}
48  ol.man‐decor li.tc {text‐align:center;letter‐spacing:4px}
49  ol.man‐decor li.tr {text‐align:right;float:right}
50  </style> </head> <!‐‐
51  The following styles are deprecated and will be removed at some
52point:
53  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
54
55  The  .man‐page,  .man‐decor,  .man‐head, .man‐foot, .man‐title,
56and
57  .man‐navigation should be used  instead.   ‐‐>  <body  id=’man‐
58page’>
59  <div class=’mp’ id=’man’>
60
61  <div class=’man‐navigation’ style=’display:none’>
62    <a href="#NAME">NAME</a>
63    <a href="#DESCRIPTION">DESCRIPTION</a>
64    <a href="#SYNOPSIS">SYNOPSIS</a>
65    <a href="#COMMANDS">COMMANDS</a>
66    <a href="#EXAMPLES">EXAMPLES</a>
67    <a href="#AUTHORS‐CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
68    <a href="#CHANGELOG">CHANGELOG</a>
69    <a href="#WWW">WWW</a>
70  </div>
71
72  <ol class=’man‐decor man‐head man head’>
73    <li class=’tl’>guard(1)</li>
74    <li class=’tc’></li>
75    <li class=’tr’>guard(1)</li>
76  </ol>
77
78  <h2 id="NAME">NAME</h2> <p class="man‐name">
79  <code>guard</code>  ‐  <span  class="man‐whatis">Guard keeps an
80eye on your file modifications.</span> </p>
81
82<h2 id="DESCRIPTION">DESCRIPTION</h2>
83
84<p>Guard is a command line tool to easily handle events  on  file
85system modifications.</p>
86
87<h2 id="SYNOPSIS">SYNOPSIS</h2>
88
89<p><code>guard &lt;COMMAND> &lt;OPTIONS></code></p>
90
91<h2 id="COMMANDS">COMMANDS</h2>
92
93<h3 id="start">start</h3>
94
95<p>Starts  Guard.  This is the default command if none is provid‐
96ed.</p>
97
98<p>The following options are available:</p>
99
100<p><code>‐c</code>, <code>‐‐clear</code>
101  Clears the Shell after each change.</p>
102
103<p><code>‐n</code>, <code>‐‐notify</code> <var>FLAG</var>
104  Disable notifications (Growl or  Libnotify  depending  on  your
105system).
106  Notifications can be disabled globally by setting a GUARD_NOTI‐
107FY environment variable to false.
108  FLAG    can    be    <code>true</code>/<code>false</code>    or
109<code>t</code>/<code>f</code>.</p>
110
111<p><code>‐g</code>,     <code>‐‐group</code>    <var>GROUP1</var>
112<var>GROUP2</var>...
113  Scopes the Guard actions to the  groups  specified  by  GROUP1,
114GROUP2, etc.
115  Group names should be separated by spaces.
116  Plugins  that don’t belong to a group are considered global and
117are always run.</p>
118
119<p><code>‐P</code>,   <code>‐‐plugin</code>    <var>PLUGIN1</var>
120<var>PLUGIN2</var>...
121  Scopes  the  Guard actions to the plugins specified by PLUGIN1,
122PLUGIN2, etc.
123  Plugin names should be separated by spaces.</p>
124
125<p><code>‐d</code>, <code>‐‐debug</code>
126  Runs Guard in debug mode.</p>
127
128<p><code>‐w</code>, <code>‐‐watchdir</code> <var>PATH</var>
129  Tells Guard to watch PATH instead of <code>./</code>.</p>
130
131<p><code>‐G</code>, <code>‐‐guardfile</code> <var>FILE</var>
132  Tells  Guard  to  use  FILE  as  its   Guardfile   instead   of
133<code>./Guardfile</code> or <code>~/.Guardfile</code>.</p>
134
135<p><code>‐i</code>, <code>‐‐no‐interactions</code>
136  Turn off completely any Guard terminal interactions.</p>
137
138<p><code>‐B</code>, <code>‐‐no‐bundler‐warning</code>
139  Turn off warning when Bundler is not present.</p>
140
141<p><code>‐l</code>, <code>‐‐latency</code>
142  Overwrite Listen’s default latency.</p>
143
144<p><code>‐p</code>, <code>‐‐force‐polling</code>
145  Force usage of the Listen polling listener.</p>
146
147<p><code>‐y</code>, <code>‐‐wait‐for‐delay</code>
148  Overwrite  Listen’s default <code>wait_for_delay</code>, useful
149for kate‐like editors through ssh access.</p>
150
151<h3 id="init‐GUARDS‐">init [GUARDS]</h3>
152
153<p>If no Guardfile is present in the current  directory,  creates
154an empty Guardfile.</p>
155
156<p>If  <var>GUARDS</var> are present, add their default Guardfile
157configuration   to   the   current    Guardfile.     Note    that
158<var>GUARDS</var> is a list of the Guard plugin names without the
159<code>guard‐</code> prefix.  For instance  to  initialize  guard‐
160rspec, run <code>guard init rspec</code>.</p>
161
162<h3 id="list">list</h3>
163
164<p>Lists    Guard   plugins   that   can   be   used   with   the
165<code>init</code> command.</p>
166
167<h3 id="‐T‐show">‐T, show</h3>
168
169<p>List defined groups and Guard plugins for the  current  Guard‐
170file.</p>
171
172<h3 id="‐h‐help‐COMMAND‐">‐h, help [COMMAND]</h3>
173
174<p>List all of Guard’s available commands.</p>
175
176<p>If  <var>COMMAND</var>  is given, displays a specific help for
177<var>TASK</var>.</p>
178
179<h2 id="EXAMPLES">EXAMPLES</h2>
180
181<p>Initialize Guard and a  specific  Guard  plugin  at  the  same
182time:</p>
183
184<p><code>[bundle exec] guard init [rspec]</code></p>
185
186<p>Run Guard:</p>
187
188<p><code>[bundle exec] guard [start] ‐‐watchdir ~/dev ‐‐guardfile
189~/env/Guardfile ‐‐clear ‐‐group backend frontend  ‐‐notify  false
190‐‐debug</code></p>
191
192<p>or in a more concise way:</p>
193
194<p><code>[bundle  exec] guard [start] ‐w ~/dev ‐G ~/env/Guardfile
195‐c ‐g backend frontend ‐n f ‐d</code></p>
196
197<h2 id="AUTHORS‐CONTRIBUTORS">AUTHORS / CONTRIBUTORS</h2>
198
199<p>Thibaud Guillaume‐Gentil is the main author.</p>
200
201<p>A list of contributors based on all commits can be found here:
202https://github.com/guard/guard/contributors</p>
203
204<h2 id="CHANGELOG">CHANGELOG</h2>
205
206<p>The        changelog        can       be       found       at:
207https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
208
209<p>This manual has been written by Remy Coutable.</p>
210
211<h2 id="WWW">WWW</h2>
212
213<p>http://guardgem.org/</p>
214
215
216  <ol class=’man‐decor man‐foot man foot’>
217    <li class=’tl’></li>
218    <li class=’tc’>November 2014</li>
219    <li class=’tr’>guard(1)</li>
220  </ol>
221
222  </div> </body> </html>
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
Impressum