94 lines
2.8 KiB
Groff
94 lines
2.8 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "GUARD" "1" "September 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"
|
|
\fBguard <COMMAND> <OPTIONS>\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 Clears the Shell after each change\.
|
|
.
|
|
.P
|
|
\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\.\.\. Runs only the groups specified by GROUP1, GROUP2 etc\. Groups name should be separated by spaces\. Guards that don\'t belong to a group are considered global and are always run\.
|
|
.
|
|
.P
|
|
\fB\-w\fR, \fB\-\-watchdir\fR \fIPATH\fR
|
|
.
|
|
.P
|
|
Tells Guard to watch PATH instead of \fB\./\fR\.
|
|
.
|
|
.P
|
|
\fB\-G\fR, \fB\-\-guardfile\fR \fIFILE\fR Tells Guard to use FILE as its Guardfile instead of \fB\./Guardfile\fR or \fB~/\.Guardfile\fR\.
|
|
.
|
|
.SS "init [GUARD]"
|
|
If no Guardfile is present in the current directory, creates an empty Guardfile\.
|
|
.
|
|
.P
|
|
If \fIGUARD\fR is present, add its default Guardfile configuration to the current Guardfile\. Note that \fIGUARD\fR is the guard\'s name without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
|
|
.
|
|
.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\.
|
|
.
|
|
.SS "\-h, help [COMMAND]"
|
|
List all of Guard\'s available commands\.
|
|
.
|
|
.P
|
|
If \fICOMMAND\fR is given, displays a specific help for \fITASK\fR\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
Initialize Guard and a specific guard at the same time:
|
|
.
|
|
.P
|
|
\fB[bundle exec] guard init [rspec]\fR
|
|
.
|
|
.P
|
|
Run Guard:
|
|
.
|
|
.P
|
|
\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
|