master/man/guard.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GUARD" "1" "August 2011" "" ""
.
.SH "NAME"
\fBguard\fR \- Guard keeps an eye on your file modifications\.
.
.SH "DESCRIPTION"
Guard is a command line tool that easily handle events on files modifications\.
.
.SH "SYNOPSIS"
guard \fIcommand\fR \fIoptions\fR
.
.SH "COMMANDS"
.
.SS "start"
Starts Guard\. This is the default command if none is provided\.
.
.P
The following options are available:
.
.P
\fB\-c\fR/\fB\-\-clear\fR
.
.IP "" 4
.
.nf

    Clears the Shell after each change\.
.
.fi
.
.IP "" 0
.
.P
\fB\-n\fR/\fB\-\-notify\fR \fIflag\fR
.
.IP "" 4
.
.nf

    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\.
.
.fi
.
.IP "" 0
.
.P
\fB\-d\fR/\fB\-\-debug\fR
.
.IP "" 4
.
.nf

    Runs Guard in debug mode\.
.
.fi
.
.IP "" 0
.
.P
\fB\-g\fR/\fB\-\-group\fR \fIgroup\fR \.\.\.
.
.IP "" 4
.
.nf

    Runs only the groups specified\.
.
.fi
.
.IP "" 0
.
.P
\fB\-w\fR/\fB\-\-watchdir\fR \fIfolder\fR
.
.IP "" 4
.
.nf

    Specify the directory to watch\.
.
.fi
.
.IP "" 0
.
.P
\fB\-G\fR/\fB\-\-guardfile\fR \fIfile\fR
.
.IP "" 4
.
.nf

    Specify a Guardfile by giving its path\.
.
.fi
.
.IP "" 0
.
.SS "init [guard]"
Add the requested guard\'s default Guardfile configuration to the current Guardfile\.
.
.SS "list"
Lists guards that can be used with the \fBinit\fR command\.
.
.SS "\-T/show"
List defined groups and guards for the current Guardfile\.
.
.SH "OPTIONS"
.
.TP
\fB\-h\fR
List all of Guard\'s available commands\.
.
.SS "start"
.
.SH "EXAMPLES"
\fB[bundle exec] guard [start] \-\-watchdir ~/dev \-\-guardfile ~/env/Guardfile \-\-clear \-\-group backend frontend \-\-notify false \-\-debug\fR
.
.P
or in a more concise way:
.
.P
\fB[bundle exec] guard [start] \-w ~/dev \-G ~/env/Guardfile \-c \-g backend frontend \-n f \-d\fR
.
.SH "AUTHORS / CONTRIBUTORS"
Thibaud Guillaume\-Gentil is the main author\.
.
.P
A list of contributors based on all commits can be found here: https://github\.com/guard/guard/contributors
.
.P
For an exhaustive list of all the contributors, please see the CHANGELOG: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
.
.P
This manual has been written by Remy Coutable\.
.
.SH "WWW"
https://github\.com/guard/guard