1
- foreman(1) -- manage Procfile-based applications
2
- ================================================
1
+ # foreman(1) -- manage Procfile-based applications
3
2
4
3
## SYNOPSIS
5
4
@@ -26,23 +25,23 @@ application type.
26
25
27
26
The following options control how the application is run:
28
27
29
- * ` -m ` , ` --formation ` :
30
- Specify the number of each process type to run. The value passed in
31
- should be in the format ` process=num,process=num `
28
+ - ` -m ` , ` --formation ` :
29
+ Specify the number of each process type to run. The value passed in
30
+ should be in the format ` process=num,process=num `
32
31
33
- * ` -e ` , ` --env ` :
34
- Specify one or more .env files to load
32
+ - ` -e ` , ` --env ` :
33
+ Specify one or more .env files to load
35
34
36
- * ` -f ` , ` --procfile ` :
37
- Specify an alternate Procfile to load, implies ` -d ` at the Procfile root.
35
+ - ` -f ` , ` --procfile ` :
36
+ Specify an alternate Procfile to load, implies ` -d ` at the Procfile root.
38
37
39
- * ` -p ` , ` --port ` :
40
- Specify which port to use as the base for this application. Should be
41
- a multiple of 1000.
38
+ - ` -p ` , ` --port ` :
39
+ Specify which port to use as the base for this application. Should be
40
+ a multiple of 1000.
42
41
43
- * ` -t ` , ` --timeout ` :
44
- Specify the amount of time (in seconds) processes have to shutdown
45
- gracefully before receiving a SIGKILL, defaults to 5.
42
+ - ` -t ` , ` --timeout ` :
43
+ Specify the amount of time (in seconds) processes have to shutdown
44
+ gracefully before receiving a SIGKILL, defaults to 5.
46
45
47
46
` foreman run ` is used to run one-off commands using the same environment
48
47
as your defined processes.
@@ -57,63 +56,63 @@ either required or optional depending on the export format.
57
56
58
57
The following options control how the application is run:
59
58
60
- * ` -a ` , ` --app ` :
61
- Use this name rather than the application's root directory name as the
62
- name of the application when exporting.
59
+ - ` -a ` , ` --app ` :
60
+ Use this name rather than the application's root directory name as the
61
+ name of the application when exporting.
63
62
64
- * ` -m ` , ` --formation ` :
65
- Specify the number of each process type to run. The value passed in
66
- should be in the format ` process=num,process=num `
63
+ - ` -m ` , ` --formation ` :
64
+ Specify the number of each process type to run. The value passed in
65
+ should be in the format ` process=num,process=num `
67
66
68
- * ` -l ` , ` --log ` :
69
- Specify the directory to place process logs in.
67
+ - ` -l ` , ` --log ` :
68
+ Specify the directory to place process logs in.
70
69
71
- * ` -p ` , ` --port ` :
72
- Specify which port to use as the base for this application. Should be
73
- a multiple of 1000.
70
+ - ` -p ` , ` --port ` :
71
+ Specify which port to use as the base for this application. Should be
72
+ a multiple of 1000.
74
73
75
- * ` -t ` , ` --template ` :
76
- Specify an alternate template to use for creating export files.
77
- See < https://github.com/ddollar/foreman/tree/master /data/export > for examples.
74
+ - ` -t ` , ` --template ` :
75
+ Specify an alternate template to use for creating export files.
76
+ See < https://github.com/ddollar/foreman/tree/main /data/export > for examples.
78
77
79
- * ` -u ` , ` --user ` :
80
- Specify the user the application should be run as. Defaults to the
81
- app name
78
+ - ` -u ` , ` --user ` :
79
+ Specify the user the application should be run as. Defaults to the
80
+ app name
82
81
83
82
## GLOBAL OPTIONS
84
83
85
84
These options control all modes of foreman's operation.
86
85
87
- * ` -d ` , ` --root ` :
88
- Specify an alternate application root. This defaults to the directory
89
- containing the Procfile.
86
+ - ` -d ` , ` --root ` :
87
+ Specify an alternate application root. This defaults to the directory
88
+ containing the Procfile.
90
89
91
- * ` -e ` , ` --env ` :
92
- Specify an alternate environment file. You can specify more than one
93
- file by using: ` --env file1,file2 ` .
90
+ - ` -e ` , ` --env ` :
91
+ Specify an alternate environment file. You can specify more than one
92
+ file by using: ` --env file1,file2 ` .
94
93
95
- * ` -f ` , ` --procfile ` :
96
- Specify an alternate location for the application's Procfile. This file's
97
- containing directory will be assumed to be the root directory of the
98
- application.
94
+ - ` -f ` , ` --procfile ` :
95
+ Specify an alternate location for the application's Procfile. This file's
96
+ containing directory will be assumed to be the root directory of the
97
+ application.
99
98
100
99
## EXPORT FORMATS
101
100
102
101
foreman currently supports the following output formats:
103
102
104
- * bluepill
103
+ - bluepill
105
104
106
- * inittab
105
+ - inittab
107
106
108
- * launchd
107
+ - launchd
109
108
110
- * runit
109
+ - runit
111
110
112
- * supervisord
111
+ - supervisord
113
112
114
- * systemd
113
+ - systemd
115
114
116
- * upstart
115
+ - upstart
117
116
118
117
## INITTAB EXPORT
119
118
@@ -129,22 +128,22 @@ Will export a chunk of inittab-compatible configuration:
129
128
Will create a series of systemd scripts in the location you specify. Scripts
130
129
will be structured to make the following commands valid:
131
130
132
- ` systemctl start appname.target `
131
+ ` systemctl start appname.target `
133
132
134
- ` systemctl stop appname-processname.target `
133
+ ` systemctl stop appname-processname.target `
135
134
136
- ` systemctl restart appname-processname-3.service `
135
+ ` systemctl restart appname-processname-3.service `
137
136
138
137
## UPSTART EXPORT
139
138
140
139
Will create a series of upstart scripts in the location you specify. Scripts
141
140
will be structured to make the following commands valid:
142
141
143
- ` start appname `
142
+ ` start appname `
144
143
145
- ` stop appname-processname `
144
+ ` stop appname-processname `
146
145
147
- ` restart appname-processname-3 `
146
+ ` restart appname-processname-3 `
148
147
149
148
## PROCFILE
150
149
0 commit comments