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

update manual to mention .env

Browse Source
This commit is contained in:
David Dollar
2011-08-18 12:52:03 -04:00
parent a2ba079665
commit 3b8fec463d
2 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
man/foreman.1
View File

@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMAN" "1" "May 2011" "Foreman 0.15.0" "Foreman Manual"
.TH "FOREMAN" "1" "August 2011" "Foreman 0.19.0" "Foreman Manual"
.
.SH "NAME"
\fBforeman\fR \- manage Procfile\-based applications
@@ -69,7 +69,7 @@ These options control all modes of foreman\'s operation\.
.
.TP
\fB\-e\fR, \fB\-\-env\fR
Specify a file containing the environment that should be set up for each child process\. The file should be key/value pairs separated by \fB=\fR, with one key/value pair per line\.
Specify an alternate environment file\.
.
.TP
\fB\-f\fR, \fB\-\-procfile\fR
@@ -141,6 +141,20 @@ $ foreman check
.
.IP "" 0
.
.SH "ENVIRONMENT"
If a \fB\.env\fR file exists in the project 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\.
.
.IP "" 4
.
.nf
FOO=bar
BAZ=qux
.
.fi
.
.IP "" 0
.
.SH "DEFAULT OPTIONS"
If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
.

13
man/foreman.1.ronn
View File

@@ -67,9 +67,7 @@ The following options control how the application is run:
These options control all modes of foreman's operation.
* `-e`, `--env`:
Specify a file containing the environment that should be set up for each
child process. The file should be key/value pairs separated by `=`, with
one key/value pair per line.
Specify an alternate environment file.
* `-f`, `--procfile`:
Specify an alternate location for the application's Procfile. This file's
@@ -116,6 +114,15 @@ You can validate your Procfile format using the `check` command
$ foreman check
## ENVIRONMENT
If a `.env` file exists in the project directory, the default environment will
be read from it. This file should contain key/value pairs, separated by `=`, with
one key/value pair per line.
FOO=bar
BAZ=qux
## DEFAULT OPTIONS
If a `.foreman` file exists in the current directory, default options will