README.rdoc in rexec-1.2.1 vs README.rdoc in rexec-1.2.3

- old
+ new

@@ -1,14 +1,61 @@ = RExec -Author:: Samuel Williams (http://www.oriontransfer.co.nz/) -Copyright:: Copyright (C) 2009, 2010 Samuel Williams -License:: GPLv3 +Author:: Samuel G. D. Williams (http://www.oriontransfer.co.nz) +Copyright:: Copyright (C) 2007, 2009, 2011 Samuel G. D. Williams +License:: MIT -RExec stands for Ruby Execute or Remote Execute (depending on how you use it). It provides a number of different things to assist with running Ruby code: +RExec stands for Remote Execute and provides support for executing processes +both locally and remotely. It provides a number of different tools to assist +with running Ruby code: -* A framework to send Ruby code to a remote server for execution -* A framework for writing command line daemons (i.e. <tt>start</tt>, <tt>restart</tt>, <tt>stop</tt>, <tt>status</tt>) -* A comprehensive <tt>Task</tt> class for launching tasks, managing input and output, exit status, etc -* Basic privilege management code for changing the processes owner -* A bunch of helpers for various different things (such as reading a file backwards) -* <tt>daemon-exec</tt> executable for running regular shell tasks in the background +* A framework to send Ruby code to a remote server for execution. +* A framework for writing command line daemons (i.e. +start+, +restart+, +stop+, +status+). +* A comprehensive +Task+ class for launching tasks, managing input and output, exit status, etc. +* Basic privilege management code for changing the processes owner. +* A bunch of helpers for various different things (such as reading a file backwards). +* +daemon-exec+ executable for running regular shell tasks in the background. + +== Comprehensive process management + ++RExec::Task+ provides a comprehensive wrapper for low level process execution +and life-cycle management. You can easy spawn new child processes, background +processes and execute Ruby code in a child instance. + +== Light weight bi-directional communication + +The +RExec::Connection+ provides a simple process based API for communicating +with distant instances of Ruby. These can either be local or remote, such +as over SSH. + +== Simple daemonization + +The +RExec::Daemon+ module provides the foundation to develop long-running +background processes. Simply create a daemon class which inherits from ++RExec::Daemon::Base+ and you can have a fully featured background daemon +with the standard command line interface, e.g. +start+, +restart+, +status+ +and +stop+. + +Along with this, a executable is included called +daemon-exec+ which allows +for any standard shell script to be run as a background process. + +== License + +Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file