[Catalyst-commits] r13975 - CatalystX-Restarter-GTK/trunk/lib/CatalystX/Restarter

[dd070 at dev.catalyst.perl.org]

Author: dd070
Date: 2011-02-24 18:39:00 +0000 (Thu, 24 Feb 2011)
New Revision: 13975

Modified:
   CatalystX-Restarter-GTK/trunk/lib/CatalystX/Restarter/GTK.pm
Log:
updated POD

Modified: CatalystX-Restarter-GTK/trunk/lib/CatalystX/Restarter/GTK.pm
===================================================================
--- CatalystX-Restarter-GTK/trunk/lib/CatalystX/Restarter/GTK.pm	2011-02-17 06:40:33 UTC (rev 13974)
+++ CatalystX-Restarter-GTK/trunk/lib/CatalystX/Restarter/GTK.pm	2011-02-24 18:39:00 UTC (rev 13975)
@@ -452,21 +452,34 @@
 
 CatalystX::Restarter::GTK - GTK based Catalyst server restarter.
 
+=head1 SYNOPSIS
+
+Set environment variable CATALYST_RESTARTER to CatalystX::Restarter::GTK. Then start server with -r (auto restart on file changes) option.
+
+    export CATALYST_RESTARTER=CatalystX::Restarter::GTK
+    perl script/myapp_server -r
+
+You can also create a shell script for above two lines and add a shortcut to panel. This completely eliminates need of console to work on Catalyst based project.
+
+To use this restarter for specific application only, set appropirate envioronment variable. 
+
+    MYAPP_RESTARTER=CatalystX::Restarter::GTK
+ 
 =head1 DESCRIPTION
 
-It shows a small GUI window for controlling catalyst server and notifying status. It also captures console output printed by application at run time, both STDERR and STDOUT.
+This module provides GUI interface for controlling Catalyst server and viewing console output generated. It captures both STDOUT and STDERR.
 
-This module forks two processes. First child process creates GUI window and listens for incoming messages from parent.(console output and signals for notifying status change). Second child process runs the actual server and creates server socket by calling run() on application module.
+It shows a very small GUI window on desktop. It is set always on to by default. You can drag window to any screen corner for convinience.
 
-With this module Catalyst application developers do not need to use console to start or manage catalyst server or viewing console output. Window stays always on top by default. User can drag to any screen corner for convenience. When developer chagne any file of project, he can immediately check whether server is restarted successfuly or not before hitting refresh on web browser.
+With this module Catalyst application developers do not need to use console to start or manage catalyst server. When a developer changes any file of project, he can see whether server is restarted successfuly or not before hitting refresh on web browser. This is useful to those who work on Catalyst projects regularly.
 
 =head1 NOTES
 
-This module extends CatalystX::Restarter::GTK which in turn extends Catalyst::Restarter. It depends upon inherited  _watcher and _handle_events members of Catalyst::Restarter for monitoring files changes.
+This module extends Catalyst::Restarter and depends on its _watcher and _handle_events.
 
 =head1 AUTHOR
 
-Dhaval Dhanani L<mailto:dhaval070 at gmail.com>, L<mailto:dhavald at farematrix.com>
+Dhaval Dhanani L<mailto:dhaval070 at gmail.com>
 
 =head1 LICENCE