Skip to content

Commit ea6543a

Browse files
committed
update docs
1 parent 23c2982 commit ea6543a

File tree

6 files changed

+76
-75
lines changed

6 files changed

+76
-75
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,43 @@ Manage Procfile-based applications
88

99
$ gem install foreman
1010

11-
Ruby users should take care *not* to install foreman in their project's `Gemfile`. See this [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) for more details.
11+
Ruby users should take care _not_ to install foreman in their project's `Gemfile`. See this [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) for more details.
1212

1313
## Getting Started
1414

15-
* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
15+
- http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
1616

1717
## Supported Ruby versions
1818

1919
See [ci.yml](.github/workflows/ci.yml) for a list of Ruby versions against which Foreman is tested.
2020

2121
## Documentation
2222

23-
* [man page](http://ddollar.github.io/foreman/)
24-
* [wiki](https://github.com/ddollar/foreman/wiki)
25-
* [changelog](https://github.com/ddollar/foreman/blob/master/Changelog.md)
23+
- [man page](http://ddollar.github.io/foreman/)
24+
- [wiki](https://github.com/ddollar/foreman/wiki)
25+
- [changelog](https://github.com/ddollar/foreman/blob/main/Changelog.md)
2626

2727
## Ports
2828

29-
* [forego](https://github.com/ddollar/forego) - Go
30-
* [node-foreman](https://github.com/strongloop/node-foreman) - Node.js
31-
* [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
32-
* [goreman](https://github.com/mattn/goreman) - Go
33-
* [honcho](https://github.com/nickstenning/honcho) - python
34-
* [proclet](https://github.com/kazeburo/Proclet) - Perl
35-
* [shoreman](https://github.com/chrismytton/shoreman) - shell
36-
* [crank](https://github.com/arktisklada/crank) - Crystal
37-
* [houseman](https://github.com/fujimura/houseman) - Haskell
38-
* [spm](https://github.com/bytegust/spm) - Go
29+
- [forego](https://github.com/ddollar/forego) - Go
30+
- [node-foreman](https://github.com/strongloop/node-foreman) - Node.js
31+
- [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
32+
- [goreman](https://github.com/mattn/goreman) - Go
33+
- [honcho](https://github.com/nickstenning/honcho) - python
34+
- [proclet](https://github.com/kazeburo/Proclet) - Perl
35+
- [shoreman](https://github.com/chrismytton/shoreman) - shell
36+
- [crank](https://github.com/arktisklada/crank) - Crystal
37+
- [houseman](https://github.com/fujimura/houseman) - Haskell
38+
- [spm](https://github.com/bytegust/spm) - Go
3939

4040
## Authors
4141

4242
#### Created and maintained by
43+
4344
David Dollar
4445

4546
#### Patches contributed by
47+
4648
[Contributor List](https://github.com/ddollar/foreman/contributors)
4749

4850
## License

lib/foreman/engine/cli.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def color(name)
4949

5050
def startup
5151
@colors = map_colors
52-
proctitle "foreman: master" unless Foreman.windows?
52+
proctitle "foreman: main" unless Foreman.windows?
5353
Color.enable($stdout, options[:color])
5454
end
5555

lib/foreman/export/base.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ def self.warn_deprecation!
7474
puts "WARNING: Using deprecated exporter interface. Please update your exporter"
7575
puts "the interface shown in the upstart exporter:"
7676
puts
77-
puts "https://github.com/ddollar/foreman/blob/master/lib/foreman/export/upstart.rb"
78-
puts "https://github.com/ddollar/foreman/blob/master/data/export/upstart/process.conf.erb"
77+
puts "https://github.com/ddollar/foreman/blob/main/lib/foreman/export/upstart.rb"
78+
puts "https://github.com/ddollar/foreman/blob/main/data/export/upstart/process.conf.erb"
7979
puts
8080
@@deprecation_warned = true
8181
end

man/foreman.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Specify the directory to place process logs in\.
5656
Specify which port to use as the base for this application\. Should be a multiple of 1000\.
5757
.TP
5858
\fB\-t\fR, \fB\-\-template\fR
59-
Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/master/data/export\fR for examples\.
59+
Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/main/data/export\fR for examples\.
6060
.TP
6161
\fB\-u\fR, \fB\-\-user\fR
6262
Specify the user the application should be run as\. Defaults to the app name

man/foreman.1.ronn

+54-55
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
foreman(1) -- manage Procfile-based applications
2-
================================================
1+
# foreman(1) -- manage Procfile-based applications
32

43
## SYNOPSIS
54

@@ -26,23 +25,23 @@ application type.
2625

2726
The following options control how the application is run:
2827

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`
3231

33-
* `-e`, `--env`:
34-
Specify one or more .env files to load
32+
- `-e`, `--env`:
33+
Specify one or more .env files to load
3534

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.
3837

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.
4241

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.
4645

4746
`foreman run` is used to run one-off commands using the same environment
4847
as your defined processes.
@@ -57,63 +56,63 @@ either required or optional depending on the export format.
5756

5857
The following options control how the application is run:
5958

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.
6362

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`
6766

68-
* `-l`, `--log`:
69-
Specify the directory to place process logs in.
67+
- `-l`, `--log`:
68+
Specify the directory to place process logs in.
7069

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.
7473

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.
7877

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
8281

8382
## GLOBAL OPTIONS
8483

8584
These options control all modes of foreman's operation.
8685

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.
9089

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`.
9493

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.
9998

10099
## EXPORT FORMATS
101100

102101
foreman currently supports the following output formats:
103102

104-
* bluepill
103+
- bluepill
105104

106-
* inittab
105+
- inittab
107106

108-
* launchd
107+
- launchd
109108

110-
* runit
109+
- runit
111110

112-
* supervisord
111+
- supervisord
113112

114-
* systemd
113+
- systemd
115114

116-
* upstart
115+
- upstart
117116

118117
## INITTAB EXPORT
119118

@@ -129,22 +128,22 @@ Will export a chunk of inittab-compatible configuration:
129128
Will create a series of systemd scripts in the location you specify. Scripts
130129
will be structured to make the following commands valid:
131130

132-
`systemctl start appname.target`
131+
`systemctl start appname.target`
133132

134-
`systemctl stop appname-processname.target`
133+
`systemctl stop appname-processname.target`
135134

136-
`systemctl restart appname-processname-3.service`
135+
`systemctl restart appname-processname-3.service`
137136

138137
## UPSTART EXPORT
139138

140139
Will create a series of upstart scripts in the location you specify. Scripts
141140
will be structured to make the following commands valid:
142141

143-
`start appname`
142+
`start appname`
144143

145-
`stop appname-processname`
144+
`stop appname-processname`
146145

147-
`restart appname-processname-3`
146+
`restart appname-processname-3`
148147

149148
## PROCFILE
150149

tasks/release.rake

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ task :pages => "man:commit" do
2424
git add -u index.html
2525
git commit -m "saving man page to github docs"
2626
git push origin -f gh-pages
27-
git checkout master
27+
git checkout main
2828
}
2929
end
3030

0 commit comments

Comments
 (0)