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

Merge pull request #10337 from dawidd6/cmd_dev-cmd_usages

Browse Source 
cmd,dev-cmd: indicate multiple named args in usage banner
This commit is contained in:
Dawid Dziurla 2021-01-15 15:56:52 +01:00 committed by GitHub
commit f7f72b1552
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
51 changed files with 143 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -16,7 +16,7 @@ module Homebrew
def __cache_args def __cache_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`--cache` [<options>] [<formula>|<cask>] `--cache` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
Display Homebrew's download cache. See also `HOMEBREW_CACHE`. Display Homebrew's download cache. See also `HOMEBREW_CACHE`.

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

@ -10,7 +10,7 @@ module Homebrew
def __caskroom_args def __caskroom_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`--caskroom` [<cask>] `--caskroom` [<cask>] [<cask> ...]
Display Homebrew's Caskroom path. Display Homebrew's Caskroom path.

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

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

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

@ -15,7 +15,7 @@ module Homebrew
def __env_args def __env_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`--env` [<options>] [<formula>] `--env` [<options>] [<formula>] [<formula> ...]
Summarise Homebrew's build environment as a plain list. Summarise Homebrew's build environment as a plain list.

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

@ -12,7 +12,7 @@ module Homebrew
def __prefix_args def __prefix_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`--prefix` [<formula>] `--prefix` [<formula>] [<formula> ...]
Display Homebrew's install path. *Default:* Display Homebrew's install path. *Default:*

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

@ -12,7 +12,7 @@ module Homebrew
def __repository_args def __repository_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`--repository`, `--repo` [<user>`/`<repo>] `--repository`, `--repo` [<user>`/`<repo>] [<user>`/`<repo> ...]
Display where Homebrew's `.git` directory is located. Display where Homebrew's `.git` directory is located.

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

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

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

@ -18,7 +18,7 @@ module Homebrew
def deps_args def deps_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`deps` [<options>] [<formula>] `deps` [<options>] [<formula>] [<formula> ...]
Show dependencies for <formula>. Additional options specific to <formula> Show dependencies for <formula>. Additional options specific to <formula>
may be appended to the command. When given multiple formula arguments, may be appended to the command. When given multiple formula arguments,

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

@ -17,7 +17,7 @@ module Homebrew
def desc_args def desc_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`desc` [<options>] (<text>|`/`<text>`/`|<formula>) `desc` [<options>] <text>|`/`<text>`/`|<formula> [<text>|`/`<text>`/`|<formula> ...]
Display <formula>'s name and one-line description. Display <formula>'s name and one-line description.
Formula descriptions are cached; the cache is created on the Formula descriptions are cached; the cache is created on the
@ -35,7 +35,7 @@ module Homebrew
conflicts "--search", "--name", "--description" conflicts "--search", "--name", "--description"
named_args :formula named_args :formula, min: 1
end end
end end
@ -51,14 +51,10 @@ module Homebrew
end end
results = if search_type.nil? results = if search_type.nil?
raise FormulaUnspecifiedError if args.no_named?
desc = {} desc = {}
args.named.to_formulae.each { |f| desc[f.full_name] = f.desc } args.named.to_formulae.each { |f| desc[f.full_name] = f.desc }
Descriptions.new(desc) Descriptions.new(desc)
else else
raise UsageError, "this command requires a search term" if args.no_named?
query = args.named.join(" ") query = args.named.join(" ")
string_or_regex = query_regexp(query) string_or_regex = query_regexp(query)
CacheStoreDatabase.use(:descriptions) do |db| CacheStoreDatabase.use(:descriptions) do |db|

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

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

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

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

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

@ -25,7 +25,7 @@ module Homebrew
def info_args def info_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`info` [<options>] [<formula>|<cask>] `info` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
Display brief statistics for your Homebrew installation. Display brief statistics for your Homebrew installation.

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

@ -24,7 +24,7 @@ module Homebrew
def install_args def install_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`install` [<options>] <formula>|<cask> `install` [<options>] <formula>|<cask> [<formula>|<cask> ...]
Install a <formula> or <cask>. Additional options specific to a <formula> may be Install a <formula> or <cask>. Additional options specific to a <formula> may be
appended to the command. appended to the command.

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

@ -15,7 +15,7 @@ module Homebrew
def link_args def link_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`link`, `ln` [<options>] <formula> `link`, `ln` [<options>] <formula> [<formula> ...]
Symlink all of <formula>'s installed files into Homebrew's prefix. This 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 is done automatically when you install formulae but can be useful for DIY

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

@ -15,7 +15,7 @@ module Homebrew
def list_args def list_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`list`, `ls` [<options>] [<formula>|<cask>] `list`, `ls` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
List all installed formulae and casks. List all installed formulae and casks.

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

@ -13,7 +13,7 @@ module Homebrew
def migrate_args def migrate_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`migrate` [<options>] <formula> `migrate` [<options>] <formula> [<formula> ...]
Migrate renamed packages to new names, where <formula> are old names of Migrate renamed packages to new names, where <formula> are old names of
packages. packages.

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

@ -15,7 +15,7 @@ module Homebrew
def missing_args def missing_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`missing` [<options>] [<formula>] `missing` [<options>] [<formula>] [<formula> ...]
Check the given <formula> kegs for missing dependencies. If no <formula> are 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 provided, check all kegs. Will exit with a non-zero status if any kegs are found

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

@ -15,7 +15,7 @@ module Homebrew
def options_args def options_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`options` [<options>] [<formula>] `options` [<options>] [<formula>] [<formula> ...]
Show install options specific to <formula>. Show install options specific to <formula>.
EOS EOS

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

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

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

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

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

@ -14,7 +14,7 @@ module Homebrew
def postinstall_args def postinstall_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`postinstall` <formula> `postinstall` <formula> [<formula> ...]
Rerun the post-install steps for <formula>. Rerun the post-install steps for <formula>.
EOS EOS

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

@ -13,7 +13,7 @@ module Homebrew
def readall_args def readall_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`readall` [<options>] [<tap>] `readall` [<options>] [<tap>] [<tap> ...]
Import all items from the specified <tap>, or from all installed taps if none is provided. 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 This can be useful for debugging issues across all items when making

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

@ -22,7 +22,7 @@ module Homebrew
def reinstall_args def reinstall_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`reinstall` [<options>] <formula>|<cask> `reinstall` [<options>] <formula>|<cask> [<formula>|<cask> ...]
Uninstall and then reinstall a <formula> or <cask> using the same options it was 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>. originally installed with, plus any appended options specific to a <formula>.

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

@ -31,7 +31,7 @@ module Homebrew
def search_args def search_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`search` [<options>] [<text>|`/`<text>`/`] `search` [<options>] [<text>|`/`<text>`/`] [<text>|`/`<text>`/` ...]
Perform a substring search of cask tokens and formula names for <text>. If <text> 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. is flanked by slashes, it is interpreted as a regular expression.

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

@ -19,7 +19,7 @@ module Homebrew
Symlink all of the specified <version> of <formula>'s installation into Homebrew's prefix. Symlink all of the specified <version> of <formula>'s installation into Homebrew's prefix.
EOS EOS
named 2 named_args number: 2
hide_from_man_page! hide_from_man_page!
end end
end end

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

@ -12,7 +12,7 @@ module Homebrew
def tap_info_args def tap_info_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`tap-info` [<options>] [<tap>] `tap-info` [<options>] [<tap>] [<tap> ...]
Show detailed information about one or more <tap>s. Show detailed information about one or more <tap>s.

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

@ -19,7 +19,7 @@ module Homebrew
def uninstall_args def uninstall_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`uninstall`, `rm`, `remove` [<options>] <formula>|<cask> `uninstall`, `rm`, `remove` [<options>] <formula>|<cask> [<formula>|<cask> ...]
Uninstall a <formula> or <cask>. Uninstall a <formula> or <cask>.
EOS EOS

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

@ -14,7 +14,7 @@ module Homebrew
def unlink_args def unlink_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`unlink` [<options>] <formula> `unlink` [<options>] <formula> [<formula> ...]
Remove symlinks for <formula> from Homebrew's prefix. This can be useful Remove symlinks for <formula> from Homebrew's prefix. This can be useful
for temporarily disabling a formula: for temporarily disabling a formula:

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

@ -13,7 +13,7 @@ module Homebrew
def unpin_args def unpin_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`unpin` <formula> `unpin` <formula> [<formula> ...]
Unpin <formula>, allowing them to be upgraded by `brew upgrade` <formula>. Unpin <formula>, allowing them to be upgraded by `brew upgrade` <formula>.
See also `pin`. See also `pin`.

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

@ -12,7 +12,7 @@ module Homebrew
def untap_args def untap_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`untap` <tap> `untap` <tap> [<tap> ...]
Remove a tapped formula repository. Remove a tapped formula repository.
EOS EOS

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

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

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

@ -18,7 +18,7 @@ module Homebrew
def upgrade_args def upgrade_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`upgrade` [<options>] [<formula>|<cask>] `upgrade` [<options>] [<formula>|<cask>] [<formula>|<cask> ...]
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally 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, installed with, plus any appended brew formula options. If <cask> or <formula> are specified,

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

@ -21,7 +21,7 @@ module Homebrew
def uses_args def uses_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`uses` [<options>] <formula> `uses` [<options>] <formula> [<formula> ...]
Show formulae and casks that specify <formula> as a dependency (i.e. show dependents 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 <formula>). When given multiple formula arguments, show the intersection

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

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

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

@ -18,7 +18,7 @@ module Homebrew
def self.bump_unversioned_casks_args def self.bump_unversioned_casks_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`bump-unversioned-casks` [<options>] [<cask>|<tap>] `bump-unversioned-casks` [<options>] <cask>|<tap> [<cask>|<tap> ...]
Check all casks with unversioned URLs in a given <tap> for updates. Check all casks with unversioned URLs in a given <tap> for updates.
EOS EOS

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

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

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

@ -13,7 +13,7 @@ module Homebrew
def command_args def command_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`command` <cmd> `command` <cmd> [<cmd> ...]
Display the path to the file being used when invoking `brew` <cmd>. Display the path to the file being used when invoking `brew` <cmd>.
EOS EOS

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

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

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

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

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

@ -14,7 +14,7 @@ module Homebrew
def linkage_args def linkage_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`linkage` [<options>] [<formula>] `linkage` [<options>] [<formula>] [<formula> ...]
Check the library links from the given <formula> kegs. If no <formula> are 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. provided, check all kegs. Raises an error if run on uninstalled formulae.

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

@ -20,7 +20,7 @@ module Homebrew
def livecheck_args def livecheck_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`livecheck` [<formulae>|<casks>] `livecheck` [<formula>|<cask>] [<formula>|<cask> ...]
Check for newer versions of formulae and/or casks from upstream. Check for newer versions of formulae and/or casks from upstream.

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

@ -13,7 +13,7 @@ module Homebrew
def mirror_args def mirror_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`mirror` <formula> `mirror` <formula> [<formula> ...]
Reupload the stable URL of a formula to Bintray for use as a mirror. Reupload the stable URL of a formula to Bintray for use as a mirror.
EOS EOS

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

@ -29,7 +29,7 @@ module Homebrew
flag "--workflow=", flag "--workflow=",
description: "Target workflow filename (default: `publish-commit-bottles.yml`)." description: "Target workflow filename (default: `publish-commit-bottles.yml`)."
named_args number: 1 named_args min: 1
end end
end end

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

@ -71,7 +71,7 @@ module Homebrew
conflicts "--clean", "--autosquash" conflicts "--clean", "--autosquash"
named_args number: 1 named_args min: 1
end end
end end

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

@ -15,7 +15,7 @@ module Homebrew
def style_args def style_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`style` [<options>] [<file>|<tap>|<formula>] `style` [<options>] [<file>|<tap>|<formula>|<cask>] [<file>|<tap>|<formula>|<cask> ...]
Check formulae or files for conformance to Homebrew style guidelines. Check formulae or files for conformance to Homebrew style guidelines.

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

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

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

@ -13,7 +13,7 @@ module Homebrew
def unbottled_args def unbottled_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`unbottled` [<formula>] `unbottled` [<formula>] [<formula> ...]
Outputs the unbottled dependents of formulae. Outputs the unbottled dependents of formulae.
EOS EOS

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

@ -14,7 +14,7 @@ module Homebrew
def unpack_args def unpack_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`unpack` [<options>] <formula> `unpack` [<options>] <formula> [<formula ...>]
Unpack the source files for <formula> into subdirectories of the current Unpack the source files for <formula> into subdirectories of the current
working directory. working directory.

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

@ -13,7 +13,7 @@ module Homebrew
def update_python_resources_args def update_python_resources_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner <<~EOS usage_banner <<~EOS
`update-python-resources` [<options>] <formula> `update-python-resources` [<options>] <formula> [<formula> ...]
Update versions for PyPI resource blocks in <formula>. Update versions for PyPI resource blocks in <formula>.
EOS EOS
@ -34,7 +34,7 @@ module Homebrew
comma_array "--exclude-packages=", comma_array "--exclude-packages=",
description: "Exclude these packages when finding resources." description: "Exclude these packages when finding resources."
named_args :formula, number: 1 named_args :formula, min: 1
end end
end end

92
docs/Manpage.md
View File

@ -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. List all locally installable casks including short names.
### `cleanup` [*`options`*] [*`formula`*|*`cask`*] ### `cleanup` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Remove stale lock files and outdated downloads for all formulae and casks, Remove stale lock files and outdated downloads for all formulae and casks,
and remove old versions of installed formulae. If arguments are specified, and remove old versions of installed formulae. If arguments are specified,
@ -110,7 +110,7 @@ Read more at <https://docs.brew.sh/Shell-Completion>.
Show Homebrew and system configuration info useful for debugging. If you file Show Homebrew and system configuration info useful for debugging. If you file
a bug report, you will be required to provide this information. a bug report, you will be required to provide this information.
### `deps` [*`options`*] [*`formula`*] ### `deps` [*`options`*] [*`formula`*] [*`formula`* ...]
Show dependencies for *`formula`*. Additional options specific to *`formula`* Show dependencies for *`formula`*. Additional options specific to *`formula`*
may be appended to the command. When given multiple formula arguments, may be appended to the command. When given multiple formula arguments,
@ -149,7 +149,7 @@ show the intersection of dependencies for each formula.
* `--cask`: * `--cask`:
Treat all named arguments as casks. Treat all named arguments as casks.
### `desc` [*`options`*] (*`text`*|`/`*`text`*`/`|*`formula`*) ### `desc` [*`options`*] *`text`*|`/`*`text`*`/`|*`formula`* [*`text`*|`/`*`text`*`/`|*`formula`* ...]
Display *`formula`*'s name and one-line description. Display *`formula`*'s name and one-line description.
Formula descriptions are cached; the cache is created on the Formula descriptions are cached; the cache is created on the
@ -175,7 +175,7 @@ an issue; just ignore this.
* `-D`, `--audit-debug`: * `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods. Enable debugging and profiling of audit methods.
### `fetch` [*`options`*] *`formula`* ### `fetch` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
Download a bottle (if available) or source packages for *`formula`*e Download a bottle (if available) or source packages for *`formula`*e
and binaries for *`cask`*s. For files, also print SHA-256 checksums. 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`: * `-p`, `--private`:
The Gist will be marked private and will not appear in listings but will be accessible with its link. The Gist will be marked private and will not appear in listings but will be accessible with its link.
### `home` [*`formula`*|*`cask`*] ### `home` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Open a *`formula`* or *`cask`*'s homepage in a browser, or open Open a *`formula`* or *`cask`*'s homepage in a browser, or open
Homebrew's own homepage if no argument is provided. Homebrew's own homepage if no argument is provided.
@ -229,7 +229,7 @@ Homebrew's own homepage if no argument is provided.
* `--cask`: * `--cask`:
Treat all named arguments as casks. Treat all named arguments as casks.
### `info` [*`options`*] [*`formula`*|*`cask`*] ### `info` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Display brief statistics for your Homebrew installation. 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`: * `--cask`:
Treat all named arguments as casks. Treat all named arguments as casks.
### `install` [*`options`*] *`formula`*|*`cask`* ### `install` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
Install a *`formula`* or *`cask`*. Additional options specific to a *`formula`* may be Install a *`formula`* or *`cask`*. Additional options specific to a *`formula`* may be
appended to the command. appended to the command.
@ -317,7 +317,7 @@ the installed formulae or, every 30 days, for all formulae.
List installed formulae that are not dependencies of another installed formula. List installed formulae that are not dependencies of another installed formula.
### `link`, `ln` [*`options`*] *`formula`* ### `link`, `ln` [*`options`*] *`formula`* [*`formula`* ...]
Symlink all of *`formula`*'s installed files into Homebrew's prefix. This 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 is done automatically when you install formulae but can be useful for DIY
@ -330,7 +330,7 @@ installations.
* `-f`, `--force`: * `-f`, `--force`:
Allow keg-only formulae to be linked. Allow keg-only formulae to be linked.
### `list`, `ls` [*`options`*] [*`formula`*|*`cask`*] ### `list`, `ls` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
List all installed formulae and casks. List all installed formulae and casks.
@ -374,7 +374,7 @@ if no formula is provided.
* `-n`, `--max-count`: * `-n`, `--max-count`:
Print only a specified number of commits. Print only a specified number of commits.
### `migrate` [*`options`*] *`formula`* ### `migrate` [*`options`*] *`formula`* [*`formula`* ...]
Migrate renamed packages to new names, where *`formula`* are old names of Migrate renamed packages to new names, where *`formula`* are old names of
packages. packages.
@ -382,7 +382,7 @@ packages.
* `-f`, `--force`: * `-f`, `--force`:
Treat installed *`formula`* and provided *`formula`* as if they are from the same taps and migrate them anyway. Treat installed *`formula`* and provided *`formula`* as if they are from the same taps and migrate them anyway.
### `missing` [*`options`*] [*`formula`*] ### `missing` [*`options`*] [*`formula`*] [*`formula`* ...]
Check the given *`formula`* kegs for missing dependencies. If no *`formula`* are 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 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`: * `--hide`:
Act as if none of the specified *`hidden`* are installed. *`hidden`* should be a comma-separated list of formulae. Act as if none of the specified *`hidden`* are installed. *`hidden`* should be a comma-separated list of formulae.
### `options` [*`options`*] [*`formula`*] ### `options` [*`options`*] [*`formula`*] [*`formula`* ...]
Show install options specific to *`formula`*. Show install options specific to *`formula`*.
@ -404,7 +404,7 @@ Show install options specific to *`formula`*.
* `--command`: * `--command`:
Show options for the specified *`command`*. Show options for the specified *`command`*.
### `outdated` [*`options`*] [*`formula`*|*`cask`*] ### `outdated` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
List installed casks and formulae that have an updated version available. By default, version List installed casks and formulae that have an updated version available. By default, version
information is displayed in interactive shells, and suppressed otherwise. information is displayed in interactive shells, and suppressed otherwise.
@ -424,16 +424,16 @@ information is displayed in interactive shells, and suppressed otherwise.
* `--greedy`: * `--greedy`:
Print outdated casks with `auto_updates` or `version :latest`. Print outdated casks with `auto_updates` or `version :latest`.
### `pin` *`formula`* ### `pin` *`formula`* [*`formula`* ...]
Pin the specified *`formula`*, preventing them from being upgraded when Pin the specified *`formula`*, preventing them from being upgraded when
issuing the `brew upgrade` *`formula`* command. See also `unpin`. issuing the `brew upgrade` *`formula`* command. See also `unpin`.
### `postinstall` *`formula`* ### `postinstall` *`formula`* [*`formula`* ...]
Rerun the post-install steps for *`formula`*. Rerun the post-install steps for *`formula`*.
### `readall` [*`options`*] [*`tap`*] ### `readall` [*`options`*] [*`tap`*] [*`tap`* ...]
Import all items from the specified *`tap`*, or from all installed taps if none is provided. 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 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`:
Syntax-check all of Homebrew's Ruby files (if no `*`tap`*` is passed). Syntax-check all of Homebrew's Ruby files (if no `*`tap`*` is passed).
### `reinstall` [*`options`*] *`formula`*|*`cask`* ### `reinstall` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
Uninstall and then reinstall a *`formula`* or *`cask`* using the same options it was 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`*. 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-cask-deps`:
Skip installing cask dependencies. Skip installing cask dependencies.
### `search` [*`options`*] [*`text`*|`/`*`text`*`/`] ### `search` [*`options`*] [*`text`*|`/`*`text`*`/`] [*`text`*|`/`*`text`*`/` ...]
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* 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. 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-pinned`:
List all pinned taps. List all pinned taps.
### `tap-info` [*`options`*] [*`tap`*] ### `tap-info` [*`options`*] [*`tap`*] [*`tap`* ...]
Show detailed information about one or more *`tap`*s. 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`: * `--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> 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`* ### `uninstall`, `rm`, `remove` [*`options`*] *`formula`*|*`cask`* [*`formula`*|*`cask`* ...]
Uninstall a *`formula`* or *`cask`*. Uninstall a *`formula`* or *`cask`*.
@ -576,7 +576,7 @@ Uninstall a *`formula`* or *`cask`*.
* `--cask`: * `--cask`:
Treat all named arguments as casks. Treat all named arguments as casks.
### `unlink` [*`options`*] *`formula`* ### `unlink` [*`options`*] *`formula`* [*`formula`* ...]
Remove symlinks for *`formula`* from Homebrew's prefix. This can be useful Remove symlinks for *`formula`* from Homebrew's prefix. This can be useful
for temporarily disabling a formula: for temporarily disabling a formula:
@ -585,12 +585,12 @@ for temporarily disabling a formula:
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
List files which would be unlinked without actually unlinking or deleting any files. List files which would be unlinked without actually unlinking or deleting any files.
### `unpin` *`formula`* ### `unpin` *`formula`* [*`formula`* ...]
Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*. Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*.
See also `pin`. See also `pin`.
### `untap` *`tap`* ### `untap` *`tap`* [*`tap`* ...]
Remove a tapped formula repository. 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`: * `-f`, `--force`:
Always do a slower, full update check (even if unnecessary). Always do a slower, full update check (even if unnecessary).
### `update-reset` [*`repository`*] ### `update-reset` [*`repository`*] [*`repository`* ...]
Fetch and reset Homebrew and all tap repositories (or any specified *`repository`*) using `git`(1) to their latest `origin/master`. 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. *Note:* this will destroy all your uncommitted or committed changes.
### `upgrade` [*`options`*] [*`formula`*|*`cask`*] ### `upgrade` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally 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, 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`: * `--greedy`:
Also include casks with `auto_updates true` or `version :latest`. Also include casks with `auto_updates true` or `version :latest`.
### `uses` [*`options`*] *`formula`* ### `uses` [*`options`*] *`formula`* [*`formula`* ...]
Show formulae and casks that specify *`formula`* as a dependency (i.e. show dependents 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 *`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`: * `--cask`:
Include only casks. Include only casks.
### `--cache` [*`options`*] [*`formula`*|*`cask`*] ### `--cache` [*`options`*] [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Display Homebrew's download cache. See also `HOMEBREW_CACHE`. 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`: * `--cask`:
Only show cache files for casks. Only show cache files for casks.
### `--caskroom` [*`cask`*] ### `--caskroom` [*`cask`*] [*`cask`* ...]
Display Homebrew's Caskroom path. Display Homebrew's Caskroom path.
If *`cask`* is provided, display the location in the Caskroom where *`cask`* 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. would be installed, without any sort of versioned directory as the last path.
### `--cellar` [*`formula`*] ### `--cellar` [*`formula`*] [*`formula`* ...]
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`. 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`* 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. would be installed, without any sort of versioned directory as the last path.
### `--env` [*`options`*] [*`formula`*] ### `--env` [*`options`*] [*`formula`*] [*`formula`* ...]
Summarise Homebrew's build environment as a plain list. 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`: * `--plain`:
Generate plain output even when piped. Generate plain output even when piped.
### `--prefix` [*`formula`*] ### `--prefix` [*`formula`*] [*`formula`* ...]
Display Homebrew's install path. *Default:* Display Homebrew's install path. *Default:*
@ -737,7 +737,7 @@ is or would be installed.
* `--unbrewed`: * `--unbrewed`:
List files in Homebrew's prefix not installed by Homebrew. List files in Homebrew's prefix not installed by Homebrew.
### `--repository`, `--repo` [*`user`*`/`*`repo`*] ### `--repository`, `--repo` [*`user`*`/`*`repo`*] [*`user`*`/`*`repo`* ...]
Display where Homebrew's `.git` directory is located. Display where Homebrew's `.git` directory is located.
@ -794,7 +794,7 @@ non-zero status if any errors are found.
* `--token-conflicts`: * `--token-conflicts`:
Audit for token conflicts Audit for token conflicts
### `bottle` [*`options`*] *`formula`* ### `bottle` [*`options`*] *`formula`* [*`formula`* ...]
Generate a bottle (binary package) from a formula that was installed with Generate a bottle (binary package) from a formula that was installed with
`--build-bottle`. `--build-bottle`.
@ -821,7 +821,7 @@ value, while `--no-rebuild` will remove it.
* `--root-url`: * `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default. Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
### `bump` [*`options`*] [*`formula`*] ### `bump` [*`options`*] [*`formula`*] [*`formula`* ...]
Display out-of-date brew formulae and the latest version available. Display out-of-date brew formulae and the latest version available.
Also displays whether a pull request has been opened with the URL. Also displays whether a pull request has been opened with the URL.
@ -925,7 +925,7 @@ present, "revision 1" will be added.
* `--message`: * `--message`:
Append *`message`* to the default commit message. Append *`message`* to the default commit message.
### `bump-unversioned-casks` [*`options`*] [*`cask`*|*`tap`*] ### `bump-unversioned-casks` [*`options`*] *`cask`*|*`tap`* [*`cask`*|*`tap`* ...]
Check all casks with unversioned URLs in a given *`tap`* for updates. Check all casks with unversioned URLs in a given *`tap`* for updates.
@ -945,7 +945,7 @@ Display the source of a *`formula`* or *`cask`*.
* `--cask`: * `--cask`:
Treat all named arguments as casks. Treat all named arguments as casks.
### `command` *`cmd`* ### `command` *`cmd`* [*`cmd`* ...]
Display the path to the file being used when invoking `brew` *`cmd`*. Display the path to the file being used when invoking `brew` *`cmd`*.
@ -1009,7 +1009,7 @@ Build bottles for these formulae with GitHub Actions.
* `--upload`: * `--upload`:
Upload built bottles to Bintray. Upload built bottles to Bintray.
### `edit` [*`formula`*|*`cask`*] ### `edit` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Open a *`formula`* or *`cask`* in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, 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. or open the Homebrew repository for editing if no formula is provided.
@ -1032,7 +1032,7 @@ a formula from a tap that is not `homebrew/core` use its fully-qualified form of
* `-f`, `--force`: * `-f`, `--force`:
Overwrite the destination formula if it already exists. Overwrite the destination formula if it already exists.
### `formula` *`formula`* ### `formula` *`formula`* [*`formula`* ...]
Display the path where *`formula`* is located. Display the path where *`formula`* is located.
@ -1049,7 +1049,7 @@ Enter the interactive Homebrew Ruby shell.
* `--pry`: * `--pry`:
Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set. Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set.
### `linkage` [*`options`*] [*`formula`*] ### `linkage` [*`options`*] [*`formula`*] [*`formula`* ...]
Check the library links from the given *`formula`* kegs. If no *`formula`* are 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. 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`: * `--cached`:
Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run. Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run.
### `livecheck` [*`formulae`*|*`casks`*] ### `livecheck` [*`formula`*|*`cask`*] [*`formula`*|*`cask`* ...]
Check for newer versions of formulae and/or casks from upstream. Check for newer versions of formulae and/or casks from upstream.
@ -1097,7 +1097,7 @@ Generate Homebrew's manpages.
* `--link`: * `--link`:
This is now done automatically by `brew update`. This is now done automatically by `brew update`.
### `mirror` *`formula`* ### `mirror` *`formula`* [*`formula`* ...]
Reupload the stable URL of a formula to Bintray for use as a mirror. Reupload the stable URL of a formula to Bintray for use as a mirror.
@ -1252,7 +1252,7 @@ which build systems would not find otherwise.
Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting into a README. Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting into a README.
### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*] ### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*|*`cask`*] [*`file`*|*`tap`*|*`formula`*|*`cask`* ...]
Check formulae or files for conformance to Homebrew style guidelines. Check formulae or files for conformance to Homebrew style guidelines.
@ -1286,7 +1286,7 @@ Generate the template files for a new tap.
* `--branch`: * `--branch`:
Initialize Git repository with the specified branch name (default: `main`). Initialize Git repository with the specified branch name (default: `main`).
### `test` [*`options`*] *`formula`* ### `test` [*`options`*] *`formula`* [*`formula`* ...]
Run the test method provided by an 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 There is no standard output or return code, but generally it should notify the
@ -1341,7 +1341,7 @@ Check for typechecking errors using Sorbet.
* `--ignore`: * `--ignore`:
Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet). Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet).
### `unbottled` [*`formula`*] ### `unbottled` [*`formula`*] [*`formula`* ...]
Outputs the unbottled dependents of formulae. Outputs the unbottled dependents of formulae.
@ -1352,7 +1352,7 @@ Outputs the unbottled dependents of formulae.
* `--total`: * `--total`:
Output the number of unbottled and total formulae. Output the number of unbottled and total formulae.
### `unpack` [*`options`*] *`formula`* ### `unpack` [*`options`*] *`formula`* [<formula ...>]
Unpack the source files for *`formula`* into subdirectories of the current Unpack the source files for *`formula`* into subdirectories of the current
working directory. working directory.
@ -1373,7 +1373,7 @@ working directory.
* `--fail-if-not-changed`: * `--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. 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`* ### `update-python-resources` [*`options`*] *`formula`* [*`formula`* ...]
Update versions for PyPI resource blocks in *`formula`*. Update versions for PyPI resource blocks in *`formula`*.

92
manpages/brew.1
View File

@ -63,7 +63,7 @@ List what would be uninstalled, but do not actually uninstall anything\.
.SS "\fBcasks\fR" .SS "\fBcasks\fR"
List all locally installable casks including short names\. List all locally installable casks including short names\.
. .
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\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\. 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 .TP
@ -107,7 +107,7 @@ Control whether Homebrew automatically links external tap shell completion files
.SS "\fBconfig\fR" .SS "\fBconfig\fR"
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\. 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]" .SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\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\. 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 .TP
@ -174,7 +174,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBdesc\fR [\fIoptions\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR)" .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 \.\.\.]"
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\. 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 .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 \fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\. Enable debugging and profiling of audit methods\.
. .
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR|\fIcask\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\. Download a bottle (if available) or source packages for \fIformula\fRe and binaries for \fIcask\fRs\. For files, also print SHA\-256 checksums\.
. .
.TP .TP
@ -265,7 +265,7 @@ Automatically create a new issue in the appropriate GitHub repository after crea
\fB\-p\fR, \fB\-\-private\fR \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\. 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]" .SS "\fBhome\fR [\fIformula\fR|\fIcask\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\. Open a \fIformula\fR or \fIcask\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no argument is provided\.
. .
.TP .TP
@ -276,7 +276,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display brief statistics for your Homebrew installation\. Display brief statistics for your Homebrew installation\.
. .
.P .P
@ -322,7 +322,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR" .SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\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\. Install a \fIformula\fR or \fIcask\fR\. Additional options specific to a \fIformula\fR may be appended to the command\.
. .
.P .P
@ -427,7 +427,7 @@ Skip installing cask dependencies\.
.SS "\fBleaves\fR" .SS "\fBleaves\fR"
List installed formulae that are not dependencies of another installed formula\. List installed formulae that are not dependencies of another installed formula\.
. .
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR [\fIformula\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\. 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 .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 \fB\-f\fR, \fB\-\-force\fR
Allow keg\-only formulae to be linked\. Allow keg\-only formulae to be linked\.
. .
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
List all installed formulae and casks\. List all installed formulae and casks\.
. .
.P .P
@ -511,21 +511,21 @@ Print only one commit\.
\fB\-n\fR, \fB\-\-max\-count\fR \fB\-n\fR, \fB\-\-max\-count\fR
Print only a specified number of commits\. Print only a specified number of commits\.
. .
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\. Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
. .
.TP .TP
\fB\-f\fR, \fB\-\-force\fR \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\. 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]" .SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\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\. 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 .TP
\fB\-\-hide\fR \fB\-\-hide\fR
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\. 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]" .SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
Show install options specific to \fIformula\fR\. Show install options specific to \fIformula\fR\.
. .
.TP .TP
@ -544,7 +544,7 @@ Show options for all available formulae\.
\fB\-\-command\fR \fB\-\-command\fR
Show options for the specified \fIcommand\fR\. Show options for the specified \fIcommand\fR\.
. .
.SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\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\. List installed casks and formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
. .
.TP .TP
@ -575,13 +575,13 @@ Fetch the upstream repository to detect if the HEAD installation of the formula
\fB\-\-greedy\fR \fB\-\-greedy\fR
Print outdated casks with \fBauto_updates\fR or \fBversion :latest\fR\. Print outdated casks with \fBauto_updates\fR or \fBversion :latest\fR\.
. .
.SS "\fBpin\fR \fIformula\fR" .SS "\fBpin\fR \fIformula\fR [\fIformula\fR \.\.\.]"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\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" .SS "\fBpostinstall\fR \fIformula\fR [\fIformula\fR \.\.\.]"
Rerun the post\-install steps for \fIformula\fR\. Rerun the post\-install steps for \fIformula\fR\.
. .
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR]" .SS "\fBreadall\fR [\fIoptions\fR] [\fItap\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\. 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 .TP
@ -592,7 +592,7 @@ Verify any alias symlinks in each tap\.
\fB\-\-syntax\fR \fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files (if no \fB<tap>\fR is passed)\. Syntax\-check all of Homebrew\'s Ruby files (if no \fB<tap>\fR is passed)\.
. .
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR" .SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\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\. 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 .P
@ -654,7 +654,7 @@ Disable/enable quarantining of downloads (default: enabled)\.
\fB\-\-skip\-cask\-deps\fR \fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\. Skip installing cask dependencies\.
. .
.SS "\fBsearch\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR]" .SS "\fBsearch\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR] [\fItext\fR|\fB/\fR\fItext\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\. 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 .P
@ -746,7 +746,7 @@ Migrate tapped formulae from symlink\-based to directory\-based structure\.
\fB\-\-list\-pinned\fR \fB\-\-list\-pinned\fR
List all pinned taps\. List all pinned taps\.
. .
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]" .SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR] [\fItap\fR \.\.\.]"
Show detailed information about one or more \fItap\fRs\. Show detailed information about one or more \fItap\fRs\.
. .
.P .P
@ -760,7 +760,7 @@ Show information on each installed tap\.
\fB\-\-json\fR \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 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" .SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR [\fIformula\fR|\fIcask\fR \.\.\.]"
Uninstall a \fIformula\fR or \fIcask\fR\. Uninstall a \fIformula\fR or \fIcask\fR\.
. .
.TP .TP
@ -783,17 +783,17 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR [\fIformula\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 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 .TP
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
List files which would be unlinked without actually unlinking or deleting any files\. List files which would be unlinked without actually unlinking or deleting any files\.
. .
.SS "\fBunpin\fR \fIformula\fR" .SS "\fBunpin\fR \fIformula\fR [\fIformula\fR \.\.\.]"
Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\. Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\.
. .
.SS "\fBuntap\fR \fItap\fR" .SS "\fBuntap\fR \fItap\fR [\fItap\fR \.\.\.]"
Remove a tapped formula repository\. Remove a tapped formula repository\.
. .
.SS "\fBupdate\fR [\fIoptions\fR]" .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 \fB\-f\fR, \fB\-\-force\fR
Always do a slower, full update check (even if unnecessary)\. Always do a slower, full update check (even if unnecessary)\.
. .
.SS "\fBupdate\-reset\fR [\fIrepository\fR]" .SS "\fBupdate\-reset\fR [\fIrepository\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\. Fetch and reset Homebrew and all tap repositories (or any specified \fIrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\.
. .
.P .P
\fINote:\fR this will destroy all your uncommitted or committed changes\. \fINote:\fR this will destroy all your uncommitted or committed changes\.
. .
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\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)\. 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 .P
@ -895,7 +895,7 @@ Skip installing cask dependencies\.
\fB\-\-greedy\fR \fB\-\-greedy\fR
Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\. Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\.
. .
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBuses\fR [\fIoptions\fR] \fIformula\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\. 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 .TP
@ -930,7 +930,7 @@ Include only formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Include only casks\. Include only casks\.
. .
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
. .
.P .P
@ -952,19 +952,19 @@ Only show cache files for formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Only show cache files for casks\. Only show cache files for casks\.
. .
.SS "\fB\-\-caskroom\fR [\fIcask\fR]" .SS "\fB\-\-caskroom\fR [\fIcask\fR] [\fIcask\fR \.\.\.]"
Display Homebrew\'s Caskroom path\. Display Homebrew\'s Caskroom path\.
. .
.P .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\. 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]" .SS "\fB\-\-cellar\fR [\fIformula\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\. 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 .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\. 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]" .SS "\fB\-\-env\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\fR \.\.\.]"
Summarise Homebrew\'s build environment as a plain list\. Summarise Homebrew\'s build environment as a plain list\.
. .
.P .P
@ -978,7 +978,7 @@ Generate a list of environment variables for the specified shell, or \fB\-\-shel
\fB\-\-plain\fR \fB\-\-plain\fR
Generate plain output even when piped\. Generate plain output even when piped\.
. .
.SS "\fB\-\-prefix\fR [\fIformula\fR]" .SS "\fB\-\-prefix\fR [\fIformula\fR] [\fIformula\fR \.\.\.]"
Display Homebrew\'s install path\. \fIDefault:\fR Display Homebrew\'s install path\. \fIDefault:\fR
. .
.IP "\(bu" 4 .IP "\(bu" 4
@ -999,7 +999,7 @@ If \fIformula\fR is provided, display the location in the Cellar where \fIformul
\fB\-\-unbrewed\fR \fB\-\-unbrewed\fR
List files in Homebrew\'s prefix not installed by Homebrew\. List files in Homebrew\'s prefix not installed by Homebrew\.
. .
.SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fIuser\fR\fB/\fR\fIrepo\fR]" .SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fIuser\fR\fB/\fR\fIrepo\fR] [\fIuser\fR\fB/\fR\fIrepo\fR \.\.\.]"
Display where Homebrew\'s \fB\.git\fR directory is located\. Display where Homebrew\'s \fB\.git\fR directory is located\.
. .
.P .P
@ -1085,7 +1085,7 @@ Audit the appcast
\fB\-\-token\-conflicts\fR \fB\-\-token\-conflicts\fR
Audit for token conflicts Audit for token conflicts
. .
.SS "\fBbottle\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBbottle\fR [\fIoptions\fR] \fIformula\fR [\fIformula\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\. 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 .TP
@ -1124,7 +1124,7 @@ When passed with \fB\-\-write\fR, a new commit will not generated after writing
\fB\-\-root\-url\fR \fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\. 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]" .SS "\fBbump\fR [\fIoptions\fR] [\fIformula\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\. Display out\-of\-date brew formulae and the latest version available\. Also displays whether a pull request has been opened with the URL\.
. .
.TP .TP
@ -1279,7 +1279,7 @@ Print what would be done rather than doing it\.
\fB\-\-message\fR \fB\-\-message\fR
Append \fImessage\fR to the default commit message\. Append \fImessage\fR to the default commit message\.
. .
.SS "\fBbump\-unversioned\-casks\fR [\fIoptions\fR] [\fIcask\fR|\fItap\fR]" .SS "\fBbump\-unversioned\-casks\fR [\fIoptions\fR] \fIcask\fR|\fItap\fR [\fIcask\fR|\fItap\fR \.\.\.]"
Check all casks with unversioned URLs in a given \fItap\fR for updates\. Check all casks with unversioned URLs in a given \fItap\fR for updates\.
. .
.TP .TP
@ -1305,7 +1305,7 @@ Treat all named arguments as formulae\.
\fB\-\-cask\fR \fB\-\-cask\fR
Treat all named arguments as casks\. Treat all named arguments as casks\.
. .
.SS "\fBcommand\fR \fIcmd\fR" .SS "\fBcommand\fR \fIcmd\fR [\fIcmd\fR \.\.\.]"
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\. Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
. .
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR" .SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
@ -1406,7 +1406,7 @@ Dispatch specified workflow (default: \fBdispatch\-build\-bottle\.yml\fR)\.
\fB\-\-upload\fR \fB\-\-upload\fR
Upload built bottles to Bintray\. Upload built bottles to Bintray\.
. .
.SS "\fBedit\fR [\fIformula\fR|\fIcask\fR]" .SS "\fBedit\fR [\fIformula\fR|\fIcask\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\. 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 .TP
@ -1428,7 +1428,7 @@ Extract the specified \fIversion\fR of \fIformula\fR instead of the most recent\
\fB\-f\fR, \fB\-\-force\fR \fB\-f\fR, \fB\-\-force\fR
Overwrite the destination formula if it already exists\. Overwrite the destination formula if it already exists\.
. .
.SS "\fBformula\fR \fIformula\fR" .SS "\fBformula\fR \fIformula\fR [\fIformula\fR \.\.\.]"
Display the path where \fIformula\fR is located\. Display the path where \fIformula\fR is located\.
. .
.SS "\fBinstall\-bundler\-gems\fR" .SS "\fBinstall\-bundler\-gems\fR"
@ -1445,7 +1445,7 @@ Show several examples\.
\fB\-\-pry\fR \fB\-\-pry\fR
Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\. Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\.
. .
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR]" .SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR] [\fIformula\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\. 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 .TP
@ -1460,7 +1460,7 @@ For every library that a keg references, print its dylib path followed by the bi
\fB\-\-cached\fR \fB\-\-cached\fR
Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\. Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\.
. .
.SS "\fBlivecheck\fR [\fIformulae\fR|\fIcasks\fR]" .SS "\fBlivecheck\fR [\fIformula\fR|\fIcask\fR] [\fIformula\fR|\fIcask\fR \.\.\.]"
Check for newer versions of formulae and/or casks from upstream\. Check for newer versions of formulae and/or casks from upstream\.
. .
.P .P
@ -1513,7 +1513,7 @@ Return a failing status code if changes are detected in the manpage outputs\. Th
\fB\-\-link\fR \fB\-\-link\fR
This is now done automatically by \fBbrew update\fR\. This is now done automatically by \fBbrew update\fR\.
. .
.SS "\fBmirror\fR \fIformula\fR" .SS "\fBmirror\fR \fIformula\fR [\fIformula\fR \.\.\.]"
Reupload the stable URL of a formula to Bintray for use as a mirror\. Reupload the stable URL of a formula to Bintray for use as a mirror\.
. .
.TP .TP
@ -1725,7 +1725,7 @@ Execute commands in a non\-interactive shell\.
.SS "\fBsponsors\fR" .SS "\fBsponsors\fR"
Print a Markdown summary of Homebrew\'s GitHub Sponsors, suitable for pasting into a README\. 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]" .SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR|\fIcask\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR|\fIcask\fR \.\.\.]"
Check formulae or files for conformance to Homebrew style guidelines\. Check formulae or files for conformance to Homebrew style guidelines\.
. .
.P .P
@ -1774,7 +1774,7 @@ Label name for pull requests ready to be pulled (default: \fBpr\-pull\fR)\.
\fB\-\-branch\fR \fB\-\-branch\fR
Initialize Git repository with the specified branch name (default: \fBmain\fR)\. Initialize Git repository with the specified branch name (default: \fBmain\fR)\.
. .
.SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR [\fIformula\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\. 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 .P
@ -1858,7 +1858,7 @@ Typecheck a single file\.
\fB\-\-ignore\fR \fB\-\-ignore\fR
Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet)\. Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet)\.
. .
.SS "\fBunbottled\fR [\fIformula\fR]" .SS "\fBunbottled\fR [\fIformula\fR] [\fIformula\fR \.\.\.]"
Outputs the unbottled dependents of formulae\. Outputs the unbottled dependents of formulae\.
. .
.TP .TP
@ -1873,7 +1873,7 @@ Don\'t get analytics data and sort by number of dependents instead\.
\fB\-\-total\fR \fB\-\-total\fR
Output the number of unbottled and total formulae\. Output the number of unbottled and total formulae\.
. .
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR" .SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR [<formula \.\.\.>]</formula>"
Unpack the source files for \fIformula\fR into subdirectories of the current working directory\. Unpack the source files for \fIformula\fR into subdirectories of the current working directory\.
. .
.TP .TP
@ -1899,7 +1899,7 @@ Update SPDX license data in the Homebrew repository\.
\fB\-\-fail\-if\-not\-changed\fR \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\. 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" .SS "\fBupdate\-python\-resources\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
Update versions for PyPI resource blocks in \fIformula\fR\. Update versions for PyPI resource blocks in \fIformula\fR\.
. .
.TP .TP