foreman 0.4.2 → 0.4.3

data/README.markdown

@@ -0,0 +1,87 @@
+foreman(1) -- manage Procfile-based applications
+================================================
+
+## SYNOPSIS
+
+`foreman start [process]`<br>
+`foreman export <var>format</var> [location]`
+
+## DESCRIPTION
+
+**Foreman** is a manager for Procfile-based applications. Its aim is to
+abstract away the details of the Procfile format, and allow you to either run
+your application directly or export it to some other process management
+format.
+
+## RUNNING
+
+`foreman start` is used to run your application directly from the command line. 
+
+If no additional parameters are passed, foreman will run one instance of each
+type of process defined in your Procfile.
+
+If a parameter is passed, foreman will run one instance of the specified
+application type.
+
+The following options control how the application is run:
+
+  * `-s`, `--screen`:
+    Run the application as a series of screen windows rather than interleaved
+    in stdout.
+
+## EXPORTING
+
+`foreman export` is used to export your application to another process
+management format.
+
+An location to export can be passed as an argument. This argument may be
+either required or optional depending on the export format.
+
+The following options control how the application is run:
+
+  * `-a`, `--app`:
+    Use this name rather than the application's root directory name as the
+    name of the application when exporting.
+    
+  * `-c`, `--concurrency`:
+    Specify the number of each process type to run. The value passed in
+    should be in the format `process=num,process=num`.
+
+## OPTIONS
+
+These options control all modes of foreman's operation.
+
+  * `-p`, `--procfile`
+    Specify an alternate location for the application's Procfile. This file's
+    containing directory will be assumed to be the root directory of the
+    application.
+
+## EXAMPLES
+
+Start one instance of each process type, interleave the output on stdout:
+
+    $ foreman start
+
+Export the application in upstart format:
+
+    $ foreman export upstart /etc/init
+    
+Run one process type from the application defined in a specific Procfile:
+
+    $ foreman start alpha -p ~/app/Procfile
+
+## COPYRIGHT
+
+Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
+
+
+[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
+[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[RUNNING]: #RUNNING "RUNNING"
+[EXPORTING]: #EXPORTING "EXPORTING"
+[OPTIONS]: #OPTIONS "OPTIONS"
+[EXAMPLES]: #EXAMPLES "EXAMPLES"
+[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
+
+
+[foreman(1)]: foreman.1.html

data/Rakefile

@@ -29,6 +29,9 @@ task :man do
   ENV['RONN_MANUAL']  = "Foreman Manual"
   ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
   sh "ronn -w -s toc -r5 --markdown man/*.ronn"
+  sh "cp man/foreman.1.markdown README.markdown"
+  sh "git add README.markdown"
+  sh "git commit -m 'update readme' || echo 'nothing to commit'"
 end
 
 task :pages => :man do

data/lib/foreman.rb

@@ -1,6 +1,6 @@
 module Foreman
 
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 
   class AppDoesNotExist < Exception; end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: foreman
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - David Dollar
@@ -137,7 +137,7 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.markdown
 files: 
 - Rakefile
 - bin/foreman
@@ -157,7 +157,7 @@ files:
 - spec/foreman/process_spec.rb
 - spec/foreman_spec.rb
 - spec/spec_helper.rb
-- README.rdoc
+- README.markdown
 has_rdoc: false
 homepage: http://github.com/ddollar/foreman
 licenses: []

data/README.rdoc

@@ -1,85 +0,0 @@
-= Foreman
-
-== Procfile
-
-    alpha ./bin/alpha
-    bravo ./bin/bravo some args
-    charlie ./bin/charlie -n 5
-
-== Development mode
-
-=== Running
-
-Log files will be output to standard out, colorized to aid in visual separation.
-
-    $ foreman start
-    [01:27:08] [alpha] started with pid 4393
-    [01:27:08] [bravo] started with pid 4394
-    [01:27:08] [charlie] started with pid 4395
-    [01:27:08] [bravo] initializing...
-    [01:27:08] [bravo] complete
-
-=== Using Screen
-
-Launch the processes in a screen session in indivudal windows
-
-    $ foreman screen
-
-== Single Process Execution
-
-    $ foreman execute alpha
-
-== Exporting to Upstart
-
-=== Export to upstart scripts
-
-    $ foreman export sampleapp
-
-    $ initctl list | grep sampleapp
-    sampleapp start/running
-    sampleapp-alpha (1) start/running, process 4204
-    sampleapp-bravo (1) start/running, process 4589
-    sampleapp-charlie (1) start/running, process 4597
-
-=== Change process concurrency levels
-
-    $ foreman scale sampleapp alpha 4
-    sampleapp-alpha (2) start/running, process 4164
-    sampleapp-alpha (3) start/running, process 4166
-    sampleapp-alpha (4) start/running, process 4168
-
-    $ initctl list | grep sampleapp
-    sampleapp start/running
-    sampleapp-alpha (4) start/running, process 4168
-    sampleapp-alpha (3) start/running, process 4166
-    sampleapp-alpha (2) start/running, process 4164
-    sampleapp-alpha (1) start/running, process 4204
-    sampleapp-bravo (1) start/running, process 4589
-    sampleapp-charlie (1) start/running, process 4597
-
-    $ foreman scale sampleapp alpha 1
-    sampleapp-alpha stop/waiting
-    sampleapp-alpha stop/waiting
-    sampleapp-alpha stop/waiting
-
-=== Good Upstart citizen
-
-All Upstart commands work as expected
-
-    $ start sampleapp
-    $ stop sampleapp
-    $ restart sampleapp
-
-=== Standardized Logging
-
-    /var/log/sampleapp/alpha.log
-    /var/log/sampleapp/bravo.log
-    /var/log/sampleapp/charlie.log
-
-== License
-
-MIT
-
-== Copyright
-
-(c) 2010 David Dollar