From d1f3e39b7bc5447190a8ce2dd54ccc867f26f020 Mon Sep 17 00:00:00 2001 From: Rylan Polster Date: Fri, 15 Jan 2021 15:04:02 -0500 Subject: [PATCH] Update commands to generate usage banner --- Library/Homebrew/cmd/--cache.rb | 4 +- Library/Homebrew/cmd/--caskroom.rb | 4 +- Library/Homebrew/cmd/--cellar.rb | 4 +- Library/Homebrew/cmd/--env.rb | 4 +- Library/Homebrew/cmd/--prefix.rb | 4 +- Library/Homebrew/cmd/--repository.rb | 4 +- Library/Homebrew/cmd/--version.rb | 4 +- Library/Homebrew/cmd/analytics.rb | 4 +- Library/Homebrew/cmd/autoremove.rb | 4 +- Library/Homebrew/cmd/cleanup.rb | 4 +- Library/Homebrew/cmd/commands.rb | 4 +- Library/Homebrew/cmd/completions.rb | 4 +- Library/Homebrew/cmd/config.rb | 4 +- Library/Homebrew/cmd/deps.rb | 4 +- Library/Homebrew/cmd/desc.rb | 6 +- Library/Homebrew/cmd/doctor.rb | 4 +- Library/Homebrew/cmd/fetch.rb | 4 +- Library/Homebrew/cmd/gist-logs.rb | 4 +- Library/Homebrew/cmd/home.rb | 4 +- Library/Homebrew/cmd/info.rb | 4 +- Library/Homebrew/cmd/install.rb | 4 +- Library/Homebrew/cmd/leaves.rb | 4 +- Library/Homebrew/cmd/link.rb | 4 +- Library/Homebrew/cmd/list.rb | 4 +- Library/Homebrew/cmd/log.rb | 4 +- Library/Homebrew/cmd/migrate.rb | 4 +- Library/Homebrew/cmd/missing.rb | 4 +- Library/Homebrew/cmd/options.rb | 4 +- Library/Homebrew/cmd/outdated.rb | 4 +- Library/Homebrew/cmd/pin.rb | 4 +- Library/Homebrew/cmd/postinstall.rb | 4 +- Library/Homebrew/cmd/readall.rb | 4 +- Library/Homebrew/cmd/reinstall.rb | 4 +- Library/Homebrew/cmd/search.rb | 8 +- Library/Homebrew/cmd/switch.rb | 4 +- Library/Homebrew/cmd/tap-info.rb | 4 +- Library/Homebrew/cmd/tap.rb | 5 +- Library/Homebrew/cmd/uninstall.rb | 4 +- Library/Homebrew/cmd/unlink.rb | 4 +- Library/Homebrew/cmd/unpin.rb | 4 +- Library/Homebrew/cmd/untap.rb | 4 +- Library/Homebrew/cmd/update-report.rb | 4 +- Library/Homebrew/cmd/update-reset.sh | 2 +- Library/Homebrew/cmd/upgrade.rb | 4 +- Library/Homebrew/cmd/uses.rb | 4 +- Library/Homebrew/dev-cmd/audit.rb | 4 +- Library/Homebrew/dev-cmd/bottle.rb | 4 +- Library/Homebrew/dev-cmd/bump-cask-pr.rb | 4 +- Library/Homebrew/dev-cmd/bump-formula-pr.rb | 4 +- Library/Homebrew/dev-cmd/bump-revision.rb | 4 +- .../dev-cmd/bump-unversioned-casks.rb | 4 +- Library/Homebrew/dev-cmd/bump.rb | 4 +- Library/Homebrew/dev-cmd/cat.rb | 4 +- Library/Homebrew/dev-cmd/command.rb | 4 +- Library/Homebrew/dev-cmd/create.rb | 6 +- .../Homebrew/dev-cmd/dispatch-build-bottle.rb | 4 +- Library/Homebrew/dev-cmd/diy.rb | 4 +- Library/Homebrew/dev-cmd/edit.rb | 4 +- Library/Homebrew/dev-cmd/extract.rb | 4 +- Library/Homebrew/dev-cmd/formula.rb | 4 +- .../Homebrew/dev-cmd/install-bundler-gems.rb | 4 +- Library/Homebrew/dev-cmd/irb.rb | 4 +- Library/Homebrew/dev-cmd/linkage.rb | 4 +- Library/Homebrew/dev-cmd/livecheck.rb | 4 +- Library/Homebrew/dev-cmd/man.rb | 4 +- Library/Homebrew/dev-cmd/mirror.rb | 4 +- Library/Homebrew/dev-cmd/pr-automerge.rb | 4 +- Library/Homebrew/dev-cmd/pr-publish.rb | 6 +- Library/Homebrew/dev-cmd/pr-pull.rb | 6 +- Library/Homebrew/dev-cmd/pr-upload.rb | 4 +- Library/Homebrew/dev-cmd/prof.rb | 4 +- Library/Homebrew/dev-cmd/release-notes.rb | 5 +- Library/Homebrew/dev-cmd/ruby.rb | 5 +- Library/Homebrew/dev-cmd/sh.rb | 6 +- Library/Homebrew/dev-cmd/sponsors.rb | 4 +- Library/Homebrew/dev-cmd/style.rb | 6 +- Library/Homebrew/dev-cmd/tap-new.rb | 5 +- Library/Homebrew/dev-cmd/test.rb | 4 +- Library/Homebrew/dev-cmd/tests.rb | 4 +- Library/Homebrew/dev-cmd/typecheck.rb | 4 +- Library/Homebrew/dev-cmd/unbottled.rb | 4 +- Library/Homebrew/dev-cmd/unpack.rb | 4 +- .../Homebrew/dev-cmd/update-license-data.rb | 6 +- .../dev-cmd/update-python-resources.rb | 4 +- Library/Homebrew/dev-cmd/update-test.rb | 4 +- Library/Homebrew/dev-cmd/vendor-gems.rb | 4 +- docs/Manpage.md | 132 +++++++++--------- manpages/brew.1 | 128 ++++++++--------- 88 files changed, 229 insertions(+), 395 deletions(-) diff --git a/Library/Homebrew/cmd/--cache.rb b/Library/Homebrew/cmd/--cache.rb index 8953b3d735..0851b3d315 100644 --- a/Library/Homebrew/cmd/--cache.rb +++ b/Library/Homebrew/cmd/--cache.rb @@ -15,9 +15,7 @@ module Homebrew sig { returns(CLI::Parser) } def __cache_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--cache` [] [|] [| ...] - + description <<~EOS Display Homebrew's download cache. See also `HOMEBREW_CACHE`. If is provided, display the file or directory used to cache . diff --git a/Library/Homebrew/cmd/--caskroom.rb b/Library/Homebrew/cmd/--caskroom.rb index 176e81582d..681cdf0331 100644 --- a/Library/Homebrew/cmd/--caskroom.rb +++ b/Library/Homebrew/cmd/--caskroom.rb @@ -9,9 +9,7 @@ module Homebrew sig { returns(CLI::Parser) } def __caskroom_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--caskroom` [] [ ...] - + description <<~EOS Display Homebrew's Caskroom path. If is provided, display the location in the Caskroom where diff --git a/Library/Homebrew/cmd/--cellar.rb b/Library/Homebrew/cmd/--cellar.rb index c2347436f6..fa1eff526e 100644 --- a/Library/Homebrew/cmd/--cellar.rb +++ b/Library/Homebrew/cmd/--cellar.rb @@ -8,9 +8,7 @@ module Homebrew def __cellar_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--cellar` [] [ ...] - + description <<~EOS Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if that directory doesn't exist, `$(brew --repository)/Cellar`. diff --git a/Library/Homebrew/cmd/--env.rb b/Library/Homebrew/cmd/--env.rb index 0853b9393e..d28330029a 100644 --- a/Library/Homebrew/cmd/--env.rb +++ b/Library/Homebrew/cmd/--env.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def __env_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--env` [] [] [ ...] - + 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, diff --git a/Library/Homebrew/cmd/--prefix.rb b/Library/Homebrew/cmd/--prefix.rb index 11da33edb4..d897a8b8c6 100644 --- a/Library/Homebrew/cmd/--prefix.rb +++ b/Library/Homebrew/cmd/--prefix.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def __prefix_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--prefix` [] [ ...] - + description <<~EOS Display Homebrew's install path. *Default:* - macOS Intel: `#{HOMEBREW_DEFAULT_PREFIX}` diff --git a/Library/Homebrew/cmd/--repository.rb b/Library/Homebrew/cmd/--repository.rb index d6dd2f8993..77cea97d6c 100644 --- a/Library/Homebrew/cmd/--repository.rb +++ b/Library/Homebrew/cmd/--repository.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def __repository_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `--repository`, `--repo` [`/`] [`/` ...] - + description <<~EOS Display where Homebrew's `.git` directory is located. If `/` are provided, display where tap `/`'s directory is located. diff --git a/Library/Homebrew/cmd/--version.rb b/Library/Homebrew/cmd/--version.rb index 5a06e7efed..f423cc7c0c 100644 --- a/Library/Homebrew/cmd/--version.rb +++ b/Library/Homebrew/cmd/--version.rb @@ -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 diff --git a/Library/Homebrew/cmd/analytics.rb b/Library/Homebrew/cmd/analytics.rb index a1b296835b..b9c3badfd0 100644 --- a/Library/Homebrew/cmd/analytics.rb +++ b/Library/Homebrew/cmd/analytics.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def analytics_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `analytics` [] - + description <<~EOS Control Homebrew's anonymous aggregate user behaviour analytics. Read more at . diff --git a/Library/Homebrew/cmd/autoremove.rb b/Library/Homebrew/cmd/autoremove.rb index 51b5b07047..e001c42edb 100644 --- a/Library/Homebrew/cmd/autoremove.rb +++ b/Library/Homebrew/cmd/autoremove.rb @@ -10,9 +10,7 @@ module Homebrew def autoremove_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `autoremove` [] - + 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", diff --git a/Library/Homebrew/cmd/cleanup.rb b/Library/Homebrew/cmd/cleanup.rb index b9204b2050..d8de40f22f 100644 --- a/Library/Homebrew/cmd/cleanup.rb +++ b/Library/Homebrew/cmd/cleanup.rb @@ -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` [] [|] [| ...] - + 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 diff --git a/Library/Homebrew/cmd/commands.rb b/Library/Homebrew/cmd/commands.rb index 137b3de924..af6cb43ed2 100644 --- a/Library/Homebrew/cmd/commands.rb +++ b/Library/Homebrew/cmd/commands.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def commands_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `commands` [] - + description <<~EOS Show lists of built-in and external commands. EOS switch "-q", "--quiet", diff --git a/Library/Homebrew/cmd/completions.rb b/Library/Homebrew/cmd/completions.rb index d0a6ebcc96..4003dd0de0 100644 --- a/Library/Homebrew/cmd/completions.rb +++ b/Library/Homebrew/cmd/completions.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def completions_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `completions` [] - + description <<~EOS Control whether Homebrew automatically links external tap shell completion files. Read more at . diff --git a/Library/Homebrew/cmd/config.rb b/Library/Homebrew/cmd/config.rb index 7a93e543d5..7271881e56 100644 --- a/Library/Homebrew/cmd/config.rb +++ b/Library/Homebrew/cmd/config.rb @@ -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 diff --git a/Library/Homebrew/cmd/deps.rb b/Library/Homebrew/cmd/deps.rb index 826d0b6de7..904c84bf8a 100644 --- a/Library/Homebrew/cmd/deps.rb +++ b/Library/Homebrew/cmd/deps.rb @@ -17,9 +17,7 @@ module Homebrew sig { returns(CLI::Parser) } def deps_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `deps` [] [] [ ...] - + description <<~EOS Show dependencies for . Additional options specific to may be appended to the command. When given multiple formula arguments, show the intersection of dependencies for each formula. diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb index 3f6b7a2630..666d60b90f 100644 --- a/Library/Homebrew/cmd/desc.rb +++ b/Library/Homebrew/cmd/desc.rb @@ -16,9 +16,7 @@ module Homebrew sig { returns(CLI::Parser) } def desc_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `desc` [] |`/``/`| [|`/``/`| ...] - + description <<~EOS Display '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 diff --git a/Library/Homebrew/cmd/doctor.rb b/Library/Homebrew/cmd/doctor.rb index b43b7a4c37..a832cf51d3 100644 --- a/Library/Homebrew/cmd/doctor.rb +++ b/Library/Homebrew/cmd/doctor.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def doctor_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `doctor` [] - + 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 diff --git a/Library/Homebrew/cmd/fetch.rb b/Library/Homebrew/cmd/fetch.rb index 7ac471552a..c96441cd59 100644 --- a/Library/Homebrew/cmd/fetch.rb +++ b/Library/Homebrew/cmd/fetch.rb @@ -16,9 +16,7 @@ module Homebrew sig { returns(CLI::Parser) } def fetch_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `fetch` [] | [| ...] - + description <<~EOS Download a bottle (if available) or source packages for e and binaries for s. For files, also print SHA-256 checksums. EOS diff --git a/Library/Homebrew/cmd/gist-logs.rb b/Library/Homebrew/cmd/gist-logs.rb index a94d7c4513..8f9a77891e 100644 --- a/Library/Homebrew/cmd/gist-logs.rb +++ b/Library/Homebrew/cmd/gist-logs.rb @@ -18,9 +18,7 @@ module Homebrew sig { returns(CLI::Parser) } def gist_logs_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `gist-logs` [] - + description <<~EOS Upload logs for a failed build of to a new Gist. Presents an error message if no logs are found. EOS diff --git a/Library/Homebrew/cmd/home.rb b/Library/Homebrew/cmd/home.rb index 6957dba195..fc68c63a77 100644 --- a/Library/Homebrew/cmd/home.rb +++ b/Library/Homebrew/cmd/home.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def home_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `home` [|] [| ...] - + description <<~EOS Open a or 's homepage in a browser, or open Homebrew's own homepage if no argument is provided. EOS diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index 159141cafb..5c4cb54685 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -24,9 +24,7 @@ module Homebrew sig { returns(CLI::Parser) } def info_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `info` [] [|] [| ...] - + description <<~EOS Display brief statistics for your Homebrew installation. If a or is provided, show summary of information about it. diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 734dc98ae2..8be132b70a 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -23,9 +23,7 @@ module Homebrew sig { returns(CLI::Parser) } def install_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `install` [] | [| ...] - + description <<~EOS Install a or . Additional options specific to a may be appended to the command. diff --git a/Library/Homebrew/cmd/leaves.rb b/Library/Homebrew/cmd/leaves.rb index 04efcdd3b9..178d94ed0e 100644 --- a/Library/Homebrew/cmd/leaves.rb +++ b/Library/Homebrew/cmd/leaves.rb @@ -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 diff --git a/Library/Homebrew/cmd/link.rb b/Library/Homebrew/cmd/link.rb index 94f7021a8a..5093666b8b 100644 --- a/Library/Homebrew/cmd/link.rb +++ b/Library/Homebrew/cmd/link.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def link_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `link`, `ln` [] [ ...] - + description <<~EOS Symlink all of 's installed files into Homebrew's prefix. This is done automatically when you install formulae but can be useful for DIY installations. diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index fcca596332..c0781d6a7a 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def list_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `list`, `ls` [] [|] [| ...] - + description <<~EOS List all installed formulae and casks. If is provided, summarise the paths within its current keg. diff --git a/Library/Homebrew/cmd/log.rb b/Library/Homebrew/cmd/log.rb index 981c36c9cf..06ca7888b5 100644 --- a/Library/Homebrew/cmd/log.rb +++ b/Library/Homebrew/cmd/log.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def log_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `log` [] [] - + description <<~EOS Show the `git log` for , or show the log for the Homebrew repository if no formula is provided. EOS diff --git a/Library/Homebrew/cmd/migrate.rb b/Library/Homebrew/cmd/migrate.rb index c7adbacef1..34d61ea942 100644 --- a/Library/Homebrew/cmd/migrate.rb +++ b/Library/Homebrew/cmd/migrate.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def migrate_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `migrate` [] [ ...] - + description <<~EOS Migrate renamed packages to new names, where are old names of packages. EOS diff --git a/Library/Homebrew/cmd/missing.rb b/Library/Homebrew/cmd/missing.rb index c082374f05..cd02c0626c 100644 --- a/Library/Homebrew/cmd/missing.rb +++ b/Library/Homebrew/cmd/missing.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def missing_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `missing` [] [] [ ...] - + description <<~EOS Check the given kegs for missing dependencies. If no are provided, check all kegs. Will exit with a non-zero status if any kegs are found to be missing dependencies. diff --git a/Library/Homebrew/cmd/options.rb b/Library/Homebrew/cmd/options.rb index 93481dedec..a34d055c9d 100644 --- a/Library/Homebrew/cmd/options.rb +++ b/Library/Homebrew/cmd/options.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def options_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `options` [] [] [ ...] - + description <<~EOS Show install options specific to . EOS switch "--compact", diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index af5c94eace..8abd45ec58 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -15,9 +15,7 @@ module Homebrew sig { returns(CLI::Parser) } def outdated_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `outdated` [] [|] [| ...] - + 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 diff --git a/Library/Homebrew/cmd/pin.rb b/Library/Homebrew/cmd/pin.rb index be6749c7fa..304105ffe9 100644 --- a/Library/Homebrew/cmd/pin.rb +++ b/Library/Homebrew/cmd/pin.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def pin_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `pin` [ ...] - + description <<~EOS Pin the specified , preventing them from being upgraded when issuing the `brew upgrade` command. See also `unpin`. EOS diff --git a/Library/Homebrew/cmd/postinstall.rb b/Library/Homebrew/cmd/postinstall.rb index 22577d343a..821195f6dd 100644 --- a/Library/Homebrew/cmd/postinstall.rb +++ b/Library/Homebrew/cmd/postinstall.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def postinstall_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `postinstall` [ ...] - + description <<~EOS Rerun the post-install steps for . EOS diff --git a/Library/Homebrew/cmd/readall.rb b/Library/Homebrew/cmd/readall.rb index 9b6b8edf06..3468d0036f 100644 --- a/Library/Homebrew/cmd/readall.rb +++ b/Library/Homebrew/cmd/readall.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def readall_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `readall` [] [] [ ...] - + description <<~EOS Import all items from the specified , 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 diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index 1ba22c52ce..86657a3002 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -21,9 +21,7 @@ module Homebrew sig { returns(CLI::Parser) } def reinstall_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `reinstall` [] | [| ...] - + description <<~EOS Uninstall and then reinstall a or using the same options it was originally installed with, plus any appended options specific to a . diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index aa4625e9df..2bffd8e704 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -30,9 +30,7 @@ module Homebrew sig { returns(CLI::Parser) } def search_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `search` [] [|`/``/`] [|`/``/` ...] - + description <<~EOS Perform a substring search of cask tokens and formula names for . If is flanked by slashes, it is interpreted as a regular expression. The search for 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 diff --git a/Library/Homebrew/cmd/switch.rb b/Library/Homebrew/cmd/switch.rb index e9d3b141c8..3e78b4fc59 100644 --- a/Library/Homebrew/cmd/switch.rb +++ b/Library/Homebrew/cmd/switch.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def switch_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `switch` - + description <<~EOS Symlink all of the specified of 's installation into Homebrew's prefix. EOS diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb index 008287496b..086d196028 100644 --- a/Library/Homebrew/cmd/tap-info.rb +++ b/Library/Homebrew/cmd/tap-info.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def tap_info_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `tap-info` [] [] [ ...] - + description <<~EOS Show detailed information about one or more s. If no names are provided, display brief statistics for all installed taps. diff --git a/Library/Homebrew/cmd/tap.rb b/Library/Homebrew/cmd/tap.rb index 13661a4f0b..2868cabbcb 100644 --- a/Library/Homebrew/cmd/tap.rb +++ b/Library/Homebrew/cmd/tap.rb @@ -11,9 +11,8 @@ module Homebrew sig { returns(CLI::Parser) } def tap_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `tap` [] [`/`] [] - + usage_banner "`tap` [] [`/`] []" + description <<~EOS Tap a formula repository. If no arguments are provided, list all installed taps. diff --git a/Library/Homebrew/cmd/uninstall.rb b/Library/Homebrew/cmd/uninstall.rb index 0c730c810a..4783bafbb2 100644 --- a/Library/Homebrew/cmd/uninstall.rb +++ b/Library/Homebrew/cmd/uninstall.rb @@ -18,9 +18,7 @@ module Homebrew sig { returns(CLI::Parser) } def uninstall_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `uninstall`, `rm`, `remove` [] | [| ...] - + description <<~EOS Uninstall a or . EOS switch "-f", "--force", diff --git a/Library/Homebrew/cmd/unlink.rb b/Library/Homebrew/cmd/unlink.rb index cd5f7f2070..fd8bf4ebf8 100644 --- a/Library/Homebrew/cmd/unlink.rb +++ b/Library/Homebrew/cmd/unlink.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def unlink_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `unlink` [] [ ...] - + description <<~EOS Remove symlinks for from Homebrew's prefix. This can be useful for temporarily disabling a formula: `brew unlink` `&&` `&& brew link` diff --git a/Library/Homebrew/cmd/unpin.rb b/Library/Homebrew/cmd/unpin.rb index e4dbbbe3ac..7e287d5956 100644 --- a/Library/Homebrew/cmd/unpin.rb +++ b/Library/Homebrew/cmd/unpin.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def unpin_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `unpin` [ ...] - + description <<~EOS Unpin , allowing them to be upgraded by `brew upgrade` . See also `pin`. EOS diff --git a/Library/Homebrew/cmd/untap.rb b/Library/Homebrew/cmd/untap.rb index 2fd28d9000..e00d6ae9e7 100644 --- a/Library/Homebrew/cmd/untap.rb +++ b/Library/Homebrew/cmd/untap.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def untap_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `untap` [ ...] - + description <<~EOS Remove a tapped formula repository. EOS diff --git a/Library/Homebrew/cmd/update-report.rb b/Library/Homebrew/cmd/update-report.rb index 3a91124812..7b4f87324e 100644 --- a/Library/Homebrew/cmd/update-report.rb +++ b/Library/Homebrew/cmd/update-report.rb @@ -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", diff --git a/Library/Homebrew/cmd/update-reset.sh b/Library/Homebrew/cmd/update-reset.sh index d652f6d3ed..5bd5e08924 100644 --- a/Library/Homebrew/cmd/update-reset.sh +++ b/Library/Homebrew/cmd/update-reset.sh @@ -1,4 +1,4 @@ -#: * `update-reset` [] [ ...] +#: * `update-reset` [ ...] #: #: Fetch and reset Homebrew and all tap repositories (or any specified ) using `git`(1) to their latest `origin/master`. #: diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb index 9fa94b21ae..89280370e1 100644 --- a/Library/Homebrew/cmd/upgrade.rb +++ b/Library/Homebrew/cmd/upgrade.rb @@ -17,9 +17,7 @@ module Homebrew sig { returns(CLI::Parser) } def upgrade_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `upgrade` [] [|] [| ...] - + 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 or are specified, upgrade only the given or kegs (unless they are pinned; see `pin`, `unpin`). diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 1c4214d1b7..9902709b89 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -20,9 +20,7 @@ module Homebrew sig { returns(CLI::Parser) } def uses_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `uses` [] [ ...] - + description <<~EOS Show formulae and casks that specify as a dependency (i.e. show dependents of ). When given multiple formula arguments, show the intersection of formulae that use . By default, `uses` shows all formulae and casks that diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index 3a8e3fcfa0..3c5a423036 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -27,9 +27,7 @@ module Homebrew sig { returns(CLI::Parser) } def audit_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `audit` [] [|] - + description <<~EOS Check for Homebrew coding style violations. This should be run before submitting a new formula or cask. If no | are provided, check all locally available formulae and casks and skip style checks. Will exit with a diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index 5898088037..1d239eee3a 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -49,9 +49,7 @@ module Homebrew sig { returns(CLI::Parser) } def bottle_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `bottle` [] [ ...] - + 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 diff --git a/Library/Homebrew/dev-cmd/bump-cask-pr.rb b/Library/Homebrew/dev-cmd/bump-cask-pr.rb index d9c7c3f66b..3c55907f57 100644 --- a/Library/Homebrew/dev-cmd/bump-cask-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-cask-pr.rb @@ -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` [] - + description <<~EOS Create a pull request to update with a new version. A best effort to determine the will be made if the value is not diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index c038cf9d99..39ed6de9a0 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -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` [] [] - + description <<~EOS Create a pull request to update with a new URL or a new tag. If a is specified, the checksum of the new download should also diff --git a/Library/Homebrew/dev-cmd/bump-revision.rb b/Library/Homebrew/dev-cmd/bump-revision.rb index c15adc09d1..727eb968b3 100644 --- a/Library/Homebrew/dev-cmd/bump-revision.rb +++ b/Library/Homebrew/dev-cmd/bump-revision.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def bump_revision_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `bump-revision` [] [ ...] - + description <<~EOS Create a commit to increment the revision of . If no revision is present, "revision 1" will be added. EOS diff --git a/Library/Homebrew/dev-cmd/bump-unversioned-casks.rb b/Library/Homebrew/dev-cmd/bump-unversioned-casks.rb index 00a29fb6c5..abc690767c 100644 --- a/Library/Homebrew/dev-cmd/bump-unversioned-casks.rb +++ b/Library/Homebrew/dev-cmd/bump-unversioned-casks.rb @@ -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` [] | [| ...] - + description <<~EOS Check all casks with unversioned URLs in a given for updates. EOS switch "-n", "--dry-run", diff --git a/Library/Homebrew/dev-cmd/bump.rb b/Library/Homebrew/dev-cmd/bump.rb index a5bec363b4..79a5216b35 100644 --- a/Library/Homebrew/dev-cmd/bump.rb +++ b/Library/Homebrew/dev-cmd/bump.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def bump_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `bump` [] [] [ ...] - + 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 diff --git a/Library/Homebrew/dev-cmd/cat.rb b/Library/Homebrew/dev-cmd/cat.rb index 6c49fd8fab..e8c521974f 100644 --- a/Library/Homebrew/dev-cmd/cat.rb +++ b/Library/Homebrew/dev-cmd/cat.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def cat_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `cat` | - + description <<~EOS Display the source of a or . EOS diff --git a/Library/Homebrew/dev-cmd/command.rb b/Library/Homebrew/dev-cmd/command.rb index 48f0384e14..0a9aa85bfa 100644 --- a/Library/Homebrew/dev-cmd/command.rb +++ b/Library/Homebrew/dev-cmd/command.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def command_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `command` [ ...] - + description <<~EOS Display the path to the file being used when invoking `brew` . EOS diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index 3e9fbc359d..1fa947fdce 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -16,9 +16,7 @@ module Homebrew sig { returns(CLI::Parser) } def create_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `create` [] - + description <<~EOS Generate a formula or, with `--cask`, a cask for the downloadable file at 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 diff --git a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb index f160bd8696..7fd1a133ca 100644 --- a/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb +++ b/Library/Homebrew/dev-cmd/dispatch-build-bottle.rb @@ -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` [] [ ...] - + description <<~EOS Build bottles for these formulae with GitHub Actions. EOS flag "--tap=", diff --git a/Library/Homebrew/dev-cmd/diy.rb b/Library/Homebrew/dev-cmd/diy.rb index 484cd531f7..64a37f337b 100644 --- a/Library/Homebrew/dev-cmd/diy.rb +++ b/Library/Homebrew/dev-cmd/diy.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def diy_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `diy` [] - + 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`. diff --git a/Library/Homebrew/dev-cmd/edit.rb b/Library/Homebrew/dev-cmd/edit.rb index 4e6a1edae5..54ab8e650c 100644 --- a/Library/Homebrew/dev-cmd/edit.rb +++ b/Library/Homebrew/dev-cmd/edit.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def edit_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `edit` [|] [| ...] - + description <<~EOS Open a or in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no formula is provided. EOS diff --git a/Library/Homebrew/dev-cmd/extract.rb b/Library/Homebrew/dev-cmd/extract.rb index 7cb5c238da..59a9519b67 100644 --- a/Library/Homebrew/dev-cmd/extract.rb +++ b/Library/Homebrew/dev-cmd/extract.rb @@ -83,9 +83,7 @@ module Homebrew sig { returns(CLI::Parser) } def extract_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `extract` [] - + description <<~EOS Look through repository history to find the most recent version of and create a copy in `/Formula/``@``.rb`. If the tap is not installed yet, attempt to install/clone the tap before continuing. To extract diff --git a/Library/Homebrew/dev-cmd/formula.rb b/Library/Homebrew/dev-cmd/formula.rb index 0091f62a06..a2ba3be2b5 100644 --- a/Library/Homebrew/dev-cmd/formula.rb +++ b/Library/Homebrew/dev-cmd/formula.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def formula_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `formula` [ ...] - + description <<~EOS Display the path where is located. EOS diff --git a/Library/Homebrew/dev-cmd/install-bundler-gems.rb b/Library/Homebrew/dev-cmd/install-bundler-gems.rb index 419e5eee6c..73ba1f7f49 100644 --- a/Library/Homebrew/dev-cmd/install-bundler-gems.rb +++ b/Library/Homebrew/dev-cmd/install-bundler-gems.rb @@ -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 diff --git a/Library/Homebrew/dev-cmd/irb.rb b/Library/Homebrew/dev-cmd/irb.rb index 2ba4d7781f..6fae810920 100644 --- a/Library/Homebrew/dev-cmd/irb.rb +++ b/Library/Homebrew/dev-cmd/irb.rb @@ -24,9 +24,7 @@ module Homebrew sig { returns(CLI::Parser) } def irb_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `irb` [] - + description <<~EOS Enter the interactive Homebrew Ruby shell. EOS switch "--examples", diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb index e1717c23b2..d907aee83f 100644 --- a/Library/Homebrew/dev-cmd/linkage.rb +++ b/Library/Homebrew/dev-cmd/linkage.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def linkage_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `linkage` [] [] [ ...] - + description <<~EOS Check the library links from the given kegs. If no are provided, check all kegs. Raises an error if run on uninstalled formulae. EOS diff --git a/Library/Homebrew/dev-cmd/livecheck.rb b/Library/Homebrew/dev-cmd/livecheck.rb index 2029b97988..921ad451f5 100644 --- a/Library/Homebrew/dev-cmd/livecheck.rb +++ b/Library/Homebrew/dev-cmd/livecheck.rb @@ -19,9 +19,7 @@ module Homebrew sig { returns(CLI::Parser) } def livecheck_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `livecheck` [|] [| ...] - + 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 diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index be2fadd234..c930124f77 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -19,9 +19,7 @@ module Homebrew sig { returns(CLI::Parser) } def man_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `man` [] - + description <<~EOS Generate Homebrew's manpages. EOS switch "--fail-if-changed", diff --git a/Library/Homebrew/dev-cmd/mirror.rb b/Library/Homebrew/dev-cmd/mirror.rb index aa4af5a9f1..69ad32a811 100644 --- a/Library/Homebrew/dev-cmd/mirror.rb +++ b/Library/Homebrew/dev-cmd/mirror.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def mirror_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `mirror` [ ...] - + description <<~EOS Reupload the stable URL of a formula to Bintray for use as a mirror. EOS flag "--bintray-org=", diff --git a/Library/Homebrew/dev-cmd/pr-automerge.rb b/Library/Homebrew/dev-cmd/pr-automerge.rb index 0e582b168a..1c8bfaba26 100644 --- a/Library/Homebrew/dev-cmd/pr-automerge.rb +++ b/Library/Homebrew/dev-cmd/pr-automerge.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def pr_automerge_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `pr-automerge` [] - + description <<~EOS Find pull requests that can be automatically merged using `brew pr-publish`. EOS flag "--tap=", diff --git a/Library/Homebrew/dev-cmd/pr-publish.rb b/Library/Homebrew/dev-cmd/pr-publish.rb index dc2e747277..82876b9c63 100644 --- a/Library/Homebrew/dev-cmd/pr-publish.rb +++ b/Library/Homebrew/dev-cmd/pr-publish.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def pr_publish_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `pr-publish` [] [ ...] - + 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 diff --git a/Library/Homebrew/dev-cmd/pr-pull.rb b/Library/Homebrew/dev-cmd/pr-pull.rb index 1f89438e04..d71d65aca2 100644 --- a/Library/Homebrew/dev-cmd/pr-pull.rb +++ b/Library/Homebrew/dev-cmd/pr-pull.rb @@ -15,9 +15,7 @@ module Homebrew sig { returns(CLI::Parser) } def pr_pull_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `pr-pull` [] [ ...] - + 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 diff --git a/Library/Homebrew/dev-cmd/pr-upload.rb b/Library/Homebrew/dev-cmd/pr-upload.rb index 584696d4e4..a710ab7a96 100644 --- a/Library/Homebrew/dev-cmd/pr-upload.rb +++ b/Library/Homebrew/dev-cmd/pr-upload.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def pr_upload_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `pr-upload` [] - + description <<~EOS Apply the bottle commit and publish bottles to Bintray or GitHub Releases. EOS switch "--no-publish", diff --git a/Library/Homebrew/dev-cmd/prof.rb b/Library/Homebrew/dev-cmd/prof.rb index 368ba90d26..1689215b0c 100644 --- a/Library/Homebrew/dev-cmd/prof.rb +++ b/Library/Homebrew/dev-cmd/prof.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def prof_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `prof` [] - + description <<~EOS Run Homebrew with a Ruby profiler, e.g. `brew prof readall`. EOS switch "--stackprof", diff --git a/Library/Homebrew/dev-cmd/release-notes.rb b/Library/Homebrew/dev-cmd/release-notes.rb index c09eb35031..53df526193 100644 --- a/Library/Homebrew/dev-cmd/release-notes.rb +++ b/Library/Homebrew/dev-cmd/release-notes.rb @@ -11,9 +11,8 @@ module Homebrew sig { returns(CLI::Parser) } def release_notes_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `release-notes` [] [] [] - + usage_banner "`release-notes` [] [] []" + description <<~EOS Print the merged pull requests on Homebrew/brew between two Git refs. If no is provided it defaults to the latest tag. If no is provided it defaults to `origin/master`. diff --git a/Library/Homebrew/dev-cmd/ruby.rb b/Library/Homebrew/dev-cmd/ruby.rb index d696e997a5..eac6ea45ea 100644 --- a/Library/Homebrew/dev-cmd/ruby.rb +++ b/Library/Homebrew/dev-cmd/ruby.rb @@ -11,9 +11,8 @@ module Homebrew sig { returns(CLI::Parser) } def ruby_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `ruby` (`-e` |) - + usage_banner "`ruby` [] (`-e` |)" + 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 diff --git a/Library/Homebrew/dev-cmd/sh.rb b/Library/Homebrew/dev-cmd/sh.rb index c8ee8ff7bb..6a693eff4f 100644 --- a/Library/Homebrew/dev-cmd/sh.rb +++ b/Library/Homebrew/dev-cmd/sh.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def sh_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `sh` [] [] - + 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 diff --git a/Library/Homebrew/dev-cmd/sponsors.rb b/Library/Homebrew/dev-cmd/sponsors.rb index 27bf7ba277..85e0daec19 100644 --- a/Library/Homebrew/dev-cmd/sponsors.rb +++ b/Library/Homebrew/dev-cmd/sponsors.rb @@ -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 diff --git a/Library/Homebrew/dev-cmd/style.rb b/Library/Homebrew/dev-cmd/style.rb index 921d09d150..ea782c7db1 100644 --- a/Library/Homebrew/dev-cmd/style.rb +++ b/Library/Homebrew/dev-cmd/style.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def style_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `style` [] [|||] [||| ...] - + description <<~EOS Check formulae or files for conformance to Homebrew style guidelines. Lists of , and 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 diff --git a/Library/Homebrew/dev-cmd/tap-new.rb b/Library/Homebrew/dev-cmd/tap-new.rb index 6996c0deb4..6d01a3ee9a 100644 --- a/Library/Homebrew/dev-cmd/tap-new.rb +++ b/Library/Homebrew/dev-cmd/tap-new.rb @@ -12,9 +12,8 @@ module Homebrew sig { returns(CLI::Parser) } def tap_new_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `tap-new` [] `/` - + usage_banner "`tap-new` [] `/`" + description <<~EOS Generate the template files for a new tap. EOS diff --git a/Library/Homebrew/dev-cmd/test.rb b/Library/Homebrew/dev-cmd/test.rb index 290ebe636d..271c682b93 100644 --- a/Library/Homebrew/dev-cmd/test.rb +++ b/Library/Homebrew/dev-cmd/test.rb @@ -14,9 +14,7 @@ module Homebrew sig { returns(CLI::Parser) } def test_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `test` [] [ ...] - + 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. diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index cf98431b93..ef58dd8bd7 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def tests_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `tests` [] - + description <<~EOS Run Homebrew's unit and integration tests. EOS switch "--coverage", diff --git a/Library/Homebrew/dev-cmd/typecheck.rb b/Library/Homebrew/dev-cmd/typecheck.rb index ccbe230b78..178ce4a475 100644 --- a/Library/Homebrew/dev-cmd/typecheck.rb +++ b/Library/Homebrew/dev-cmd/typecheck.rb @@ -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", diff --git a/Library/Homebrew/dev-cmd/unbottled.rb b/Library/Homebrew/dev-cmd/unbottled.rb index 2188a77d52..32bf39921a 100644 --- a/Library/Homebrew/dev-cmd/unbottled.rb +++ b/Library/Homebrew/dev-cmd/unbottled.rb @@ -12,9 +12,7 @@ module Homebrew sig { returns(CLI::Parser) } def unbottled_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `unbottled` [] [ ...] - + description <<~EOS Outputs the unbottled dependents of formulae. EOS flag "--tag=", diff --git a/Library/Homebrew/dev-cmd/unpack.rb b/Library/Homebrew/dev-cmd/unpack.rb index b586ad64c5..14f9a2e0af 100644 --- a/Library/Homebrew/dev-cmd/unpack.rb +++ b/Library/Homebrew/dev-cmd/unpack.rb @@ -13,9 +13,7 @@ module Homebrew sig { returns(CLI::Parser) } def unpack_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `unpack` [] [] - + description <<~EOS Unpack the source files for into subdirectories of the current working directory. EOS diff --git a/Library/Homebrew/dev-cmd/update-license-data.rb b/Library/Homebrew/dev-cmd/update-license-data.rb index 284ee6842c..158596937c 100644 --- a/Library/Homebrew/dev-cmd/update-license-data.rb +++ b/Library/Homebrew/dev-cmd/update-license-data.rb @@ -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` [] - - 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 " \ diff --git a/Library/Homebrew/dev-cmd/update-python-resources.rb b/Library/Homebrew/dev-cmd/update-python-resources.rb index 2f7de56886..654061c263 100644 --- a/Library/Homebrew/dev-cmd/update-python-resources.rb +++ b/Library/Homebrew/dev-cmd/update-python-resources.rb @@ -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` [] [ ...] - + description <<~EOS Update versions for PyPI resource blocks in . EOS switch "-p", "--print-only", diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index 3659375d1e..3de5641385 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -11,9 +11,7 @@ module Homebrew sig { returns(CLI::Parser) } def update_test_args Homebrew::CLI::Parser.new do - usage_banner <<~EOS - `update-test` [] - + 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 diff --git a/Library/Homebrew/dev-cmd/vendor-gems.rb b/Library/Homebrew/dev-cmd/vendor-gems.rb index 1047daa96d..56e1de3a48 100644 --- a/Library/Homebrew/dev-cmd/vendor-gems.rb +++ b/Library/Homebrew/dev-cmd/vendor-gems.rb @@ -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 diff --git a/docs/Manpage.md b/docs/Manpage.md index d5a54bbf3f..7cb09d7aad 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -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 . @@ -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 . @@ -105,12 +105,12 @@ Read more at . `brew completions` (`link`|`unlink`)
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: -### `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`* [] +### `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. diff --git a/manpages/brew.1 b/manpages/brew.1 index 55be99d871..1596ea1c24 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -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\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 []" +.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