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

Update commands to generate usage banner

Browse Source
This commit is contained in:
Rylan Polster 2021-01-15 15:04:02 -05:00
parent b7977244ea
commit d1f3e39b7b
No known key found for this signature in database
GPG Key ID: 46A744940CFF4D64
88 changed files with 229 additions and 395 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Library/Homebrew/cmd/--cache.rb
View File

@ -15,9 +15,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __cache_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--cache` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
If <formula> is provided, display the file or directory used to cache <formula>.

4
Library/Homebrew/cmd/--caskroom.rb
View File

@ -9,9 +9,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __caskroom_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--caskroom` [<cask>] [<cask> ...]
description <<~EOS
Display Homebrew's Caskroom path.
If <cask> is provided, display the location in the Caskroom where <cask>

4
Library/Homebrew/cmd/--cellar.rb
View File

@ -8,9 +8,7 @@ module Homebrew
def __cellar_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--cellar` [<formula>] [<formula> ...]
description <<~EOS
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.

4
Library/Homebrew/cmd/--env.rb
View File

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __env_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--env` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Summarise Homebrew's build environment as a plain list.
If the command's output is sent through a pipe and no shell is specified,

4
Library/Homebrew/cmd/--prefix.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __prefix_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--prefix` [<formula>] [<formula> ...]
description <<~EOS
Display Homebrew's install path. *Default:*
- macOS Intel: `#{HOMEBREW_DEFAULT_PREFIX}`

4
Library/Homebrew/cmd/--repository.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __repository_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--repository`, `--repo` [<user>`/`<repo>] [<user>`/`<repo> ...]
description <<~EOS
Display where Homebrew's `.git` directory is located.
If <user>`/`<repo> are provided, display where tap <user>`/`<repo>'s directory is located.

4
Library/Homebrew/cmd/--version.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def __version_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--version`
description <<~EOS
Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output.
EOS

4
Library/Homebrew/cmd/analytics.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def analytics_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`analytics` [<subcommand>]
description <<~EOS
Control Homebrew's anonymous aggregate user behaviour analytics.
Read more at <https://docs.brew.sh/Analytics>.

4
Library/Homebrew/cmd/autoremove.rb
View File

@ -10,9 +10,7 @@ module Homebrew
def autoremove_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`autoremove` [<options>]
description <<~EOS
Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed.
EOS
switch "-n", "--dry-run",

4
Library/Homebrew/cmd/cleanup.rb
View File

@ -13,9 +13,7 @@ module Homebrew
def cleanup_args
Homebrew::CLI::Parser.new do
days = Homebrew::EnvConfig::ENVS[:HOMEBREW_CLEANUP_MAX_AGE_DAYS][:default]
usage_banner <<~EOS
`cleanup` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Remove stale lock files and outdated downloads for all formulae and casks,
and remove old versions of installed formulae. If arguments are specified,
only do this for the given formulae and casks. Removes all downloads more than

4
Library/Homebrew/cmd/commands.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def commands_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`commands` [<options>]
description <<~EOS
Show lists of built-in and external commands.
EOS
switch "-q", "--quiet",

4
Library/Homebrew/cmd/completions.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def completions_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`completions` [<subcommand>]
description <<~EOS
Control whether Homebrew automatically links external tap shell completion files.
Read more at <https://docs.brew.sh/Shell-Completion>.

4
Library/Homebrew/cmd/config.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def config_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`config`
description <<~EOS
Show Homebrew and system configuration info useful for debugging. If you file
a bug report, you will be required to provide this information.
EOS

4
Library/Homebrew/cmd/deps.rb
View File

@ -17,9 +17,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def deps_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`deps` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Show dependencies for <formula>. Additional options specific to <formula>
may be appended to the command. When given multiple formula arguments,
show the intersection of dependencies for each formula.

6
Library/Homebrew/cmd/desc.rb
View File

@ -16,9 +16,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def desc_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`desc` [<options>] <text>|`/`<text>`/`|<formula> [<text>|`/`<text>`/`|<formula> ...]
description <<~EOS
Display <formula>'s name and one-line description.
Formula descriptions are cached; the cache is created on the
first search, making that search slower than subsequent ones.
@ -35,7 +33,7 @@ module Homebrew
conflicts "--search", "--name", "--description"
named_args :formula, min: 1
named_args [:formula, :text_or_regex], min: 1
end
end

4
Library/Homebrew/cmd/doctor.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def doctor_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`doctor` [<options>]
description <<~EOS
Check your system for potential problems. Will exit with a non-zero status
if any potential problems are found. Please note that these warnings are just
used to help the Homebrew maintainers with debugging if you file an issue. If

4
Library/Homebrew/cmd/fetch.rb
View File

@ -16,9 +16,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def fetch_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`fetch` [<options>] <formula>|<cask> [<formula>|<cask> ...]
description <<~EOS
Download a bottle (if available) or source packages for <formula>e
and binaries for <cask>s. For files, also print SHA-256 checksums.
EOS

4
Library/Homebrew/cmd/gist-logs.rb
View File

@ -18,9 +18,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def gist_logs_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`gist-logs` [<options>] <formula>
description <<~EOS
Upload logs for a failed build of <formula> to a new Gist. Presents an
error message if no logs are found.
EOS

4
Library/Homebrew/cmd/home.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def home_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`home` [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Open a <formula> or <cask>'s homepage in a browser, or open
Homebrew's own homepage if no argument is provided.
EOS

4
Library/Homebrew/cmd/info.rb
View File

@ -24,9 +24,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def info_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`info` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Display brief statistics for your Homebrew installation.
If a <formula> or <cask> is provided, show summary of information about it.

4
Library/Homebrew/cmd/install.rb
View File

@ -23,9 +23,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def install_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`install` [<options>] <formula>|<cask> [<formula>|<cask> ...]
description <<~EOS
Install a <formula> or <cask>. Additional options specific to a <formula> may be
appended to the command.

4
Library/Homebrew/cmd/leaves.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def leaves_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`leaves`
description <<~EOS
List installed formulae that are not dependencies of another installed formula.
EOS

4
Library/Homebrew/cmd/link.rb
View File

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def link_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`link`, `ln` [<options>] <formula> [<formula> ...]
description <<~EOS
Symlink all of <formula>'s installed files into Homebrew's prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.

4
Library/Homebrew/cmd/list.rb
View File

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def list_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`list`, `ls` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
List all installed formulae and casks.
If <formula> is provided, summarise the paths within its current keg.

4
Library/Homebrew/cmd/log.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def log_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`log` [<options>] [<formula>]
description <<~EOS
Show the `git log` for <formula>, or show the log for the Homebrew repository
if no formula is provided.
EOS

4
Library/Homebrew/cmd/migrate.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def migrate_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`migrate` [<options>] <formula> [<formula> ...]
description <<~EOS
Migrate renamed packages to new names, where <formula> are old names of
packages.
EOS

4
Library/Homebrew/cmd/missing.rb
View File

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def missing_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`missing` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Check the given <formula> kegs for missing dependencies. If no <formula> are
provided, check all kegs. Will exit with a non-zero status if any kegs are found
to be missing dependencies.

4
Library/Homebrew/cmd/options.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def options_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`options` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Show install options specific to <formula>.
EOS
switch "--compact",

4
Library/Homebrew/cmd/outdated.rb
View File

@ -15,9 +15,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def outdated_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`outdated` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
List installed casks and formulae that have an updated version available. By default, version
information is displayed in interactive shells, and suppressed otherwise.
EOS

4
Library/Homebrew/cmd/pin.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def pin_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pin` <formula> [<formula> ...]
description <<~EOS
Pin the specified <formula>, preventing them from being upgraded when
issuing the `brew upgrade` <formula> command. See also `unpin`.
EOS

4
Library/Homebrew/cmd/postinstall.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def postinstall_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`postinstall` <formula> [<formula> ...]
description <<~EOS
Rerun the post-install steps for <formula>.
EOS

4
Library/Homebrew/cmd/readall.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def readall_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`readall` [<options>] [<tap>] [<tap> ...]
description <<~EOS
Import all items from the specified <tap>, or from all installed taps if none is provided.
This can be useful for debugging issues across all items when making
significant changes to `formula.rb`, testing the performance of loading

4
Library/Homebrew/cmd/reinstall.rb
View File

@ -21,9 +21,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def reinstall_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`reinstall` [<options>] <formula>|<cask> [<formula>|<cask> ...]
description <<~EOS
Uninstall and then reinstall a <formula> or <cask> using the same options it was
originally installed with, plus any appended options specific to a <formula>.

8
Library/Homebrew/cmd/search.rb
View File

@ -30,9 +30,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def search_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`search` [<options>] [<text>|`/`<text>`/`] [<text>|`/`<text>`/` ...]
description <<~EOS
Perform a substring search of cask tokens and formula names for <text>. If <text>
is flanked by slashes, it is interpreted as a regular expression.
The search for <text> is extended online to `homebrew/core` and `homebrew/cask`.
@ -67,8 +65,8 @@ module Homebrew
conflicts("--desc", "--pull-request")
conflicts(*package_manager_switches)
# TODO: (2.9) uncomment when the `odeprecated`/`odisabled` for `brew search` with no arguments is removed
# named_args min: 1
# TODO: (2.9) add `min: 1` when the `odeprecated`/`odisabled` for `brew search` with no arguments is removed
named_args :text_or_regex
end
end

4
Library/Homebrew/cmd/switch.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def switch_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`switch` <formula> <version>
description <<~EOS
Symlink all of the specified <version> of <formula>'s installation into Homebrew's prefix.
EOS

4
Library/Homebrew/cmd/tap-info.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def tap_info_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap-info` [<options>] [<tap>] [<tap> ...]
description <<~EOS
Show detailed information about one or more <tap>s.
If no <tap> names are provided, display brief statistics for all installed taps.

5
Library/Homebrew/cmd/tap.rb
View File

@ -11,9 +11,8 @@ module Homebrew
sig { returns(CLI::Parser) }
def tap_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap` [<options>] [<user>`/`<repo>] [<URL>]
usage_banner "`tap` [<options>] [<user>`/`<repo>] [<URL>]"
description <<~EOS
Tap a formula repository.
If no arguments are provided, list all installed taps.

4
Library/Homebrew/cmd/uninstall.rb
View File

@ -18,9 +18,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def uninstall_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`uninstall`, `rm`, `remove` [<options>] <formula>|<cask> [<formula>|<cask> ...]
description <<~EOS
Uninstall a <formula> or <cask>.
EOS
switch "-f", "--force",

4
Library/Homebrew/cmd/unlink.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def unlink_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`unlink` [<options>] <formula> [<formula> ...]
description <<~EOS
Remove symlinks for <formula> from Homebrew's prefix. This can be useful
for temporarily disabling a formula:
`brew unlink` <formula> `&&` <commands> `&& brew link` <formula>

4
Library/Homebrew/cmd/unpin.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def unpin_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`unpin` <formula> [<formula> ...]
description <<~EOS
Unpin <formula>, allowing them to be upgraded by `brew upgrade` <formula>.
See also `pin`.
EOS

4
Library/Homebrew/cmd/untap.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def untap_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`untap` <tap> [<tap> ...]
description <<~EOS
Remove a tapped formula repository.
EOS

4
Library/Homebrew/cmd/update-report.rb
View File

@ -25,9 +25,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def update_report_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update-report`
description <<~EOS
The Ruby implementation of `brew update`. Never called manually.
EOS
switch "--preinstall",

2
Library/Homebrew/cmd/update-reset.sh
View File

@ -1,4 +1,4 @@
#: * `update-reset` [<repository>] [<repository> ...]
#: * `update-reset` [<repository> ...]
#:
#: Fetch and reset Homebrew and all tap repositories (or any specified <repository>) using `git`(1) to their latest `origin/master`.
#:

4
Library/Homebrew/cmd/upgrade.rb
View File

@ -17,9 +17,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def upgrade_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`upgrade` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally
installed with, plus any appended brew formula options. If <cask> or <formula> are specified,
upgrade only the given <cask> or <formula> kegs (unless they are pinned; see `pin`, `unpin`).

4
Library/Homebrew/cmd/uses.rb
View File

@ -20,9 +20,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def uses_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`uses` [<options>] <formula> [<formula> ...]
description <<~EOS
Show formulae and casks that specify <formula> as a dependency (i.e. show dependents
of <formula>). When given multiple formula arguments, show the intersection
of formulae that use <formula>. By default, `uses` shows all formulae and casks that

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

@ -27,9 +27,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def audit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`audit` [<options>] [<formula>|<cask>]
description <<~EOS
Check <formula> for Homebrew coding style violations. This should be run before
submitting a new formula or cask. If no <formula>|<cask> are provided, check all
locally available formulae and casks and skip style checks. Will exit with a

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

@ -49,9 +49,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def bottle_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bottle` [<options>] <formula> [<formula> ...]
description <<~EOS
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

4
Library/Homebrew/dev-cmd/bump-cask-pr.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def bump_cask_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-cask-pr` [<options>] <cask>
description <<~EOS
Create a pull request to update <cask> with a new version.
A best effort to determine the <SHA-256> will be made if the value is not

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

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def bump_formula_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-formula-pr` [<options>] [<formula>]
description <<~EOS
Create a pull request to update <formula> with a new URL or a new tag.
If a <URL> is specified, the <SHA-256> checksum of the new download should also

4
Library/Homebrew/dev-cmd/bump-revision.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def bump_revision_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-revision` [<options>] <formula> [<formula> ...]
description <<~EOS
Create a commit to increment the revision of <formula>. If no revision is
present, "revision 1" will be added.
EOS

4
Library/Homebrew/dev-cmd/bump-unversioned-casks.rb
View File

@ -17,9 +17,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def self.bump_unversioned_casks_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-unversioned-casks` [<options>] <cask>|<tap> [<cask>|<tap> ...]
description <<~EOS
Check all casks with unversioned URLs in a given <tap> for updates.
EOS
switch "-n", "--dry-run",

4
Library/Homebrew/dev-cmd/bump.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def bump_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Display out-of-date brew formulae and the latest version available.
Also displays whether a pull request has been opened with the URL.
EOS

4
Library/Homebrew/dev-cmd/cat.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def cat_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`cat` <formula>|<cask>
description <<~EOS
Display the source of a <formula> or <cask>.
EOS

4
Library/Homebrew/dev-cmd/command.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def command_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`command` <cmd> [<cmd> ...]
description <<~EOS
Display the path to the file being used when invoking `brew` <cmd>.
EOS

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

@ -16,9 +16,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def create_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`create` [<options>] <URL>
description <<~EOS
Generate a formula or, with `--cask`, a cask 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.
@ -69,7 +67,7 @@ module Homebrew
conflicts "--cask", "--HEAD"
conflicts "--cask", "--set-license"
named_args number: 1
named_args :url, number: 1
end
end

4
Library/Homebrew/dev-cmd/dispatch-build-bottle.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def dispatch_build_bottle_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`dispatch-build-bottle` [<options>] <formula> [<formula> ...]
description <<~EOS
Build bottles for these formulae with GitHub Actions.
EOS
flag "--tap=",

4
Library/Homebrew/dev-cmd/diy.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def diy_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`diy` [<options>]
description <<~EOS
Automatically determine the installation prefix for non-Homebrew software.
Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with `brew link`.

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

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def edit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`edit` [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Open a <formula> or <cask> in the editor set by `EDITOR` or `HOMEBREW_EDITOR`,
or open the Homebrew repository for editing if no formula is provided.
EOS

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

@ -83,9 +83,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def extract_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`extract` [<options>] <formula> <tap>
description <<~EOS
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. To extract

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

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def formula_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`formula` <formula> [<formula> ...]
description <<~EOS
Display the path where <formula> is located.
EOS

4
Library/Homebrew/dev-cmd/install-bundler-gems.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def install_bundler_gems_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`install-bundler-gems`
description <<~EOS
Install Homebrew's Bundler gems.
EOS

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

@ -24,9 +24,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def irb_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`irb` [<options>]
description <<~EOS
Enter the interactive Homebrew Ruby shell.
EOS
switch "--examples",

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

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def linkage_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`linkage` [<options>] [<formula>] [<formula> ...]
description <<~EOS
Check the library links from the given <formula> kegs. If no <formula> are
provided, check all kegs. Raises an error if run on uninstalled formulae.
EOS

4
Library/Homebrew/dev-cmd/livecheck.rb
View File

@ -19,9 +19,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def livecheck_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`livecheck` [<formula>|<cask>] [<formula>|<cask> ...]
description <<~EOS
Check for newer versions of formulae and/or casks from upstream.
If no formula or cask argument is passed, the list of formulae and

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

@ -19,9 +19,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def man_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`man` [<options>]
description <<~EOS
Generate Homebrew's manpages.
EOS
switch "--fail-if-changed",

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

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def mirror_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`mirror` <formula> [<formula> ...]
description <<~EOS
Reupload the stable URL of a formula to Bintray for use as a mirror.
EOS
flag "--bintray-org=",

4
Library/Homebrew/dev-cmd/pr-automerge.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def pr_automerge_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pr-automerge` [<options>]
description <<~EOS
Find pull requests that can be automatically merged using `brew pr-publish`.
EOS
flag "--tap=",

6
Library/Homebrew/dev-cmd/pr-publish.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def pr_publish_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pr-publish` [<options>] <pull_request> [<pull_request> ...]
description <<~EOS
Publish bottles for a pull request with GitHub Actions.
Requires write access to the repository.
EOS
@ -29,7 +27,7 @@ module Homebrew
flag "--workflow=",
description: "Target workflow filename (default: `publish-commit-bottles.yml`)."
named_args min: 1
named_args :pull_request, min: 1
end
end

6
Library/Homebrew/dev-cmd/pr-pull.rb
View File

@ -15,9 +15,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def pr_pull_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pr-pull` [<options>] <pull_request> [<pull_request> ...]
description <<~EOS
Download and publish bottles, and apply the bottle commit from a
pull request with artifacts generated by GitHub Actions.
Requires write access to the repository.
@ -71,7 +69,7 @@ module Homebrew
conflicts "--clean", "--autosquash"
named_args min: 1
named_args :pull_request, min: 1
end
end

4
Library/Homebrew/dev-cmd/pr-upload.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def pr_upload_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`pr-upload` [<options>]
description <<~EOS
Apply the bottle commit and publish bottles to Bintray or GitHub Releases.
EOS
switch "--no-publish",

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

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def prof_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`prof` [<command>]
description <<~EOS
Run Homebrew with a Ruby profiler, e.g. `brew prof readall`.
EOS
switch "--stackprof",

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

@ -11,9 +11,8 @@ module Homebrew
sig { returns(CLI::Parser) }
def release_notes_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`release-notes` [<options>] [<previous_tag>] [<end_ref>]
usage_banner "`release-notes` [<options>] [<previous_tag>] [<end_ref>]"
description <<~EOS
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`.

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

@ -11,9 +11,8 @@ module Homebrew
sig { returns(CLI::Parser) }
def ruby_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`ruby` (`-e` <text>|<file>)
usage_banner "`ruby` [<options>] (`-e` <text>|<file>)"
description <<~EOS
Run a Ruby instance with Homebrew's libraries loaded, e.g.
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
EOS

6
Library/Homebrew/dev-cmd/sh.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def sh_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`sh` [<options>] [<file>]
description <<~EOS
Homebrew build environment that uses years-battle-hardened
build logic to help your `./configure && make && make install`
and even your `gem install` succeed. Especially handy if you run Homebrew
@ -27,7 +25,7 @@ module Homebrew
flag "-c=", "--cmd=",
description: "Execute commands in a non-interactive shell."
named_args max: 1
named_args :file, max: 1
end
end

4
Library/Homebrew/dev-cmd/sponsors.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def sponsors_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`sponsors`
description <<~EOS
Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting into a README.
EOS

6
Library/Homebrew/dev-cmd/style.rb
View File

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def style_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`style` [<options>] [<file>|<tap>|<formula>|<cask>] [<file>|<tap>|<formula>|<cask> ...]
description <<~EOS
Check formulae or files for conformance to Homebrew style guidelines.
Lists of <file>, <tap> and <formula> may not be combined. If none are
@ -43,7 +41,7 @@ module Homebrew
conflicts "--formula", "--cask"
conflicts "--only-cops", "--except-cops"
named_args [:formula, :cask, :tap]
named_args [:file, :tap, :formula, :cask]
end
end

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

@ -12,9 +12,8 @@ module Homebrew
sig { returns(CLI::Parser) }
def tap_new_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tap-new` [<options>] <user>`/`<repo>
usage_banner "`tap-new` [<options>] <user>`/`<repo>"
description <<~EOS
Generate the template files for a new tap.
EOS

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

@ -14,9 +14,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`test` [<options>] <formula> [<formula> ...]
description <<~EOS
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.

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

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def tests_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`tests` [<options>]
description <<~EOS
Run Homebrew's unit and integration tests.
EOS
switch "--coverage",

4
Library/Homebrew/dev-cmd/typecheck.rb
View File

@ -11,9 +11,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def typecheck_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`typecheck`
description <<~EOS
Check for typechecking errors using Sorbet.
EOS
switch "--fix",

4
Library/Homebrew/dev-cmd/unbottled.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def unbottled_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`unbottled` [<formula>] [<formula> ...]
description <<~EOS
Outputs the unbottled dependents of formulae.
EOS
flag "--tag=",

4
Library/Homebrew/dev-cmd/unpack.rb
View File

@ -13,9 +13,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def unpack_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`unpack` [<options>] <formula> [<formula ...>]
description <<~EOS
Unpack the source files for <formula> into subdirectories of the current
working directory.
EOS

6
Library/Homebrew/dev-cmd/update-license-data.rb
View File

@ -12,10 +12,8 @@ module Homebrew
sig { returns(CLI::Parser) }
def update_license_data_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update-license-data` [<options>]
Update SPDX license data in the Homebrew repository.
description <<~EOS
Update SPDX license data in the Homebrew repository.
EOS
switch "--fail-if-not-changed",
description: "Return a failing status code if current license data's version is the same as " \

4
Library/Homebrew/dev-cmd/update-python-resources.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def update_python_resources_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`update-python-resources` [<options>] <formula> [<formula> ...]
description <<~EOS
Update versions for PyPI resource blocks in <formula>.
EOS
switch "-p", "--print-only",

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

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

4
Library/Homebrew/dev-cmd/vendor-gems.rb
View File

@ -12,9 +12,7 @@ module Homebrew
sig { returns(CLI::Parser) }
def vendor_gems_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`vendor-gems`
description <<~EOS
Install and commit Homebrew's vendored gems.
EOS

132
docs/Manpage.md
View File

@ -44,7 +44,7 @@ If no search term is provided, all locally available formulae are listed.
## COMMANDS
### `analytics` [*`subcommand`*]
### `analytics` [*`options`*] [*`subcommand`*]
Control Homebrew's anonymous aggregate user behaviour analytics.
Read more at <https://docs.brew.sh/Analytics>.
@ -69,7 +69,7 @@ Uninstall formulae that were only installed as a dependency of another formula a
List all locally installable casks including short names.
### `cleanup` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `cleanup` [*`options`*] [*`formula`*|*`cask`* ...]
Remove stale lock files and outdated downloads for all formulae and casks,
and remove old versions of installed formulae. If arguments are specified,
@ -94,7 +94,7 @@ Show lists of built-in and external commands.
* `--include-aliases`:
Include aliases of internal commands.
### `completions` [*`subcommand`*]
### `completions` [*`options`*] [*`subcommand`*]
Control whether Homebrew automatically links external tap shell completion files.
Read more at <https://docs.brew.sh/Shell-Completion>.
@ -105,12 +105,12 @@ Read more at <https://docs.brew.sh/Shell-Completion>.
`brew completions` (`link`|`unlink`)
<br>Link or unlink Homebrew's completions.
### `config`
### `config`, `--config` [*`options`*]
Show Homebrew and system configuration info useful for debugging. If you file
a bug report, you will be required to provide this information.
### `deps` [*`options`*] [*`formula`*] [*`formula`* ...]
### `deps` [*`options`*] [*`formula`*|*`cask`* ...]
Show dependencies for *`formula`*. Additional options specific to *`formula`*
may be appended to the command. When given multiple formula arguments,
@ -149,7 +149,7 @@ show the intersection of dependencies for each formula.
* `--cask`:
Treat all named arguments as casks.
### `desc` [*`options`*] *`text`*|`/`*`text`*`/`|*`formula`* [*`text`*|`/`*`text`*`/`|*`formula`* ...]
### `desc` [*`options`*] *`formula`*|*`text`*|`/`*`regex`*`/` [...]
Display *`formula`*'s name and one-line description.
Formula descriptions are cached; the cache is created on the
@ -162,7 +162,7 @@ first search, making that search slower than subsequent ones.
* `-d`, `--description`:
Search just descriptions for *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
### `doctor` [*`options`*]
### `doctor`, `dr` [*`options`*] [*`diagnostic_check`* ...]
Check your system for potential problems. Will exit with a non-zero status
if any potential problems are found. Please note that these warnings are just
@ -175,7 +175,7 @@ an issue; just ignore this.
* `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods.
### `fetch` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
### `fetch` [*`options`*] *`formula`*|*`cask`* [...]
Download a bottle (if available) or source packages for *`formula`*e
and binaries for *`cask`*s. For files, also print SHA-256 checksums.
@ -219,7 +219,7 @@ error message if no logs are found.
* `-p`, `--private`:
The Gist will be marked private and will not appear in listings but will be accessible with its link.
### `home` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `home`, `homepage` [*`options`*] [*`formula`*|*`cask`* ...]
Open a *`formula`* or *`cask`*'s homepage in a browser, or open
Homebrew's own homepage if no argument is provided.
@ -229,7 +229,7 @@ Homebrew's own homepage if no argument is provided.
* `--cask`:
Treat all named arguments as casks.
### `info` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `info`, `abv` [*`options`*] [*`formula`*|*`cask`* ...]
Display brief statistics for your Homebrew installation.
@ -256,7 +256,7 @@ If a *`formula`* or *`cask`* is provided, show summary of information about it.
* `--cask`:
Treat all named arguments as casks.
### `install` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
### `install` [*`options`*] *`formula`*|*`cask`* [...]
Install a *`formula`* or *`cask`*. Additional options specific to a *`formula`* may be
appended to the command.
@ -313,11 +313,11 @@ the installed formulae or, every 30 days, for all formulae.
* `--skip-cask-deps`:
Skip installing cask dependencies.
### `leaves`
### `leaves` [*`options`*]
List installed formulae that are not dependencies of another installed formula.
### `link`, `ln` [*`options`*] *`formula`* [*`formula`* ...]
### `link`, `ln` [*`options`*] *`installed_formula`* [...]
Symlink all of *`formula`*'s installed files into Homebrew's prefix. This
is done automatically when you install formulae but can be useful for DIY
@ -330,7 +330,7 @@ installations.
* `-f`, `--force`:
Allow keg-only formulae to be linked.
### `list`, `ls` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `list`, `ls` [*`options`*] [*`installed_formula`*|*`installed_cask`* ...]
List all installed formulae and casks.
@ -374,7 +374,7 @@ if no formula is provided.
* `-n`, `--max-count`:
Print only a specified number of commits.
### `migrate` [*`options`*] *`formula`* [*`formula`* ...]
### `migrate` [*`options`*] *`installed_formula`* [...]
Migrate renamed packages to new names, where *`formula`* are old names of
packages.
@ -382,7 +382,7 @@ packages.
* `-f`, `--force`:
Treat installed *`formula`* and provided *`formula`* as if they are from the same taps and migrate them anyway.
### `missing` [*`options`*] [*`formula`*] [*`formula`* ...]
### `missing` [*`options`*] [*`formula`* ...]
Check the given *`formula`* kegs for missing dependencies. If no *`formula`* are
provided, check all kegs. Will exit with a non-zero status if any kegs are found
@ -391,7 +391,7 @@ to be missing dependencies.
* `--hide`:
Act as if none of the specified *`hidden`* are installed. *`hidden`* should be a comma-separated list of formulae.
### `options` [*`options`*] [*`formula`*] [*`formula`* ...]
### `options` [*`options`*] [*`formula`* ...]
Show install options specific to *`formula`*.
@ -404,7 +404,7 @@ Show install options specific to *`formula`*.
* `--command`:
Show options for the specified *`command`*.
### `outdated` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `outdated` [*`options`*] [*`formula`*|*`cask`* ...]
List installed casks and formulae that have an updated version available. By default, version
information is displayed in interactive shells, and suppressed otherwise.
@ -424,16 +424,16 @@ information is displayed in interactive shells, and suppressed otherwise.
* `--greedy`:
Print outdated casks with `auto_updates` or `version :latest`.
### `pin` *`formula`* [*`formula`* ...]
### `pin` [*`options`*] *`installed_formula`* [...]
Pin the specified *`formula`*, preventing them from being upgraded when
issuing the `brew upgrade` *`formula`* command. See also `unpin`.
### `postinstall` *`formula`* [*`formula`* ...]
### `postinstall` [*`options`*] *`installed_formula`* [...]
Rerun the post-install steps for *`formula`*.
### `readall` [*`options`*] [*`tap`*] [*`tap`* ...]
### `readall` [*`options`*] [*`tap`* ...]
Import all items from the specified *`tap`*, or from all installed taps if none is provided.
This can be useful for debugging issues across all items when making
@ -445,7 +445,7 @@ all items or checking if any current formulae/casks have Ruby issues.
* `--syntax`:
Syntax-check all of Homebrew's Ruby files (if no `*`tap`*` is passed).
### `reinstall` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
### `reinstall` [*`options`*] *`formula`*|*`cask`* [...]
Uninstall and then reinstall a *`formula`* or *`cask`* using the same options it was
originally installed with, plus any appended options specific to a *`formula`*.
@ -482,7 +482,7 @@ reinstalled formulae or, every 30 days, for all formulae.
* `--skip-cask-deps`:
Skip installing cask dependencies.
### `search` [*`options`*] [*`text`*|`/`*`text`*`/`] [*`text`*|`/`*`text`*`/` ...]
### `search`, `-S` [*`options`*] [*`text`*|`/`*`regex`*`/` ...]
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
is flanked by slashes, it is interpreted as a regular expression.
@ -550,7 +550,7 @@ using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
* `--list-pinned`:
List all pinned taps.
### `tap-info` [*`options`*] [*`tap`*] [*`tap`* ...]
### `tap-info` [*`options`*] [*`tap`* ...]
Show detailed information about one or more *`tap`*s.
@ -561,7 +561,7 @@ If no *`tap`* names are provided, display brief statistics for all installed tap
* `--json`:
Print a JSON representation of *`tap`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
### `uninstall`, `rm`, `remove` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
### `uninstall`, `remove`, `rm` [*`options`*] *`installed_formula`*|*`installed_cask`* [...]
Uninstall a *`formula`* or *`cask`*.
@ -576,7 +576,7 @@ Uninstall a *`formula`* or *`cask`*.
* `--cask`:
Treat all named arguments as casks.
### `unlink` [*`options`*] *`formula`* [*`formula`* ...]
### `unlink` [*`options`*] *`installed_formula`* [...]
Remove symlinks for *`formula`* from Homebrew's prefix. This can be useful
for temporarily disabling a formula:
@ -585,12 +585,12 @@ for temporarily disabling a formula:
* `-n`, `--dry-run`:
List files which would be unlinked without actually unlinking or deleting any files.
### `unpin` *`formula`* [*`formula`* ...]
### `unpin` [*`options`*] *`installed_formula`* [...]
Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*.
See also `pin`.
### `untap` *`tap`* [*`tap`* ...]
### `untap` [*`options`*] *`tap`* [...]
Remove a tapped formula repository.
@ -605,13 +605,13 @@ Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1)
* `-f`, `--force`:
Always do a slower, full update check (even if unnecessary).
### `update-reset` [*`repository`*] [*`repository`* ...]
### `update-reset` [*`repository`* ...]
Fetch and reset Homebrew and all tap repositories (or any specified *`repository`*) using `git`(1) to their latest `origin/master`.
*Note:* this will destroy all your uncommitted or committed changes.
### `upgrade` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `upgrade` [*`options`*] [*`installed_formula`*|*`installed_cask`* ...]
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally
installed with, plus any appended brew formula options. If *`cask`* or *`formula`* are specified,
@ -657,7 +657,7 @@ upgraded formulae or, every 30 days, for all formulae.
* `--greedy`:
Also include casks with `auto_updates true` or `version :latest`.
### `uses` [*`options`*] *`formula`* [*`formula`* ...]
### `uses` [*`options`*] *`formula`* [...]
Show formulae and casks that specify *`formula`* as a dependency (i.e. show dependents
of *`formula`*). When given multiple formula arguments, show the intersection
@ -681,7 +681,7 @@ specify *`formula`* as a required or recommended dependency for their stable bui
* `--cask`:
Include only casks.
### `--cache` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `--cache` [*`options`*] [*`formula`*|*`cask`* ...]
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
@ -696,14 +696,14 @@ If *`formula`* is provided, display the file or directory used to cache *`formul
* `--cask`:
Only show cache files for casks.
### `--caskroom` [*`cask`*] [*`cask`* ...]
### `--caskroom` [*`options`*] [*`cask`* ...]
Display Homebrew's Caskroom path.
If *`cask`* is provided, display the location in the Caskroom where *`cask`*
would be installed, without any sort of versioned directory as the last path.
### `--cellar` [*`formula`*] [*`formula`* ...]
### `--cellar` [*`options`*] [*`formula`* ...]
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.
@ -711,7 +711,7 @@ that directory doesn't exist, `$(brew --repository)/Cellar`.
If *`formula`* is provided, display the location in the Cellar where *`formula`*
would be installed, without any sort of versioned directory as the last path.
### `--env` [*`options`*] [*`formula`*] [*`formula`* ...]
### `--env` [*`options`*] [*`formula`* ...]
Summarise Homebrew's build environment as a plain list.
@ -723,7 +723,7 @@ the list is formatted for export to `bash`(1) unless `--plain` is passed.
* `--plain`:
Generate plain output even when piped.
### `--prefix` [*`formula`*] [*`formula`* ...]
### `--prefix` [*`options`*] [*`formula`* ...]
Display Homebrew's install path. *Default:*
@ -737,20 +737,20 @@ is or would be installed.
* `--unbrewed`:
List files in Homebrew's prefix not installed by Homebrew.
### `--repository`, `--repo` [*`user`*`/`*`repo`*] [*`user`*`/`*`repo`* ...]
### `--repository` [*`options`*] [*`tap`* ...]
Display where Homebrew's `.git` directory is located.
If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located.
### `--version`
### `--version` [*`options`*]
Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output.
## DEVELOPER COMMANDS
### `audit` [*`options`*] [*`formula`*|*`cask`*]
### `audit` [*`options`*] [*`formula`*|*`cask`* ...]
Check *`formula`* for Homebrew coding style violations. This should be run before
submitting a new formula or cask. If no *`formula`*|*`cask`* are provided, check all
@ -794,7 +794,7 @@ non-zero status if any errors are found.
* `--token-conflicts`:
Audit for token conflicts
### `bottle` [*`options`*] *`formula`* [*`formula`* ...]
### `bottle` [*`options`*] *`installed_formula`* [...]
Generate a bottle (binary package) from a formula that was installed with
`--build-bottle`.
@ -821,7 +821,7 @@ value, while `--no-rebuild` will remove it.
* `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
### `bump` [*`options`*] [*`formula`*] [*`formula`* ...]
### `bump` [*`options`*] [*`formula`* ...]
Display out-of-date brew formulae and the latest version available.
Also displays whether a pull request has been opened with the URL.
@ -915,7 +915,7 @@ nor vice versa. It must use whichever style specification the formula already us
* `-f`, `--force`:
Ignore duplicate open PRs. Remove all mirrors if `--mirror` was not specified.
### `bump-revision` [*`options`*] *`formula`* [*`formula`* ...]
### `bump-revision` [*`options`*] *`formula`* [...]
Create a commit to increment the revision of *`formula`*. If no revision is
present, "revision 1" will be added.
@ -925,7 +925,7 @@ present, "revision 1" will be added.
* `--message`:
Append *`message`* to the default commit message.
### `bump-unversioned-casks` [*`options`*] *`cask`*|*`tap`* [*`cask`*|*`tap`* ...]
### `bump-unversioned-casks` [*`options`*] *`cask`*|*`tap`* [...]
Check all casks with unversioned URLs in a given *`tap`* for updates.
@ -936,7 +936,7 @@ Check all casks with unversioned URLs in a given *`tap`* for updates.
* `--state-file`:
File for caching state.
### `cat` *`formula`*|*`cask`*
### `cat` [*`options`*] *`formula`*|*`cask`*
Display the source of a *`formula`* or *`cask`*.
@ -945,7 +945,7 @@ Display the source of a *`formula`* or *`cask`*.
* `--cask`:
Treat all named arguments as casks.
### `command` *`cmd`* [*`cmd`* ...]
### `command` [*`options`*] *`command`* [...]
Display the path to the file being used when invoking `brew` *`cmd`*.
@ -994,7 +994,7 @@ The `wget` formula serves as a simple example. For the complete API, see:
* `-f`, `--force`:
Ignore errors for disallowed formula names and names that shadow aliases.
### `dispatch-build-bottle` [*`options`*] *`formula`* [*`formula`* ...]
### `dispatch-build-bottle` [*`options`*] *`formula`* [...]
Build bottles for these formulae with GitHub Actions.
@ -1009,7 +1009,7 @@ Build bottles for these formulae with GitHub Actions.
* `--upload`:
Upload built bottles to Bintray.
### `edit` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `edit` [*`options`*] [*`formula`*|*`cask`* ...]
Open a *`formula`* or *`cask`* in the editor set by `EDITOR` or `HOMEBREW_EDITOR`,
or open the Homebrew repository for editing if no formula is provided.
@ -1019,7 +1019,7 @@ or open the Homebrew repository for editing if no formula is provided.
* `--cask`:
Treat all named arguments as casks.
### `extract` [*`options`*] *`formula`* *`tap`*
### `extract` [*`options`*] *`formula`* ...
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
@ -1032,11 +1032,11 @@ a formula from a tap that is not `homebrew/core` use its fully-qualified form of
* `-f`, `--force`:
Overwrite the destination formula if it already exists.
### `formula` *`formula`* [*`formula`* ...]
### `formula` [*`options`*] *`formula`* [...]
Display the path where *`formula`* is located.
### `install-bundler-gems`
### `install-bundler-gems` [*`options`*]
Install Homebrew's Bundler gems.
@ -1049,7 +1049,7 @@ Enter the interactive Homebrew Ruby shell.
* `--pry`:
Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set.
### `linkage` [*`options`*] [*`formula`*] [*`formula`* ...]
### `linkage` [*`options`*] [*`installed_formula`* ...]
Check the library links from the given *`formula`* kegs. If no *`formula`* are
provided, check all kegs. Raises an error if run on uninstalled formulae.
@ -1061,7 +1061,7 @@ provided, check all kegs. Raises an error if run on uninstalled formulae.
* `--cached`:
Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run.
### `livecheck` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
### `livecheck` [*`options`*] [*`formula`*|*`cask`* ...]
Check for newer versions of formulae and/or casks from upstream.
@ -1095,7 +1095,7 @@ Generate Homebrew's manpages.
* `--fail-if-changed`:
Return a failing status code if changes are detected in the manpage outputs. This can be used to notify CI 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).
### `mirror` *`formula`* [*`formula`* ...]
### `mirror` [*`options`*] *`formula`* [...]
Reupload the stable URL of a formula to Bintray for use as a mirror.
@ -1125,7 +1125,7 @@ Find pull requests that can be automatically merged using `brew pr-publish`.
* `--ignore-failures`:
Include pull requests that have failing status checks.
### `pr-publish` [*`options`*] *`pull_request`* [*`pull_request`* ...]
### `pr-publish` [*`options`*] *`pull_request`* [...]
Publish bottles for a pull request with GitHub Actions.
Requires write access to the repository.
@ -1139,7 +1139,7 @@ Requires write access to the repository.
* `--workflow`:
Target workflow filename (default: `publish-commit-bottles.yml`).
### `pr-pull` [*`options`*] *`pull_request`* [*`pull_request`* ...]
### `pr-pull` [*`options`*] *`pull_request`* [...]
Download and publish bottles, and apply the bottle commit from a
pull request with artifacts generated by GitHub Actions.
@ -1199,7 +1199,7 @@ Apply the bottle commit and publish bottles to Bintray or GitHub Releases.
* `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
### `prof` [*`command`*]
### `prof` [*`options`*] [*`command`* ...]
Run Homebrew with a Ruby profiler, e.g. `brew prof readall`.
@ -1223,7 +1223,7 @@ a warning will be shown if the latest minor release was less than one month ago.
Installs, configures and runs Homebrew's `rubocop`.
### `ruby` (`-e` *`text`*|*`file`*)
### `ruby` [*`options`*] (`-e` *`text`*|*`file`*)
Run a Ruby instance with Homebrew's libraries loaded, e.g.
`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
@ -1246,11 +1246,11 @@ which build systems would not find otherwise.
* `-c`, `--cmd`:
Execute commands in a non-interactive shell.
### `sponsors`
### `sponsors` [*`options`*]
Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting into a README.
### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*|*`cask`*] [*`file`*|*`tap`*|*`formula`*|*`cask`* ...]
### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*|*`cask`* ...]
Check formulae or files for conformance to Homebrew style guidelines.
@ -1284,7 +1284,7 @@ Generate the template files for a new tap.
* `--branch`:
Initialize Git repository with the specified branch name (default: `main`).
### `test` [*`options`*] *`formula`* [*`formula`* ...]
### `test` [*`options`*] *`installed_formula`* [...]
Run the test method provided by an installed formula.
There is no standard output or return code, but generally it should notify the
@ -1318,7 +1318,7 @@ Run Homebrew's unit and integration tests.
* `--seed`:
Randomise tests with the specified *`value`* instead of a random seed.
### `typecheck`
### `typecheck`, `tc` [*`options`*]
Check for typechecking errors using Sorbet.
@ -1339,7 +1339,7 @@ Check for typechecking errors using Sorbet.
* `--ignore`:
Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet).
### `unbottled` [*`formula`*] [*`formula`* ...]
### `unbottled` [*`options`*] [*`formula`* ...]
Outputs the unbottled dependents of formulae.
@ -1350,7 +1350,7 @@ Outputs the unbottled dependents of formulae.
* `--total`:
Output the number of unbottled and total formulae.
### `unpack` [*`options`*] *`formula`* [<formula ...>]
### `unpack` [*`options`*] *`formula`* [...]
Unpack the source files for *`formula`* into subdirectories of the current
working directory.
@ -1366,12 +1366,12 @@ working directory.
### `update-license-data` [*`options`*]
Update SPDX license data in the Homebrew repository.
Update SPDX license data in the Homebrew repository.
* `--fail-if-not-changed`:
Return a failing status code if current license data's version is the same as the upstream. This can be used to notify CI when the SPDX license data is out of date.
### `update-python-resources` [*`options`*] *`formula`* [*`formula`* ...]
### `update-python-resources` [*`options`*] *`formula`* [...]
Update versions for PyPI resource blocks in *`formula`*.
@ -1404,7 +1404,7 @@ If no options are passed, use `origin/master` as the start commit.
* `--before`:
Use the commit at the specified *`date`* as the start commit.
### `vendor-gems`
### `vendor-gems` [*`options`*]
Install and commit Homebrew's vendored gems.

128
manpages/brew.1
View File

@ -38,7 +38,7 @@ Perform a substring search of cask tokens and formula names for \fItext\fR\. If
.
.SH "COMMANDS"
.
.SS "\fBanalytics\fR [\fIsubcommand\fR]"
.SS "\fBanalytics\fR [\fIoptions\fR] [\fIsubcommand\fR]"
Control Homebrew\'s anonymous aggregate user behaviour analytics\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.P
@ -63,7 +63,7 @@ List what would be uninstalled, but do not actually uninstall anything\.
.SS "\fBcasks\fR"
List all locally installable casks including short names\.
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR\.
.
.TP
@ -93,7 +93,7 @@ List only the names of commands without category headers\.
\fB\-\-include\-aliases\fR
Include aliases of internal commands\.
.
.SS "\fBcompletions\fR [\fIsubcommand\fR]"
.SS "\fBcompletions\fR [\fIoptions\fR] [\fIsubcommand\fR]"
Control whether Homebrew automatically links external tap shell completion files\. Read more at \fIhttps://docs\.brew\.sh/Shell\-Completion\fR\.
.
.P
@ -104,10 +104,10 @@ Control whether Homebrew automatically links external tap shell completion files
\fBbrew completions\fR (\fBlink\fR|\fBunlink\fR)
Link or unlink Homebrew\'s completions\.
.
.SS "\fBconfig\fR"
.SS "\fBconfig\fR, \fB\-\-config\fR [\fIoptions\fR]"
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\.
.
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Show dependencies for \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\. When given multiple formula arguments, show the intersection of dependencies for each formula\.
.
.TP
@ -174,7 +174,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBdesc\fR [\fIoptions\fR] \fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR \.\.\.]"
.SS "\fBdesc\fR [\fIoptions\fR] \fIformula\fR|\fItext\fR|\fB/\fR\fIregex\fR\fB/\fR [\.\.\.]"
Display \fIformula\fR\'s name and one\-line description\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
.
.TP
@ -189,7 +189,7 @@ Search just names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is in
\fB\-d\fR, \fB\-\-description\fR
Search just descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.SS "\fBdoctor\fR [\fIoptions\fR]"
.SS "\fBdoctor\fR, \fBdr\fR [\fIoptions\fR] [\fIdiagnostic_check\fR \.\.\.]"
Check your system for potential problems\. Will exit with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
.
.TP
@ -200,7 +200,7 @@ List all audit methods, which can be run individually if provided as arguments\.
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
.
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Download a bottle (if available) or source packages for \fIformula\fRe and binaries for \fIcask\fRs\. For files, also print SHA\-256 checksums\.
.
.TP
@ -265,7 +265,7 @@ Automatically create a new issue in the appropriate GitHub repository after crea
\fB\-p\fR, \fB\-\-private\fR
The Gist will be marked private and will not appear in listings but will be accessible with its link\.
.
.SS "\fBhome\fR [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBhome\fR, \fBhomepage\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Open a \fIformula\fR or \fIcask\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no argument is provided\.
.
.TP
@ -276,7 +276,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBinfo\fR, \fBabv\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display brief statistics for your Homebrew installation\.
.
.P
@ -322,7 +322,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Install a \fIformula\fR or \fIcask\fR\. Additional options specific to a \fIformula\fR may be appended to the command\.
.
.P
@ -424,10 +424,10 @@ Disable/enable quarantining of downloads (default: enabled)\.
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.SS "\fBleaves\fR"
.SS "\fBleaves\fR [\fIoptions\fR]"
List installed formulae that are not dependencies of another installed formula\.
.
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Symlink all of \fIformula\fR\'s installed files into Homebrew\'s prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.TP
@ -442,7 +442,7 @@ List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR wit
\fB\-f\fR, \fB\-\-force\fR
Allow keg\-only formulae to be linked\.
.
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIinstalled_formula\fR|\fIinstalled_cask\fR \.\.\.]"
List all installed formulae and casks\.
.
.P
@ -511,21 +511,21 @@ Print only one commit\.
\fB\-n\fR, \fB\-\-max\-count\fR
Print only a specified number of commits\.
.
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBmigrate\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Treat installed \fIformula\fR and provided \fIformula\fR as if they are from the same taps and migrate them anyway\.
.
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\fR are provided, check all kegs\. Will exit with a non\-zero status if any kegs are found to be missing dependencies\.
.
.TP
\fB\-\-hide\fR
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
.
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Show install options specific to \fIformula\fR\.
.
.TP
@ -544,7 +544,7 @@ Show options for all available formulae\.
\fB\-\-command\fR
Show options for the specified \fIcommand\fR\.
.
.SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
List installed casks and formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
.
.TP
@ -575,13 +575,13 @@ Fetch the upstream repository to detect if the HEAD installation of the formula
\fB\-\-greedy\fR
Print outdated casks with \fBauto_updates\fR or \fBversion :latest\fR\.
.
.SS "\fBpin\fR \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBpin\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\.
.
.SS "\fBpostinstall\fR \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBpostinstall\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Rerun the post\-install steps for \fIformula\fR\.
.
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR] [\fItap\fR \.\.\.]"
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR \.\.\.]"
Import all items from the specified \fItap\fR, or from all installed taps if none is provided\. This can be useful for debugging issues across all items when making significant changes to \fBformula\.rb\fR, testing the performance of loading all items or checking if any current formulae/casks have Ruby issues\.
.
.TP
@ -592,7 +592,7 @@ Verify any alias symlinks in each tap\.
\fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files (if no \fB<tap>\fR is passed)\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\.\.\.]"
Uninstall and then reinstall a \fIformula\fR or \fIcask\fR using the same options it was originally installed with, plus any appended options specific to a \fIformula\fR\.
.
.P
@ -654,7 +654,7 @@ Disable/enable quarantining of downloads (default: enabled)\.
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.SS "\fBsearch\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR \.\.\.]"
.SS "\fBsearch\fR, \fB\-S\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fIregex\fR\fB/\fR \.\.\.]"
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\.
.
.P
@ -746,7 +746,7 @@ Migrate tapped formulae from symlink\-based to directory\-based structure\.
\fB\-\-list\-pinned\fR
List all pinned taps\.
.
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR] [\fItap\fR \.\.\.]"
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR \.\.\.]"
Show detailed information about one or more \fItap\fRs\.
.
.P
@ -760,7 +760,7 @@ Show information on each installed tap\.
\fB\-\-json\fR
Print a JSON representation of \fItap\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBuninstall\fR, \fBremove\fR, \fBrm\fR [\fIoptions\fR] \fIinstalled_formula\fR|\fIinstalled_cask\fR [\.\.\.]"
Uninstall a \fIformula\fR or \fIcask\fR\.
.
.TP
@ -783,17 +783,17 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBunlink\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Remove symlinks for \fIformula\fR from Homebrew\'s prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List files which would be unlinked without actually unlinking or deleting any files\.
.
.SS "\fBunpin\fR \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBunpin\fR [\fIoptions\fR] \fIinstalled_formula\fR [\.\.\.]"
Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\.
.
.SS "\fBuntap\fR \fItap\fR [\fItap\fR \.\.\.]"
.SS "\fBuntap\fR [\fIoptions\fR] \fItap\fR [\.\.\.]"
Remove a tapped formula repository\.
.
.SS "\fBupdate\fR [\fIoptions\fR]"
@ -811,13 +811,13 @@ Run on auto\-updates (e\.g\. before \fBbrew install\fR)\. Skips some slower step
\fB\-f\fR, \fB\-\-force\fR
Always do a slower, full update check (even if unnecessary)\.
.
.SS "\fBupdate\-reset\fR [\fIrepository\fR] [\fIrepository\fR \.\.\.]"
.SS "\fBupdate\-reset\fR [\fIrepository\fR \.\.\.]"
Fetch and reset Homebrew and all tap repositories (or any specified \fIrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\.
.
.P
\fINote:\fR this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIinstalled_formula\fR|\fIinstalled_cask\fR \.\.\.]"
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options\. If \fIcask\fR or \fIformula\fR are specified, upgrade only the given \fIcask\fR or \fIformula\fR kegs (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.P
@ -895,7 +895,7 @@ Skip installing cask dependencies\.
\fB\-\-greedy\fR
Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\.
.
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Show formulae and casks that specify \fIformula\fR as a dependency (i\.e\. show dependents of \fIformula\fR)\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\.
.
.TP
@ -930,7 +930,7 @@ Include only formulae\.
\fB\-\-cask\fR
Include only casks\.
.
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
.
.P
@ -952,19 +952,19 @@ Only show cache files for formulae\.
\fB\-\-cask\fR
Only show cache files for casks\.
.
.SS "\fB\-\-caskroom\fR [\fIcask\fR] [\fIcask\fR \.\.\.]"
.SS "\fB\-\-caskroom\fR [\fIoptions\fR] [\fIcask\fR \.\.\.]"
Display Homebrew\'s Caskroom path\.
.
.P
If \fIcask\fR is provided, display the location in the Caskroom where \fIcask\fR would be installed, without any sort of versioned directory as the last path\.
.
.SS "\fB\-\-cellar\fR [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fB\-\-cellar\fR [\fIoptions\fR] [\fIformula\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\.
.
.P
If \fIformula\fR is provided, display the location in the Cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.SS "\fB\-\-env\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fB\-\-env\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Summarise Homebrew\'s build environment as a plain list\.
.
.P
@ -978,7 +978,7 @@ Generate a list of environment variables for the specified shell, or \fB\-\-shel
\fB\-\-plain\fR
Generate plain output even when piped\.
.
.SS "\fB\-\-prefix\fR [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fB\-\-prefix\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Display Homebrew\'s install path\. \fIDefault:\fR
.
.IP "\(bu" 4
@ -999,18 +999,18 @@ If \fIformula\fR is provided, display the location in the Cellar where \fIformul
\fB\-\-unbrewed\fR
List files in Homebrew\'s prefix not installed by Homebrew\.
.
.SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fIuser\fR\fB/\fR\fIrepo\fR] [\fIuser\fR\fB/\fR\fIrepo\fR \.\.\.]"
.SS "\fB\-\-repository\fR [\fIoptions\fR] [\fItap\fR \.\.\.]"
Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.P
If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.SS "\fB\-\-version\fR"
.SS "\fB\-\-version\fR [\fIoptions\fR]"
Print the version numbers of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output\.
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
.SS "\fBaudit\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula or cask\. If no \fIformula\fR|\fIcask\fR are provided, check all locally available formulae and casks and skip style checks\. Will exit with a non\-zero status if any errors are found\.
.
.TP
@ -1085,7 +1085,7 @@ Audit the appcast
\fB\-\-token\-conflicts\fR
Audit for token conflicts
.
.SS "\fBbottle\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBbottle\fR [\fIoptions\fR] \fIinstalled_formula\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
@ -1124,7 +1124,7 @@ When passed with \fB\-\-write\fR, a new commit will not generated after writing
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBbump\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBbump\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Display out\-of\-date brew formulae and the latest version available\. Also displays whether a pull request has been opened with the URL\.
.
.TP
@ -1268,7 +1268,7 @@ Specify the new commit \fIrevision\fR corresponding to the specified git \fItag\
\fB\-f\fR, \fB\-\-force\fR
Ignore duplicate open PRs\. Remove all mirrors if \fB\-\-mirror\fR was not specified\.
.
.SS "\fBbump\-revision\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBbump\-revision\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Create a commit to increment the revision of \fIformula\fR\. If no revision is present, "revision 1" will be added\.
.
.TP
@ -1279,7 +1279,7 @@ Print what would be done rather than doing it\.
\fB\-\-message\fR
Append \fImessage\fR to the default commit message\.
.
.SS "\fBbump\-unversioned\-casks\fR [\fIoptions\fR] \fIcask\fR|\fItap\fR [\fIcask\fR|\fItap\fR \.\.\.]"
.SS "\fBbump\-unversioned\-casks\fR [\fIoptions\fR] \fIcask\fR|\fItap\fR [\.\.\.]"
Check all casks with unversioned URLs in a given \fItap\fR for updates\.
.
.TP
@ -1294,7 +1294,7 @@ Maximum runtime in minutes\.
\fB\-\-state\-file\fR
File for caching state\.
.
.SS "\fBcat\fR \fIformula\fR|\fIcask\fR"
.SS "\fBcat\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR"
Display the source of a \fIformula\fR or \fIcask\fR\.
.
.TP
@ -1305,7 +1305,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBcommand\fR \fIcmd\fR [\fIcmd\fR \.\.\.]"
.SS "\fBcommand\fR [\fIoptions\fR] \fIcommand\fR [\.\.\.]"
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
.
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
@ -1383,7 +1383,7 @@ Generate the new formula within the given tap, specified as \fIuser\fR\fB/\fR\fI
\fB\-f\fR, \fB\-\-force\fR
Ignore errors for disallowed formula names and names that shadow aliases\.
.
.SS "\fBdispatch\-build\-bottle\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBdispatch\-build\-bottle\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Build bottles for these formulae with GitHub Actions\.
.
.TP
@ -1406,7 +1406,7 @@ Dispatch specified workflow (default: \fBdispatch\-build\-bottle\.yml\fR)\.
\fB\-\-upload\fR
Upload built bottles to Bintray\.
.
.SS "\fBedit\fR [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBedit\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Open a \fIformula\fR or \fIcask\fR in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no formula is provided\.
.
.TP
@ -1417,7 +1417,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR"
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\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\. To extract a formula from a tap that is not \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\.
.
.TP
@ -1428,10 +1428,10 @@ Extract the specified \fIversion\fR of \fIformula\fR instead of the most recent\
\fB\-f\fR, \fB\-\-force\fR
Overwrite the destination formula if it already exists\.
.
.SS "\fBformula\fR \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBformula\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Display the path where \fIformula\fR is located\.
.
.SS "\fBinstall\-bundler\-gems\fR"
.SS "\fBinstall\-bundler\-gems\fR [\fIoptions\fR]"
Install Homebrew\'s Bundler gems\.
.
.SS "\fBirb\fR [\fIoptions\fR]"
@ -1445,7 +1445,7 @@ Show several examples\.
\fB\-\-pry\fR
Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\.
.
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIinstalled_formula\fR \.\.\.]"
Check the library links from the given \fIformula\fR kegs\. If no \fIformula\fR are provided, check all kegs\. Raises an error if run on uninstalled formulae\.
.
.TP
@ -1460,7 +1460,7 @@ For every library that a keg references, print its dylib path followed by the bi
\fB\-\-cached\fR
Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\.
.
.SS "\fBlivecheck\fR [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBlivecheck\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Check for newer versions of formulae and/or casks from upstream\.
.
.P
@ -1555,7 +1555,7 @@ Instruct \fBbrew pr\-publish\fR to automatically reformat and reword commits in
\fB\-\-ignore\-failures\fR
Include pull requests that have failing status checks\.
.
.SS "\fBpr\-publish\fR [\fIoptions\fR] \fIpull_request\fR [\fIpull_request\fR \.\.\.]"
.SS "\fBpr\-publish\fR [\fIoptions\fR] \fIpull_request\fR [\.\.\.]"
Publish bottles for a pull request with GitHub Actions\. Requires write access to the repository\.
.
.TP
@ -1574,7 +1574,7 @@ Target tap repository (default: \fBhomebrew/core\fR)\.
\fB\-\-workflow\fR
Target workflow filename (default: \fBpublish\-commit\-bottles\.yml\fR)\.
.
.SS "\fBpr\-pull\fR [\fIoptions\fR] \fIpull_request\fR [\fIpull_request\fR \.\.\.]"
.SS "\fBpr\-pull\fR [\fIoptions\fR] \fIpull_request\fR [\.\.\.]"
Download and publish bottles, and apply the bottle commit from a pull request with artifacts generated by GitHub Actions\. Requires write access to the repository\.
.
.TP
@ -1676,7 +1676,7 @@ Upload to the specified Bintray organisation (default: \fBhomebrew\fR)\.
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBprof\fR [\fIcommand\fR]"
.SS "\fBprof\fR [\fIoptions\fR] [\fIcommand\fR \.\.\.]"
Run Homebrew with a Ruby profiler, e\.g\. \fBbrew prof readall\fR\.
.
.TP
@ -1696,7 +1696,7 @@ Print as a Markdown list\.
.SS "\fBrubocop\fR"
Installs, configures and runs Homebrew\'s \fBrubocop\fR\.
.
.SS "\fBruby\fR (\fB\-e\fR \fItext\fR|\fIfile\fR)"
.SS "\fBruby\fR [\fIoptions\fR] (\fB\-e\fR \fItext\fR|\fIfile\fR)"
Run a Ruby instance with Homebrew\'s libraries loaded, e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR\.
.
.TP
@ -1718,10 +1718,10 @@ Use the standard \fBPATH\fR instead of superenv\'s when \fBstd\fR is passed\.
\fB\-c\fR, \fB\-\-cmd\fR
Execute commands in a non\-interactive shell\.
.
.SS "\fBsponsors\fR"
.SS "\fBsponsors\fR [\fIoptions\fR]"
Print a Markdown summary of Homebrew\'s GitHub Sponsors, suitable for pasting into a README\.
.
.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR|\fIcask\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR|\fIcask\fR \.\.\.]"
.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR|\fIcask\fR \.\.\.]"
Check formulae or files for conformance to Homebrew style guidelines\.
.
.P
@ -1770,7 +1770,7 @@ Label name for pull requests ready to be pulled (default: \fBpr\-pull\fR)\.
\fB\-\-branch\fR
Initialize Git repository with the specified branch name (default: \fBmain\fR)\.
.
.SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBtest\fR [\fIoptions\fR] \fIinstalled_formula\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
@ -1819,7 +1819,7 @@ Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR w
\fB\-\-seed\fR
Randomise tests with the specified \fIvalue\fR instead of a random seed\.
.
.SS "\fBtypecheck\fR"
.SS "\fBtypecheck\fR, \fBtc\fR [\fIoptions\fR]"
Check for typechecking errors using Sorbet\.
.
.TP
@ -1854,7 +1854,7 @@ Typecheck a single file\.
\fB\-\-ignore\fR
Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet)\.
.
.SS "\fBunbottled\fR [\fIformula\fR] [\fIformula\fR \.\.\.]"
.SS "\fBunbottled\fR [\fIoptions\fR] [\fIformula\fR \.\.\.]"
Outputs the unbottled dependents of formulae\.
.
.TP
@ -1869,7 +1869,7 @@ Don\'t get analytics data and sort by number of dependents instead\.
\fB\-\-total\fR
Output the number of unbottled and total formulae\.
.
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR [<formula \.\.\.>]</formula>"
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Unpack the source files for \fIformula\fR into subdirectories of the current working directory\.
.
.TP
@ -1895,7 +1895,7 @@ Update SPDX license data in the Homebrew repository\.
\fB\-\-fail\-if\-not\-changed\fR
Return a failing status code if current license data\'s version is the same as the upstream\. This can be used to notify CI when the SPDX license data is out of date\.
.
.SS "\fBupdate\-python\-resources\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
.SS "\fBupdate\-python\-resources\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
Update versions for PyPI resource blocks in \fIformula\fR\.
.
.TP
@ -1945,7 +1945,7 @@ Use the specified \fIcommit\fR as the start commit\.
\fB\-\-before\fR
Use the commit at the specified \fIdate\fR as the start commit\.
.
.SS "\fBvendor\-gems\fR"
.SS "\fBvendor\-gems\fR [\fIoptions\fR]"
Install and commit Homebrew\'s vendored gems\.
.
.TP