Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddollar committed Apr 23, 2016
1 parent 854a90b commit c02e674
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions man/foreman.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMAN" "1" "January 2015" "Foreman 0.78.0" "Foreman Manual"
.TH "FOREMAN" "1" "April 2016" "Foreman 0.80.0" "Foreman Manual"
.
.SH "NAME"
\fBforeman\fR \- manage Procfile\-based applications
Expand Down Expand Up @@ -31,7 +31,7 @@ If a parameter is passed, foreman will run one instance of the specified applica
The following options control how the application is run:
.
.TP
\fB\-c\fR, \fB\-\-concurrency\fR
\fB\-m\fR, \fB\-\-formation\fR
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
.
.TP
Expand All @@ -57,7 +57,7 @@ Specify the amount of time (in seconds) processes have to shutdown gracefully be
\fBforeman export\fR is used to export your application to another process management format\.
.
.P
A location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
An location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
.
.P
The following options control how the application is run:
Expand All @@ -67,7 +67,7 @@ The following options control how the application is run:
Use this name rather than the application\'s root directory name as the name of the application when exporting\.
.
.TP
\fB\-c\fR, \fB\-\-concurrency\fR
\fB\-m\fR, \fB\-\-formation\fR
Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
.
.TP
Expand Down Expand Up @@ -194,6 +194,12 @@ $ foreman check
.
.IP "" 0
.
.P
The special environment variables \fB$PORT\fR and \fB$PS\fR are available within the Procfile\. \fB$PORT\fR is the port selected for that process\. \fB$PS\fR is the name of the process for the line\.
.
.P
The \fB$PORT\fR value starts as the base port as specified by \fB\-p\fR, then increments by 100 for each new process line\. Multiple instances of the same process are assigned \fB$PORT\fR values that increment by 1\.
.
.SH "ENVIRONMENT"
If a \fB\.env\fR file exists in the current directory, the default environment will be read from it\. This file should contain key/value pairs, separated by \fB=\fR, with one key/value pair per line\.
.
Expand All @@ -215,7 +221,7 @@ If a \fB\.foreman\fR file exists in the current directory, default options will
.
.nf

concurrency: alpha=0,bravo=1
formation: alpha=0,bravo=1
port: 15000
.
.fi
Expand Down Expand Up @@ -268,7 +274,7 @@ Start all processes except the one named worker:
.
.nf

$ foreman start \-c all=1,worker=0
$ foreman start \-m all=1,worker=0
.
.fi
.
Expand Down

0 comments on commit c02e674

Please sign in to comment.