update docs
This commit is contained in:
+9
-2
@@ -8,7 +8,7 @@ foreman(1) -- manage Procfile-based applications
|
|||||||
|
|
||||||
## DESCRIPTION
|
## DESCRIPTION
|
||||||
|
|
||||||
**Foreman** is a manager for Procfile-based applications. Its aim is to
|
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
|
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.
|
||||||
@@ -33,6 +33,9 @@ The following options control how the application is run:
|
|||||||
Specify which port to use as the base for this application. Should be
|
Specify which port to use as the base for this application. Should be
|
||||||
a multiple of 1000.
|
a multiple of 1000.
|
||||||
|
|
||||||
|
`foreman run` is used to run one-off commands using the same environment
|
||||||
|
as your defined processes.
|
||||||
|
|
||||||
## EXPORTING
|
## EXPORTING
|
||||||
|
|
||||||
`foreman export` is used to export your application to another process
|
`foreman export` is used to export your application to another process
|
||||||
@@ -58,11 +61,15 @@ The following options control how the application is run:
|
|||||||
Specify which port to use as the base for this application. Should be
|
Specify which port to use as the base for this application. Should be
|
||||||
a multiple of 1000.
|
a multiple of 1000.
|
||||||
|
|
||||||
|
* `-t`, `--template`:
|
||||||
|
Specify an alternate template to use for creating export files.
|
||||||
|
See <https://github.com/ddollar/foreman/tree/master/data/export> for examples.
|
||||||
|
|
||||||
* `-u`, `--user`:
|
* `-u`, `--user`:
|
||||||
Specify the user the application should be run as. Defaults to the
|
Specify the user the application should be run as. Defaults to the
|
||||||
app name
|
app name
|
||||||
|
|
||||||
## OPTIONS
|
## GLOBAL OPTIONS
|
||||||
|
|
||||||
These options control all modes of foreman's operation.
|
These options control all modes of foreman's operation.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user