wonko9/i_can_daemonize

= i_can_daemonize

== DESCRIPTION:

ICanDaemonize makes it dead simple to create daemons of your own.

== REQUIREMENTS:

* A Computer
* Ruby

== INSTALL:

* Get ICanDaemonize off github

== THE BASICS:

  require 'rubygems'
  require 'i_can_daemonize'
  class MyDaemonClass
    include ICanDaemonize
    
    daemonize do
      # your code here
    end
    
  end

Run your daemon

  ruby your_daemon_script start
  
ICD will create a log file in log/ called your_daemon_script.log as well as a pid file in log called your_daemon_script.pid

It will essentially run the block given to daemonize within a loop.

== USAGE:

The daemonize method accepts a number of options see ICanDaemonize::ClassMethods daemonize() for options

There are a number of other blocks you can define in your class as well, including:

  before do/end

  after do/end

  die_if do/end

  exit_if do/end

See ICanDaemonize docs for more info on these options.

Your daemon can be called with a number of options

      --loop-every SECONDS         How long to sleep between each loop
  -t, --ontop                      Stay on top (does not daemonize)
      --instances=NUM              Allow multiple instances to run simultaneously? 0 for infinite. default: 1
      --log-file=LOGFILE           Logfile to log to
      --pid-file=PIDFILE           Directory to put pidfile
  -h, --help                       Show this message

You can add your own command line options by using the 'arg' class macro.  
See http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html for more info on OptionParser.
  
  arg('--scott-rocks', 'Does scott rock?') do |value|
    @scott_rocks = value
  end
  
== BUGS:

My method names may be too common to be included class methods

ICanDaemonize attempts to capture all STDOUT or STDERR and prepend that output with a timestamp and PID.
I don't like how this was implemented anyway. Feels dirty.

== LICENSE:

(The MIT License)

Copyright (c) 2009 Adam Pisoni, Amos Elliston

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.