foreman 0.7.2 → 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.markdown +4 -0
  2. data/lib/foreman.rb +1 -1
  3. data/man/foreman.1 +163 -0
  4. metadata +7 -5
data/README.markdown ADDED
@@ -0,0 +1,4 @@
1
+ Foreman
2
+ =======
3
+
4
+ See the [man page](http://ddollar.github.com/foreman) for usage.
data/lib/foreman.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  module Foreman
2
2
 
3
- VERSION = "0.7.2"
3
+ VERSION = "0.7.3"
4
4
 
5
5
  class AppDoesNotExist < Exception; end
6
6
 
data/man/foreman.1 ADDED
@@ -0,0 +1,163 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "FOREMAN" "1" "June 2010" "Foreman 0.6.0" "Foreman Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBforeman\fR \- manage Procfile\-based applications
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBforeman start [process]\fR
11
+ .
12
+ .br
13
+ \fBforeman export <format> [location]\fR
14
+ .
15
+ .SH "DESCRIPTION"
16
+ \fBForeman\fR 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\.
17
+ .
18
+ .SH "RUNNING"
19
+ \fBforeman start\fR is used to run your application directly from the command line\.
20
+ .
21
+ .P
22
+ If no additional parameters are passed, foreman will run one instance of each type of process defined in your Procfile\.
23
+ .
24
+ .P
25
+ If a parameter is passed, foreman will run one instance of the specified application type\.
26
+ .
27
+ .P
28
+ The following options control how the application is run:
29
+ .
30
+ .TP
31
+ \fB\-s\fR, \fB\-\-screen\fR
32
+ Run the application as a series of screen windows rather than interleaved in stdout\.
33
+ .
34
+ .SH "EXPORTING"
35
+ \fBforeman export\fR is used to export your application to another process management format\.
36
+ .
37
+ .P
38
+ An location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
39
+ .
40
+ .P
41
+ The following options control how the application is run:
42
+ .
43
+ .TP
44
+ \fB\-a\fR, \fB\-\-app\fR
45
+ Use this name rather than the application\'s root directory name as the name of the application when exporting\.
46
+ .
47
+ .TP
48
+ \fB\-c\fR, \fB\-\-concurrency\fR
49
+ Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
50
+ .
51
+ .TP
52
+ \fB\-l\fR, \fB\-\-log\fR
53
+ Specify the directory to place process logs in\.
54
+ .
55
+ .TP
56
+ \fB\-p\fR, \fB\-\-port\fR
57
+ Specify which port to use as the base for this application\. Should be a multiple of 1000\.
58
+ .
59
+ .TP
60
+ \fB\-u\fR, \fB\-\-user\fR
61
+ Specify the user the application should be run as\. Defaults to the app name
62
+ .
63
+ .SH "OPTIONS"
64
+ These options control all modes of foreman\'s operation\.
65
+ .
66
+ .TP
67
+ \fB\-f\fR, \fB\-\-procfile\fR
68
+ 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\.
69
+ .
70
+ .SH "EXPORT FORMATS"
71
+ foreman currently supports the following output formats:
72
+ .
73
+ .IP "\(bu" 4
74
+ inittab
75
+ .
76
+ .IP "\(bu" 4
77
+ upstart
78
+ .
79
+ .IP "" 0
80
+ .
81
+ .SH "INITTAB EXPORT"
82
+ Will export a chunk of inittab\-compatible configuration:
83
+ .
84
+ .IP "" 4
85
+ .
86
+ .nf
87
+
88
+ # \-\-\-\-\- foreman example processes \-\-\-\-\-
89
+ EX01:4:respawn:/bin/su \- example \-c \'PORT=5000 bundle exec thin start >> /var/log/web\-1\.log 2>&1\'
90
+ EX02:4:respawn:/bin/su \- example \-c \'PORT=5100 bundle exec rake jobs:work >> /var/log/job\-1\.log 2>&1\'
91
+ # \-\-\-\-\- end foreman example processes \-\-\-\-\-
92
+ .
93
+ .fi
94
+ .
95
+ .IP "" 0
96
+ .
97
+ .SH "UPSTART EXPORT"
98
+ Will create a series of upstart scripts in the location you specify\. Scripts will be structured to make the following commands valid:
99
+ .
100
+ .P
101
+ \fBstart appname\fR
102
+ .
103
+ .P
104
+ \fBstop appname\-processname\fR
105
+ .
106
+ .P
107
+ \fBrestart appname\-processname\-3\fR
108
+ .
109
+ .SH "PROCFILE"
110
+ A Procfile should contain both a name for the process and the command used to run it\.
111
+ .
112
+ .IP "" 4
113
+ .
114
+ .nf
115
+
116
+ web bundle exec thin start
117
+ job bundle exec rake jobs:work
118
+ .
119
+ .fi
120
+ .
121
+ .IP "" 0
122
+ .
123
+ .SH "EXAMPLES"
124
+ Start one instance of each process type, interleave the output on stdout:
125
+ .
126
+ .IP "" 4
127
+ .
128
+ .nf
129
+
130
+ $ foreman start
131
+ .
132
+ .fi
133
+ .
134
+ .IP "" 0
135
+ .
136
+ .P
137
+ Export the application in upstart format:
138
+ .
139
+ .IP "" 4
140
+ .
141
+ .nf
142
+
143
+ $ foreman export upstart /etc/init
144
+ .
145
+ .fi
146
+ .
147
+ .IP "" 0
148
+ .
149
+ .P
150
+ Run one process type from the application defined in a specific Procfile:
151
+ .
152
+ .IP "" 4
153
+ .
154
+ .nf
155
+
156
+ $ foreman start alpha \-p ~/app/Procfile
157
+ .
158
+ .fi
159
+ .
160
+ .IP "" 0
161
+ .
162
+ .SH "COPYRIGHT"
163
+ Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: foreman
3
3
  version: !ruby/object:Gem::Version
4
- hash: 7
4
+ hash: 5
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 7
9
- - 2
10
- version: 0.7.2
9
+ - 3
10
+ version: 0.7.3
11
11
  platform: ruby
12
12
  authors:
13
13
  - |
@@ -150,14 +150,16 @@ description: Process manager for applications with multiple components
150
150
  email: |
151
151
  <ddollar@gmail.com>
152
152
 
153
- executables: []
154
-
153
+ executables:
154
+ - foreman
155
155
  extensions: []
156
156
 
157
157
  extra_rdoc_files: []
158
158
 
159
159
  files:
160
160
  - bin/foreman
161
+ - man/foreman.1
162
+ - README.markdown
161
163
  - lib/foreman.rb
162
164
  - lib/foreman/cli.rb
163
165
  - lib/foreman/engine.rb