diff --git a/Guardfile b/Guardfile index 3febef2..106cadf 100644 --- a/Guardfile +++ b/Guardfile @@ -1,9 +1,13 @@ -guard 'rspec', :version => 2, :keep_failed => false, :cli => '--format Fuubar' do +guard :rspec, :version => 2, :keep_failed => false, :cli => '--format Fuubar' do watch(%r{^spec/.+_spec\.rb$}) watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" } watch('spec/spec_helper.rb') { "spec" } end +guard :ronn do + watch(%r{^man/.+\.ronn?$}) +end + # require 'guard/guard' # # module ::Guard @@ -17,7 +21,3 @@ end # group "exceptional" do # guard :breaking # end - -guard 'ronn' do - watch(%r{^man/.+\.m(ark)?d(own)?$}) -end diff --git a/man/guard.1 b/man/guard.1 index a6d51fa..ea54ba5 100644 --- a/man/guard.1 +++ b/man/guard.1 @@ -10,7 +10,7 @@ Guard is a command line tool that easily handle events on files modifications\. . .SH "SYNOPSIS" -guard \fIcommand\fR \fIoptions\fR +\fBguard \fR . .SH "COMMANDS" . @@ -21,103 +21,54 @@ Starts Guard\. This is the default command if none is provided\. The following options are available: . .P -\fB\-c\fR/\fB\-\-clear\fR -. -.IP "" 4 -. -.nf - - Clears the Shell after each change\. -. -.fi -. -.IP "" 0 +\fB\-c\fR, \fB\-\-clear\fR Clears the Shell after each change\. . .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 part can be passed to guard using true/false or t/f\. -. -.fi -. -.IP "" 0 +\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 -. -.IP "" 4 -. -.nf - - Runs Guard in debug mode\. -. -.fi -. -.IP "" 0 +\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\. . .P -\fB\-g\fR/\fB\-\-group\fR \fIgroup\fR \.\.\. -. -.IP "" 4 -. -.nf - - Runs only the groups specified\. -. -.fi -. -.IP "" 0 +\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 \fIfolder\fR -. -.IP "" 4 -. -.nf - - Specify the directory to watch\. -. -.fi -. -.IP "" 0 +\fB\-w\fR, \fB\-\-watchdir\fR \fIPATH\fR . .P -\fB\-G\fR/\fB\-\-guardfile\fR \fIfile\fR +Tells Guard to watch PATH instead of \fB\./\fR\. . -.IP "" 4 +.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\. . -.nf - - Specify a Guardfile by giving its path\. +.SS "init [GUARD]" +If no Guardfile is present in the current directory, creates an empty Guardfile\. . -.fi -. -.IP "" 0 -. -.SS "init [guard]" -Add the requested guard\'s default Guardfile configuration to the current 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" +.SS "\-T, show" List defined groups and guards for the current Guardfile\. . -.SH "OPTIONS" -. -.TP -\fB\-h\fR +.SS "\-h, help [COMMAND]" List all of Guard\'s available commands\. . -.SS "start" +.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 diff --git a/man/guard.1.html b/man/guard.1.html index 81d3956..95d230f 100644 --- a/man/guard.1.html +++ b/man/guard.1.html @@ -57,7 +57,6 @@ DESCRIPTION SYNOPSIS COMMANDS - OPTIONS EXAMPLES AUTHORS / CONTRIBUTORS WWW @@ -80,71 +79,69 @@

SYNOPSIS

-

guard command options

+

guard <COMMAND> <OPTIONS>

COMMANDS

start

-

Starts Guard. This is the default command if none is provided.

+

Starts Guard. This is the default command if none is provided.

The following options are available:

-

-c/--clear

+

-c, --clear + Clears the Shell after each change.

-
    Clears the Shell after each change.
-
+

-n, --notify FLAG + 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 true/false or t/f.

-

-n/--notify flag

+

-d, --debug + Runs Guard in debug mode.

-
    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.
-
+

-g, --group GROUP1 GROUP2... + 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.

-

-d/--debug

+

-w, --watchdir PATH

-
    Runs Guard in debug mode.
-
+

Tells Guard to watch PATH instead of ./.

-

-g/--group group ...

+

-G, --guardfile FILE + Tells Guard to use FILE as its Guardfile instead of ./Guardfile or ~/.Guardfile.

-
    Runs only the groups specified.
-
+

init [GUARD]

-

-w/--watchdir folder

+

If no Guardfile is present in the current directory, creates an empty Guardfile.

-
    Specify the directory to watch.
-
- -

-G/--guardfile file

- -
    Specify a Guardfile by giving its path.
-
- -

init [guard]

- -

Add the requested guard's default Guardfile configuration to the current Guardfile.

+

If GUARD is present, add its default Guardfile configuration to the current Guardfile. +Note that GUARD is the guard's name without the guard- prefix. +For instance to initialize guard-rspec, run guard init rspec.

list

-

Lists guards that can be used with the init command.

+

Lists guards that can be used with the init command.

-

-T/show

+

-T, show

-

List defined groups and guards for the current Guardfile.

+

List defined groups and guards for the current Guardfile.

-

OPTIONS

+

-h, help [COMMAND]

-
-
-h
List all of Guard's available commands.
-
+

List all of Guard's available commands.

- -

start

+

If COMMAND is given, displays a specific help for TASK.

EXAMPLES

+

Initialize Guard and a specific guard at the same time:

+ +

[bundle exec] guard init [rspec]

+ +

Run Guard:

+

[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile --clear --group backend frontend --notify false --debug

or in a more concise way:

diff --git a/man/guard.md b/man/guard.md deleted file mode 100644 index f61dd1d..0000000 --- a/man/guard.md +++ /dev/null @@ -1,77 +0,0 @@ -guard(1) -- Guard keeps an eye on your file modifications. -======================================================== - -## DESCRIPTION - -Guard is a command line tool that easily handle events on files modifications. - -## SYNOPSIS - -guard - -## COMMANDS - -### start - Starts Guard. This is the default command if none is provided. - -The following options are available: - - `-c`/`--clear` - Clears the Shell after each change. - - `-n`/`--notify` - 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 part can be passed to guard using true/false or t/f. - - `-d`/`--debug` - Runs Guard in debug mode. - - `-g`/`--group` ... - Runs only the groups specified. - - `-w`/`--watchdir` - Specify the directory to watch. - - `-G`/`--guardfile` - Specify a Guardfile by giving its path. - -### init [guard] - Add the requested guard's default Guardfile configuration to the current Guardfile. - -### list - Lists guards that can be used with the `init` command. - -### -T/show - List defined groups and guards for the current Guardfile. - -## OPTIONS - -* `-h`: - List all of Guard's available commands. - -### start - -## EXAMPLES - -`[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile --clear --group backend frontend --notify false --debug` - -or in a more concise way: - -`[bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c -g backend frontend -n f -d` - -## AUTHORS / CONTRIBUTORS - -Thibaud Guillaume-Gentil is the main author. - -A list of contributors based on all commits can be found here: -https://github.com/guard/guard/contributors - -For an exhaustive list of all the contributors, please see the CHANGELOG: -https://github.com/guard/guard/blob/master/CHANGELOG.md - -This manual has been written by Remy Coutable. - -## WWW - -https://github.com/guard/guard \ No newline at end of file diff --git a/man/guard.ronn b/man/guard.ronn new file mode 100644 index 0000000..412284a --- /dev/null +++ b/man/guard.ronn @@ -0,0 +1,93 @@ +guard(1) -- Guard keeps an eye on your file modifications. +======================================================== + +## DESCRIPTION + +Guard is a command line tool that easily handle events on files modifications. + +## SYNOPSIS + +`guard ` + +## COMMANDS + +### start + +Starts Guard. This is the default command if none is provided. + +The following options are available: + +`-c`, `--clear` + Clears the Shell after each change. + +`-n`, `--notify` + 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 `true`/`false` or `t`/`f`. + +`-d`, `--debug` + Runs Guard in debug mode. + +`-g`, `--group` ... + 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. + +`-w`, `--watchdir` + +Tells Guard to watch PATH instead of `./`. + +`-G`, `--guardfile` + Tells Guard to use FILE as its Guardfile instead of `./Guardfile` or `~/.Guardfile`. + +### init [GUARD] + +If no Guardfile is present in the current directory, creates an empty Guardfile. + +If is present, add its default Guardfile configuration to the current Guardfile. +Note that is the guard's name without the `guard-` prefix. +For instance to initialize guard-rspec, run `guard init rspec`. + +### list + +Lists guards that can be used with the `init` command. + +### -T, show + +List defined groups and guards for the current Guardfile. + +### -h, help [COMMAND] + +List all of Guard's available commands. + +If is given, displays a specific help for . + +## EXAMPLES + +Initialize Guard and a specific guard at the same time: + +`[bundle exec] guard init [rspec]` + +Run Guard: + +`[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile --clear --group backend frontend --notify false --debug` + +or in a more concise way: + +`[bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c -g backend frontend -n f -d` + +## AUTHORS / CONTRIBUTORS + +Thibaud Guillaume-Gentil is the main author. + +A list of contributors based on all commits can be found here: +https://github.com/guard/guard/contributors + +For an exhaustive list of all the contributors, please see the CHANGELOG: +https://github.com/guard/guard/blob/master/CHANGELOG.md + +This manual has been written by Remy Coutable. + +## WWW + +https://github.com/guard/guard \ No newline at end of file