Skip to content

Beautify README with markdown #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Beautify README with markdown #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40501d5
Update and rename README to README.md
debbbbie Jun 7, 2015
f48dd61
Update README.md
debbbbie Jun 7, 2015
810c2ae
Update daemons.gemspec
debbbbie Jun 7, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 41 additions & 26 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Daemons Version 1.0.11
# Daemons Version 1.0.11

(See Releases for release-specific information)

== What is Daemons?
## What is Daemons?

Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server)
to be <i>run as a daemon</i> and to be <i>controlled by simple start/stop/restart commands</i>.
Expand All @@ -17,66 +17,73 @@ if they crash.
Daemons includes the <tt>daemonize.rb</tt> script written by <i>Travis Whitton</i> to do the daemonization
process.

== Basic Usage
## Basic Usage

You can use Daemons in four differet ways:

=== 1. Create wrapper scripts for your server scripts or applications
### 1. Create wrapper scripts for your server scripts or applications

Layout: suppose you have your self-written server <tt>myserver.rb</tt>:

``` ruby
# this is myserver.rb
# it does nothing really useful at the moment

loop do
sleep(5)
end

```
To use <tt>myserver.rb</tt> in a production environment, you need to be able to
run <tt>myserver.rb</tt> in the _background_ (this means detach it from the console, fork it
in the background, release all directories and file descriptors).

Just create <tt>myserver_control.rb</tt> like this:

``` ruby
# this is myserver_control.rb

require 'rubygems' # if you use RubyGems
require 'daemons'

Daemons.run('myserver.rb')

```
And use it like this from the console:

``` bash
$ ruby myserver_control.rb start
(myserver.rb is now running in the background)
$ ruby myserver_control.rb restart
(...)
$ ruby myserver_control.rb stop

```
For testing purposes you can even run <tt>myserver.rb</tt> <i>without forking</i> in the background:

``` bash
$ ruby myserver_control.rb run

```
An additional nice feature of Daemons is that you can pass <i>additional arguments</i> to the script that
should be daemonized by seperating them by two _hyphens_:

``` bash
$ ruby myserver_control.rb start -- --file=anyfile --a_switch another_argument

```

=== 2. Create wrapper scripts that include your server procs
### 2. Create wrapper scripts that include your server procs

Layout: suppose you have some code you want to run in the background and control that background process
from a script:

``` ruby
# this is your code
# it does nothing really useful at the moment

loop do
sleep(5)
end

```
To run this code as a daemon create <tt>myproc_control.rb</tt> like this and include your code:

``` ruby
# this is myproc_control.rb

require 'rubygems' # if you use RubyGems
Expand All @@ -87,24 +94,27 @@ To run this code as a daemon create <tt>myproc_control.rb</tt> like this and inc
sleep(5)
end
end

```
And use it like this from the console:

``` bash
$ ruby myproc_control.rb start
(myproc.rb is now running in the background)
$ ruby myproc_control.rb restart
(...)
$ ruby myproc_control.rb stop

```
For testing purposes you can even run <tt>myproc.rb</tt> <i>without forking</i> in the background:

``` bash
$ ruby myproc_control.rb run

=== 3. Control a bunch of daemons from another application
```
### 3. Control a bunch of daemons from another application

Layout: you have an application <tt>my_app.rb</tt> that wants to run a bunch of
server tasks as daemon processes.

``` ruby
# this is my_app.rb

require 'rubygems' # if you use RubyGems
Expand Down Expand Up @@ -134,12 +144,13 @@ server tasks as daemon processes.
task2.stop

exit

=== 4. Daemonize the currently running process
```
### 4. Daemonize the currently running process

Layout: you have an application <tt>my_daemon.rb</tt> that wants to run as a daemon
(but without the ability to be controlled by daemons via start/stop commands)

``` ruby
# this is my_daemons.rb

require 'rubygems' # if you use RubyGems
Expand All @@ -156,37 +167,41 @@ Layout: you have an application <tt>my_daemon.rb</tt> that wants to run as a dae
conn = accept_conn()
serve(conn)
}

```

<b>For further documentation, refer to the module documentation of Daemons.</b>


== Download and Installation
## Download and Installation

*Download*: just go to http://rubyforge.org/projects/daemons/

Installation *with* RubyGems:

``` bash
$ su
# gem install daemons

```
Installation *without* RubyGems:

``` bash
$ tar xfz daemons-x.x.x.tar.gz
$ cd daemons-x.x.x
$ su
# ruby setup.rb

== Documentation
```
## Documentation

For further documentation, refer to the module documentation of Daemons (click on Daemons).

The RDoc documentation is also online at http://daemons.rubyforge.org


== Author
## Author

Written in 2005-2008 by Thomas Uehlinger <mailto:[email protected]>.

== License
## License

Copyright (c) 2005-2008 Thomas Uehlinger

Expand Down Expand Up @@ -218,6 +233,6 @@ The Daemonize extension module is copywrited free software by Travis Whitton
<[email protected]>. You can redistribute it under the terms specified in
the COPYING file of the Ruby distribution.

== Feedback and other resources
## Feedback and other resources

At http://rubyforge.org/projects/daemons.
At [http://rubyforge.org/projects/daemons]().
4 changes: 2 additions & 2 deletions daemons.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Gem::Specification.new do |s|
s.date = %q{2009-08-26}
s.description = %q{Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server) to be run as a daemon and to be controlled by simple start/stop/restart commands. You can also call blocks as daemons and control them from the parent or just daemonize the current process. Besides this basic functionality, daemons offers many advanced features like exception backtracing and logging (in case your ruby script crashes) and monitoring and automatic restarting of your processes if they crash.}
s.email = %q{[email protected]}
s.extra_rdoc_files = ["README", "Releases", "TODO"]
s.files = ["Rakefile", "Releases", "TODO", "README", "LICENSE", "setup.rb", "lib/daemons.rb", "lib/daemons/cmdline.rb", "lib/daemons/exceptions.rb", "lib/daemons/daemonize.rb", "lib/daemons/pidfile.rb", "lib/daemons/monitor.rb", "lib/daemons/application_group.rb", "lib/daemons/controller.rb", "lib/daemons/pid.rb", "lib/daemons/pidmem.rb", "lib/daemons/application.rb", "examples/run", "examples/run/ctrl_exec.rb", "examples/run/ctrl_exit.rb", "examples/run/ctrl_multiple.rb", "examples/run/myserver_crashing.rb.output", "examples/run/ctrl_normal.rb", "examples/run/ctrl_proc_multiple.rb", "examples/run/ctrl_monitor.rb", "examples/run/myserver.rb", "examples/run/myserver_crashing.rb", "examples/run/ctrl_proc.rb", "examples/run/ctrl_proc.rb.output", "examples/run/ctrl_proc_multiple.rb.output", "examples/run/ctrl_optionparser.rb", "examples/run/ctrl_ontop.rb", "examples/run/myserver_exiting.rb", "examples/run/ctrl_crash.rb", "examples/run/ctrl_proc_simple.rb", "examples/run/ctrl_keep_pid_files.rb", "examples/call", "examples/call/call_monitor.rb", "examples/call/call.rb", "examples/daemonize", "examples/daemonize/daemonize.rb"]
s.extra_rdoc_files = ["README.md", "Releases", "TODO"]
s.files = ["Rakefile", "Releases", "TODO", "README.md", "LICENSE", "setup.rb", "lib/daemons.rb", "lib/daemons/cmdline.rb", "lib/daemons/exceptions.rb", "lib/daemons/daemonize.rb", "lib/daemons/pidfile.rb", "lib/daemons/monitor.rb", "lib/daemons/application_group.rb", "lib/daemons/controller.rb", "lib/daemons/pid.rb", "lib/daemons/pidmem.rb", "lib/daemons/application.rb", "examples/run", "examples/run/ctrl_exec.rb", "examples/run/ctrl_exit.rb", "examples/run/ctrl_multiple.rb", "examples/run/myserver_crashing.rb.output", "examples/run/ctrl_normal.rb", "examples/run/ctrl_proc_multiple.rb", "examples/run/ctrl_monitor.rb", "examples/run/myserver.rb", "examples/run/myserver_crashing.rb", "examples/run/ctrl_proc.rb", "examples/run/ctrl_proc.rb.output", "examples/run/ctrl_proc_multiple.rb.output", "examples/run/ctrl_optionparser.rb", "examples/run/ctrl_ontop.rb", "examples/run/myserver_exiting.rb", "examples/run/ctrl_crash.rb", "examples/run/ctrl_proc_simple.rb", "examples/run/ctrl_keep_pid_files.rb", "examples/call", "examples/call/call_monitor.rb", "examples/call/call.rb", "examples/daemonize", "examples/daemonize/daemonize.rb"]
s.has_rdoc = true
s.homepage = %q{http://daemons.rubyforge.org}
s.require_paths = ["lib"]
Expand Down