From 215af072a2c3511d3aa3f44a932e5f4c47386cde Mon Sep 17 00:00:00 2001 From: Thibaud Guillaume-Gentil Date: Sat, 3 Sep 2011 22:40:06 +0200 Subject: [PATCH] Replace Signal handlers README section by Interactions --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index faa1ad6..c1bc356 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ gem 'rb-fsevent' gem 'growl_notify' # or gem 'growl' ``` -The difference between growl and growl_notify is that growl_notify uses AppleScript to +The difference between growl and growl_notify is that growl_notify uses AppleScript to display a message, whereas growl uses the `growlnotify` command. In general the AppleScript approach is preferred, but you may also use the older growl gem. @@ -218,16 +218,17 @@ An exhaustive list of options is available with: $ guard help [TASK] ``` -Signal handlers ---------------- +Interactions +------------ -Signal handlers are used to interact with Guard: +**From version >= 0.7.0 Posix Signal handlers are no more used to interact with Guard.** -* `Ctrl-C` - Calls each guard's `#stop` method, in the same order they are declared in the Guardfile, and then quits Guard itself. -* `Ctrl-\` - Calls each guard's `#run_all` method, in the same order they are declared in the Guardfile. -* `Ctrl-Z` - Calls each guard's `#reload` method, in the same order they are declared in the Guardfile. +When Guard do nothing you can interact with by entering a command + hitting enter: -You can read more about [configure the signal keyboard shortcuts](https://github.com/guard/guard/wiki/Configure-keyboard-shortcuts) in the wiki. +* `stop|quit|exit|s|q|e + enter` - Calls each guard's `#stop` method, in the same order they are declared in the Guardfile, and then quits Guard itself. +* `reload|r|z + enter` - Calls each guard's `#reload` method, in the same order they are declared in the Guardfile. +* `pause|p + enter` - Toggle files modification listening. Useful when switching git branches. +* `just enter (no commands)` - Calls each guard's `#run_all` method, in the same order they are declared in the Guardfile. Available Guards ----------------