admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

dev-cmd/: remove colons from command specs.

Browse Source 
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs.
This commit is contained in:
EricFromCanada 2018-10-15 15:06:33 -04:00
parent 7fb425a5c6
commit 388781f6a7
21 changed files with 364 additions and 358 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Library/Homebrew/dev-cmd/audit.rb
View File

@ -53,7 +53,7 @@ module Homebrew
def audit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`audit` [<options>] <formulae>:
`audit` [<options>] <formulae>
Check <formulae> for Homebrew coding style violations. This should be run before
submitting a new formula. Will exit with a non-zero status if any errors are

2
Library/Homebrew/dev-cmd/bottle.rb
View File

@ -72,7 +72,7 @@ module Homebrew
def bottle_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bottle` [<options>] <formulae>:
`bottle` [<options>] <formulae>
Generate a bottle (binary package) from a formula that was installed with
`--build-bottle`.

2
Library/Homebrew/dev-cmd/bump-formula-pr.rb
View File

@ -50,7 +50,7 @@ module Homebrew
def bump_formula_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-formula-pr` [<options>] [<formula>]:
`bump-formula-pr` [<options>] [<formula>]
Create a pull request to update a formula with a new URL or a new tag.

2
Library/Homebrew/dev-cmd/create.rb
View File

@ -30,7 +30,7 @@ module Homebrew
def create_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`create` [<options>] <URL>:
`create` [<options>] <URL>
Generate a formula for the downloadable file at <URL> and open it in the editor.
Homebrew will attempt to automatically derive the formula name and version, but

2
Library/Homebrew/dev-cmd/edit.rb
View File

@ -13,7 +13,7 @@ module Homebrew
def edit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`edit` [<formulae>]:
`edit` [<formulae>]
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no <formula> is provided.

2
Library/Homebrew/dev-cmd/extract.rb
View File

@ -99,7 +99,7 @@ module Homebrew
def extract_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`extract` [<options>] <formula> <tap>:
`extract` [<options>] <formula> <tap>
Look through repository history to find the most recent version of <formula> and
create a copy in <tap>`/Formula/`<formula>`@`<version>`.rb`. If the tap is not

2
Library/Homebrew/dev-cmd/formula.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def formula_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`formula` <formulae>:
`formula` <formulae>
Display the path where a formula is located.
EOS

2
Library/Homebrew/dev-cmd/irb.rb
View File

@ -26,7 +26,7 @@ module Homebrew
def irb_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`irb` [<options>]:
`irb` [<options>]
Enter the interactive Homebrew Ruby shell.
EOS

2
Library/Homebrew/dev-cmd/linkage.rb
View File

@ -20,7 +20,7 @@ module Homebrew
def linkage_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`linkage` [<options>] [<formulae>]:
`linkage` [<options>] [<formulae>]
Check the library links for kegs of installed formulae.
Raises an error if run on uninstalled formulae.

2
Library/Homebrew/dev-cmd/man.rb
View File

@ -40,7 +40,7 @@ module Homebrew
def man_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`man` [<options>]:
`man` [<options>]
Generate Homebrew's manpages.
EOS

2
Library/Homebrew/dev-cmd/mirror.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def mirror_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`mirror` <formulae>:
`mirror` <formulae>
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
EOS

2
Library/Homebrew/dev-cmd/prof.rb
View File

@ -9,7 +9,7 @@ module Homebrew
def prof_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`prof` [<ruby options>]:
`prof` [<ruby options>]
Run Homebrew with the Ruby profiler.

2
Library/Homebrew/dev-cmd/pull.rb
View File

@ -74,7 +74,7 @@ module Homebrew
def pull_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pull` [<options>] <patch sources>:
`pull` [<options>] <patch sources>
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish updated bottles for the formulae changed by the patch.

2
Library/Homebrew/dev-cmd/release-notes.rb
View File

@ -13,7 +13,7 @@ module Homebrew
def release_notes_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`release-notes` [<options>] [<previous_tag>] [<end_ref>]:
`release-notes` [<options>] [<previous_tag>] [<end_ref>]
Print the merged pull requests on Homebrew/brew between two Git refs.
If no <previous_tag> is provided it defaults to the latest tag.

2
Library/Homebrew/dev-cmd/ruby.rb
View File

@ -11,7 +11,7 @@ module Homebrew
def ruby_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`ruby` [<ruby options>]:
`ruby` [<ruby options>]
Run a Ruby instance with Homebrew's libraries loaded.

2
Library/Homebrew/dev-cmd/tap-new.rb
View File

@ -10,7 +10,7 @@ module Homebrew
def tap_new_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap-new` <user>`/`<repo>:
`tap-new` <user>`/`<repo>
Generate the template files for a new tap.
EOS

2
Library/Homebrew/dev-cmd/test.rb
View File

@ -25,7 +25,7 @@ module Homebrew
def test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`test` [<options>] <formulae>:
`test` [<options>] <formulae>
Run the test method provided by an installed formula.
There is no standard output or return code, but generally it should notify the

2
Library/Homebrew/dev-cmd/tests.rb
View File

@ -24,7 +24,7 @@ module Homebrew
def tests_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tests` [<options>]:
`tests` [<options>]
Run Homebrew's unit and integration tests.
EOS

2
Library/Homebrew/dev-cmd/update-test.rb
View File

@ -22,7 +22,7 @@ module Homebrew
def update_test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update-test` [<options>]:
`update-test` [<options>]
Run a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as the start commit.

454
docs/Manpage.md
View File

@ -663,199 +663,201 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## DEVELOPER COMMANDS
### `audit` [*`options`*] *`formulae`*:
### `audit` [*`options`*] *`formulae`*
Check *`formulae`* for Homebrew coding style violations. This should be
run before submitting a new formula.
Check *`formulae`* for Homebrew coding style violations. This should be run before
submitting a new formula. Will exit with a non-zero status if any errors are
found, which can be useful for implementing pre-commit hooks.
If no *`formulae`* are provided, all of them are checked.
* `--strict`:
Run additional style checks, including Rubocop style checks.
* `--online`:
Run additional slower style checks that require a network connection.
* `--new-formula`:
Run various additional style checks to determine if a new formula is eligible for Homebrew. This should be used when creating new formula and implies `--strict` and `--online`.
* `--fix`:
Fix style violations automatically using RuboCop's auto-correct feature.
* `--display-cop-names`:
Include the RuboCop cop name for each violation in the output.
* `--display-filename`:
Prefix everyline of output with name of the file or formula being audited, to make output easy to grep.
* `-D`, `--audit-debug`:
Activates debugging and profiling
* `--only`:
Passing `--only=`*`method`* will run only the methods named audit_*`method`*. *`method`* should be a comma-separated list.
* `--except`:
Passing `--except=`*`method`* will run only the methods named audit_*`method`*, *`method`* should be a comma-separated list.
* `--only-cops`:
Passing `--only-cops=`*`cops`* will check for violations of only the listed RuboCop cops. *`cops`* should be a comma-separated list of cop names.
* `--except-cops`:
Passing `--except-cops=`*`cops`* will skip checking the listed RuboCop cops violations. *`cops`* should be a comma-separated list of cop names.
* `--strict`:
Run additional style checks, including RuboCop style checks.
* `--online`:
Run additional slower style checks that require a network connection.
* `--new-formula`:
Run various additional style checks to determine if a new formula is eligible for Homebrew. This should be used when creating new formula and implies `--strict` and `--online`.
* `--fix`:
Fix style violations automatically using RuboCop's auto-correct feature.
* `--display-cop-names`:
Include the RuboCop cop name for each violation in the output.
* `--display-filename`:
Prefix every line of output with name of the file or formula being audited, to make output easy to grep.
* `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods.
* `--only`:
Specify a comma-separated *`method`* list to only run the methods named `audit_`*`method`*.
* `--except`:
Specify a comma-separated *`method`* list to skip running the methods named `audit_`*`method`*.
* `--only-cops`:
Specify a comma-separated *`cops`* list to check for violations of only the listed RuboCop cops.
* `--except-cops`:
Specify a comma-separated *`cops`* list to skip checking for violations of the listed RuboCop cops.
### `bottle` [*`options`*] *`formulae`*:
### `bottle` [*`options`*] *`formulae`*
Generate a bottle (binary package) from a formula installed with
Generate a bottle (binary package) from a formula that was installed with
`--build-bottle`.
If the formula specifies a rebuild version, it will be incremented in the
generated DSL. Passing `--keep-old` will attempt to keep it at its
original value, while `--no-rebuild` will remove it.
generated DSL. Passing `--keep-old` will attempt to keep it at its original
value, while `--no-rebuild` will remove it.
* `--skip-relocation`:
Do not check if the bottle can be marked as relocatable.
* `--or-later`:
Append `_or_later` to the bottle tag.
* `--force-core-tap`:
Build a bottle even if *`formula`* is not in homebrew/core or any installed taps.
* `--no-rebuild`:
If the formula specifies a rebuild version, it will be removed in the generated DSL.
* `--keep-old`:
If the formula specifies a rebuild version, it will attempted to be kept in the generated DSL.
* `--merge`:
Generate a bottle from a formula and print the new DSL merged into the existing formula.
* `--write`:
Changes will be written to the formula file. A new commit will be generated unless `--no-commit` is passed.
* `--no-commit`:
When passed with `--write`, a new commit will not generated while writing changes to the formula file.
* `--json`:
Write bottle information to a JSON file, which can be used as the argument for `--merge`.
* `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
* `--skip-relocation`:
Do not check if the bottle can be marked as relocatable.
* `--or-later`:
Append `_or_later` to the bottle tag.
* `--force-core-tap`:
Build a bottle even if *`formula`* is not in homebrew/core or any installed taps.
* `--no-rebuild`:
If the formula specifies a rebuild version, remove it from the generated DSL.
* `--keep-old`:
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL.
* `--json`:
Write bottle information to a JSON file, which can be used as the argument for `--merge`.
* `--merge`:
Generate an updated bottle block for a formula and optionally merge it into the formula file. Instead of a formula name, requires a JSON file generated with `brew bottle --json` *`formula`*.
* `--write`:
Write the changes to the formula file. A new commit will be generated unless `--no-commit` is passed.
* `--no-commit`:
When passed with `--write`, a new commit will not generated after writing changes to the formula file.
* `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
### `bump-formula-pr` [*`options`*] *`formula`*:
### `bump-formula-pr` [*`options`*] [*`formula`*]
Creates a pull request to update the formula with a new URL or a new tag.
Create a pull request to update a formula with a new URL or a new tag.
If a *`URL`* is specified, the *`sha-256`* checksum of the new download must
also be specified. A best effort to determine the *`sha-256`* and *`formula`*
name will be made if either or both values are not supplied by the user.
If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also
be specified. A best effort to determine the *`SHA-256`* and *`formula`* name will
be made if either or both values are not supplied by the user.
If a *`tag`* is specified, the git commit *`revision`* corresponding to that
tag must also be specified.
If a *`tag`* is specified, the Git commit *`revision`* corresponding to that tag
must also be specified.
Note that this command cannot be used to transition a formula from a
URL-and-sha256 style specification into a tag-and-revision style
specification, nor vice versa. It must use whichever style specification
the preexisting formula already uses.
*Note:* this command cannot be used to transition a formula from a
URL-and-SHA-256 style specification into a tag-and-revision style specification,
nor vice versa. It must use whichever style specification the preexisting
formula already uses.
* `--devel`:
Bump the development rather than stable version. The development spec must already exist.
* `-n`, `--dry-run`:
Print what would be done rather than doing it.
* `--write`:
When passed along with `--dry-run`, perform a not-so-dry run making the expected file modifications but not taking any git actions.
* `--audit`:
Run `brew audit` before opening the PR.
* `--strict`:
Run `brew audit --strict` before opening the PR.
* `--no-browse`:
Output the pull request URL instead of opening in a browser
* `--url`:
Provide new *`URL`* for the formula. If a *`URL`* is specified, the *`sha-256`* checksum of the new download must also be specified.
* `--revision`:
Specify the new git commit *`revision`* corresponding to a specified *`tag`*.
* `--tag`:
Specify the new git commit *`tag`* for the formula.
* `--sha256`:
Specify the *`sha-256`* checksum of new download.
* `--mirror`:
Use the provided *`URL`* as a mirror URL.
* `--version`:
Use the provided *`version`* to override the value parsed from the URL or tag. Note that `--version=0` can be used to delete an existing `version` override from a formula if it has become redundant.
* `--message`:
Append provided *`message`* to the default PR message.
* `--devel`:
Bump the development rather than stable version. The development spec must already exist.
* `-n`, `--dry-run`:
Print what would be done rather than doing it.
* `--write`:
When passed along with `--dry-run`, perform a not-so-dry run by making the expected file modifications but not taking any Git actions.
* `--audit`:
Run `brew audit` before opening the PR.
* `--strict`:
Run `brew audit --strict` before opening the PR.
* `--no-browse`:
Print the pull request URL instead of opening in a browser.
* `--mirror`:
Use the provided *`URL`* as a mirror URL.
* `--version`:
Use the provided *`version`* to override the value parsed from the URL or tag. Note that `--version=0` can be used to delete an existing version override from a formula if it has become redundant.
* `--message`:
Append the provided *`message`* to the default PR message.
* `--url`:
Specify the *`URL`* for the new download. If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also be specified.
* `--sha256`:
Specify the *`SHA-256`* checksum of the new download.
* `--tag`:
Specify the new git commit *`tag`* for the formula.
* `--revision`:
Specify the new git commit *`revision`* corresponding to a specified *`tag`*.
### `create` *`URL`* [*`options`*]:
### `create` [*`options`*] *`URL`*
Generate a formula for the downloadable file at *`URL`* and open it in the editor.
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The `wget`
formula serves as a simple example. For the complete API have a look at
<http://www.rubydoc.info/github/Homebrew/brew/master/Formula>.
Homebrew will attempt to automatically derive the formula name and version, but
if it fails, you'll have to make your own template. The `wget` formula serves as
a simple example. For the complete API, see:
<http://www.rubydoc.info/github/Homebrew/brew/master/Formula>
* `--autotools`:
Create a basic template for an Autotools-style build.
* `--cmake`:
Create a basic template for a CMake-style build.
* `--meson`:
Create a basic template for a Meson-style build.
* `--no-fetch`:
Homebrew will not download *`URL`* to the cache and will thus not add the SHA256 to the formula for you. It will also not check the GitHub API for GitHub projects (to fill out the description and homepage).
* `--HEAD`:
HEAD
* `--set-name`:
Set the provided name of the package you are creating.
* `--set-version`:
Set the provided version of the package you are creating.
* `--tap`:
Takes a tap [*`user`*`/`*`repo`*] as argument and generates the formula in the specified tap.
* `--autotools`:
Create a basic template for an Autotools-style build.
* `--cmake`:
Create a basic template for a CMake-style build.
* `--meson`:
Create a basic template for a Meson-style build.
* `--no-fetch`:
Homebrew will not download *`URL`* to the cache and will thus not add the SHA-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage).
* `--HEAD`:
Indicate that *`URL`* points to the package's repository rather than a file.
* `--set-name`:
Set the name of the new formula to the provided *`name`*.
* `--set-version`:
Set the version of the new formula to the provided *`version`*.
* `--tap`:
Generate the new formula in the provided tap, specified as *`user`*`/`*`repo`*.
### `edit` *`formula`*:
Open *`formula`* in the editor. Open all of Homebrew for editing if
no *`formula`* is provided.
### `edit` [*`formulae`*]
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no *`formula`* is provided.
### `extract` [*`options`*] *`formula`* *`tap`*:
### `extract` [*`options`*] *`formula`* *`tap`*
Looks through repository history to find the *`version`* of *`formula`* and
creates a copy in *`tap`*/Formula/*`formula`*@*`version`*.rb. If the tap is
not installed yet, attempts to install/clone the tap before continuing.
Look through repository history to find the most recent version of *`formula`* and
create a copy in *`tap`*`/Formula/`*`formula`*`@`*`version`*`.rb`. If the tap is not
installed yet, attempt to install/clone the tap before continuing.
* `--version`:
Provided *`version`* of *`formula`* will be extracted and placed in the destination tap. Otherwise, the most recent version that can be found will be used.
* `--version`:
Extract the provided *`version`* of *`formula`* instead of the most recent.
### `formula` *`formula`*:
### `formula` *`formulae`*
Display the path where *`formula`* is located.
Display the path where a formula is located.
### `irb` [*`options`*]:
### `irb` [*`options`*]
Enter the interactive Homebrew Ruby shell.
* `--examples`:
Show several examples.
* `--pry`:
Pry will be used instead of irb if `--pry` is passed or HOMEBREW_PRY is set.
* `--examples`:
Show several examples.
* `--pry`:
Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set.
### `linkage` [*`options`*] *`formula`*:
### `linkage` [*`options`*] [*`formulae`*]
Checks the library links of an installed formula.
Check the library links for kegs of installed formulae.
Raises an error if run on uninstalled formulae.
Only works on installed formulae. An error is raised if it is run on
uninstalled formulae.
* `--test`:
Display only missing libraries and exit with a non-zero status if any missing libraries are found.
* `--reverse`:
For every library that a keg references, print its dylib path followed by the binaries that link to it.
* `--cached`:
Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run.
* `--test`:
Display only missing libraries and exit with a non-zero exit code if any missing libraries were found.
* `--reverse`:
Print the dylib followed by the binaries which link to it for each library the keg references.
* `--cached`:
Print the cached linkage values stored in HOMEBREW_CACHE, set from a previous `brew linkage` run.
### `man` [*`options`*]:
### `man` [*`options`*]
Generate Homebrew's manpages.
* `--fail-if-changed`:
Return a failing status code if changes are detected in the manpage outputs. This can be used for CI to be notified when the manpages are out of date. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date).
* `--link`:
It is now done automatically by `brew update`.
* `--fail-if-changed`:
Return a failing status code if changes are detected in the manpage outputs. This can be used for CI to be notified when the manpages are out of date. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date).
* `--link`:
This is now done automatically by `brew update`.
### `mirror` *`formulae`*:
### `mirror` *`formulae`*
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
* `prof` [*`ruby options`*]:
Run Homebrew with the Ruby profiler.
For example:
brew prof readall
### `prof` [*`ruby options`*]
### `pull` [*`options`*] *`formula`*:
Run Homebrew with the Ruby profiler.
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.
*Example:* `brew prof readall`
Each *`patch-source`* may be one of:
### `pull` [*`options`*] *`patch sources`*
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish updated bottles for the formulae changed by the patch.
Each *`patch source`* may be one of:
~ The ID number of a PR (pull request) in the homebrew/core GitHub
repository
@ -868,113 +870,113 @@ Each *`patch-source`* may be one of:
~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID
* `--bottle`:
Handle bottles, pulling the bottle-update commit and publishing files on Bintray.
* `--bump`:
For one-formula PRs, automatically reword commit message to our preferred format.
* `--clean`:
Do not rewrite or otherwise modify the commits found in the pulled PR.
* `--ignore-whitespace`:
Silently ignore whitespace discrepancies when applying diffs.
* `--resolve`:
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting.
* `--branch-okay`:
Do not warn if pulling to a branch besides master (useful for testing).
* `--no-pbcopy`:
Do not copy anything to the system clipboard.
* `--no-publish`:
Do not publish bottles to Bintray.
* `--warn-on-publish-failure`:
Do not exit if there's a failure publishing bottles on Bintray.
* `--bintray-org`:
Publish at the given Bintray organisation.
* `--test-bot-user`:
Pull the bottle block commit from the specified user on GitHub.
* `--bottle`:
Handle bottles, pulling the bottle-update commit and publishing files on Bintray.
* `--bump`:
For one-formula PRs, automatically reword commit message to our preferred format.
* `--clean`:
Do not rewrite or otherwise modify the commits found in the pulled PR.
* `--ignore-whitespace`:
Silently ignore whitespace discrepancies when applying diffs.
* `--resolve`:
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting.
* `--branch-okay`:
Do not warn if pulling to a branch besides master (useful for testing).
* `--no-pbcopy`:
Do not copy anything to the system clipboard.
* `--no-publish`:
Do not publish bottles to Bintray.
* `--warn-on-publish-failure`:
Do not exit if there's a failure publishing bottles on Bintray.
* `--bintray-org`:
Publish bottles at the provided Bintray *`organisation`*.
* `--test-bot-user`:
Pull the bottle block commit from the provided *`user`* on GitHub.
### `release-notes` [*`options`*] [*`previous_tag`*] [*`end_ref`*]:
### `release-notes` [*`options`*] [*`previous_tag`*] [*`end_ref`*]
Output the merged pull requests on Homebrew/brew between two Git refs.
Print the merged pull requests on Homebrew/brew between two Git refs.
If no *`previous_tag`* is provided it defaults to the latest tag.
If no *`end_ref`* is provided it defaults to `origin/master`.
* `--markdown`:
Output as a Markdown list.
* `--markdown`:
Print as a Markdown list.
* `ruby` [*`ruby options`*]:
Run a Ruby instance with Homebrew's libraries loaded.
For example:
### `ruby` [*`ruby options`*]
### `tap-new` *`user`*/*`repo`*:
Run a Ruby instance with Homebrew's libraries loaded.
*Example:* `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`
* `-e`:
Execute the provided string argument as a script.
### `tap-new` *`user`*`/`*`repo`*
Generate the template files for a new tap.
* `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] *`formula`*:
Most formulae provide a test method. `brew test` *`formula`* runs this
test method. There is no standard output or return code, but it should
generally indicate to the user if something is wrong with the installed
formula.
### `test` [*`options`*] *`formulae`*
To test the development or head version of a formula, use `--devel` or
`--HEAD`.
Run the test method provided by an installed formula.
There is no standard output or return code, but generally it should notify the
user if something is wrong with the installed formula.
If `--debug` (or `-d`) is passed and the test fails, an interactive debugger will be
launched with access to IRB or a shell inside the temporary test directory.
*Example:* `brew install jruby && brew test jruby`
If `--keep-tmp` is passed, the temporary files created for the test are
not deleted.
* `--devel`:
Test the development version of a formula.
* `--HEAD`:
Test the head version of a formula.
* `--keep-tmp`:
Keep the temporary files created for the test.
Example: `brew install jruby && brew test jruby`
### `tests` [*`options`*]
### `tests` [*`options`*]:
Run Homebrew's unit and integration tests.
Run Homebrew's unit and integration tests. If provided,
`--only=`*`test_script`* runs only *`test_script`*_spec.rb, and `--seed`
randomizes tests with the provided value instead of a random seed.
* `--coverage`:
Generate code coverage reports.
* `--generic`:
Run only OS-agnostic tests.
* `--no-compat`:
Do not load the compatibility layer when running tests.
* `--online`:
Include tests that use the GitHub API and tests that use any of the taps for official external commands.
* `--only`:
Run only *`test_script`*`_spec.rb`. Appending `:`*`line_number`* will start at a specific line.
* `--seed`:
Randomize tests with the provided *`value`* instead of a random seed.
* `--coverage`:
Generate code coverage reports.
* `--generic`:
Run only OS-agnostic tests.
* `--no-compat`:
Do not load the compatibility layer when running tests.
* `--online`:
Include tests that use the GitHub API and tests that use any of the taps for official external commands.
* `--only`:
Run only *`test_script`*_spec.rb
* `--seed`:
Randomizes tests with the provided value instead of a random seed.
### `update-test` [*`options`*]:
Runs a test of `brew update` with a new repository clone.
### `update-test` [*`options`*]
Run a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as the start commit.
* `--to-tag`:
Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags.
* `--keep-tmp`:
Retain the temporary directory containing the new repository clone.
* `--commit`:
Use provided *`commit`* as the start commit.
* `--before`:
Use the commit at provided *`date`* as the start commit.
* `--to-tag`:
Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags.
* `--keep-tmp`:
Retain the temporary directory containing the new repository clone.
* `--commit`:
Use provided *`commit`* as the start commit.
* `--before`:
Use the commit at provided *`date`* as the start commit.
## GLOBAL OPTIONS
These options are applicable across all sub-commands.
* `-q`, `--quiet`:
Suppress any warnings.
* `-q`, `--quiet`:
Suppress any warnings.
* `-v`, `--verbose`:
Make some output more verbose.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
* `-d`, `--debug`:
Display any debugging information.
* `-f`, `--force`:
Override warnings and enable potentially unsafe operations.
* `-f`, `--force`:
Override warnings and enable potentially unsafe operations.
## OFFICIAL EXTERNAL COMMANDS

230
manpages/brew.1
View File

@ -676,12 +676,12 @@ Print the version number of Homebrew to standard output and exit\.
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] \fIformulae\fR:"
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. If no \fIformulae\fR are provided, all of them are checked\.
.SS "\fBaudit\fR [\fIoptions\fR] \fIformulae\fR"
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\. If no \fIformulae\fR are provided, all of them are checked\.
.
.TP
\fB\-\-strict\fR
Run additional style checks, including Rubocop style checks\.
Run additional style checks, including RuboCop style checks\.
.
.TP
\fB\-\-online\fR
@ -701,30 +701,30 @@ Include the RuboCop cop name for each violation in the output\.
.
.TP
\fB\-\-display\-filename\fR
Prefix everyline of output with name of the file or formula being audited, to make output easy to grep\.
Prefix every line of output with name of the file or formula being audited, to make output easy to grep\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Activates debugging and profiling
Enable debugging and profiling of audit methods\.
.
.TP
\fB\-\-only\fR
Passing \fB\-\-only=\fR\fImethod\fR will run only the methods named audit_\fImethod\fR\. \fImethod\fR should be a comma\-separated list\.
Specify a comma\-separated \fImethod\fR list to only run the methods named \fBaudit_\fR\fImethod\fR\.
.
.TP
\fB\-\-except\fR
Passing \fB\-\-except=\fR\fImethod\fR will run only the methods named audit_\fImethod\fR, \fImethod\fR should be a comma\-separated list\.
Specify a comma\-separated \fImethod\fR list to skip running the methods named \fBaudit_\fR\fImethod\fR\.
.
.TP
\fB\-\-only\-cops\fR
Passing \fB\-\-only\-cops=\fR\fIcops\fR will check for violations of only the listed RuboCop cops\. \fIcops\fR should be a comma\-separated list of cop names\.
Specify a comma\-separated \fIcops\fR list to check for violations of only the listed RuboCop cops\.
.
.TP
\fB\-\-except\-cops\fR
Passing \fB\-\-except\-cops=\fR\fIcops\fR will skip checking the listed RuboCop cops violations\. \fIcops\fR should be a comma\-separated list of cop names\.
Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\.
.
.SS "\fBbottle\fR [\fIoptions\fR] \fIformulae\fR:"
Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\. If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
.SS "\fBbottle\fR [\fIoptions\fR] \fIformulae\fR"
Generate a bottle (binary package) from a formula that was installed with \fB\-\-build\-bottle\fR\. If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
.
.TP
\fB\-\-skip\-relocation\fR
@ -740,43 +740,43 @@ Build a bottle even if \fIformula\fR is not in homebrew/core or any installed ta
.
.TP
\fB\-\-no\-rebuild\fR
If the formula specifies a rebuild version, it will be removed in the generated DSL\.
If the formula specifies a rebuild version, remove it from the generated DSL\.
.
.TP
\fB\-\-keep\-old\fR
If the formula specifies a rebuild version, it will attempted to be kept in the generated DSL\.
.
.TP
\fB\-\-merge\fR
Generate a bottle from a formula and print the new DSL merged into the existing formula\.
.
.TP
\fB\-\-write\fR
Changes will be written to the formula file\. A new commit will be generated unless \fB\-\-no\-commit\fR is passed\.
.
.TP
\fB\-\-no\-commit\fR
When passed with \fB\-\-write\fR, a new commit will not generated while writing changes to the formula file\.
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL\.
.
.TP
\fB\-\-json\fR
Write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
.
.TP
\fB\-\-merge\fR
Generate an updated bottle block for a formula and optionally merge it into the formula file\. Instead of a formula name, requires a JSON file generated with \fBbrew bottle \-\-json\fR \fIformula\fR\.
.
.TP
\fB\-\-write\fR
Write the changes to the formula file\. A new commit will be generated unless \fB\-\-no\-commit\fR is passed\.
.
.TP
\fB\-\-no\-commit\fR
When passed with \fB\-\-write\fR, a new commit will not generated after writing changes to the formula file\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBbump\-formula\-pr\fR [\fIoptions\fR] \fIformula\fR:"
Creates a pull request to update the formula with a new URL or a new tag\.
.SS "\fBbump\-formula\-pr\fR [\fIoptions\fR] [\fIformula\fR]"
Create a pull request to update a formula with a new URL or a new tag\.
.
.P
If a \fIURL\fR is specified, the \fIsha\-256\fR checksum of the new download must also be specified\. A best effort to determine the \fIsha\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\.
If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download should also be specified\. A best effort to determine the \fISHA\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\.
.
.P
If a \fItag\fR is specified, the git commit \fIrevision\fR corresponding to that tag must also be specified\.
If a \fItag\fR is specified, the Git commit \fIrevision\fR corresponding to that tag must also be specified\.
.
.P
Note that this command cannot be used to transition a formula from a URL\-and\-sha256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\.
\fINote:\fR this command cannot be used to transition a formula from a URL\-and\-SHA\-256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\.
.
.TP
\fB\-\-devel\fR
@ -788,7 +788,7 @@ Print what would be done rather than doing it\.
.
.TP
\fB\-\-write\fR
When passed along with \fB\-\-dry\-run\fR, perform a not\-so\-dry run making the expected file modifications but not taking any git actions\.
When passed along with \fB\-\-dry\-run\fR, perform a not\-so\-dry run by making the expected file modifications but not taking any Git actions\.
.
.TP
\fB\-\-audit\fR
@ -800,23 +800,7 @@ Run \fBbrew audit \-\-strict\fR before opening the PR\.
.
.TP
\fB\-\-no\-browse\fR
Output the pull request URL instead of opening in a browser
.
.TP
\fB\-\-url\fR
Provide new \fIURL\fR for the formula\. If a \fIURL\fR is specified, the \fIsha\-256\fR checksum of the new download must also be specified\.
.
.TP
\fB\-\-revision\fR
Specify the new git commit \fIrevision\fR corresponding to a specified \fItag\fR\.
.
.TP
\fB\-\-tag\fR
Specify the new git commit \fItag\fR for the formula\.
.
.TP
\fB\-\-sha256\fR
Specify the \fIsha\-256\fR checksum of new download\.
Print the pull request URL instead of opening in a browser\.
.
.TP
\fB\-\-mirror\fR
@ -824,14 +808,30 @@ Use the provided \fIURL\fR as a mirror URL\.
.
.TP
\fB\-\-version\fR
Use the provided \fIversion\fR to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing \fBversion\fR override from a formula if it has become redundant\.
Use the provided \fIversion\fR to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing version override from a formula if it has become redundant\.
.
.TP
\fB\-\-message\fR
Append provided \fImessage\fR to the default PR message\.
Append the provided \fImessage\fR to the default PR message\.
.
.SS "\fBcreate\fR \fIURL\fR [\fIoptions\fR]:"
Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR\.
.TP
\fB\-\-url\fR
Specify the \fIURL\fR for the new download\. If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download should also be specified\.
.
.TP
\fB\-\-sha256\fR
Specify the \fISHA\-256\fR checksum of the new download\.
.
.TP
\fB\-\-tag\fR
Specify the new git commit \fItag\fR for the formula\.
.
.TP
\fB\-\-revision\fR
Specify the new git commit \fIrevision\fR corresponding to a specified \fItag\fR\.
.
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API, see: \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR
.
.TP
\fB\-\-autotools\fR
@ -847,38 +847,38 @@ Create a basic template for a Meson\-style build\.
.
.TP
\fB\-\-no\-fetch\fR
Homebrew will not download \fIURL\fR to the cache and will thus not add the SHA256 to the formula for you\. It will also not check the GitHub API for GitHub projects (to fill out the description and homepage)\.
Homebrew will not download \fIURL\fR to the cache and will thus not add the SHA\-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage)\.
.
.TP
\fB\-\-HEAD\fR
HEAD
Indicate that \fIURL\fR points to the package\'s repository rather than a file\.
.
.TP
\fB\-\-set\-name\fR
Set the provided name of the package you are creating\.
Set the name of the new formula to the provided \fIname\fR\.
.
.TP
\fB\-\-set\-version\fR
Set the provided version of the package you are creating\.
Set the version of the new formula to the provided \fIversion\fR\.
.
.TP
\fB\-\-tap\fR
Takes a tap [\fIuser\fR\fB/\fR\fIrepo\fR] as argument and generates the formula in the specified tap\.
Generate the new formula in the provided tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
.
.SS "\fBedit\fR \fIformula\fR:"
Open \fIformula\fR in the editor\. Open all of Homebrew for editing if no \fIformula\fR is provided\.
.SS "\fBedit\fR [\fIformulae\fR]"
Open a formula in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no \fIformula\fR is provided\.
.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR:"
Looks through repository history to find the \fIversion\fR of \fIformula\fR and creates a copy in \fItap\fR/Formula/\fIformula\fR@\fIversion\fR\.rb\. If the tap is not installed yet, attempts to install/clone the tap before continuing\.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR"
Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. If the tap is not installed yet, attempt to install/clone the tap before continuing\.
.
.TP
\fB\-\-version\fR
Provided \fIversion\fR of \fIformula\fR will be extracted and placed in the destination tap\. Otherwise, the most recent version that can be found will be used\.
Extract the provided \fIversion\fR of \fIformula\fR instead of the most recent\.
.
.SS "\fBformula\fR \fIformula\fR:"
Display the path where \fIformula\fR is located\.
.SS "\fBformula\fR \fIformulae\fR"
Display the path where a formula is located\.
.
.SS "\fBirb\fR [\fIoptions\fR]:"
.SS "\fBirb\fR [\fIoptions\fR]"
Enter the interactive Homebrew Ruby shell\.
.
.TP
@ -887,27 +887,24 @@ Show several examples\.
.
.TP
\fB\-\-pry\fR
Pry will be used instead of irb if \fB\-\-pry\fR is passed or HOMEBREW_PRY is set\.
Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\.
.
.SS "\fBlinkage\fR [\fIoptions\fR] \fIformula\fR:"
Checks the library links of an installed formula\.
.
.P
Only works on installed formulae\. An error is raised if it is run on uninstalled formulae\.
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformulae\fR]"
Check the library links for kegs of installed formulae\. Raises an error if run on uninstalled formulae\.
.
.TP
\fB\-\-test\fR
Display only missing libraries and exit with a non\-zero exit code if any missing libraries were found\.
Display only missing libraries and exit with a non\-zero status if any missing libraries are found\.
.
.TP
\fB\-\-reverse\fR
Print the dylib followed by the binaries which link to it for each library the keg references\.
For every library that a keg references, print its dylib path followed by the binaries that link to it\.
.
.TP
\fB\-\-cached\fR
Print the cached linkage values stored in HOMEBREW_CACHE, set from a previous \fBbrew linkage\fR run\.
Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\.
.
.SS "\fBman\fR [\fIoptions\fR]:"
.SS "\fBman\fR [\fIoptions\fR]"
Generate Homebrew\'s manpages\.
.
.TP
@ -916,20 +913,22 @@ Return a failing status code if changes are detected in the manpage outputs\. Th
.
.TP
\fB\-\-link\fR
It is now done automatically by \fBbrew update\fR\.
This is now done automatically by \fBbrew update\fR\.
.
.SS "\fBmirror\fR \fIformulae\fR:"
.SS "\fBmirror\fR \fIformulae\fR"
Reuploads the stable URL for a formula to Bintray to use it as a mirror\.
.
.TP
\fBprof\fR [\fIruby options\fR]
Run Homebrew with the Ruby profiler\. For example: brew prof readall
.
.SS "\fBpull\fR [\fIoptions\fR] \fIformula\fR:"
Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\.
.SS "\fBprof\fR [\fIruby options\fR]"
Run Homebrew with the Ruby profiler\.
.
.P
Each \fIpatch\-source\fR may be one of:
\fIExample:\fR \fBbrew prof readall\fR
.
.SS "\fBpull\fR [\fIoptions\fR] \fIpatch sources\fR"
Get a patch from a GitHub commit or pull request and apply it to Homebrew\. Optionally, publish updated bottles for the formulae changed by the patch\.
.
.P
Each \fIpatch source\fR may be one of:
.
.P
~ The ID number of a PR (pull request) in the homebrew/core GitHub repository
@ -981,44 +980,52 @@ Do not exit if there\'s a failure publishing bottles on Bintray\.
.
.TP
\fB\-\-bintray\-org\fR
Publish at the given Bintray organisation\.
Publish bottles at the provided Bintray \fIorganisation\fR\.
.
.TP
\fB\-\-test\-bot\-user\fR
Pull the bottle block commit from the specified user on GitHub\.
Pull the bottle block commit from the provided \fIuser\fR on GitHub\.
.
.SS "\fBrelease\-notes\fR [\fIoptions\fR] [\fIprevious_tag\fR] [\fIend_ref\fR]:"
Output the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the latest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\.
.SS "\fBrelease\-notes\fR [\fIoptions\fR] [\fIprevious_tag\fR] [\fIend_ref\fR]"
Print the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the latest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\.
.
.TP
\fB\-\-markdown\fR
Output as a Markdown list\.
Print as a Markdown list\.
.
.SS "\fBruby\fR [\fIruby options\fR]"
Run a Ruby instance with Homebrew\'s libraries loaded\.
.
.P
\fIExample:\fR \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR
.
.TP
\fBruby\fR [\fIruby options\fR]
Run a Ruby instance with Homebrew\'s libraries loaded\. For example:
\fB\-e\fR
Execute the provided string argument as a script\.
.
.SS "\fBtap\-new\fR \fIuser\fR/\fIrepo\fR:"
.SS "\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR"
Generate the template files for a new tap\.
.
.SS "\fBtest\fR [\fIoptions\fR] \fIformulae\fR"
Run the test method provided by an installed formula\. There is no standard output or return code, but generally it should notify the user if something is wrong with the installed formula\.
.
.P
\fIExample:\fR \fBbrew install jruby && brew test jruby\fR
.
.TP
\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR
Most formulae provide a test method\. \fBbrew test\fR \fIformula\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\.
\fB\-\-devel\fR
Test the development version of a formula\.
.
.IP
To test the development or head version of a formula, use \fB\-\-devel\fR or \fB\-\-HEAD\fR\.
.TP
\fB\-\-HEAD\fR
Test the head version of a formula\.
.
.IP
If \fB\-\-debug\fR (or \fB\-d\fR) is passed and the test fails, an interactive debugger will be launched with access to IRB or a shell inside the temporary test directory\.
.TP
\fB\-\-keep\-tmp\fR
Keep the temporary files created for the test\.
.
.IP
If \fB\-\-keep\-tmp\fR is passed, the temporary files created for the test are not deleted\.
.
.IP
Example: \fBbrew install jruby && brew test jruby\fR
.
.SS "\fBtests\fR [\fIoptions\fR]:"
Run Homebrew\'s unit and integration tests\. If provided, \fB\-\-only=\fR\fItest_script\fR runs only \fItest_script\fR_spec\.rb, and \fB\-\-seed\fR randomizes tests with the provided value instead of a random seed\.
.SS "\fBtests\fR [\fIoptions\fR]"
Run Homebrew\'s unit and integration tests\.
.
.TP
\fB\-\-coverage\fR
@ -1038,17 +1045,14 @@ Include tests that use the GitHub API and tests that use any of the taps for off
.
.TP
\fB\-\-only\fR
Run only \fItest_script\fR_spec\.rb
Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR will start at a specific line\.
.
.TP
\fB\-\-seed\fR
Randomizes tests with the provided value instead of a random seed\.
Randomize tests with the provided \fIvalue\fR instead of a random seed\.
.
.SS "\fBupdate\-test\fR [\fIoptions\fR]:"
Runs a test of \fBbrew update\fR with a new repository clone\.
.
.P
If no arguments are passed, use \fBorigin/master\fR as the start commit\.
.SS "\fBupdate\-test\fR [\fIoptions\fR]"
Run a test of \fBbrew update\fR with a new repository clone\. If no arguments are passed, use \fBorigin/master\fR as the start commit\.
.
.TP
\fB\-\-to\-tag\fR