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

man: Generate dev cmd manpages

Browse Source
This commit is contained in:
Gautham Goli 2018-09-28 21:39:52 +05:30
parent cfaaa0eb71
commit 4f58f2db99
No known key found for this signature in database
GPG Key ID: 6A9ABBC284468364
16 changed files with 1085 additions and 652 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -71,18 +71,45 @@ module Homebrew
def bottle_args def bottle_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--merge" usage_banner <<~EOS
switch "--skip-relocation" `bottle` [<options>] [<formulae>]:
switch "--force-core-tap"
switch "--no-rebuild" Generate a bottle (binary package) from a formula installed with
switch "--keep-old" `--build-bottle`.
switch "--write"
switch "--no-commit" If the formula specifies a rebuild version, it will be incremented in the
switch "--json" generated DSL. Passing `--keep-old` will attempt to keep it at its
switch "--or-later" original value, while `--no-rebuild` will remove it.
EOS
switch "--skip-relocation",
description: "Do not check if the bottle can be marked as relocatable."
switch "--or-later",
description: "Append `_or_later` to the bottle tag."
switch "--force-core-tap",
description: "Build a bottle even if <formula> is not in homebrew/core or any installed taps."
switch "--no-rebuild",
description: "If the formula specifies a rebuild version, it will be removed in the generated DSL."
switch "--keep-old",
description: "If the formula specifies a rebuild version, it will attempted to be kept in the "\
" generated DSL."
switch "--merge",
description: "Generate a bottle from a formula and print the new DSL merged into the "\
"existing formula."
switch "--write",
description: "Changes will be written to the formula file. A new commit will be generated unless "\
"`--no-commit` is passed."
switch "--no-commit",
description: "When passed with `--write`, a new commit will not generated while writing changes "\
"to the formula file.",
depends_on: "--write"
switch "--json",
description: "Write bottle information to a JSON file, which can be used as the argument for "\
"`--merge`."
flag "--root-url",
description: "Use the specified <URL> as the root of the bottle's URL instead of Homebrew's "\
"default."
switch :verbose switch :verbose
switch :debug switch :debug
flag "--root-url"
end end
end end

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

@ -49,25 +49,58 @@ module Homebrew
def bump_formula_pr_args def bump_formula_pr_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--devel" usage_banner <<~EOS
switch "-n", "--dry-run" `bump-formula-pr` [<options>] <formula>:
switch "--write"
switch "--audit" Creates a pull request to update the formula with a new URL or a new tag.
switch "--strict"
switch "--no-browse" 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 <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.
EOS
switch "--devel",
description: "Bump the development rather than stable version. The development spec must already exist."
switch "-n", "--dry-run",
description: "Print what would be done rather than doing it."
switch "--write",
description: "When passed along with `--dry-run`, perform a not-so-dry run making the expected "\
"file modifications but not taking any git actions."
switch "--audit",
description: "Run `brew audit` before opening the PR."
switch "--strict",
description: "Run `brew audit --strict` before opening the PR."
switch "--no-browse",
description: "Output the pull request URL instead of opening in a browser"
flag "--url=",
description: "Provide new <URL> for the formula. If a <URL> is specified, the <sha-256> "\
"checksum of the new download must also be specified."
flag "--revision=",
description: "Specify the new git commit <revision> corresponding to a specified <tag>."
flag "--tag=", required_for: "--revision=",
description: "Specify the new git commit <tag> for the formula."
flag "--sha256=", depends_on: "--url=",
description: "Specify the <sha-256> checksum of new download."
flag "--mirror=",
description: "Use the provided <URL> as a mirror URL."
flag "--version=",
description: "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."
flag "--message=",
description: "Append provided <message> to the default PR message."
switch :quiet switch :quiet
switch :force switch :force
switch :verbose switch :verbose
switch :debug switch :debug
flag "--url="
flag "--revision="
flag "--tag=", required_for: "--revision="
flag "--sha256=", depends_on: "--url="
flag "--mirror="
flag "--version="
flag "--message="
conflicts "--url", "--tag" conflicts "--url", "--tag"
end end
end end

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

@ -29,17 +29,36 @@ module Homebrew
def create_args def create_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--autotools" usage_banner <<~EOS
switch "--cmake" `create` <URL> [<options>]:
switch "--meson"
switch "--no-fetch" 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>.
EOS
switch "--autotools",
description: "Create a basic template for an Autotools-style build."
switch "--cmake",
description: "Create a basic template for a CMake-style build."
switch "--meson",
description: "Create a basic template for a Meson-style build."
switch "--no-fetch",
description: "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)."
switch "--HEAD" switch "--HEAD"
flag "--set-name=",
description: "Set the provided name of the package you are creating."
flag "--set-version=",
description: "Set the provided version of the package you are creating."
flag "--tap=",
description: "Takes a tap [<user>`/`<repo>] as argument and generates the formula in the "\
"specified tap."
switch :force switch :force
switch :verbose switch :verbose
switch :debug switch :debug
flag "--set-name="
flag "--set-version="
flag "--tap="
end end
end end

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

@ -12,6 +12,13 @@ module Homebrew
def edit_args def edit_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS
* `edit`:
Open all of Homebrew for editing.
* `edit` <formula>:
Open <formula> in the editor.
EOS
switch :force switch :force
switch :verbose switch :verbose
switch :debug switch :debug

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

@ -9,6 +9,11 @@ module Homebrew
def formula_args def formula_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`formula` <formula>:
Display the path where <formula> is located.
EOS
switch :debug switch :debug
switch :verbose switch :verbose
end end

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

@ -24,8 +24,15 @@ module Homebrew
def irb_args def irb_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--examples" usage_banner <<~EOS
switch "--pry", env: :pry `irb` [<options>]:
Enter the interactive Homebrew Ruby shell.
EOS
switch "--examples",
description: "Show several examples."
switch "--pry", env: :pry,
description: "Pry will be used instead of irb if `--pry` is passed or HOMEBREW_PRY is set."
end end
end end

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

@ -21,8 +21,23 @@ module Homebrew
def linkage_args def linkage_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--test" usage_banner <<~EOS
switch "--reverse" `linkage` [<options>] <formula>:
Checks the library links of an installed formula.
Only works on installed formulae. An error is raised if it is run on
uninstalled formulae.
EOS
switch "--test",
description: "Display only missing libraries and exit with a non-zero exit code if any missing "\
"libraries were found."
switch "--reverse",
description: "Print the dylib followed by the binaries which link to it for each library the keg "\
"references."
switch "--cached",
description: "Print the cached linkage values stored in HOMEBREW_CACHE, set from a previous "\
"`brew linkage` run."
switch :verbose switch :verbose
switch :debug switch :debug
end end

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

@ -12,6 +12,19 @@ require "erb"
require "ostruct" require "ostruct"
require "cli_parser" require "cli_parser"
require "dev-cmd/audit" require "dev-cmd/audit"
require "dev-cmd/bottle"
require "dev-cmd/bump-formula-pr"
require "dev-cmd/create"
require "dev-cmd/edit"
require "dev-cmd/formula"
require "dev-cmd/irb"
require "dev-cmd/linkage"
require "dev-cmd/mirror"
require "dev-cmd/pull"
require "dev-cmd/release-notes"
require "dev-cmd/tap-new"
require "dev-cmd/tests"
require "dev-cmd/update-test"
module Homebrew module Homebrew
module_function module_function
@ -22,8 +35,18 @@ module Homebrew
def man_args def man_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--fail-if-changed" usage_banner <<~EOS
switch "--link" `man` [<options>]:
Generate Homebrew's manpages.
EOS
switch "--fail-if-changed",
description: "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)."
switch "--link",
description: "It is now done automatically by `brew update`."
end end
end end
@ -58,7 +81,6 @@ module Homebrew
def path_glob_commands(glob) def path_glob_commands(glob)
Pathname.glob(glob) Pathname.glob(glob)
.sort_by { |source_file| sort_key_for_path(source_file) }
.map(&:read).map(&:lines) .map(&:read).map(&:lines)
.map { |lines| lines.grep(/^#:/).map { |line| line.slice(2..-1) }.join } .map { |lines| lines.grep(/^#:/).map { |line| line.slice(2..-1) }.join }
.reject { |s| s.strip.empty? || s.include?("@hide_from_man_page") } .reject { |s| s.strip.empty? || s.include?("@hide_from_man_page") }
@ -69,7 +91,8 @@ module Homebrew
variables = OpenStruct.new variables = OpenStruct.new
variables[:commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/cmd/*.{rb,sh}") variables[:commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/cmd/*.{rb,sh}")
variables[:developer_commands] = generate_cmd_manpage(Homebrew.send(:audit_args)) + path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/dev-cmd/*.{rb,sh}")
variables[:developer_commands] = generate_cmd_manpages("#{HOMEBREW_LIBRARY_PATH}/dev-cmd/*.{rb,sh}")
readme = HOMEBREW_REPOSITORY/"README.md" readme = HOMEBREW_REPOSITORY/"README.md"
variables[:lead_maintainer] = variables[:lead_maintainer] =
readme.read[/(Homebrew's lead maintainer .*\.)/, 1] readme.read[/(Homebrew's lead maintainer .*\.)/, 1]
@ -151,7 +174,25 @@ module Homebrew
end end
end end
def generate_cmd_manpage(cmd_parser) def generate_cmd_manpages(glob)
cmd_paths = Pathname.glob(glob)
man_page_lines = []
cmd_paths.each do |cmd_path|
begin
cmd_parser = Homebrew.send(cmd_arg_parser(cmd_path))
man_page_lines << generate_cmd_manpage_lines(cmd_parser).join
rescue NoMethodError
man_page_lines << path_glob_commands(cmd_path.to_s)[0]
end
end
man_page_lines
end
def cmd_arg_parser(cmd_path)
"#{cmd_path.basename.to_s.gsub('.rb', '').gsub('-', '_')}_args".to_sym
end
def generate_cmd_manpage_lines(cmd_parser)
lines = [cmd_parser.usage_banner_text] lines = [cmd_parser.usage_banner_text]
lines += cmd_parser.processed_options.map do |short, long, _, desc| lines += cmd_parser.processed_options.map do |short, long, _, desc|
generate_option_doc(short, long, desc) generate_option_doc(short, long, desc)

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

@ -9,6 +9,11 @@ module Homebrew
def mirror_args def mirror_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`mirror` [<formulae>]:
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
EOS
switch :debug switch :debug
switch :verbose switch :verbose
end end

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

@ -74,19 +74,50 @@ module Homebrew
def pull_args def pull_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--bottle" usage_banner <<~EOS
switch "--bump" `bump-formula-pr` [<options>] <formula>:
switch "--clean"
switch "--ignore-whitespace" Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
switch "--resolve" Optionally, installs the formulae changed by the patch.
switch "--branch-okay"
switch "--no-pbcopy" Each <patch-source> may be one of:
switch "--no-publish"
switch "--warn-on-publish-failure" ~ The ID number of a PR (pull request) in the homebrew/core GitHub
repository
~ The URL of a PR on GitHub, using either the web page or API URL
formats. In this form, the PR may be on Homebrew/brew,
Homebrew/homebrew-core or any tap.
~ The URL of a commit on GitHub
~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID
EOS
switch "--bottle",
description: "Handle bottles, pulling the bottle-update commit and publishing files on Bintray."
switch "--bump",
description: "For one-formula PRs, automatically reword commit message to our preferred format."
switch "--clean",
description: "Do not rewrite or otherwise modify the commits found in the pulled PR."
switch "--ignore-whitespace",
description: "Silently ignore whitespace discrepancies when applying diffs."
switch "--resolve",
description: "When a patch fails to apply, leave in progress and allow user to resolve, instead "\
"of aborting."
switch "--branch-okay",
description: "Do not warn if pulling to a branch besides master (useful for testing)."
switch "--no-pbcopy",
description: "Do not copy anything to the system clipboard."
switch "--no-publish",
description: "Do not publish bottles to Bintray."
switch "--warn-on-publish-failure",
description: "Do not exit if there's a failure publishing bottles on Bintray."
flag "--bintray-org=",
description: "Publish at the given Bintray organisation."
flag "--test-bot-user=",
description: "Pull the bottle block commit from the specified user on GitHub."
switch :verbose switch :verbose
switch :debug switch :debug
flag "--bintray-org="
flag "--test-bot-user="
end end
end end

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

@ -12,7 +12,15 @@ module Homebrew
def release_notes_args def release_notes_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--markdown" usage_banner <<~EOS
`release-notes` [<previous_tag>] [<end_ref>]:
Output 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`.
EOS
switch "--markdown",
description: "Output as a Markdown list."
end end
end end

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

@ -17,6 +17,11 @@ module Homebrew
def tap_new_args def tap_new_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap-new` <user>`/`<repo>:
Generate the template files for a new tap.
EOS
switch :debug switch :debug
switch :verbose switch :verbose
end end

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

@ -23,14 +23,28 @@ module Homebrew
def tests_args def tests_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--no-compat" usage_banner <<~EOS
switch "--generic" `tests` [<options>] <formula>:
switch "--coverage"
switch "--online" Run Homebrew's unit and integration tests. If provided,
switch :debug `--only=`<test_script> runs only <test_script>_spec.rb, and `--seed`
randomizes tests with the provided value instead of a random seed.
EOS
switch "--coverage",
description: "Generate code coverage reports."
switch "--generic",
description: "Run only OS-agnostic tests."
switch "--no-compat",
description: "Do not load the compatibility layer when running tests."
switch "--online",
description: "Include tests that use the GitHub API and tests that use any of the taps for "\
"official external commands."
flag "--only=",
description: "Run only <test_script>_spec.rb"
flag "--seed=",
description: "Randomizes tests with the provided value instead of a random seed."
switch :verbose switch :verbose
flag "--only=" switch :debug
flag "--seed="
end end
end end

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

@ -21,12 +21,23 @@ module Homebrew
def update_test_args def update_test_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
switch "--to-tag" usage_banner <<~EOS
switch "--keep-tmp" `update-test` [<options>]:
Runs a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as the start commit.
EOS
switch "--to-tag",
description: "Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags."
switch "--keep-tmp",
description: "Retain the temporary directory containing the new repository clone."
flag "--commit=",
description: "Use provided <commit> as the start commit."
flag "--before=",
description: "Use the commit at provided <date> as the start commit."
switch :verbose switch :verbose
switch :debug switch :debug
flag "--commit="
flag "--before="
end end
end end

625
docs/Manpage.md
View File

@ -37,6 +37,44 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## COMMANDS ## COMMANDS
* `--cache`:
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
* `--cache` [`--build-from-source`|`-s`] [`--force-bottle`] `formula`:
Display the file or directory used to cache `formula`.
* `--cellar`:
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.
* `--cellar` `formula`:
Display the location in the cellar where `formula` would be installed,
without any sort of versioned directory as the last path.
* `--env` [`--shell=`(`shell`|`auto`)|`--plain`]:
Show a summary of the Homebrew build environment as a plain list.
Pass `--shell=``shell` to generate a list of environment variables for the
specified shell, or `--shell=auto` to detect the current shell.
If the command's output is sent through a pipe and no shell is specified,
the list is formatted for export to `bash`(1) unless `--plain` is passed.
* `--prefix`:
Display Homebrew's install path. *Default:* `/usr/local`
* `--prefix` `formula`:
Display the location in the cellar where `formula` is or would be installed.
* `--repository`:
Display where Homebrew's `.git` directory is located.
* `--repository` `user``/``repo`:
Display where tap `user``/``repo`'s directory is located.
* `--version`:
Print the version number of Homebrew to standard output and exit.
* `analytics` [`state`]: * `analytics` [`state`]:
Display anonymous user behaviour analytics state. Display anonymous user behaviour analytics state.
Read more at <https://docs.brew.sh/Analytics>. Read more at <https://docs.brew.sh/Analytics>.
@ -473,6 +511,30 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `switch` `formula` `version`: * `switch` `formula` `version`:
Symlink all of the specific `version` of `formula`'s install to Homebrew prefix. Symlink all of the specific `version` of `formula`'s install to Homebrew prefix.
* `tap-info`:
Display a brief summary of all installed taps.
* `tap-info` (`--installed`|`taps`):
Display detailed information about one or more `taps`.
Pass `--installed` to display information on all installed taps.
* `tap-info` `--json=``version` (`--installed`|`taps`):
Print a JSON representation of `taps`. Currently the only accepted value
for `version` is `v1`.
Pass `--installed` to get information on installed taps.
See the docs for examples of using the JSON output:
<https://docs.brew.sh/Querying-Brew>
* `tap-pin` `tap`:
Pin `tap`, prioritizing its formulae over core when formula names are supplied
by the user. See also `tap-unpin`.
* `tap-unpin` `tap`:
Unpin `tap` so its formulae are no longer prioritized. See also `tap-pin`.
* `tap`: * `tap`:
List all installed taps. List all installed taps.
@ -507,30 +569,6 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `tap` `--list-pinned`: * `tap` `--list-pinned`:
List all pinned taps. List all pinned taps.
* `tap-info`:
Display a brief summary of all installed taps.
* `tap-info` (`--installed`|`taps`):
Display detailed information about one or more `taps`.
Pass `--installed` to display information on all installed taps.
* `tap-info` `--json=``version` (`--installed`|`taps`):
Print a JSON representation of `taps`. Currently the only accepted value
for `version` is `v1`.
Pass `--installed` to get information on installed taps.
See the docs for examples of using the JSON output:
<https://docs.brew.sh/Querying-Brew>
* `tap-pin` `tap`:
Pin `tap`, prioritizing its formulae over core when formula names are supplied
by the user. See also `tap-unpin`.
* `tap-unpin` `tap`:
Unpin `tap` so its formulae are no longer prioritized. See also `tap-pin`.
* `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] `formula`: * `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] `formula`:
Uninstall `formula`. Uninstall `formula`.
@ -566,22 +604,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `untap` `tap`: * `untap` `tap`:
Remove a tapped repository. Remove a tapped repository.
* `update` [`--merge`] [`--force`]: * `upgrade` [`install-options`] [`--cleanup`] [`--fetch-HEAD`] [`--ignore-pinned`] [`formulae`]:
Fetch the newest version of Homebrew and all formulae from GitHub using
`git`(1) and perform any necessary migrations.
If `--merge` is specified then `git merge` is used to include updates
(rather than `git rebase`).
If `--force` (or `-f`) is specified then always do a slower, full update check even
if unnecessary.
* `update-reset` [`repositories`]:
Fetches and resets Homebrew and all tap repositories (or the specified
`repositories`) using `git`(1) to their latest `origin/master`. Note this
will destroy all your uncommitted or committed changes.
* `upgrade` [`install-options`] [`--cleanup`] [`--fetch-HEAD`] [`--ignore-pinned`] [`--display-times`] [`formulae`]:
Upgrade outdated, unpinned brews (with existing install options). Upgrade outdated, unpinned brews (with existing install options).
Options for the `install` command are also valid here. Options for the `install` command are also valid here.
@ -623,43 +646,20 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
cases where `formulae` is used by development or HEAD build, pass cases where `formulae` is used by development or HEAD build, pass
`--devel` or `--HEAD`. `--devel` or `--HEAD`.
* `--cache`: * `update-reset`:
Display Homebrew's download cache. See also `HOMEBREW_CACHE`. Fetches and resets Homebrew and all tap repositories using `git`(1) to
their latest `origin/master`. Note this will destroy all your uncommitted
or committed changes.
* `--cache` [`--build-from-source`|`-s`] [`--force-bottle`] `formula`: * `update` [`--merge`] [`--force`]:
Display the file or directory used to cache `formula`. Fetch the newest version of Homebrew and all formulae from GitHub using
`git`(1) and perform any necessary migrations.
* `--cellar`: If `--merge` is specified then `git merge` is used to include updates
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if (rather than `git rebase`).
that directory doesn't exist, `$(brew --repository)/Cellar`.
* `--cellar` `formula`: If `--force` (or `-f`) is specified then always do a slower, full update check even
Display the location in the cellar where `formula` would be installed, if unnecessary.
without any sort of versioned directory as the last path.
* `--env` [`--shell=`(`shell`|`auto`)|`--plain`]:
Show a summary of the Homebrew build environment as a plain list.
Pass `--shell=``shell` to generate a list of environment variables for the
specified shell, or `--shell=auto` to detect the current shell.
If the command's output is sent through a pipe and no shell is specified,
the list is formatted for export to `bash`(1) unless `--plain` is passed.
* `--prefix`:
Display Homebrew's install path. *Default:* `/usr/local` on macOS and `/home/linuxbrew/.linuxbrew` on Linux
* `--prefix` `formula`:
Display the location in the cellar where `formula` is or would be installed.
* `--repository`:
Display where Homebrew's `.git` directory is located.
* `--repository` `user``/``repo`:
Display where tap `user``/``repo`'s directory is located.
* `--version`:
Print the version number of Homebrew to standard output and exit.
## DEVELOPER COMMANDS ## DEVELOPER COMMANDS
@ -670,296 +670,286 @@ run before submitting a new formula.
If no `formulae` are provided, all of them are checked. If no `formulae` are provided, all of them are checked.
* `--strict`: * `--strict`:
Run additional style checks, including Rubocop style checks. Run additional style checks, including Rubocop style checks.
* `--online`: * `--online`:
Run additional slower style checks that require a network connection. Run additional slower style checks that require a network connection.
* `--new-formula`: * `--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`. 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`:
Fix style violations automatically using RuboCop's auto-correct feature. Fix style violations automatically using RuboCop's auto-correct feature.
* `--display-cop-names`: * `--display-cop-names`:
Include the RuboCop cop name for each violation in the output. Include the RuboCop cop name for each violation in the output.
* `--display-filename`: * `--display-filename`:
Prefix everyline of output with name of the file or formula being audited, to make output easy to grep. Prefix everyline of output with name of the file or formula being audited, to make output easy to grep.
* `-D`, `--audit-debug`: * `-D`, `--audit-debug`:
Activates debugging and profiling Activates debugging and profiling
* `--only`: * `--only`:
Passing `--only`=`method` will run only the methods named audit_`method`, `method` should be a comma-separated list. Passing `--only`=`method` will run only the methods named audit_`method`, `method` should be a comma-separated list.
* `--except`: * `--except`:
Passing `--except`=`method` will run only the methods named audit_`method`, `method` should be a comma-separated list. Passing `--except`=`method` will run only the methods named audit_`method`, `method` should be a comma-separated list.
* `--only-cops`: * `--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. 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`: * `--except-cops`:
Passing `--except-cops`=`cops` will skip checking the listed RuboCop cops violations. `cops` should be a comma-separated list of cop names. Passing `--except-cops`=`cops` will skip checking the listed RuboCop cops violations. `cops` should be a comma-separated list of cop names.
* `-v`, `--verbose`: * `-v`, `--verbose`:
Make some output more verbose. Make some output more verbose.
* `-d`, `--debug`: * `-d`, `--debug`:
Display any debugging information. Display any debugging information.
* `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`--only=``method`|`--except=``method`] [`--only-cops=``cops`|`--except-cops=``cops`] [`formulae`]: `bottle` [`options`] [`formulae`]:
Check `formulae` for Homebrew coding style violations. This should be
run before submitting a new formula.
If no `formulae` are provided, all of them are checked. Generate a bottle (binary package) from a formula installed with
`--build-bottle`.
If `--strict` is passed, additional checks are run, including RuboCop If the formula specifies a rebuild version, it will be incremented in the
style checks. generated DSL. Passing `--keep-old` will attempt to keep it at its
original value, while `--no-rebuild` will remove it.
If `--fix` is passed, style violations will be * `--skip-relocation`:
automatically fixed using RuboCop's auto-correct feature. 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.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--online` is passed, additional slower checks that require a network `bump-formula-pr` [`options`] `formula`:
connection are run.
If `--new-formula` is passed, various additional checks are run that check Creates a pull request to update the formula with a new URL or a new tag.
if a new formula is eligible for Homebrew. This should be used when creating
new formulae and implies `--strict` and `--online`.
If `--display-cop-names` is passed, the RuboCop cop name for each violation If a `URL` is specified, the `sha-256` checksum of the new download must
is included in the output. 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 `--display-filename` is passed, every line of output is prefixed with the If a `tag` is specified, the git commit `revision` corresponding to that
name of the file or formula being audited, to make the output easy to grep. tag must also be specified.
Passing `--only=``method` will run only the methods named `audit_`method, Note that this command cannot be used to transition a formula from a
while `--except=``method` will skip the methods named `audit_`method. URL-and-sha256 style specification into a tag-and-revision style
For either option `method` should be a comma-separated list. specification, nor vice versa. It must use whichever style specification
the preexisting formula already uses.
Passing `--only-cops=``cops` will check for violations of only the listed * `--devel`:
RuboCop `cops`, while `--except-cops=``cops` will skip checking the listed Bump the development rather than stable version. The development spec must already exist.
`cops`. For either option `cops` should be a comma-separated list of cop names. * `-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.
* `-q`, `--quiet`:
Suppress any warnings.
* `-f`, `--force`:
Override warnings and enable potentially unsafe operations.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
`audit` exits with a non-zero status if any errors are found. This is useful, `create` `URL` [`options`]:
for instance, for implementing pre-commit hooks.
* `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--or-later`] [`--root-url=``URL`] [`--force-core-tap`] [`--json`] `formulae`: Generate a formula for the downloadable file at `URL` and open it in the editor.
Generate a bottle (binary package) from a formula installed with Homebrew will attempt to automatically derive the formula name
`--build-bottle`. 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>.
If the formula specifies a rebuild version, it will be incremented in the * `--autotools`:
generated DSL. Passing `--keep-old` will attempt to keep it at its Create a basic template for an Autotools-style build.
original value, while `--no-rebuild` will remove it. * `--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.
* `-f`, `--force`:
Override warnings and enable potentially unsafe operations.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--verbose` (or `-v`) is passed, print the bottling commands and any warnings * `edit`:
encountered. Open all of Homebrew for editing.
If `--skip-relocation` is passed, do not check if the bottle can be marked * `edit` `formula`:
as relocatable. Open `formula` in the editor.
If `--root-url` is passed, use the specified `URL` as the root of the * `-f`, `--force`:
bottle's URL instead of Homebrew's default. Override warnings and enable potentially unsafe operations.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--or-later` is passed, append _or_later to the bottle tag. `formula` `formula`:
If `--force-core-tap` is passed, build a bottle even if `formula` is not Display the path where `formula` is located.
in homebrew/core or any installed taps.
If `--json` is passed, write bottle information to a JSON file, which can * `-d`, `--debug`:
be used as the argument for `--merge`. Display any debugging information.
* `-v`, `--verbose`:
Make some output more verbose.
* `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] `bottle_json_files`: `irb` [`options`]:
Generate a bottle from a `--json` output file and print the new DSL merged
into the existing formula.
If `--write` is passed, write the changes to the formula file. A new Enter the interactive Homebrew Ruby shell.
commit will then be generated unless `--no-commit` is passed.
* `bump-formula-pr` [`--devel`] [`--dry-run` [`--write`]] [`--audit`|`--strict`] [`--mirror=``URL`] [`--version=``version`] [`--message=``message`] (`--url=``URL` `--sha256=``sha-256`|`--tag=``tag` `--revision=``revision`) `formula`: * `--examples`:
Creates a pull request to update the formula with a new URL or a new tag. Show several examples.
* `--pry`:
Pry will be used instead of irb if `--pry` is passed or HOMEBREW_PRY is set.
If a `URL` is specified, the `sha-256` checksum of the new download must `linkage` [`options`] `formula`:
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 Checks the library links of an installed formula.
tag must also be specified.
If `--devel` is passed, bump the development rather than stable version. Only works on installed formulae. An error is raised if it is run on
The development spec must already exist. uninstalled formulae.
If `--dry-run` is passed, print what would be done rather than doing it. * `--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.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--write` is passed along with `--dry-run`, perform a not-so-dry run `man` [`options`]:
making the expected file modifications but not taking any git actions.
If `--audit` is passed, run `brew audit` before opening the PR. Generate Homebrew's manpages.
If `--strict` is passed, run `brew audit --strict` before opening the PR. * `--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`.
If `--mirror=``URL` is passed, use the value as a mirror URL. `mirror` [`formulae`]:
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
If `--version=``version` is passed, use the value to override the value * `-d`, `--debug`:
parsed from the URL or tag. Note that `--version=0` can be used to delete Display any debugging information.
an existing `version` override from a formula if it has become redundant. * `-v`, `--verbose`:
Make some output more verbose.
If `--message=``message` is passed, append `message` to the default PR
message.
If `--no-browse` is passed, don't pass the `--browse` argument to `hub`
which opens the pull request URL in a browser. Instead, output it to the
command line.
If `--quiet` is passed, don't output replacement messages or warn about
duplicate pull requests.
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.
* `create` `URL` [`--autotools`|`--cmake`|`--meson`] [`--no-fetch`] [`--set-name` `name`] [`--set-version` `version`] [`--tap` `user``/``repo`]:
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>.
If `--autotools` is passed, create a basic template for an Autotools-style build.
If `--cmake` is passed, create a basic template for a CMake-style build.
If `--meson` is passed, create a basic template for a Meson-style build.
If `--no-fetch` is passed, 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).
The options `--set-name` and `--set-version` each take an argument and allow
you to explicitly set the name and version of the package you are creating.
The option `--tap` takes a tap as its argument and generates the formula in
the specified tap.
* `edit`:
Open all of Homebrew for editing.
* `edit` `formula`:
Open `formula` in the editor.
* `extract` [`--force`] `formula` `tap` [`--version=``version`]:
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.
If `--force` is passed, the file at the destination will be overwritten
if it already exists. Otherwise, existing files will be preserved.
If an argument is passed through `--version`, `version` of `formula`
will be extracted and placed in the destination tap. Otherwise, the most
recent version that can be found will be used.
* `formula` `formula`:
Display the path where `formula` is located.
* `irb` [`--examples`] [`--pry`]:
Enter the interactive Homebrew Ruby shell.
If `--examples` is passed, several examples will be shown.
If `--pry` is passed or HOMEBREW_PRY is set, pry will be
used instead of irb.
* `linkage` [`--test`] [`--reverse`] [`formulae`]:
Checks the library links of installed formulae.
Only works on installed formulae. An error is raised if it is run on
uninstalled formulae.
If `--test` is passed, only display missing libraries and exit with a
non-zero exit code if any missing libraries were found.
If `--reverse` is passed, print the dylib followed by the binaries
which link to it for each library the keg references.
If `formulae` are given, check linkage for only the specified brews.
* `man` [`--fail-if-changed`]:
Generate Homebrew's manpages.
If `--fail-if-changed` is passed, the command will 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).
* `prof` [`ruby options`]: * `prof` [`ruby options`]:
Run Homebrew with the Ruby profiler. Run Homebrew with the Ruby profiler.
For example: For example:
* `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] [`--warn-on-publish-failure`] [`--bintray-org=``bintray-org`] [`--test-bot-user=``test-bot-user`] `patch-source` [`patch-source`]: `bump-formula-pr` [`options`] `formula`:
Gets a patch from a GitHub commit or pull request and applies it to Homebrew. Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch. Optionally, installs the formulae changed by the patch.
Each `patch-source` may be one of: Each `patch-source` may be one of:
~ The ID number of a PR (pull request) in the homebrew/core GitHub ~ The ID number of a PR (pull request) in the homebrew/core GitHub
repository repository
~ The URL of a PR on GitHub, using either the web page or API URL ~ The URL of a PR on GitHub, using either the web page or API URL
formats. In this form, the PR may be on Homebrew/brew, formats. In this form, the PR may be on Homebrew/brew,
Homebrew/homebrew-core or any tap. Homebrew/homebrew-core or any tap.
~ The URL of a commit on GitHub ~ The URL of a commit on GitHub
~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID ~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID
If `--bottle` is passed, handle bottles, pulling the bottle-update * `--bottle`:
commit and publishing files on Bintray. 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.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--bump` is passed, for one-formula PRs, automatically reword `release-notes` [`previous_tag`] [`end_ref`]:
commit message to our preferred format.
If `--clean` is passed, do not rewrite or otherwise modify the Output the merged pull requests on Homebrew/brew between two Git refs.
commits found in the pulled PR. If no `previous_tag` is provided it defaults to the latest tag.
If no `end_ref` is provided it defaults to `origin/master`.
If `--ignore-whitespace` is passed, silently ignore whitespace * `--markdown`:
discrepancies when applying diffs. Output as a Markdown list.
If `--resolve` is passed, when a patch fails to apply, leave in
progress and allow user to resolve, instead of aborting.
If `--branch-okay` is passed, do not warn if pulling to a branch
besides master (useful for testing).
If `--no-pbcopy` is passed, do not copy anything to the system
clipboard.
If `--no-publish` is passed, do not publish bottles to Bintray.
If `--warn-on-publish-failure` was passed, do not exit if there's a
failure publishing bottles on Bintray.
If `--bintray-org=``bintray-org` is passed, publish at the given Bintray
organisation.
If `--test-bot-user=``test-bot-user` is passed, pull the bottle block
commit from the specified user on GitHub.
* `release-notes` [`--markdown`] [`previous_tag`] [`end_ref`]:
Output 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`.
If `--markdown` is passed, output as a Markdown list.
* `ruby` [`ruby options`]: * `ruby` [`ruby options`]:
Run a Ruby instance with Homebrew's libraries loaded. Run a Ruby instance with Homebrew's libraries loaded.
For example: For example:
* `tap-new` `user``/``repo`: `tap-new` `user``/``repo`:
Generate the template files for a new tap.
Generate the template files for a new tap.
* `-d`, `--debug`:
Display any debugging information.
* `-v`, `--verbose`:
Make some output more verbose.
* `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] `formula`: * `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] `formula`:
Most formulae provide a test method. `brew test` `formula` runs this Most formulae provide a test method. `brew test` `formula` runs this
@ -978,38 +968,47 @@ Display any debugging information.
Example: `brew install jruby && brew test jruby` Example: `brew install jruby && brew test jruby`
* `tests` [`--verbose`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=``test_script`[`:``line_number`]] [`--seed=``seed`] [`--online`] [`--official-cmd-taps`]: `tests` [`options`] `formula`:
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.
If `--verbose` (or `-v`) is passed, print the command that runs the 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.
If `--coverage` is passed, also generate code coverage reports. * `--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.
* `-v`, `--verbose`:
Make some output more verbose.
* `-d`, `--debug`:
Display any debugging information.
If `--generic` is passed, only run OS-agnostic tests. `update-test` [`options`]:
If `--no-compat` is passed, do not load the compatibility layer when Runs a test of `brew update` with a new repository clone.
running tests.
If `--online` is passed, include tests that use the GitHub API and tests If no arguments are passed, use `origin/master` as the start commit.
that use any of the taps for official external commands.
* `update-test` [`--commit=``commit`] [`--before=``date`] [`--to-tag`] [`--keep-tmp`]: * `--to-tag`:
Runs a test of `brew update` with a new repository clone. Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags.
* `--keep-tmp`:
If no arguments are passed, use `origin/master` as the start commit. Retain the temporary directory containing the new repository clone.
* `--commit`:
If `--commit=``commit` is passed, use `commit` as the start commit. Use provided `commit` as the start commit.
* `--before`:
If `--before=``date` is passed, use the commit at `date` as the Use the commit at provided `date` as the start commit.
start commit. * `-v`, `--verbose`:
Make some output more verbose.
If `--to-tag` is passed, set `HOMEBREW_UPDATE_TO_TAG` to test updating * `-d`, `--debug`:
between tags. Display any debugging information.
If `--keep-tmp` is passed, retain the temporary directory containing
the new repository clone.
## OFFICIAL EXTERNAL COMMANDS ## OFFICIAL EXTERNAL COMMANDS

756
manpages/brew.1
View File

@ -43,8 +43,55 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
. .
.SH "COMMANDS" .SH "COMMANDS"
. .
.IP "\(bu" 4 .TP
\fBanalytics\fR [\fBstate\fR]: Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\. \fB\-\-cache\fR
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
.
.TP
\fB\-\-cache\fR [\fB\-\-build\-from\-source\fR|\fB\-s\fR] [\fB\-\-force\-bottle\fR] \fIformula\fR
Display the file or directory used to cache \fIformula\fR\.
.
.TP
\fB\-\-cellar\fR
Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\.
.
.TP
\fB\-\-cellar\fR \fIformula\fR
Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.TP
\fB\-\-env\fR [\fB\-\-shell=\fR(\fIshell\fR|\fBauto\fR)|\fB\-\-plain\fR]
Show a summary of the Homebrew build environment as a plain list\.
.
.IP
Pass \fB\-\-shell=\fR\fIshell\fR to generate a list of environment variables for the specified shell, or \fB\-\-shell=auto\fR to detect the current shell\.
.
.IP
If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\.
.
.TP
\fB\-\-prefix\fR
Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR
.
.TP
\fB\-\-prefix\fR \fIformula\fR
Display the location in the cellar where \fIformula\fR is or would be installed\.
.
.TP
\fB\-\-repository\fR
Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.TP
\fB\-\-repository\fR \fIuser\fR\fB/\fR\fIrepo\fR
Display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.TP
\fB\-\-version\fR
Print the version number of Homebrew to standard output and exit\.
.
.TP
\fBanalytics\fR [\fBstate\fR]
Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBanalytics\fR (\fBon\fR|\fBoff\fR): Turn on/off Homebrew\'s analytics\. \fBanalytics\fR (\fBon\fR|\fBoff\fR): Turn on/off Homebrew\'s analytics\.
@ -433,8 +480,38 @@ Exits with a non\-zero status if any style violations are found\.
.IP "\(bu" 4 .IP "\(bu" 4
\fBswitch\fR \fIformula\fR \fIversion\fR: Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\. \fBswitch\fR \fIformula\fR \fIversion\fR: Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\.
. .
.IP "\(bu" 4 .TP
\fBtap\fR: List all installed taps\. \fBtap\-info\fR
Display a brief summary of all installed taps\.
.
.TP
\fBtap\-info\fR (\fB\-\-installed\fR|\fItaps\fR)
Display detailed information about one or more \fItaps\fR\.
.
.IP
Pass \fB\-\-installed\fR to display information on all installed taps\.
.
.TP
\fBtap\-info\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-installed\fR|\fItaps\fR)
Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
.
.IP
Pass \fB\-\-installed\fR to get information on installed taps\.
.
.IP
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.TP
\fBtap\-pin\fR \fItap\fR
Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\.
.
.TP
\fBtap\-unpin\fR \fItap\fR
Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\.
.
.TP
\fBtap\fR
List all installed taps\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBtap\fR [\fB\-\-full\fR] [\fB\-\-force\-auto\-update\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]: Tap a formula repository\. \fBtap\fR [\fB\-\-full\fR] [\fB\-\-force\-auto\-update\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]: Tap a formula repository\.
@ -460,32 +537,9 @@ By default, only taps hosted on GitHub are auto\-updated (for performance reason
.IP "\(bu" 4 .IP "\(bu" 4
\fBtap\fR \fB\-\-list\-pinned\fR: List all pinned taps\. \fBtap\fR \fB\-\-list\-pinned\fR: List all pinned taps\.
. .
.IP "\(bu" 4 .TP
\fBtap\-info\fR: Display a brief summary of all installed taps\. \fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fB\-\-force\fR] [\fB\-\-ignore\-dependencies\fR] \fIformula\fR
. Uninstall \fIformula\fR\.
.IP "\(bu" 4
\fBtap\-info\fR (\fB\-\-installed\fR|\fItaps\fR): Display detailed information about one or more \fItaps\fR\.
.
.IP
Pass \fB\-\-installed\fR to display information on all installed taps\.
.
.IP "\(bu" 4
\fBtap\-info\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-installed\fR|\fItaps\fR): Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
.
.IP
Pass \fB\-\-installed\fR to get information on installed taps\.
.
.IP
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.IP "\(bu" 4
\fBtap\-pin\fR \fItap\fR: Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\.
.
.IP "\(bu" 4
\fBtap\-unpin\fR \fItap\fR: Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\.
.
.IP "\(bu" 4
\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fB\-\-force\fR] [\fB\-\-ignore\-dependencies\fR] \fIformula\fR: Uninstall \fIformula\fR\.
. .
.IP .IP
If \fB\-\-force\fR (or \fB\-f\fR) is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\. If \fB\-\-force\fR (or \fB\-f\fR) is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
@ -514,20 +568,9 @@ If \fB\-\-git\fR (or \fB\-g\fR) is passed, a Git repository will be initialized
.IP "\(bu" 4 .IP "\(bu" 4
\fBuntap\fR \fItap\fR: Remove a tapped repository\. \fBuntap\fR \fItap\fR: Remove a tapped repository\.
. .
.IP "\(bu" 4 .TP
\fBupdate\fR [\fB\-\-merge\fR] [\fB\-\-force\fR]: Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\. \fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fB\-\-ignore\-pinned\fR] [\fIformulae\fR]
. Upgrade outdated, unpinned brews (with existing install options)\.
.IP
If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
.
.IP
If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\.
.
.IP "\(bu" 4
\fBupdate\-reset\fR [\fIrepositories\fR]: Fetches and resets Homebrew and all tap repositories (or the specified \fBrepositories\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
.
.IP "\(bu" 4
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fB\-\-ignore\-pinned\fR] [\fB\-\-display\-times\fR] [\fIformulae\fR]: Upgrade outdated, unpinned brews (with existing install options)\.
. .
.IP .IP
Options for the \fBinstall\fR command are also valid here\. Options for the \fBinstall\fR command are also valid here\.
@ -562,43 +605,19 @@ By default, \fBuses\fR shows all formulae that specify \fIformulae\fR as a requi
.IP .IP
By default, \fBuses\fR shows usage of \fIformulae\fR by stable builds\. To find cases where \fIformulae\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\. By default, \fBuses\fR shows usage of \fIformulae\fR by stable builds\. To find cases where \fIformulae\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\.
. .
.IP "\(bu" 4 .TP
\fB\-\-cache\fR: Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. \fBupdate\-reset\fR
Fetches and resets Homebrew and all tap repositories using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
. .
.IP "\(bu" 4 .TP
\fB\-\-cache\fR [\fB\-\-build\-from\-source\fR|\fB\-s\fR] [\fB\-\-force\-bottle\fR] \fIformula\fR: Display the file or directory used to cache \fIformula\fR\. \fBupdate\fR [\fB\-\-merge\fR] [\fB\-\-force\fR]
. Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
.IP "\(bu" 4
\fB\-\-cellar\fR: Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\.
.
.IP "\(bu" 4
\fB\-\-cellar\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.IP "\(bu" 4
\fB\-\-env\fR [\fB\-\-shell=\fR(\fIshell\fR|\fBauto\fR)|\fB\-\-plain\fR]: Show a summary of the Homebrew build environment as a plain list\.
. .
.IP .IP
Pass \fB\-\-shell=\fR\fIshell\fR to generate a list of environment variables for the specified shell, or \fB\-\-shell=auto\fR to detect the current shell\. If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
. .
.IP .IP
If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\. If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\.
.
.IP "\(bu" 4
\fB\-\-prefix\fR: Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux
.
.IP "\(bu" 4
\fB\-\-prefix\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR is or would be installed\.
.
.IP "\(bu" 4
\fB\-\-repository\fR: Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.IP "\(bu" 4
\fB\-\-repository\fR \fIuser\fR\fB/\fR\fIrepo\fR: Display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.IP "\(bu" 4
\fB\-\-version\fR: Print the version number of Homebrew to standard output and exit\.
.
.IP "" 0
. .
.SH "DEVELOPER COMMANDS" .SH "DEVELOPER COMMANDS"
\fBaudit\fR [\fIoptions\fR] [\fIformulae\fR]: \fBaudit\fR [\fIoptions\fR] [\fIformulae\fR]:
@ -661,130 +680,198 @@ Make some output more verbose\.
\fB\-d\fR, \fB\-\-debug\fR \fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\. Display any debugging information\.
. .
.TP .P
\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-fix\fR] [\fB\-\-online\fR] [\fB\-\-new\-formula\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-display\-filename\fR] [\fB\-\-only=\fR\fImethod\fR|\fB\-\-except=\fR\fImethod\fR] [\fB\-\-only\-cops=\fR\fIcops\fR|\fB\-\-except\-cops=\fR\fIcops\fR] [\fIformulae\fR] \fBbottle\fR [\fIoptions\fR] [\fIformulae\fR]:
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
. .
.IP .P
If no \fIformulae\fR are provided, all of them are checked\.
.
.IP
If \fB\-\-strict\fR is passed, additional checks are run, including RuboCop style checks\.
.
.IP
If \fB\-\-fix\fR is passed, style violations will be automatically fixed using RuboCop\'s auto\-correct feature\.
.
.IP
If \fB\-\-online\fR is passed, additional slower checks that require a network connection are run\.
.
.IP
If \fB\-\-new\-formula\fR is passed, various additional checks are run that check if a new formula is eligible for Homebrew\. This should be used when creating new formulae and implies \fB\-\-strict\fR and \fB\-\-online\fR\.
.
.IP
If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\.
.
.IP
If \fB\-\-display\-filename\fR is passed, every line of output is prefixed with the name of the file or formula being audited, to make the output easy to grep\.
.
.IP
Passing \fB\-\-only=\fR\fImethod\fR will run only the methods named \fBaudit_<method>\fR, while \fB\-\-except=\fR\fImethod\fR will skip the methods named \fBaudit_<method>\fR\. For either option \fImethod\fR should be a comma\-separated list\.
.
.IP
Passing \fB\-\-only\-cops=\fR\fIcops\fR will check for violations of only the listed RuboCop \fIcops\fR, while \fB\-\-except\-cops=\fR\fIcops\fR will skip checking the listed \fIcops\fR\. For either option \fIcops\fR should be a comma\-separated list of cop names\.
.
.IP
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
.
.TP
\fBbottle\fR [\fB\-\-verbose\fR] [\fB\-\-no\-rebuild\fR|\fB\-\-keep\-old\fR] [\fB\-\-skip\-relocation\fR] [\fB\-\-or\-later\fR] [\fB\-\-root\-url=\fR\fIURL\fR] [\fB\-\-force\-core\-tap\fR] [\fB\-\-json\fR] \fIformulae\fR
Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\. Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\.
. .
.IP .P
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\. 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\.
. .
.IP .TP
If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the bottling commands and any warnings encountered\. \fB\-\-skip\-relocation\fR
Do not check if the bottle can be marked as relocatable\.
. .
.IP .TP
If \fB\-\-skip\-relocation\fR is passed, do not check if the bottle can be marked as relocatable\. \fB\-\-or\-later\fR
Append \fB_or_later\fR to the bottle tag\.
. .
.IP .TP
If \fB\-\-root\-url\fR is passed, use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\. \fB\-\-force\-core\-tap\fR
Build a bottle even if \fIformula\fR is not in homebrew/core or any installed taps\.
. .
.IP .TP
If \fB\-\-or\-later\fR is passed, append _or_later to the bottle tag\. \fB\-\-no\-rebuild\fR
If the formula specifies a rebuild version, it will be removed in the generated DSL\.
. .
.IP .TP
If \fB\-\-force\-core\-tap\fR is passed, build a bottle even if \fIformula\fR is not in homebrew/core or any installed taps\. \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\.
.
.TP
\fB\-\-json\fR
Write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBbump\-formula\-pr\fR [\fIoptions\fR] \fIformula\fR:
.
.P
Creates a pull request to update the 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\.
.
.P
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\.
. .
.IP .IP
If \fB\-\-json\fR is passed, write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\. If \fB\-\-json\fR is passed, write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
. .
.TP .TP
\fBbottle\fR \fB\-\-merge\fR [\fB\-\-keep\-old\fR] [\fB\-\-write\fR [\fB\-\-no\-commit\fR]] \fIbottle_json_files\fR \fB\-\-devel\fR
Generate a bottle from a \fB\-\-json\fR output file and print the new DSL merged into the existing formula\. Bump the development rather than stable version\. The development spec must already exist\.
.
.IP
If \fB\-\-write\fR is passed, write the changes to the formula file\. A new commit will then be generated unless \fB\-\-no\-commit\fR is passed\.
. .
.TP .TP
\fBbump\-formula\-pr\fR [\fB\-\-devel\fR] [\fB\-\-dry\-run\fR [\fB\-\-write\fR]] [\fB\-\-audit\fR|\fB\-\-strict\fR] [\fB\-\-mirror=\fR\fIURL\fR] [\fB\-\-version=\fR\fIversion\fR] [\fB\-\-message=\fR\fImessage\fR] (\fB\-\-url=\fR\fIURL\fR \fB\-\-sha256=\fR\fIsha\-256\fR|\fB\-\-tag=\fR\fItag\fR \fB\-\-revision=\fR\fIrevision\fR) \fIformula\fR \fB\-n\fR, \fB\-\-dry\-run\fR
Creates a pull request to update the formula with a new URL or a new tag\. Print what would be done rather than doing it\.
.
.IP
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\.
.
.IP
If a \fItag\fR is specified, the git commit \fIrevision\fR corresponding to that tag must also be specified\.
.
.IP
If \fB\-\-devel\fR is passed, bump the development rather than stable version\. The development spec must already exist\.
.
.IP
If \fB\-\-dry\-run\fR is passed, print what would be done rather than doing it\.
.
.IP
If \fB\-\-write\fR is passed along with \fB\-\-dry\-run\fR, perform a not\-so\-dry run making the expected file modifications but not taking any git actions\.
.
.IP
If \fB\-\-audit\fR is passed, run \fBbrew audit\fR before opening the PR\.
.
.IP
If \fB\-\-strict\fR is passed, run \fBbrew audit \-\-strict\fR before opening the PR\.
.
.IP
If \fB\-\-mirror=\fR\fIURL\fR is passed, use the value as a mirror URL\.
.
.IP
If \fB\-\-version=\fR\fIversion\fR is passed, use the value 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\.
.
.IP
If \fB\-\-message=\fR\fImessage\fR is passed, append \fImessage\fR to the default PR message\.
.
.IP
If \fB\-\-no\-browse\fR is passed, don\'t pass the \fB\-\-browse\fR argument to \fBhub\fR which opens the pull request URL in a browser\. Instead, output it to the command line\.
.
.IP
If \fB\-\-quiet\fR is passed, don\'t output replacement messages or warn about duplicate pull requests\.
.
.IP
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\.
. .
.TP .TP
\fBcreate\fR \fIURL\fR [\fB\-\-autotools\fR|\fB\-\-cmake\fR|\fB\-\-meson\fR] [\fB\-\-no\-fetch\fR] [\fB\-\-set\-name\fR \fIname\fR] [\fB\-\-set\-version\fR \fIversion\fR] [\fB\-\-tap\fR \fIuser\fR\fB/\fR\fIrepo\fR] \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\.
.
.TP
\fB\-\-audit\fR
Run \fBbrew audit\fR before opening the PR\.
.
.TP
\fB\-\-strict\fR
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\.
.
.TP
\fB\-\-mirror\fR
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\.
.
.TP
\fB\-\-message\fR
Append provided \fImessage\fR to the default PR message\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress any warnings\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Override warnings and enable potentially unsafe operations\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBcreate\fR \fIURL\fR [\fIoptions\fR]:
.
.P
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\. 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\.
. .
.IP .TP
If \fB\-\-autotools\fR is passed, create a basic template for an Autotools\-style build\. If \fB\-\-cmake\fR is passed, create a basic template for a CMake\-style build\. If \fB\-\-meson\fR is passed, create a basic template for a Meson\-style build\. \fB\-\-autotools\fR
Create a basic template for an Autotools\-style build\.
. .
.IP .TP
If \fB\-\-no\-fetch\fR is passed, 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)\. \fB\-\-cmake\fR
Create a basic template for a CMake\-style build\.
. .
.IP .TP
The options \fB\-\-set\-name\fR and \fB\-\-set\-version\fR each take an argument and allow you to explicitly set the name and version of the package you are creating\. \fB\-\-meson\fR
Create a basic template for a Meson\-style build\.
. .
.IP .TP
The option \fB\-\-tap\fR takes a tap as its argument and generates the formula in the specified tap\. \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)\.
.
.TP
\fB\-\-HEAD\fR
HEAD
.
.TP
\fB\-\-set\-name\fR
Set the provided name of the package you are creating\.
.
.TP
\fB\-\-set\-version\fR
Set the provided version of the package you are creating\.
.
.TP
\fB\-\-tap\fR
Takes a tap [\fIuser\fR\fB/\fR\fIrepo\fR] as argument and generates the formula in the specified tap\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Override warnings and enable potentially unsafe operations\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
. .
.TP .TP
\fBedit\fR \fBedit\fR
@ -795,123 +882,209 @@ Open all of Homebrew for editing\.
Open \fIformula\fR in the editor\. Open \fIformula\fR in the editor\.
. .
.TP .TP
\fBextract\fR [\fB\-\-force\fR] \fIformula\fR \fItap\fR [\fB\-\-version=\fR\fIversion\fR] \fB\-f\fR, \fB\-\-force\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\. Override warnings and enable potentially unsafe operations\.
.
.IP
If \fB\-\-force\fR is passed, the file at the destination will be overwritten if it already exists\. Otherwise, existing files will be preserved\.
.
.IP
If an argument is passed through \fB\-\-version\fR, \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\.
. .
.TP .TP
\fBformula\fR \fIformula\fR \fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBformula\fR \fIformula\fR:
.
.P
Display the path where \fIformula\fR is located\. Display the path where \fIformula\fR is located\.
. .
.TP .TP
\fBirb\fR [\fB\-\-examples\fR] [\fB\-\-pry\fR] \fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.P
\fBirb\fR [\fIoptions\fR]:
.
.P
Enter the interactive Homebrew Ruby shell\. Enter the interactive Homebrew Ruby shell\.
. .
.IP .TP
If \fB\-\-examples\fR is passed, several examples will be shown\. If \fB\-\-pry\fR is passed or HOMEBREW_PRY is set, pry will be used instead of irb\. \fB\-\-examples\fR
Show several examples\.
. .
.TP .TP
\fBlinkage\fR [\fB\-\-test\fR] [\fB\-\-reverse\fR] [\fIformulae\fR] \fB\-\-pry\fR
Checks the library links of installed formulae\. Pry will be used instead of irb if \fB\-\-pry\fR is passed or HOMEBREW_PRY is set\.
. .
.IP .P
\fBlinkage\fR [\fIoptions\fR] \fIformula\fR:
.
.P
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\. Only works on installed formulae\. An error is raised if it is run on uninstalled formulae\.
. .
.IP .TP
If \fB\-\-test\fR is passed, only display missing libraries and exit with a non\-zero exit code if any missing libraries were found\. \fB\-\-test\fR
. Display only missing libraries and exit with a non\-zero exit code if any missing libraries were found\.
.IP
If \fB\-\-reverse\fR is passed, print the dylib followed by the binaries which link to it for each library the keg references\.
.
.IP
If \fIformulae\fR are given, check linkage for only the specified brews\.
. .
.TP .TP
\fBman\fR [\fB\-\-fail\-if\-changed\fR] \fB\-\-reverse\fR
Print the dylib followed by the binaries which link to it for each library the keg references\.
.
.TP
\fB\-\-cached\fR
Print the cached linkage values stored in HOMEBREW_CACHE, set from a previous \fBbrew linkage\fR run\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBman\fR [\fIoptions\fR]:
.
.P
Generate Homebrew\'s manpages\. Generate Homebrew\'s manpages\.
. .
.IP .TP
If \fB\-\-fail\-if\-changed\fR is passed, the command will 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)\. \fB\-\-fail\-if\-changed\fR
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)\.
.
.TP
\fB\-\-link\fR
It is now done automatically by \fBbrew update\fR\.
.
.P
\fBmirror\fR [\fIformulae\fR]:
.
.P
Reuploads the stable URL for a formula to Bintray to use it as a mirror\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
. .
.TP .TP
\fBprof\fR [\fIruby options\fR] \fBprof\fR [\fIruby options\fR]
Run Homebrew with the Ruby profiler\. For example: Run Homebrew with the Ruby profiler\. For example:
. .
.TP .P
\fBpull\fR [\fB\-\-bottle\fR] [\fB\-\-bump\fR] [\fB\-\-clean\fR] [\fB\-\-ignore\-whitespace\fR] [\fB\-\-resolve\fR] [\fB\-\-branch\-okay\fR] [\fB\-\-no\-pbcopy\fR] [\fB\-\-no\-publish\fR] [\fB\-\-warn\-on\-publish\-failure\fR] [\fB\-\-bintray\-org=\fR\fIbintray\-org\fR] [\fB\-\-test\-bot\-user=\fR\fItest\-bot\-user\fR] \fIpatch\-source\fR [\fIpatch\-source\fR]: \fBbump\-formula\-pr\fR [\fIoptions\fR] \fIformula\fR:
. .
.IP .P
Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\. Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\.
. .
.IP .P
Each \fIpatch\-source\fR may be one of: Each \fIpatch\-source\fR may be one of:
. .
.IP .P
~ The ID number of a PR (pull request) in the homebrew/core GitHub repository ~ The ID number of a PR (pull request) in the homebrew/core GitHub repository
. .
.IP .P
~ The URL of a PR on GitHub, using either the web page or API URL formats\. In this form, the PR may be on Homebrew/brew, Homebrew/homebrew\-core or any tap\. ~ The URL of a PR on GitHub, using either the web page or API URL formats\. In this form, the PR may be on Homebrew/brew, Homebrew/homebrew\-core or any tap\.
. .
.IP .P
~ The URL of a commit on GitHub ~ The URL of a commit on GitHub
. .
.IP .P
~ A "https://jenkins\.brew\.sh/job/\.\.\." string specifying a testing job ID ~ A "https://jenkins\.brew\.sh/job/\.\.\." string specifying a testing job ID
. .
.IP .TP
If \fB\-\-bottle\fR is passed, handle bottles, pulling the bottle\-update commit and publishing files on Bintray\. \fB\-\-bottle\fR
. Handle bottles, pulling the bottle\-update commit and publishing files on Bintray\.
.IP
If \fB\-\-bump\fR is passed, for one\-formula PRs, automatically reword commit message to our preferred format\.
.
.IP
If \fB\-\-clean\fR is passed, do not rewrite or otherwise modify the commits found in the pulled PR\.
.
.IP
If \fB\-\-ignore\-whitespace\fR is passed, silently ignore whitespace discrepancies when applying diffs\.
.
.IP
If \fB\-\-resolve\fR is passed, when a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\.
.
.IP
If \fB\-\-branch\-okay\fR is passed, do not warn if pulling to a branch besides master (useful for testing)\.
.
.IP
If \fB\-\-no\-pbcopy\fR is passed, do not copy anything to the system clipboard\.
.
.IP
If \fB\-\-no\-publish\fR is passed, do not publish bottles to Bintray\.
.
.IP
If \fB\-\-warn\-on\-publish\-failure\fR was passed, do not exit if there\'s a failure publishing bottles on Bintray\.
.
.IP
If \fB\-\-bintray\-org=\fR\fIbintray\-org\fR is passed, publish at the given Bintray organisation\.
.
.IP
If \fB\-\-test\-bot\-user=\fR\fItest\-bot\-user\fR is passed, pull the bottle block commit from the specified user on GitHub\.
. .
.TP .TP
\fBrelease\-notes\fR [\fB\-\-markdown\fR] [\fIprevious_tag\fR] [\fIend_ref\fR] \fB\-\-bump\fR
For one\-formula PRs, automatically reword commit message to our preferred format\.
.
.TP
\fB\-\-clean\fR
Do not rewrite or otherwise modify the commits found in the pulled PR\.
.
.TP
\fB\-\-ignore\-whitespace\fR
Silently ignore whitespace discrepancies when applying diffs\.
.
.TP
\fB\-\-resolve\fR
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\.
.
.TP
\fB\-\-branch\-okay\fR
Do not warn if pulling to a branch besides master (useful for testing)\.
.
.TP
\fB\-\-no\-pbcopy\fR
Do not copy anything to the system clipboard\.
.
.TP
\fB\-\-no\-publish\fR
Do not publish bottles to Bintray\.
.
.TP
\fB\-\-warn\-on\-publish\-failure\fR
Do not exit if there\'s a failure publishing bottles on Bintray\.
.
.TP
\fB\-\-bintray\-org\fR
Publish at the given Bintray organisation\.
.
.TP
\fB\-\-test\-bot\-user\fR
Pull the bottle block commit from the specified user on GitHub\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBrelease\-notes\fR [\fIprevious_tag\fR] [\fIend_ref\fR]:
.
.P
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\. 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\.
. .
.IP .TP
If \fB\-\-markdown\fR is passed, output as a Markdown list\. \fB\-\-markdown\fR
Output as a Markdown list\.
. .
.TP .TP
\fBruby\fR [\fIruby options\fR] \fBruby\fR [\fIruby options\fR]
Run a Ruby instance with Homebrew\'s libraries loaded\. For example: Run a Ruby instance with Homebrew\'s libraries loaded\. For example:
. .
.TP .P
\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR:
.
.P
Generate the template files for a new tap\. Generate the template files for a new tap\.
. .
.TP .TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR \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\. 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\.
. .
@ -926,45 +1099,78 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created for the test are n
. .
.IP .IP
Example: \fBbrew install jruby && brew test jruby\fR Example: \fBbrew install jruby && brew test jruby\fR
. .
.TP .P
\fBtests\fR [\fB\-\-verbose\fR] [\fB\-\-coverage\fR] [\fB\-\-generic\fR] [\fB\-\-no\-compat\fR] [\fB\-\-only=\fR\fItest_script\fR[\fB:\fR\fIline_number\fR]] [\fB\-\-seed=\fR\fIseed\fR] [\fB\-\-online\fR] [\fB\-\-official\-cmd\-taps\fR] \fBtests\fR [\fIoptions\fR] \fIformula\fR:
.
.P
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\. 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\.
. .
.IP .TP
If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the command that runs the tests\. \fB\-\-coverage\fR
. Generate code coverage reports\.
.IP
If \fB\-\-coverage\fR is passed, also generate code coverage reports\.
.
.IP
If \fB\-\-generic\fR is passed, only run OS\-agnostic tests\.
.
.IP
If \fB\-\-no\-compat\fR is passed, do not load the compatibility layer when running tests\.
.
.IP
If \fB\-\-online\fR is passed, include tests that use the GitHub API and tests that use any of the taps for official external commands\.
. .
.TP .TP
\fBupdate\-test\fR [\fB\-\-commit=\fR\fIcommit\fR] [\fB\-\-before=\fR\fIdate\fR] [\fB\-\-to\-tag\fR] [\fB\-\-keep\-tmp\fR] \fB\-\-generic\fR
Run only OS\-agnostic tests\.
.
.TP
\fB\-\-no\-compat\fR
Do not load the compatibility layer when running tests\.
.
.TP
\fB\-\-online\fR
Include tests that use the GitHub API and tests that use any of the taps for official external commands\.
.
.TP
\fB\-\-only\fR
Run only \fItest_script\fR_spec\.rb
.
.TP
\fB\-\-seed\fR
Randomizes tests with the provided value instead of a random seed\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.P
\fBupdate\-test\fR [\fIoptions\fR]:
.
.P
Runs a test of \fBbrew update\fR with a new repository clone\. Runs a test of \fBbrew update\fR with a new repository clone\.
. .
.IP .P
If no arguments are passed, use \fBorigin/master\fR as the start commit\. If no arguments are passed, use \fBorigin/master\fR as the start commit\.
. .
.IP .TP
If \fB\-\-commit=\fR\fIcommit\fR is passed, use \fIcommit\fR as the start commit\. \fB\-\-to\-tag\fR
Set \fBHOMEBREW_UPDATE_TO_TAG\fR to test updating between tags\.
. .
.IP .TP
If \fB\-\-before=\fR\fIdate\fR is passed, use the commit at \fIdate\fR as the start commit\. \fB\-\-keep\-tmp\fR
Retain the temporary directory containing the new repository clone\.
. .
.IP .TP
If \fB\-\-to\-tag\fR is passed, set \fBHOMEBREW_UPDATE_TO_TAG\fR to test updating between tags\. \fB\-\-commit\fR
Use provided \fIcommit\fR as the start commit\.
. .
.IP .TP
If \fB\-\-keep\-tmp\fR is passed, retain the temporary directory containing the new repository clone\. \fB\-\-before\fR
Use the commit at provided \fIdate\fR as the start commit\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
. .
.SH "OFFICIAL EXTERNAL COMMANDS" .SH "OFFICIAL EXTERNAL COMMANDS"
. .