diff --git a/README.md b/README.md index 92fab56a..4b981135 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ Manage Procfile-based applications $ gem install foreman -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. +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. ## Getting Started -* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html +- http://blog.daviddollar.org/2011/05/06/introducing-foreman.html ## Supported Ruby versions @@ -20,29 +20,31 @@ See [ci.yml](.github/workflows/ci.yml) for a list of Ruby versions against which ## Documentation -* [man page](http://ddollar.github.io/foreman/) -* [wiki](https://github.com/ddollar/foreman/wiki) -* [changelog](https://github.com/ddollar/foreman/blob/master/Changelog.md) +- [man page](http://ddollar.github.io/foreman/) +- [wiki](https://github.com/ddollar/foreman/wiki) +- [changelog](https://github.com/ddollar/foreman/blob/main/Changelog.md) ## Ports -* [forego](https://github.com/ddollar/forego) - Go -* [node-foreman](https://github.com/strongloop/node-foreman) - Node.js -* [gaffer](https://github.com/jingweno/gaffer) - Java/JVM -* [goreman](https://github.com/mattn/goreman) - Go -* [honcho](https://github.com/nickstenning/honcho) - python -* [proclet](https://github.com/kazeburo/Proclet) - Perl -* [shoreman](https://github.com/chrismytton/shoreman) - shell -* [crank](https://github.com/arktisklada/crank) - Crystal -* [houseman](https://github.com/fujimura/houseman) - Haskell -* [spm](https://github.com/bytegust/spm) - Go +- [forego](https://github.com/ddollar/forego) - Go +- [node-foreman](https://github.com/strongloop/node-foreman) - Node.js +- [gaffer](https://github.com/jingweno/gaffer) - Java/JVM +- [goreman](https://github.com/mattn/goreman) - Go +- [honcho](https://github.com/nickstenning/honcho) - python +- [proclet](https://github.com/kazeburo/Proclet) - Perl +- [shoreman](https://github.com/chrismytton/shoreman) - shell +- [crank](https://github.com/arktisklada/crank) - Crystal +- [houseman](https://github.com/fujimura/houseman) - Haskell +- [spm](https://github.com/bytegust/spm) - Go ## Authors #### Created and maintained by + David Dollar #### Patches contributed by + [Contributor List](https://github.com/ddollar/foreman/contributors) ## License diff --git a/lib/foreman/engine/cli.rb b/lib/foreman/engine/cli.rb index a6055332..1cbc66f4 100644 --- a/lib/foreman/engine/cli.rb +++ b/lib/foreman/engine/cli.rb @@ -49,7 +49,7 @@ def color(name) def startup @colors = map_colors - proctitle "foreman: master" unless Foreman.windows? + proctitle "foreman: main" unless Foreman.windows? Color.enable($stdout, options[:color]) end diff --git a/lib/foreman/export/base.rb b/lib/foreman/export/base.rb index 2608b546..010529e6 100644 --- a/lib/foreman/export/base.rb +++ b/lib/foreman/export/base.rb @@ -74,8 +74,8 @@ def self.warn_deprecation! puts "WARNING: Using deprecated exporter interface. Please update your exporter" puts "the interface shown in the upstart exporter:" puts - puts "https://github.com/ddollar/foreman/blob/master/lib/foreman/export/upstart.rb" - puts "https://github.com/ddollar/foreman/blob/master/data/export/upstart/process.conf.erb" + puts "https://github.com/ddollar/foreman/blob/main/lib/foreman/export/upstart.rb" + puts "https://github.com/ddollar/foreman/blob/main/data/export/upstart/process.conf.erb" puts @@deprecation_warned = true end diff --git a/man/foreman.1 b/man/foreman.1 index 2e10ceef..83813e21 100644 --- a/man/foreman.1 +++ b/man/foreman.1 @@ -56,7 +56,7 @@ Specify the directory to place process logs in\. Specify which port to use as the base for this application\. Should be a multiple of 1000\. .TP \fB\-t\fR, \fB\-\-template\fR -Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/master/data/export\fR for examples\. +Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/main/data/export\fR for examples\. .TP \fB\-u\fR, \fB\-\-user\fR Specify the user the application should be run as\. Defaults to the app name diff --git a/man/foreman.1.ronn b/man/foreman.1.ronn index 78e07350..9961741c 100644 --- a/man/foreman.1.ronn +++ b/man/foreman.1.ronn @@ -1,5 +1,4 @@ -foreman(1) -- manage Procfile-based applications -================================================ +# foreman(1) -- manage Procfile-based applications ## SYNOPSIS @@ -26,23 +25,23 @@ application type. The following options control how the application is run: - * `-m`, `--formation`: - Specify the number of each process type to run. The value passed in - should be in the format `process=num,process=num` +- `-m`, `--formation`: + Specify the number of each process type to run. The value passed in + should be in the format `process=num,process=num` - * `-e`, `--env`: - Specify one or more .env files to load +- `-e`, `--env`: + Specify one or more .env files to load - * `-f`, `--procfile`: - Specify an alternate Procfile to load, implies `-d` at the Procfile root. +- `-f`, `--procfile`: + Specify an alternate Procfile to load, implies `-d` at the Procfile root. - * `-p`, `--port`: - Specify which port to use as the base for this application. Should be - a multiple of 1000. +- `-p`, `--port`: + Specify which port to use as the base for this application. Should be + a multiple of 1000. - * `-t`, `--timeout`: - Specify the amount of time (in seconds) processes have to shutdown - gracefully before receiving a SIGKILL, defaults to 5. +- `-t`, `--timeout`: + Specify the amount of time (in seconds) processes have to shutdown + gracefully before receiving a SIGKILL, defaults to 5. `foreman run` is used to run one-off commands using the same environment as your defined processes. @@ -57,63 +56,63 @@ either required or optional depending on the export format. The following options control how the application is run: - * `-a`, `--app`: - Use this name rather than the application's root directory name as the - name of the application when exporting. +- `-a`, `--app`: + Use this name rather than the application's root directory name as the + name of the application when exporting. - * `-m`, `--formation`: - Specify the number of each process type to run. The value passed in - should be in the format `process=num,process=num` +- `-m`, `--formation`: + Specify the number of each process type to run. The value passed in + should be in the format `process=num,process=num` - * `-l`, `--log`: - Specify the directory to place process logs in. +- `-l`, `--log`: + Specify the directory to place process logs in. - * `-p`, `--port`: - Specify which port to use as the base for this application. Should be - a multiple of 1000. +- `-p`, `--port`: + Specify which port to use as the base for this application. Should be + a multiple of 1000. - * `-t`, `--template`: - Specify an alternate template to use for creating export files. - See for examples. +- `-t`, `--template`: + Specify an alternate template to use for creating export files. + See for examples. - * `-u`, `--user`: - Specify the user the application should be run as. Defaults to the - app name +- `-u`, `--user`: + Specify the user the application should be run as. Defaults to the + app name ## GLOBAL OPTIONS These options control all modes of foreman's operation. - * `-d`, `--root`: - Specify an alternate application root. This defaults to the directory - containing the Procfile. +- `-d`, `--root`: + Specify an alternate application root. This defaults to the directory + containing the Procfile. - * `-e`, `--env`: - Specify an alternate environment file. You can specify more than one - file by using: `--env file1,file2`. +- `-e`, `--env`: + Specify an alternate environment file. You can specify more than one + file by using: `--env file1,file2`. - * `-f`, `--procfile`: - Specify an alternate location for the application's Procfile. This file's - containing directory will be assumed to be the root directory of the - application. +- `-f`, `--procfile`: + Specify an alternate location for the application's Procfile. This file's + containing directory will be assumed to be the root directory of the + application. ## EXPORT FORMATS foreman currently supports the following output formats: - * bluepill +- bluepill - * inittab +- inittab - * launchd +- launchd - * runit +- runit - * supervisord +- supervisord - * systemd +- systemd - * upstart +- upstart ## INITTAB EXPORT @@ -129,22 +128,22 @@ Will export a chunk of inittab-compatible configuration: Will create a series of systemd scripts in the location you specify. Scripts will be structured to make the following commands valid: - `systemctl start appname.target` +`systemctl start appname.target` - `systemctl stop appname-processname.target` +`systemctl stop appname-processname.target` - `systemctl restart appname-processname-3.service` +`systemctl restart appname-processname-3.service` ## UPSTART EXPORT Will create a series of upstart scripts in the location you specify. Scripts will be structured to make the following commands valid: - `start appname` +`start appname` - `stop appname-processname` +`stop appname-processname` - `restart appname-processname-3` +`restart appname-processname-3` ## PROCFILE diff --git a/tasks/release.rake b/tasks/release.rake index bc02c8c1..eefc1917 100644 --- a/tasks/release.rake +++ b/tasks/release.rake @@ -24,7 +24,7 @@ task :pages => "man:commit" do git add -u index.html git commit -m "saving man page to github docs" git push origin -f gh-pages - git checkout master + git checkout main } end