add a bit more example to the docs

This commit is contained in:
David Dollar
2010-06-30 21:48:11 -04:00
parent 895672efe8
commit fbdf4d7220

View File

@@ -62,11 +62,39 @@ The following options control how the application is run:
These options control all modes of foreman's operation.
* `-f`, `--procfile`
* `-f`, `--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.
## EXPORT FORMATS
foreman currently supports the following output formats:
* inittab
* upstart
## INITTAB EXPORT
Will export a chunk of inittab-compatible configuration:
# ----- foreman example processes -----
EX01:4:respawn:/bin/su - example -c 'PORT=5000 bundle exec thin start >> /var/log/web-1.log 2>&1'
EX02:4:respawn:/bin/su - example -c 'PORT=5100 bundle exec rake jobs:work >> /var/log/job-1.log 2>&1'
# ----- end foreman example processes -----
## UPSTART EXPORT
Will create a series of upstart scripts in the location you specify. Scripts
will be structured to make the following commands valid:
`start appname`
`stop appname-processname`
`restart appname-processname-3`
## PROCFILE
A Procfile should contain both a name for the process and the command used