dinislage/foreman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update man page

Browse Source
This commit is contained in:
David Dollar
2010-12-13 18:11:36 -05:00
parent a504a59f0b
commit f2be566051
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/foreman.1.ronn
+12 -12
View File
@@ -1,4 +1,4 @@
foreman(1) -- manage Psfile-based applications foreman(1) -- manage Procfile-based applications
================================================ ================================================
## SYNOPSIS ## SYNOPSIS
@@ -8,8 +8,8 @@ foreman(1) -- manage Psfile-based applications
## DESCRIPTION ## DESCRIPTION
**Foreman** is a manager for Psfile-based applications. Its aim is to **Foreman** is a manager for Procfile-based applications. Its aim is to
abstract away the details of the Psfile format, and allow you to either run 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 your application directly or export it to some other process management
format. format.
@@ -18,7 +18,7 @@ format.
`foreman start` is used to run your application directly from the command line. `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 If no additional parameters are passed, foreman will run one instance of each
type of process defined in your Psfile. type of process defined in your Procfile.
If a parameter is passed, foreman will run one instance of the specified If a parameter is passed, foreman will run one instance of the specified
application type. application type.
@@ -66,8 +66,8 @@ The following options control how the application is run:
These options control all modes of foreman's operation. These options control all modes of foreman's operation.
* `-f`, `--psfile`: * `-f`, `--procfile`:
Specify an alternate location for the application's Psfile. This file's Specify an alternate location for the application's Procfile. This file's
containing directory will be assumed to be the root directory of the containing directory will be assumed to be the root directory of the
application. application.
@@ -99,13 +99,13 @@ will be structured to make the following commands valid:
`restart appname-processname-3` `restart appname-processname-3`
## PSFILE ## PROCFILE
A Psfile should contain both a name for the process and the command used A Procfile should contain both a name for the process and the command used
to run it. to run it.
web bundle exec thin start web: bundle exec thin start
job bundle exec rake jobs:work job: bundle exec rake jobs:work
## EXAMPLES ## EXAMPLES
@@ -117,9 +117,9 @@ Export the application in upstart format:
$ foreman export upstart /etc/init $ foreman export upstart /etc/init
Run one process type from the application defined in a specific Psfile: Run one process type from the application defined in a specific Procfile:
$ foreman start alpha -p ~/myapp/Psfile $ foreman start alpha -p ~/myapp/Procfile
## COPYRIGHT ## COPYRIGHT