diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb index eda01f6274..9d6e4b3314 100644 --- a/Library/Homebrew/cli/parser.rb +++ b/Library/Homebrew/cli/parser.rb @@ -208,11 +208,15 @@ module Homebrew return if global_switch description = option_description(description, *names, hidden:) - process_option(*names, description, type: :switch, hidden:) unless disable - + env, counterpart = env + if env && @non_global_processed_options.any? + affix = counterpart ? " and `#{counterpart}` is passed." : "." + description += " Enabled by default if `$HOMEBREW_#{env.upcase}` is set#{affix}" + end if replacement || disable description += " (#{disable ? "disabled" : "deprecated"}#{"; replaced by #{replacement}" if replacement})" end + process_option(*names, description, type: :switch, hidden:) unless disable @parser.public_send(method, *names, *wrap_option_desc(description)) do |value| # This odeprecated should stick around indefinitely. diff --git a/Library/Homebrew/cmd/bundle.rb b/Library/Homebrew/cmd/bundle.rb index 4dfb7a60f0..122341a741 100755 --- a/Library/Homebrew/cmd/bundle.rb +++ b/Library/Homebrew/cmd/bundle.rb @@ -73,11 +73,10 @@ module Homebrew description: "`install` prints output from commands as they are run. " \ "`check` lists all missing dependencies." switch "--no-upgrade", - env: :bundle_no_upgrade, description: "`install` does not run `brew upgrade` on outdated dependencies. " \ "`check` does not check for outdated dependencies. " \ - "Note they may still be upgraded by `brew install` if needed. " \ - "This is enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set." + "Note they may still be upgraded by `brew install` if needed.", + env: :bundle_no_upgrade switch "--upgrade", description: "`install` runs `brew upgrade` on outdated dependencies, " \ "even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set." @@ -87,18 +86,15 @@ module Homebrew switch "--install", description: "Run `install` before continuing to other operations e.g. `exec`." switch "--services", - env: :bundle_services, - description: "Temporarily start services while running the `exec` or `sh` command. " \ - "This is enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set." + description: "Temporarily start services while running the `exec` or `sh` command.", + env: :bundle_services switch "-f", "--force", description: "`install` runs with `--force`/`--overwrite`. " \ "`dump` overwrites an existing `Brewfile`. " \ "`cleanup` actually performs its cleanup operations." switch "--cleanup", - env: :bundle_install_cleanup, - description: "`install` performs cleanup operation, same as running `cleanup --force`. " \ - "This is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and " \ - "`--global` is passed." + description: "`install` performs cleanup operation, same as running `cleanup --force`.", + env: [:bundle_install_cleanup, "--global"] switch "--all", description: "`list` all dependencies." switch "--formula", "--brews", @@ -114,14 +110,12 @@ module Homebrew switch "--vscode", description: "`list`, `dump` or `cleanup` VSCode (and forks/variants) extensions." switch "--no-vscode", - env: :bundle_dump_no_vscode, - description: "`dump` without VSCode (and forks/variants) extensions. " \ - "This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set." + description: "`dump` without VSCode (and forks/variants) extensions.", + env: :bundle_dump_no_vscode switch "--describe", - env: :bundle_dump_describe, description: "`dump` adds a description comment above each line, unless the " \ - "dependency does not have a description. " \ - "This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set." + "dependency does not have a description.", + env: :bundle_dump_describe switch "--no-restart", description: "`dump` does not add `restart_service` to formula lines." switch "--zap", diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 517414f9fe..ee695c1b43 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -33,8 +33,8 @@ module Homebrew description: "If brewing fails, open an interactive debugging session with access to IRB " \ "or a shell inside the temporary build directory." switch "--display-times", - env: :display_install_times, - description: "Print install times for each package at the end of the run." + description: "Print install times for each package at the end of the run.", + env: :display_install_times switch "-f", "--force", description: "Install formulae without checking for previously installed keg-only or " \ "non-migrated versions. When installing casks, overwrite existing files " \ @@ -44,9 +44,9 @@ module Homebrew switch "-n", "--dry-run", description: "Show what would be installed, but do not actually install anything." switch "--ask", - env: :ask, description: "Ask for confirmation before downloading and installing formulae. " \ - "Print bottles and dependencies download size and install size." + "Print download and install sizes of bottles and dependencies.", + env: :ask [ [:switch, "--formula", "--formulae", { description: "Treat all named arguments as formulae.", diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index 3acc2fcf84..6b4d81f179 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -32,12 +32,10 @@ module Homebrew "formula is outdated. Otherwise, the repository's HEAD will only be checked for " \ "updates when a new stable or development version has been released." switch "-g", "--greedy", - env: :upgrade_greedy, - description: "Also include outdated casks with `auto_updates true` or `version :latest`." - + description: "Also include outdated casks with `auto_updates true` or `version :latest`.", + env: :upgrade_greedy switch "--greedy-latest", description: "Also include outdated casks including those with `version :latest`." - switch "--greedy-auto-updates", description: "Also include outdated casks including those with `auto_updates true`." diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index 2c1208e54a..f6361ec689 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -32,8 +32,8 @@ module Homebrew description: "If brewing fails, open an interactive debugging session with access to IRB " \ "or a shell inside the temporary build directory." switch "--display-times", - env: :display_install_times, - description: "Print install times for each package at the end of the run." + description: "Print install times for each package at the end of the run.", + env: :display_install_times switch "-f", "--force", description: "Install without checking for previously installed keg-only or " \ "non-migrated versions." @@ -41,7 +41,7 @@ module Homebrew description: "Print the verification and post-install steps." switch "--ask", description: "Ask for confirmation before downloading and upgrading formulae. " \ - "Print bottles and dependencies download size, install and net install size.", + "Print download, install and net install sizes of bottles and dependencies.", env: :ask [ [:switch, "--formula", "--formulae", { description: "Treat all named arguments as formulae." }], diff --git a/Library/Homebrew/cmd/shellenv.rb b/Library/Homebrew/cmd/shellenv.rb index 03c530f502..6e5c959046 100644 --- a/Library/Homebrew/cmd/shellenv.rb +++ b/Library/Homebrew/cmd/shellenv.rb @@ -13,18 +13,20 @@ module Homebrew description <<~EOS Valid shells: bash|csh|fish|pwsh|sh|tcsh|zsh - Print export statements. When run in a shell, this installation of Homebrew will be added to your `PATH`, `MANPATH`, and `INFOPATH`. + Print export statements. When run in a shell, this installation of Homebrew will be added to your + `$PATH`, `$MANPATH`, and `$INFOPATH`. The variables `$HOMEBREW_PREFIX`, `$HOMEBREW_CELLAR` and `$HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times. To help guarantee idempotence, this command produces no output when Homebrew's `bin` and `sbin` directories - are first and second respectively in your `PATH`. Consider adding evaluation of this command's output to + are first and second respectively in your `$PATH`. Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.bash_profile` or ~/.zprofile` on macOS and ~/.bashrc` or ~/.zshrc` on Linux) with: `eval "$(brew shellenv)"` The shell can be specified explicitly with a supported shell name parameter. Unknown shells will output POSIX exports. EOS + named_args :shell end end diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb index 9895706138..d1880ea4bd 100644 --- a/Library/Homebrew/cmd/upgrade.rb +++ b/Library/Homebrew/cmd/upgrade.rb @@ -29,8 +29,8 @@ module Homebrew description: "If brewing fails, open an interactive debugging session with access to IRB " \ "or a shell inside the temporary build directory." switch "--display-times", - env: :display_install_times, - description: "Print install times for each package at the end of the run." + description: "Print install times for each package at the end of the run.", + env: :display_install_times switch "-f", "--force", description: "Install formulae without checking for previously installed keg-only or " \ "non-migrated versions. When installing casks, overwrite existing files " \ @@ -41,7 +41,7 @@ module Homebrew description: "Show what would be upgraded, but do not actually upgrade anything." switch "--ask", description: "Ask for confirmation before downloading and upgrading formulae. " \ - "Print bottles and dependencies download size, install and net install size.", + "Print download, install and net install sizes of bottles and dependencies.", env: :ask [ [:switch, "--formula", "--formulae", { diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index 24e69cb463..7b20891797 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -43,7 +43,7 @@ module Homebrew description: "Only check formulae and casks that are currently installed." switch "--eval-all", description: "Evaluate all available formulae and casks, whether installed or not, to audit them. " \ - "Implied if `HOMEBREW_EVAL_ALL` is set." + "Implied if `$HOMEBREW_EVAL_ALL` is set." switch "--new", description: "Run various additional style checks to determine if a new formula or cask is eligible " \ "for Homebrew. This should be used when creating new formulae or casks and implies " \ diff --git a/Library/Homebrew/dev-cmd/bump.rb b/Library/Homebrew/dev-cmd/bump.rb index e9422d9e56..1d510088fa 100644 --- a/Library/Homebrew/dev-cmd/bump.rb +++ b/Library/Homebrew/dev-cmd/bump.rb @@ -118,7 +118,7 @@ module Homebrew else raise UsageError, "`brew bump` without named arguments needs `--installed` or `--eval-all` passed or " \ - "`HOMEBREW_EVAL_ALL` set!" + "`$HOMEBREW_EVAL_ALL` set!" end if args.start_with diff --git a/Library/Homebrew/dev-cmd/determine-test-runners.rb b/Library/Homebrew/dev-cmd/determine-test-runners.rb index 39449ea83f..52757b3f8d 100644 --- a/Library/Homebrew/dev-cmd/determine-test-runners.rb +++ b/Library/Homebrew/dev-cmd/determine-test-runners.rb @@ -21,7 +21,8 @@ module Homebrew "dependents.", env: :eval_all switch "--dependents", - description: "Determine runners for testing dependents. Requires `--eval-all` or `HOMEBREW_EVAL_ALL`.", + description: "Determine runners for testing dependents. " \ + "Requires `--eval-all` or `$HOMEBREW_EVAL_ALL` to be set.", depends_on: "--eval-all" named_args max: 2 diff --git a/Library/Homebrew/dev-cmd/edit.rb b/Library/Homebrew/dev-cmd/edit.rb index d88d603735..bee0caf795 100644 --- a/Library/Homebrew/dev-cmd/edit.rb +++ b/Library/Homebrew/dev-cmd/edit.rb @@ -9,10 +9,9 @@ module Homebrew class Edit < AbstractCommand cmd_args do description <<~EOS - Open a , or in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, + Open a , or in the editor set by `$EDITOR` or `$HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided. EOS - switch "--formula", "--formulae", description: "Treat all named arguments as formulae." switch "--cask", "--casks", diff --git a/Library/Homebrew/dev-cmd/irb.rb b/Library/Homebrew/dev-cmd/irb.rb index 31cf968bcc..55107b78c1 100644 --- a/Library/Homebrew/dev-cmd/irb.rb +++ b/Library/Homebrew/dev-cmd/irb.rb @@ -44,8 +44,8 @@ module Homebrew switch "--examples", description: "Show several examples." switch "--pry", - env: :pry, - description: "Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set." + description: "Use Pry instead of IRB.", + env: :pry end # work around IRB modifying ARGV. diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb index 23462cc98a..73ce789aed 100644 --- a/Library/Homebrew/dev-cmd/linkage.rb +++ b/Library/Homebrew/dev-cmd/linkage.rb @@ -23,7 +23,7 @@ module Homebrew description: "For every library that a keg references, print its dylib path followed by the " \ "binaries that link to it." switch "--cached", - description: "Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous " \ + description: "Print the cached linkage values stored in `$HOMEBREW_CACHE`, set by a previous " \ "`brew linkage` run." named_args :installed_formula diff --git a/Library/Homebrew/dev-cmd/livecheck.rb b/Library/Homebrew/dev-cmd/livecheck.rb index dee478de47..af56300ab9 100644 --- a/Library/Homebrew/dev-cmd/livecheck.rb +++ b/Library/Homebrew/dev-cmd/livecheck.rb @@ -13,7 +13,7 @@ module Homebrew 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 - casks to check is taken from `HOMEBREW_LIVECHECK_WATCHLIST` or + casks to check is taken from `$HOMEBREW_LIVECHECK_WATCHLIST` or `~/.homebrew/livecheck_watchlist.txt`. EOS switch "--full-name", diff --git a/Library/Homebrew/dev-cmd/sh.rb b/Library/Homebrew/dev-cmd/sh.rb index c6161dd1ad..2ba18a56e9 100644 --- a/Library/Homebrew/dev-cmd/sh.rb +++ b/Library/Homebrew/dev-cmd/sh.rb @@ -13,11 +13,11 @@ module Homebrew Enter an interactive shell for Homebrew's build environment. Use years-battle-hardened build logic to help your `./configure && make && make install` and even your `gem install` succeed. Especially handy if you run Homebrew - in an Xcode-only configuration since it adds tools like `make` to your `PATH` + in an Xcode-only configuration since it adds tools like `make` to your `$PATH` which build systems would not find otherwise. EOS flag "--env=", - description: "Use the standard `PATH` instead of superenv's when `std` is passed." + description: "Use the standard `$PATH` instead of superenv's when `std` is passed." flag "-c=", "--cmd=", description: "Execute commands in a non-interactive shell." diff --git a/Library/Homebrew/dev-cmd/unbottled.rb b/Library/Homebrew/dev-cmd/unbottled.rb index 3fb1880093..d439868d22 100644 --- a/Library/Homebrew/dev-cmd/unbottled.rb +++ b/Library/Homebrew/dev-cmd/unbottled.rb @@ -23,7 +23,7 @@ module Homebrew description: "Print the `homebrew/core` commits where bottles were lost in the last week." switch "--eval-all", description: "Evaluate all available formulae and casks, whether installed or not, to check them. " \ - "Implied if `HOMEBREW_EVAL_ALL` is set." + "Implied if `$HOMEBREW_EVAL_ALL` is set." conflicts "--dependents", "--total", "--lost" @@ -68,7 +68,7 @@ module Homebrew all = args.eval_all? if args.total? if !all && !Homebrew::EnvConfig.eval_all? - raise UsageError, "`brew unbottled --total` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!" + raise UsageError, "`brew unbottled --total` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!" end all = true @@ -119,7 +119,7 @@ module Homebrew elsif args.dependents? if !args.eval_all? && !Homebrew::EnvConfig.eval_all? raise UsageError, - "`brew unbottled --dependents` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!" + "`brew unbottled --dependents` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!" end formulae = all_formulae = Formula.all(eval_all: args.eval_all?) @@ -136,7 +136,7 @@ module Homebrew if analytics.blank? raise UsageError, "default sort by analytics data requires " \ - "`HOMEBREW_NO_GITHUB_API` and `HOMEBREW_NO_ANALYTICS` to be unset" + "`$HOMEBREW_NO_GITHUB_API` and `$HOMEBREW_NO_ANALYTICS` to be unset." end formulae = analytics["items"].filter_map do |i| diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index eb975b73fd..45a0257797 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -15,7 +15,7 @@ module Homebrew If no options are passed, use `origin/master` as the start commit. EOS switch "--to-tag", - description: "Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags." + description: "Set `$HOMEBREW_UPDATE_TO_TAG` to test updating between tags." switch "--keep-tmp", description: "Retain the temporary directory containing the new repository clone." flag "--commit=", diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb index 7fc446340d..1af588add6 100644 --- a/Library/Homebrew/env_config.rb +++ b/Library/Homebrew/env_config.rb @@ -463,7 +463,7 @@ module Homebrew default_text: "`~/.ssh/config`", }, HOMEBREW_SUDO_THROUGH_SUDO_USER: { - description: "If set, Homebrew will use the `SUDO_USER` environment variable to define the user to " \ + description: "If set, Homebrew will use the `$SUDO_USER` environment variable to define the user to " \ "`sudo`(8) through when running `sudo`(8).", boolean: true, }, diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index d3b0173d8a..13461256a3 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -133,7 +133,7 @@ If no search term is provided, all locally available formulae are listed. ## CUSTOM EXTERNAL COMMANDS Homebrew, like `git`(1), supports external commands. These are executable -scripts that reside somewhere in the `PATH`, named `brew-` or +scripts that reside somewhere in the `$PATH`, named `brew-` or `brew-``.rb`, which can be invoked like `brew` . This allows you to create your own commands without modifying Homebrew's internals. @@ -184,7 +184,7 @@ files: User-specific environment files take precedence over prefix-specific files and prefix-specific files take precedence over system-wide files (unless -`HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below). +`$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below). Note that these files do not support shell variable expansion e.g. `$HOME` or command execution e.g. `$(cat file)`. diff --git a/completions/fish/brew.fish b/completions/fish/brew.fish index 0457b6dd6a..8a0face365 100644 --- a/completions/fish/brew.fish +++ b/completions/fish/brew.fish @@ -344,7 +344,7 @@ __fish_brew_complete_arg 'audit' -l audit-debug -d 'Enable debugging and profili __fish_brew_complete_arg 'audit' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'audit' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'audit' -l display-filename -d 'Prefix every line of output with the file or formula name being audited, to make output easy to grep' -__fish_brew_complete_arg 'audit' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `HOMEBREW_EVAL_ALL` is set' +__fish_brew_complete_arg 'audit' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `$HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'audit' -l except -d 'Specify a comma-separated method list to skip running the methods named `audit_`method' __fish_brew_complete_arg 'audit' -l except-cops -d 'Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops' __fish_brew_complete_arg 'audit' -l fix -d 'Fix style violations automatically using RuboCop\'s auto-correct feature' @@ -508,9 +508,9 @@ __fish_brew_complete_sub_cmd 'bundle' 'edit' __fish_brew_complete_arg 'bundle' -l all -d '`list` all dependencies' __fish_brew_complete_arg 'bundle' -l cask -d '`list`, `dump` or `cleanup` Homebrew cask dependencies' __fish_brew_complete_arg 'bundle' -l check -d 'Check that all dependencies in the Brewfile are installed before running `exec`, `sh`, or `env`' -__fish_brew_complete_arg 'bundle' -l cleanup -d '`install` performs cleanup operation, same as running `cleanup --force`. This is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed' +__fish_brew_complete_arg 'bundle' -l cleanup -d '`install` performs cleanup operation, same as running `cleanup --force`. Enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed' __fish_brew_complete_arg 'bundle' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'bundle' -l describe -d '`dump` adds a description comment above each line, unless the dependency does not have a description. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set' +__fish_brew_complete_arg 'bundle' -l describe -d '`dump` adds a description comment above each line, unless the dependency does not have a description. Enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set' __fish_brew_complete_arg 'bundle' -l file -d 'Read from or write to the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout' __fish_brew_complete_arg 'bundle' -l force -d '`install` runs with `--force`/`--overwrite`. `dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations' __fish_brew_complete_arg 'bundle' -l formula -d '`list`, `dump` or `cleanup` Homebrew formula dependencies' @@ -519,10 +519,10 @@ __fish_brew_complete_arg 'bundle' -l help -d 'Show this message' __fish_brew_complete_arg 'bundle' -l install -d 'Run `install` before continuing to other operations e.g. `exec`' __fish_brew_complete_arg 'bundle' -l mas -d '`list` or `dump` Mac App Store dependencies' __fish_brew_complete_arg 'bundle' -l no-restart -d '`dump` does not add `restart_service` to formula lines' -__fish_brew_complete_arg 'bundle' -l no-upgrade -d '`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. This is enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set' -__fish_brew_complete_arg 'bundle' -l no-vscode -d '`dump` without VSCode (and forks/variants) extensions. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set' +__fish_brew_complete_arg 'bundle' -l no-upgrade -d '`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. Enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set' +__fish_brew_complete_arg 'bundle' -l no-vscode -d '`dump` without VSCode (and forks/variants) extensions. Enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set' __fish_brew_complete_arg 'bundle' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'bundle' -l services -d 'Temporarily start services while running the `exec` or `sh` command. This is enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set' +__fish_brew_complete_arg 'bundle' -l services -d 'Temporarily start services while running the `exec` or `sh` command. Enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set' __fish_brew_complete_arg 'bundle' -l tap -d '`list`, `dump` or `cleanup` Homebrew tap dependencies' __fish_brew_complete_arg 'bundle' -l upgrade -d '`install` runs `brew upgrade` on outdated dependencies, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set' __fish_brew_complete_arg 'bundle' -l upgrade-formulae -d '`install` runs `brew upgrade` on any of these comma-separated formulae, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set' @@ -694,8 +694,8 @@ __fish_brew_complete_arg 'desc; and not __fish_seen_argument -l formula -l formu __fish_brew_complete_cmd 'determine-test-runners' 'Determines the runners used to test formulae or their dependents' __fish_brew_complete_arg 'determine-test-runners' -l all-supported -d 'Instead of selecting runners based on the chosen formula, return all supported runners' __fish_brew_complete_arg 'determine-test-runners' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'determine-test-runners' -l dependents -d 'Determine runners for testing dependents. Requires `--eval-all` or `HOMEBREW_EVAL_ALL`' -__fish_brew_complete_arg 'determine-test-runners' -l eval-all -d 'Evaluate all available formulae, whether installed or not, to determine testing dependents' +__fish_brew_complete_arg 'determine-test-runners' -l dependents -d 'Determine runners for testing dependents. Requires `--eval-all` or `$HOMEBREW_EVAL_ALL` to be set' +__fish_brew_complete_arg 'determine-test-runners' -l eval-all -d 'Evaluate all available formulae, whether installed or not, to determine testing dependents. Enabled by default if `$HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'determine-test-runners' -l help -d 'Show this message' __fish_brew_complete_arg 'determine-test-runners' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'determine-test-runners' -l verbose -d 'Make some output more verbose' @@ -756,7 +756,7 @@ __fish_brew_complete_arg 'dr' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'dr' -a '(__fish_brew_suggest_diagnostic_checks)' -__fish_brew_complete_cmd 'edit' 'Open a formula, cask or tap in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided' +__fish_brew_complete_cmd 'edit' 'Open a formula, cask or tap in the editor set by `$EDITOR` or `$HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided' __fish_brew_complete_arg 'edit' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'edit' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'edit' -l formula -d 'Treat all named arguments as formulae' @@ -804,9 +804,9 @@ __fish_brew_complete_arg 'fetch' -l force -d 'Remove a previously cached version __fish_brew_complete_arg 'fetch' -l force-bottle -d 'Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation' __fish_brew_complete_arg 'fetch' -l formula -d 'Treat all named arguments as formulae' __fish_brew_complete_arg 'fetch' -l help -d 'Show this message' -__fish_brew_complete_arg 'fetch' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'fetch' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'fetch' -l os -d 'Download for the given operating system. (Pass `all` to download for all operating systems.)' -__fish_brew_complete_arg 'fetch' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'fetch' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'fetch' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'fetch' -l retry -d 'Retry if downloading fails or re-download if the checksum of a previously cached version no longer matches. Tries at most 5 times with exponential backoff' __fish_brew_complete_arg 'fetch' -l verbose -d 'Do a verbose VCS checkout, if the URL represents a VCS. This is useful for seeing if an existing VCS cache has been updated' @@ -952,9 +952,9 @@ __fish_brew_complete_arg 'instal' -l HEAD -d 'If formula defines it, install the __fish_brew_complete_arg 'instal' -l adopt -d 'Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`' __fish_brew_complete_arg 'instal' -l appdir -d 'Target location for Applications (default: `/Applications`)' __fish_brew_complete_arg 'instal' -l as-dependency -d 'Install but mark as installed as a dependency and not installed on request' -__fish_brew_complete_arg 'instal' -l ask -d 'Ask for confirmation before downloading and installing formulae. Print bottles and dependencies download size and install size' +__fish_brew_complete_arg 'instal' -l ask -d 'Ask for confirmation before downloading and installing formulae. Print download and install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set' __fish_brew_complete_arg 'instal' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)' -__fish_brew_complete_arg 'instal' -l binaries -d 'Disable/enable linking of helper executables (default: enabled)' +__fish_brew_complete_arg 'instal' -l binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' __fish_brew_complete_arg 'instal' -l bottle-arch -d 'Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on' __fish_brew_complete_arg 'instal' -l build-bottle -d 'Prepare the formula for eventual bottling during installation, skipping any post-install steps' __fish_brew_complete_arg 'instal' -l build-from-source -d 'Compile formula from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available' @@ -964,7 +964,7 @@ __fish_brew_complete_arg 'instal' -l colorpickerdir -d 'Target location for Colo __fish_brew_complete_arg 'instal' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' __fish_brew_complete_arg 'instal' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'instal' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' -__fish_brew_complete_arg 'instal' -l display-times -d 'Print install times for each package at the end of the run' +__fish_brew_complete_arg 'instal' -l display-times -d 'Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set' __fish_brew_complete_arg 'instal' -l dry-run -d 'Show what would be installed, but do not actually install anything' __fish_brew_complete_arg 'instal' -l fetch-HEAD -d 'Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released' __fish_brew_complete_arg 'instal' -l fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)' @@ -982,15 +982,15 @@ __fish_brew_complete_arg 'instal' -l keep-tmp -d 'Retain the temporary files cre __fish_brew_complete_arg 'instal' -l keyboard-layoutdir -d 'Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)' __fish_brew_complete_arg 'instal' -l language -d 'Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask\'s default language. The default value is the language of your system' __fish_brew_complete_arg 'instal' -l mdimporterdir -d 'Target location for Spotlight Plugins (default: `~/Library/Spotlight`)' -__fish_brew_complete_arg 'instal' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled)' -__fish_brew_complete_arg 'instal' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'instal' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' +__fish_brew_complete_arg 'instal' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'instal' -l only-dependencies -d 'Install the dependencies with specified options but do not install the formula itself' __fish_brew_complete_arg 'instal' -l overwrite -d 'Delete files that already exist in the prefix while linking' __fish_brew_complete_arg 'instal' -l prefpanedir -d 'Target location for Preference Panes (default: `~/Library/PreferencePanes`)' __fish_brew_complete_arg 'instal' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `~/Library/QuickLook`)' -__fish_brew_complete_arg 'instal' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'instal' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'instal' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'instal' -l require-sha -d 'Require all casks to have a checksum' +__fish_brew_complete_arg 'instal' -l require-sha -d 'Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set' __fish_brew_complete_arg 'instal' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'instal' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'instal' -l skip-cask-deps -d 'Skip installing cask dependencies' @@ -1009,9 +1009,9 @@ __fish_brew_complete_arg 'install' -l HEAD -d 'If formula defines it, install th __fish_brew_complete_arg 'install' -l adopt -d 'Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`' __fish_brew_complete_arg 'install' -l appdir -d 'Target location for Applications (default: `/Applications`)' __fish_brew_complete_arg 'install' -l as-dependency -d 'Install but mark as installed as a dependency and not installed on request' -__fish_brew_complete_arg 'install' -l ask -d 'Ask for confirmation before downloading and installing formulae. Print bottles and dependencies download size and install size' +__fish_brew_complete_arg 'install' -l ask -d 'Ask for confirmation before downloading and installing formulae. Print download and install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set' __fish_brew_complete_arg 'install' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)' -__fish_brew_complete_arg 'install' -l binaries -d 'Disable/enable linking of helper executables (default: enabled)' +__fish_brew_complete_arg 'install' -l binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' __fish_brew_complete_arg 'install' -l bottle-arch -d 'Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on' __fish_brew_complete_arg 'install' -l build-bottle -d 'Prepare the formula for eventual bottling during installation, skipping any post-install steps' __fish_brew_complete_arg 'install' -l build-from-source -d 'Compile formula from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available' @@ -1021,7 +1021,7 @@ __fish_brew_complete_arg 'install' -l colorpickerdir -d 'Target location for Col __fish_brew_complete_arg 'install' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' __fish_brew_complete_arg 'install' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'install' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' -__fish_brew_complete_arg 'install' -l display-times -d 'Print install times for each package at the end of the run' +__fish_brew_complete_arg 'install' -l display-times -d 'Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set' __fish_brew_complete_arg 'install' -l dry-run -d 'Show what would be installed, but do not actually install anything' __fish_brew_complete_arg 'install' -l fetch-HEAD -d 'Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released' __fish_brew_complete_arg 'install' -l fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)' @@ -1039,15 +1039,15 @@ __fish_brew_complete_arg 'install' -l keep-tmp -d 'Retain the temporary files cr __fish_brew_complete_arg 'install' -l keyboard-layoutdir -d 'Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)' __fish_brew_complete_arg 'install' -l language -d 'Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask\'s default language. The default value is the language of your system' __fish_brew_complete_arg 'install' -l mdimporterdir -d 'Target location for Spotlight Plugins (default: `~/Library/Spotlight`)' -__fish_brew_complete_arg 'install' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled)' -__fish_brew_complete_arg 'install' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'install' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' +__fish_brew_complete_arg 'install' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'install' -l only-dependencies -d 'Install the dependencies with specified options but do not install the formula itself' __fish_brew_complete_arg 'install' -l overwrite -d 'Delete files that already exist in the prefix while linking' __fish_brew_complete_arg 'install' -l prefpanedir -d 'Target location for Preference Panes (default: `~/Library/PreferencePanes`)' __fish_brew_complete_arg 'install' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `~/Library/QuickLook`)' -__fish_brew_complete_arg 'install' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'install' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'install' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'install' -l require-sha -d 'Require all casks to have a checksum' +__fish_brew_complete_arg 'install' -l require-sha -d 'Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set' __fish_brew_complete_arg 'install' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'install' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'install' -l skip-cask-deps -d 'Skip installing cask dependencies' @@ -1074,7 +1074,7 @@ __fish_brew_complete_cmd 'irb' 'Enter the interactive Homebrew Ruby shell' __fish_brew_complete_arg 'irb' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'irb' -l examples -d 'Show several examples' __fish_brew_complete_arg 'irb' -l help -d 'Show this message' -__fish_brew_complete_arg 'irb' -l pry -d 'Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set' +__fish_brew_complete_arg 'irb' -l pry -d 'Use Pry instead of IRB. Enabled by default if `$HOMEBREW_PRY` is set' __fish_brew_complete_arg 'irb' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'irb' -l verbose -d 'Make some output more verbose' @@ -1121,7 +1121,7 @@ __fish_brew_complete_arg 'link' -a '(__fish_brew_suggest_formulae_installed)' __fish_brew_complete_cmd 'linkage' 'Check the library links from the given formula kegs' -__fish_brew_complete_arg 'linkage' -l cached -d 'Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run' +__fish_brew_complete_arg 'linkage' -l cached -d 'Print the cached linkage values stored in `$HOMEBREW_CACHE`, set by a previous `brew linkage` run' __fish_brew_complete_arg 'linkage' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'linkage' -l help -d 'Show this message' __fish_brew_complete_arg 'linkage' -l quiet -d 'Make some output more quiet' @@ -1272,7 +1272,7 @@ __fish_brew_complete_arg 'outdated' -l cask -d 'List only outdated casks' __fish_brew_complete_arg 'outdated' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'outdated' -l fetch-HEAD -d 'Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released' __fish_brew_complete_arg 'outdated' -l formula -d 'List only outdated formulae' -__fish_brew_complete_arg 'outdated' -l greedy -d 'Also include outdated casks with `auto_updates true` or `version :latest`' +__fish_brew_complete_arg 'outdated' -l greedy -d 'Also include outdated casks with `auto_updates true` or `version :latest`. Enabled by default if `$HOMEBREW_UPGRADE_GREEDY` is set' __fish_brew_complete_arg 'outdated' -l greedy-auto-updates -d 'Also include outdated casks including those with `auto_updates true`' __fish_brew_complete_arg 'outdated' -l greedy-latest -d 'Also include outdated casks including those with `version :latest`' __fish_brew_complete_arg 'outdated' -l help -d 'Show this message' @@ -1417,16 +1417,16 @@ __fish_brew_complete_arg 'readall' -a '(__fish_brew_suggest_taps_installed)' __fish_brew_complete_cmd 'reinstall' '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' __fish_brew_complete_arg 'reinstall' -l adopt -d 'Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`' __fish_brew_complete_arg 'reinstall' -l appdir -d 'Target location for Applications (default: `/Applications`)' -__fish_brew_complete_arg 'reinstall' -l ask -d 'Ask for confirmation before downloading and upgrading formulae. Print bottles and dependencies download size, install and net install size' +__fish_brew_complete_arg 'reinstall' -l ask -d 'Ask for confirmation before downloading and upgrading formulae. Print download, install and net install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set' __fish_brew_complete_arg 'reinstall' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)' -__fish_brew_complete_arg 'reinstall' -l binaries -d 'Disable/enable linking of helper executables (default: enabled)' +__fish_brew_complete_arg 'reinstall' -l binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' __fish_brew_complete_arg 'reinstall' -l build-from-source -d 'Compile formula from source even if a bottle is available' __fish_brew_complete_arg 'reinstall' -l cask -d 'Treat all named arguments as casks' __fish_brew_complete_arg 'reinstall' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'reinstall' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' __fish_brew_complete_arg 'reinstall' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'reinstall' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' -__fish_brew_complete_arg 'reinstall' -l display-times -d 'Print install times for each package at the end of the run' +__fish_brew_complete_arg 'reinstall' -l display-times -d 'Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set' __fish_brew_complete_arg 'reinstall' -l fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)' __fish_brew_complete_arg 'reinstall' -l force -d 'Install without checking for previously installed keg-only or non-migrated versions' __fish_brew_complete_arg 'reinstall' -l force-bottle -d 'Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation' @@ -1440,13 +1440,13 @@ __fish_brew_complete_arg 'reinstall' -l keep-tmp -d 'Retain the temporary files __fish_brew_complete_arg 'reinstall' -l keyboard-layoutdir -d 'Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)' __fish_brew_complete_arg 'reinstall' -l language -d 'Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask\'s default language. The default value is the language of your system' __fish_brew_complete_arg 'reinstall' -l mdimporterdir -d 'Target location for Spotlight Plugins (default: `~/Library/Spotlight`)' -__fish_brew_complete_arg 'reinstall' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled)' -__fish_brew_complete_arg 'reinstall' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'reinstall' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' +__fish_brew_complete_arg 'reinstall' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'reinstall' -l prefpanedir -d 'Target location for Preference Panes (default: `~/Library/PreferencePanes`)' __fish_brew_complete_arg 'reinstall' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `~/Library/QuickLook`)' -__fish_brew_complete_arg 'reinstall' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'reinstall' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'reinstall' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'reinstall' -l require-sha -d 'Require all casks to have a checksum' +__fish_brew_complete_arg 'reinstall' -l require-sha -d 'Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set' __fish_brew_complete_arg 'reinstall' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'reinstall' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'reinstall' -l skip-cask-deps -d 'Skip installing cask dependencies' @@ -1575,7 +1575,7 @@ __fish_brew_complete_arg 'setup-ruby' -a '(__fish_brew_suggest_commands)' __fish_brew_complete_cmd 'sh' 'Enter an interactive shell for Homebrew\'s build environment' __fish_brew_complete_arg 'sh' -l cmd -d 'Execute commands in a non-interactive shell' __fish_brew_complete_arg 'sh' -l debug -d 'Display any debugging information' -__fish_brew_complete_arg 'sh' -l env -d 'Use the standard `PATH` instead of superenv\'s when `std` is passed' +__fish_brew_complete_arg 'sh' -l env -d 'Use the standard `$PATH` instead of superenv\'s when `std` is passed' __fish_brew_complete_arg 'sh' -l help -d 'Show this message' __fish_brew_complete_arg 'sh' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'sh' -l verbose -d 'Make some output more verbose' @@ -1720,7 +1720,7 @@ __fish_brew_complete_arg 'unalias' -l verbose -d 'Make some output more verbose' __fish_brew_complete_cmd 'unbottled' 'Show the unbottled dependents of formulae' __fish_brew_complete_arg 'unbottled' -l debug -d 'Display any debugging information' __fish_brew_complete_arg 'unbottled' -l dependents -d 'Skip getting analytics data and sort by number of dependents instead' -__fish_brew_complete_arg 'unbottled' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `HOMEBREW_EVAL_ALL` is set' +__fish_brew_complete_arg 'unbottled' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `$HOMEBREW_EVAL_ALL` is set' __fish_brew_complete_arg 'unbottled' -l help -d 'Show this message' __fish_brew_complete_arg 'unbottled' -l lost -d 'Print the `homebrew/core` commits where bottles were lost in the last week' __fish_brew_complete_arg 'unbottled' -l quiet -d 'Make some output more quiet' @@ -1882,22 +1882,22 @@ __fish_brew_complete_arg 'update-test' -l debug -d 'Display any debugging inform __fish_brew_complete_arg 'update-test' -l help -d 'Show this message' __fish_brew_complete_arg 'update-test' -l keep-tmp -d 'Retain the temporary directory containing the new repository clone' __fish_brew_complete_arg 'update-test' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'update-test' -l to-tag -d 'Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags' +__fish_brew_complete_arg 'update-test' -l to-tag -d 'Set `$HOMEBREW_UPDATE_TO_TAG` to test updating between tags' __fish_brew_complete_arg 'update-test' -l verbose -d 'Make some output more verbose' __fish_brew_complete_cmd 'upgrade' 'Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options' __fish_brew_complete_arg 'upgrade' -l appdir -d 'Target location for Applications (default: `/Applications`)' -__fish_brew_complete_arg 'upgrade' -l ask -d 'Ask for confirmation before downloading and upgrading formulae. Print bottles and dependencies download size, install and net install size' +__fish_brew_complete_arg 'upgrade' -l ask -d 'Ask for confirmation before downloading and upgrading formulae. Print download, install and net install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set' __fish_brew_complete_arg 'upgrade' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)' -__fish_brew_complete_arg 'upgrade' -l binaries -d 'Disable/enable linking of helper executables (default: enabled)' +__fish_brew_complete_arg 'upgrade' -l binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' __fish_brew_complete_arg 'upgrade' -l build-from-source -d 'Compile formula from source even if a bottle is available' __fish_brew_complete_arg 'upgrade' -l cask -d 'Treat all named arguments as casks. If no named arguments are specified, upgrade only outdated casks' __fish_brew_complete_arg 'upgrade' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)' __fish_brew_complete_arg 'upgrade' -l debug -d 'If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory' __fish_brew_complete_arg 'upgrade' -l debug-symbols -d 'Generate debug symbols on build. Source will be retained in a cache directory' __fish_brew_complete_arg 'upgrade' -l dictionarydir -d 'Target location for Dictionaries (default: `~/Library/Dictionaries`)' -__fish_brew_complete_arg 'upgrade' -l display-times -d 'Print install times for each package at the end of the run' +__fish_brew_complete_arg 'upgrade' -l display-times -d 'Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set' __fish_brew_complete_arg 'upgrade' -l dry-run -d 'Show what would be upgraded, but do not actually upgrade anything' __fish_brew_complete_arg 'upgrade' -l fetch-HEAD -d 'Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository\'s HEAD will only be checked for updates when a new stable or development version has been released' __fish_brew_complete_arg 'upgrade' -l fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)' @@ -1915,14 +1915,14 @@ __fish_brew_complete_arg 'upgrade' -l keep-tmp -d 'Retain the temporary files cr __fish_brew_complete_arg 'upgrade' -l keyboard-layoutdir -d 'Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)' __fish_brew_complete_arg 'upgrade' -l language -d 'Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask\'s default language. The default value is the language of your system' __fish_brew_complete_arg 'upgrade' -l mdimporterdir -d 'Target location for Spotlight Plugins (default: `~/Library/Spotlight`)' -__fish_brew_complete_arg 'upgrade' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled)' -__fish_brew_complete_arg 'upgrade' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'upgrade' -l no-binaries -d 'Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set' +__fish_brew_complete_arg 'upgrade' -l no-quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'upgrade' -l overwrite -d 'Delete files that already exist in the prefix while linking' __fish_brew_complete_arg 'upgrade' -l prefpanedir -d 'Target location for Preference Panes (default: `~/Library/PreferencePanes`)' __fish_brew_complete_arg 'upgrade' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `~/Library/QuickLook`)' -__fish_brew_complete_arg 'upgrade' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)' +__fish_brew_complete_arg 'upgrade' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set' __fish_brew_complete_arg 'upgrade' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'upgrade' -l require-sha -d 'Require all casks to have a checksum' +__fish_brew_complete_arg 'upgrade' -l require-sha -d 'Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set' __fish_brew_complete_arg 'upgrade' -l screen-saverdir -d 'Target location for Screen Savers (default: `~/Library/Screen Savers`)' __fish_brew_complete_arg 'upgrade' -l servicedir -d 'Target location for Services (default: `~/Library/Services`)' __fish_brew_complete_arg 'upgrade' -l skip-cask-deps -d 'Skip installing cask dependencies' diff --git a/completions/zsh/_brew b/completions/zsh/_brew index 8d1d4e3da9..c1e48d5b19 100644 --- a/completions/zsh/_brew +++ b/completions/zsh/_brew @@ -167,7 +167,7 @@ __brew_internal_commands() { 'dispatch-build-bottle:Build bottles for these formulae with GitHub Actions' 'docs:Open Homebrew'\''s online documentation at https://docs.brew.sh in a browser' 'doctor:Check your system for potential problems' - 'edit:Open a formula, cask or tap in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided' + 'edit:Open a formula, cask or tap in the editor set by `$EDITOR` or `$HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is provided' 'extract:Look through repository history to find the most recent version of formula and create a copy in tap' 'fetch:Download a bottle (if available) or source packages for formulae and binaries for casks' 'formula:Display the path where formula is located' @@ -467,7 +467,7 @@ _brew_audit() { '--audit-debug[Enable debugging and profiling of audit methods]' \ '--debug[Display any debugging information]' \ '--display-filename[Prefix every line of output with the file or formula name being audited, to make output easy to grep]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `HOMEBREW_EVAL_ALL` is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if `$HOMEBREW_EVAL_ALL` is set]' \ '(--only)--except[Specify a comma-separated method list to skip running the methods named `audit_`method]' \ '(--only-cops --strict --only-cops --only)--except-cops[Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops]' \ '--fix[Fix style violations automatically using RuboCop'\''s auto-correct feature]' \ @@ -651,9 +651,9 @@ _brew_bundle() { '(--no-vscode)--all[`list` all dependencies]' \ '--cask[`list`, `dump` or `cleanup` Homebrew cask dependencies]' \ '--check[Check that all dependencies in the Brewfile are installed before running `exec`, `sh`, or `env`]' \ - '--cleanup[`install` performs cleanup operation, same as running `cleanup --force`. This is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed]' \ + '--cleanup[`install` performs cleanup operation, same as running `cleanup --force`. Enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` is passed]' \ '--debug[Display any debugging information]' \ - '--describe[`dump` adds a description comment above each line, unless the dependency does not have a description. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set]' \ + '--describe[`dump` adds a description comment above each line, unless the dependency does not have a description. Enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set]' \ '--file[Read from or write to the `Brewfile` from this location. Use `--file=-` to pipe to stdin/stdout]' \ '--force[`install` runs with `--force`/`--overwrite`. `dump` overwrites an existing `Brewfile`. `cleanup` actually performs its cleanup operations]' \ '--formula[`list`, `dump` or `cleanup` Homebrew formula dependencies]' \ @@ -662,10 +662,10 @@ _brew_bundle() { '(--upgrade)--install[Run `install` before continuing to other operations e.g. `exec`]' \ '--mas[`list` or `dump` Mac App Store dependencies]' \ '--no-restart[`dump` does not add `restart_service` to formula lines]' \ - '--no-upgrade[`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. This is enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \ - '(--all --vscode)--no-vscode[`dump` without VSCode (and forks/variants) extensions. This is enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set]' \ + '--no-upgrade[`install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew install` if needed. Enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \ + '(--all --vscode)--no-vscode[`dump` without VSCode (and forks/variants) extensions. Enabled by default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set]' \ '--quiet[Make some output more quiet]' \ - '--services[Temporarily start services while running the `exec` or `sh` command. This is enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set]' \ + '--services[Temporarily start services while running the `exec` or `sh` command. Enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set]' \ '--tap[`list`, `dump` or `cleanup` Homebrew tap dependencies]' \ '(--install)--upgrade[`install` runs `brew upgrade` on outdated dependencies, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \ '--upgrade-formulae[`install` runs `brew upgrade` on any of these comma-separated formulae, even if `$HOMEBREW_BUNDLE_NO_UPGRADE` is set]' \ @@ -874,8 +874,8 @@ _brew_determine_test_runners() { _arguments \ '(--dependents)--all-supported[Instead of selecting runners based on the chosen formula, return all supported runners]' \ '--debug[Display any debugging information]' \ - '(--all-supported)--dependents[Determine runners for testing dependents. Requires `--eval-all` or `HOMEBREW_EVAL_ALL`]' \ - '--eval-all[Evaluate all available formulae, whether installed or not, to determine testing dependents]' \ + '(--all-supported)--dependents[Determine runners for testing dependents. Requires `--eval-all` or `$HOMEBREW_EVAL_ALL` to be set]' \ + '--eval-all[Evaluate all available formulae, whether installed or not, to determine testing dependents. Enabled by default if `$HOMEBREW_EVAL_ALL` is set]' \ '--help[Show this message]' \ '--quiet[Make some output more quiet]' \ '--verbose[Make some output more verbose]' @@ -1008,9 +1008,9 @@ _brew_fetch() { '--force[Remove a previously cached version and re-fetch]' \ '(--build-from-source --build-bottle --bottle-tag --cask)--force-bottle[Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation]' \ '--help[Show this message]' \ - '--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--no-quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '(--bottle-tag)--os[Download for the given operating system. (Pass `all` to download for all operating systems.)]' \ - '--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '--quiet[Make some output more quiet]' \ '--retry[Retry if downloading fails or re-download if the checksum of a previously cached version no longer matches. Tries at most 5 times with exponential backoff]' \ '--verbose[Do a verbose VCS checkout, if the URL represents a VCS. This is useful for seeing if an existing VCS cache has been updated]' \ @@ -1196,9 +1196,9 @@ _brew_instal() { '(--formula --force)--adopt[Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`]' \ '(--formula)--appdir[Target location for Applications (default: `/Applications`)]' \ '(--cask)--as-dependency[Install but mark as installed as a dependency and not installed on request]' \ - '--ask[Ask for confirmation before downloading and installing formulae. Print bottles and dependencies download size and install size]' \ + '--ask[Ask for confirmation before downloading and installing formulae. Print download and install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set]' \ '(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \ - '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \ + '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ '(--cask)--bottle-arch[Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on]' \ '(--cask --build-from-source --force-bottle)--build-bottle[Prepare the formula for eventual bottling during installation, skipping any post-install steps]' \ '(--cask --build-bottle --force-bottle)--build-from-source[Compile formula from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available]' \ @@ -1207,7 +1207,7 @@ _brew_instal() { '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ - '--display-times[Print install times for each package at the end of the run]' \ + '--display-times[Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set]' \ '--dry-run[Show what would be installed, but do not actually install anything]' \ '(--cask)--fetch-HEAD[Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository'\''s HEAD will only be checked for updates when a new stable or development version has been released]' \ '(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \ @@ -1224,15 +1224,15 @@ _brew_instal() { '(--formula)--keyboard-layoutdir[Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)]' \ '(--formula)--language[Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask'\''s default language. The default value is the language of your system]' \ '(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `~/Library/Spotlight`)]' \ - '--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \ - '--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--no-binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ + '--no-quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '(--cask --ignore-dependencies)--only-dependencies[Install the dependencies with specified options but do not install the formula itself]' \ '(--cask)--overwrite[Delete files that already exist in the prefix while linking]' \ '(--formula)--prefpanedir[Target location for Preference Panes (default: `~/Library/PreferencePanes`)]' \ '(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `~/Library/QuickLook`)]' \ - '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '--quiet[Make some output more quiet]' \ - '(--formula)--require-sha[Require all casks to have a checksum]' \ + '(--formula)--require-sha[Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ @@ -1257,9 +1257,9 @@ _brew_install() { '(--formula --force)--adopt[Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`]' \ '(--formula)--appdir[Target location for Applications (default: `/Applications`)]' \ '(--cask)--as-dependency[Install but mark as installed as a dependency and not installed on request]' \ - '--ask[Ask for confirmation before downloading and installing formulae. Print bottles and dependencies download size and install size]' \ + '--ask[Ask for confirmation before downloading and installing formulae. Print download and install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set]' \ '(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \ - '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \ + '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ '(--cask)--bottle-arch[Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on]' \ '(--cask --build-from-source --force-bottle)--build-bottle[Prepare the formula for eventual bottling during installation, skipping any post-install steps]' \ '(--cask --build-bottle --force-bottle)--build-from-source[Compile formula from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available]' \ @@ -1268,7 +1268,7 @@ _brew_install() { '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ - '--display-times[Print install times for each package at the end of the run]' \ + '--display-times[Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set]' \ '--dry-run[Show what would be installed, but do not actually install anything]' \ '(--cask)--fetch-HEAD[Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository'\''s HEAD will only be checked for updates when a new stable or development version has been released]' \ '(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \ @@ -1285,15 +1285,15 @@ _brew_install() { '(--formula)--keyboard-layoutdir[Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)]' \ '(--formula)--language[Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask'\''s default language. The default value is the language of your system]' \ '(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `~/Library/Spotlight`)]' \ - '--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \ - '--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--no-binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ + '--no-quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '(--cask --ignore-dependencies)--only-dependencies[Install the dependencies with specified options but do not install the formula itself]' \ '(--cask)--overwrite[Delete files that already exist in the prefix while linking]' \ '(--formula)--prefpanedir[Target location for Preference Panes (default: `~/Library/PreferencePanes`)]' \ '(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `~/Library/QuickLook`)]' \ - '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '--quiet[Make some output more quiet]' \ - '(--formula)--require-sha[Require all casks to have a checksum]' \ + '(--formula)--require-sha[Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ @@ -1328,7 +1328,7 @@ _brew_irb() { '--debug[Display any debugging information]' \ '--examples[Show several examples]' \ '--help[Show this message]' \ - '--pry[Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set]' \ + '--pry[Use Pry instead of IRB. Enabled by default if `$HOMEBREW_PRY` is set]' \ '--quiet[Make some output more quiet]' \ '--verbose[Make some output more verbose]' } @@ -1386,7 +1386,7 @@ _brew_link() { # brew linkage _brew_linkage() { _arguments \ - '--cached[Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run]' \ + '--cached[Print the cached linkage values stored in `$HOMEBREW_CACHE`, set by a previous `brew linkage` run]' \ '--debug[Display any debugging information]' \ '--help[Show this message]' \ '--quiet[Make some output more quiet]' \ @@ -1569,7 +1569,7 @@ _brew_outdated() { _arguments \ '--debug[Display any debugging information]' \ '--fetch-HEAD[Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository'\''s HEAD will only be checked for updates when a new stable or development version has been released]' \ - '--greedy[Also include outdated casks with `auto_updates true` or `version :latest`]' \ + '--greedy[Also include outdated casks with `auto_updates true` or `version :latest`. Enabled by default if `$HOMEBREW_UPGRADE_GREEDY` is set]' \ '--greedy-auto-updates[Also include outdated casks including those with `auto_updates true`]' \ '--greedy-latest[Also include outdated casks including those with `version :latest`]' \ '--help[Show this message]' \ @@ -1747,15 +1747,15 @@ _brew_reinstall() { _arguments \ '(--formula)--adopt[Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with `--force`]' \ '(--formula)--appdir[Target location for Applications (default: `/Applications`)]' \ - '--ask[Ask for confirmation before downloading and upgrading formulae. Print bottles and dependencies download size, install and net install size]' \ + '--ask[Ask for confirmation before downloading and upgrading formulae. Print download, install and net install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set]' \ '(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \ - '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \ + '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ '(--cask --force-bottle)--build-from-source[Compile formula from source even if a bottle is available]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ - '--display-times[Print install times for each package at the end of the run]' \ + '--display-times[Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set]' \ '(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \ '--force[Install without checking for previously installed keg-only or non-migrated versions]' \ '(--cask --build-from-source)--force-bottle[Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation]' \ @@ -1768,13 +1768,13 @@ _brew_reinstall() { '(--formula)--keyboard-layoutdir[Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)]' \ '(--formula)--language[Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask'\''s default language. The default value is the language of your system]' \ '(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `~/Library/Spotlight`)]' \ - '--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \ - '--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--no-binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ + '--no-quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '(--formula)--prefpanedir[Target location for Preference Panes (default: `~/Library/PreferencePanes`)]' \ '(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `~/Library/QuickLook`)]' \ - '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '--quiet[Make some output more quiet]' \ - '(--formula)--require-sha[Require all casks to have a checksum]' \ + '(--formula)--require-sha[Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ @@ -1928,7 +1928,7 @@ _brew_sh() { _arguments \ '--cmd[Execute commands in a non-interactive shell]' \ '--debug[Display any debugging information]' \ - '--env[Use the standard `PATH` instead of superenv'\''s when `std` is passed]' \ + '--env[Use the standard `$PATH` instead of superenv'\''s when `std` is passed]' \ '--help[Show this message]' \ '--quiet[Make some output more quiet]' \ '--verbose[Make some output more verbose]' \ @@ -2112,7 +2112,7 @@ _brew_unbottled() { _arguments \ '--debug[Display any debugging information]' \ '(--total --lost)--dependents[Skip getting analytics data and sort by number of dependents instead]' \ - '--eval-all[Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `HOMEBREW_EVAL_ALL` is set]' \ + '--eval-all[Evaluate all available formulae and casks, whether installed or not, to check them. Implied if `$HOMEBREW_EVAL_ALL` is set]' \ '--help[Show this message]' \ '(--dependents --total)--lost[Print the `homebrew/core` commits where bottles were lost in the last week]' \ '--quiet[Make some output more quiet]' \ @@ -2318,7 +2318,7 @@ _brew_update_test() { '--help[Show this message]' \ '--keep-tmp[Retain the temporary directory containing the new repository clone]' \ '--quiet[Make some output more quiet]' \ - '--to-tag[Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags]' \ + '--to-tag[Set `$HOMEBREW_UPDATE_TO_TAG` to test updating between tags]' \ '--verbose[Make some output more verbose]' } @@ -2326,15 +2326,15 @@ _brew_update_test() { _brew_upgrade() { _arguments \ '(--formula)--appdir[Target location for Applications (default: `/Applications`)]' \ - '--ask[Ask for confirmation before downloading and upgrading formulae. Print bottles and dependencies download size, install and net install size]' \ + '--ask[Ask for confirmation before downloading and upgrading formulae. Print download, install and net install sizes of bottles and dependencies. Enabled by default if `$HOMEBREW_ASK` is set]' \ '(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \ - '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \ + '(--formula)--binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ '(--cask --force-bottle)--build-from-source[Compile formula from source even if a bottle is available]' \ '(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \ '--debug[If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory]' \ '(--cask)--debug-symbols[Generate debug symbols on build. Source will be retained in a cache directory]' \ '(--formula)--dictionarydir[Target location for Dictionaries (default: `~/Library/Dictionaries`)]' \ - '--display-times[Print install times for each package at the end of the run]' \ + '--display-times[Print install times for each package at the end of the run. Enabled by default if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set]' \ '--dry-run[Show what would be upgraded, but do not actually upgrade anything]' \ '(--cask)--fetch-HEAD[Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository'\''s HEAD will only be checked for updates when a new stable or development version has been released]' \ '(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \ @@ -2351,14 +2351,14 @@ _brew_upgrade() { '(--formula)--keyboard-layoutdir[Target location for Keyboard Layouts (default: `/Library/Keyboard Layouts`)]' \ '(--formula)--language[Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the cask'\''s default language. The default value is the language of your system]' \ '(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `~/Library/Spotlight`)]' \ - '--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \ - '--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '--no-binaries[Disable/enable linking of helper executables (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_BINARIES` is set]' \ + '--no-quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '(--cask)--overwrite[Delete files that already exist in the prefix while linking]' \ '(--formula)--prefpanedir[Target location for Preference Panes (default: `~/Library/PreferencePanes`)]' \ '(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `~/Library/QuickLook`)]' \ - '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \ + '(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled). Enabled by default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set]' \ '--quiet[Make some output more quiet]' \ - '(--formula)--require-sha[Require all casks to have a checksum]' \ + '(--formula)--require-sha[Require all casks to have a checksum. Enabled by default if `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set]' \ '(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \ '(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \ '(--formula)--skip-cask-deps[Skip installing cask dependencies]' \ diff --git a/docs/Manpage.md b/docs/Manpage.md index 861f6d0e92..d5238f107c 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -239,8 +239,8 @@ flags which will help with finding keg-only dependencies like `openssl`, : `install` does not run `brew upgrade` on outdated dependencies. `check` does not check for outdated dependencies. Note they may still be upgraded by `brew - install` if needed. This is enabled by default if - `$HOMEBREW_BUNDLE_NO_UPGRADE` is set. + install` if needed. Enabled by default if `$HOMEBREW_BUNDLE_NO_UPGRADE` is + set. `--upgrade` @@ -258,8 +258,8 @@ flags which will help with finding keg-only dependencies like `openssl`, `--services` -: Temporarily start services while running the `exec` or `sh` command. This is - enabled by default if `$HOMEBREW_BUNDLE_SERVICES` is set. +: Temporarily start services while running the `exec` or `sh` command. Enabled + by default if `$HOMEBREW_BUNDLE_SERVICES` is set. `-f`, `--force` @@ -268,9 +268,9 @@ flags which will help with finding keg-only dependencies like `openssl`, `--cleanup` -: `install` performs cleanup operation, same as running `cleanup --force`. This - is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and - `--global` is passed. +: `install` performs cleanup operation, same as running `cleanup --force`. + Enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and `--global` + is passed. `--all` @@ -302,14 +302,14 @@ flags which will help with finding keg-only dependencies like `openssl`, `--no-vscode` -: `dump` without VSCode (and forks/variants) extensions. This is enabled by - default if `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set. +: `dump` without VSCode (and forks/variants) extensions. Enabled by default if + `$HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set. `--describe` : `dump` adds a description comment above each line, unless the dependency does - not have a description. This is enabled by default if - `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set. + not have a description. Enabled by default if `$HOMEBREW_BUNDLE_DUMP_DESCRIBE` + is set. `--no-restart` @@ -627,7 +627,8 @@ binaries for *`cask`*s. For files, also print SHA-256 checksums. `--[no-]quarantine` -: Disable/enable quarantining of downloads (default: enabled). +: Disable/enable quarantining of downloads (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set. `--formula` @@ -763,7 +764,8 @@ upgrade *`formula`* if it is already installed but outdated. `--display-times` -: Print install times for each package at the end of the run. +: Print install times for each package at the end of the run. Enabled by default + if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set. `-f`, `--force` @@ -781,8 +783,9 @@ upgrade *`formula`* if it is already installed but outdated. `--ask` -: Ask for confirmation before downloading and installing formulae. Print bottles - and dependencies download size and install size. +: Ask for confirmation before downloading and installing formulae. Print + download and install sizes of bottles and dependencies. Enabled by default if + `$HOMEBREW_ASK` is set. `--formula` @@ -884,15 +887,18 @@ upgrade *`formula`* if it is already installed but outdated. `--[no-]binaries` -: Disable/enable linking of helper executables (default: enabled). +: Disable/enable linking of helper executables (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_BINARIES` is set. `--require-sha` -: Require all casks to have a checksum. +: Require all casks to have a checksum. Enabled by default if + `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set. `--[no-]quarantine` -: Disable/enable quarantining of downloads (default: enabled). +: Disable/enable quarantining of downloads (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set. `--adopt` @@ -1145,6 +1151,7 @@ otherwise. `-g`, `--greedy` : Also include outdated casks with `auto_updates true` or `version :latest`. + Enabled by default if `$HOMEBREW_UPGRADE_GREEDY` is set. `--greedy-latest` @@ -1234,7 +1241,8 @@ for the reinstalled formulae or, every 30 days, for all formulae. `--display-times` -: Print install times for each package at the end of the run. +: Print install times for each package at the end of the run. Enabled by default + if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set. `-f`, `--force` @@ -1247,8 +1255,9 @@ for the reinstalled formulae or, every 30 days, for all formulae. `--ask` -: Ask for confirmation before downloading and upgrading formulae. Print bottles - and dependencies download size, install and net install size. +: Ask for confirmation before downloading and upgrading formulae. Print + download, install and net install sizes of bottles and dependencies. Enabled + by default if `$HOMEBREW_ASK` is set. `--formula` @@ -1287,15 +1296,18 @@ for the reinstalled formulae or, every 30 days, for all formulae. `--[no-]binaries` -: Disable/enable linking of helper executables (default: enabled). +: Disable/enable linking of helper executables (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_BINARIES` is set. `--require-sha` -: Require all casks to have a checksum. +: Require all casks to have a checksum. Enabled by default if + `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set. `--[no-]quarantine` -: Disable/enable quarantining of downloads (default: enabled). +: Disable/enable quarantining of downloads (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set. `--adopt` @@ -1464,12 +1476,12 @@ run Bundler if necessary for that command. Valid shells: bash\|csh\|fish\|pwsh\|sh\|tcsh\|zsh Print export statements. When run in a shell, this installation of Homebrew will -be added to your `PATH`, `MANPATH`, and `INFOPATH`. +be added to your `$PATH`, `$MANPATH`, and `$INFOPATH`. The variables `$HOMEBREW_PREFIX`, `$HOMEBREW_CELLAR` and `$HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times. To help guarantee idempotence, this command produces no output when Homebrew's `bin` and `sbin` -directories are first and second respectively in your `PATH`. Consider adding +directories are first and second respectively in your `$PATH`. Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.bash_profile` or ~/.zprofile` on macOS and ~/.bashrc` or ~/.zshrc` on Linux) with: `eval "$(brew shellenv)"\` @@ -1663,7 +1675,8 @@ for the upgraded formulae or, every 30 days, for all formulae. `--display-times` -: Print install times for each package at the end of the run. +: Print install times for each package at the end of the run. Enabled by default + if `$HOMEBREW_DISPLAY_INSTALL_TIMES` is set. `-f`, `--force` @@ -1681,8 +1694,9 @@ for the upgraded formulae or, every 30 days, for all formulae. `--ask` -: Ask for confirmation before downloading and upgrading formulae. Print bottles - and dependencies download size, install and net install size. +: Ask for confirmation before downloading and upgrading formulae. Print + download, install and net install sizes of bottles and dependencies. Enabled + by default if `$HOMEBREW_ASK` is set. `--formula` @@ -1745,15 +1759,18 @@ for the upgraded formulae or, every 30 days, for all formulae. `--[no-]binaries` -: Disable/enable linking of helper executables (default: enabled). +: Disable/enable linking of helper executables (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_BINARIES` is set. `--require-sha` -: Require all casks to have a checksum. +: Require all casks to have a checksum. Enabled by default if + `$HOMEBREW_CASK_OPTS_REQUIRE_SHA` is set. `--[no-]quarantine` -: Disable/enable quarantining of downloads (default: enabled). +: Disable/enable quarantining of downloads (default: enabled). Enabled by + default if `$HOMEBREW_CASK_OPTS_QUARANTINE` is set. ### `uses` \[*`options`*\] *`formula`* \[...\] @@ -1951,7 +1968,7 @@ checks. Will exit with a non-zero status if any errors are found. `--eval-all` : Evaluate all available formulae and casks, whether installed or not, to audit - them. Implied if `HOMEBREW_EVAL_ALL` is set. + them. Implied if `$HOMEBREW_EVAL_ALL` is set. `--new` @@ -2551,9 +2568,9 @@ Build bottles for these formulae with GitHub Actions. ### `edit` \[*`options`*\] \[*`formula`*\|*`cask`*\|*`tap`* ...\] -Open a *`formula`*, *`cask`* or *`tap`* in the editor set by `EDITOR` or -`HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument is -provided. +Open a *`formula`*, *`cask`* or *`tap`* in the editor set by `$EDITOR` or +`$HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no argument +is provided. `--formula` @@ -2715,7 +2732,7 @@ Enter the interactive Homebrew Ruby shell. `--pry` -: Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set. +: Use Pry instead of IRB. Enabled by default if `$HOMEBREW_PRY` is set. ### `linkage` \[*`options`*\] \[*`installed_formula`* ...\] @@ -2739,14 +2756,14 @@ 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 +: Print the cached linkage values stored in `$HOMEBREW_CACHE`, set by a previous `brew linkage` run. ### `livecheck`, `lc` \[*`options`*\] \[*`formula`*\|*`cask`* ...\] Check for newer versions of formulae and/or casks from upstream. If no formula or cask argument is passed, the list of formulae and casks to check is taken -from `HOMEBREW_LIVECHECK_WATCHLIST` or `~/.homebrew/livecheck_watchlist.txt`. +from `$HOMEBREW_LIVECHECK_WATCHLIST` or `~/.homebrew/livecheck_watchlist.txt`. `--full-name` @@ -3068,11 +3085,11 @@ Enter an interactive shell for Homebrew's build environment. Use years-battle-hardened build logic to help your `./configure && make && make install` and even your `gem install` succeed. Especially handy if you run Homebrew in an Xcode-only configuration since it adds tools like `make` to your -`PATH` which build systems would not find otherwise. +`$PATH` which build systems would not find otherwise. `--env` -: Use the standard `PATH` instead of superenv's when `std` is passed. +: Use the standard `$PATH` instead of superenv's when `std` is passed. `-c`, `--cmd` @@ -3263,7 +3280,7 @@ Show the unbottled dependents of formulae. `--eval-all` : Evaluate all available formulae and casks, whether installed or not, to check - them. Implied if `HOMEBREW_EVAL_ALL` is set. + them. Implied if `$HOMEBREW_EVAL_ALL` is set. ### `unpack` \[*`options`*\] *`formula`* \[...\] @@ -3350,7 +3367,7 @@ passed, use `origin/master` as the start commit. `--to-tag` -: Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags. +: Set `$HOMEBREW_UPDATE_TO_TAG` to test updating between tags. `--keep-tmp` @@ -3738,7 +3755,7 @@ Database update for `brew which-formula`. ## CUSTOM EXTERNAL COMMANDS Homebrew, like `git`(1), supports external commands. These are executable -scripts that reside somewhere in the `PATH`, named `brew-`*`cmdname`* or +scripts that reside somewhere in the `$PATH`, named `brew-`*`cmdname`* or `brew-`*`cmdname`*`.rb`, which can be invoked like `brew` *`cmdname`*. This allows you to create your own commands without modifying Homebrew's internals. @@ -3785,7 +3802,7 @@ files: User-specific environment files take precedence over prefix-specific files and prefix-specific files take precedence over system-wide files (unless -`HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below). +`$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below). Note that these files do not support shell variable expansion e.g. `$HOME` or command execution e.g. `$(cat file)`. @@ -4333,7 +4350,7 @@ command execution e.g. `$(cat file)`. `HOMEBREW_SUDO_THROUGH_SUDO_USER` -: If set, Homebrew will use the `SUDO_USER` environment variable to define the +: If set, Homebrew will use the `$SUDO_USER` environment variable to define the user to `sudo`(8) through when running `sudo`(8). `HOMEBREW_SVN` diff --git a/manpages/brew.1 b/manpages/brew.1 index 1d84a042df..c2c51dd6a3 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -1,5 +1,5 @@ .\" generated by kramdown -.TH "BREW" "1" "May 2025" "Homebrew" +.TH "BREW" "1" "June 2025" "Homebrew" .SH NAME brew \- The Missing Package Manager for macOS (or Linux) .SH "SYNOPSIS" @@ -145,7 +145,7 @@ Read from or write to the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP \fBinstall\fP prints output from commands as they are run\. \fBcheck\fP lists all missing dependencies\. .TP \fB\-\-no\-upgrade\fP -\fBinstall\fP does not run \fBbrew upgrade\fP on outdated dependencies\. \fBcheck\fP does not check for outdated dependencies\. Note they may still be upgraded by \fBbrew install\fP if needed\. This is enabled by default if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\. +\fBinstall\fP does not run \fBbrew upgrade\fP on outdated dependencies\. \fBcheck\fP does not check for outdated dependencies\. Note they may still be upgraded by \fBbrew install\fP if needed\. Enabled by default if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\. .TP \fB\-\-upgrade\fP \fBinstall\fP runs \fBbrew upgrade\fP on outdated dependencies, even if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\fP is set\. @@ -157,13 +157,13 @@ Read from or write to the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP Run \fBinstall\fP before continuing to other operations e\.g\. \fBexec\fP\&\. .TP \fB\-\-services\fP -Temporarily start services while running the \fBexec\fP or \fBsh\fP command\. This is enabled by default if \fB$HOMEBREW_BUNDLE_SERVICES\fP is set\. +Temporarily start services while running the \fBexec\fP or \fBsh\fP command\. Enabled by default if \fB$HOMEBREW_BUNDLE_SERVICES\fP is set\. .TP \fB\-f\fP, \fB\-\-force\fP \fBinstall\fP runs with \fB\-\-force\fP/\fB\-\-overwrite\fP\&\. \fBdump\fP overwrites an existing \fBBrewfile\fP\&\. \fBcleanup\fP actually performs its cleanup operations\. .TP \fB\-\-cleanup\fP -\fBinstall\fP performs cleanup operation, same as running \fBcleanup \-\-force\fP\&\. This is enabled by default if \fB$HOMEBREW_BUNDLE_INSTALL_CLEANUP\fP is set and \fB\-\-global\fP is passed\. +\fBinstall\fP performs cleanup operation, same as running \fBcleanup \-\-force\fP\&\. Enabled by default if \fB$HOMEBREW_BUNDLE_INSTALL_CLEANUP\fP is set and \fB\-\-global\fP is passed\. .TP \fB\-\-all\fP \fBlist\fP all dependencies\. @@ -187,10 +187,10 @@ Temporarily start services while running the \fBexec\fP or \fBsh\fP command\. Th \fBlist\fP, \fBdump\fP or \fBcleanup\fP VSCode (and forks/variants) extensions\. .TP \fB\-\-no\-vscode\fP -\fBdump\fP without VSCode (and forks/variants) extensions\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_NO_VSCODE\fP is set\. +\fBdump\fP without VSCode (and forks/variants) extensions\. Enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_NO_VSCODE\fP is set\. .TP \fB\-\-describe\fP -\fBdump\fP adds a description comment above each line, unless the dependency does not have a description\. This is enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_DESCRIBE\fP is set\. +\fBdump\fP adds a description comment above each line, unless the dependency does not have a description\. Enabled by default if \fB$HOMEBREW_BUNDLE_DUMP_DESCRIBE\fP is set\. .TP \fB\-\-no\-restart\fP \fBdump\fP does not add \fBrestart_service\fP to formula lines\. @@ -393,7 +393,7 @@ Download source packages (for eventual bottling) rather than a bottle\. Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\. .TP \fB\-\-[no\-]quarantine\fP -Disable/enable quarantining of downloads (default: enabled)\. +Disable/enable quarantining of downloads (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_QUARANTINE\fP is set\. .TP \fB\-\-formula\fP Treat all named arguments as formulae\. @@ -476,7 +476,7 @@ Unless \fB$HOMEBREW_NO_INSTALL_UPGRADE\fP is set, \fBbrew install\fP \fIformula\ If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. .TP \fB\-\-display\-times\fP -Print install times for each package at the end of the run\. +Print install times for each package at the end of the run\. Enabled by default if \fB$HOMEBREW_DISPLAY_INSTALL_TIMES\fP is set\. .TP \fB\-f\fP, \fB\-\-force\fP Install formulae without checking for previously installed keg\-only or non\-migrated versions\. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask)\. @@ -488,7 +488,7 @@ Print the verification and post\-install steps\. Show what would be installed, but do not actually install anything\. .TP \fB\-\-ask\fP -Ask for confirmation before downloading and installing formulae\. Print bottles and dependencies download size and install size\. +Ask for confirmation before downloading and installing formulae\. Print download and install sizes of bottles and dependencies\. Enabled by default if \fB$HOMEBREW_ASK\fP is set\. .TP \fB\-\-formula\fP Treat all named arguments as formulae\. @@ -551,13 +551,13 @@ Delete files that already exist in the prefix while linking\. Treat all named arguments as casks\. .TP \fB\-\-[no\-]binaries\fP -Disable/enable linking of helper executables (default: enabled)\. +Disable/enable linking of helper executables (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_BINARIES\fP is set\. .TP \fB\-\-require\-sha\fP -Require all casks to have a checksum\. +Require all casks to have a checksum\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_REQUIRE_SHA\fP is set\. .TP \fB\-\-[no\-]quarantine\fP -Disable/enable quarantining of downloads (default: enabled)\. +Disable/enable quarantining of downloads (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_QUARANTINE\fP is set\. .TP \fB\-\-adopt\fP Adopt existing artifacts in the destination that are identical to those being installed\. Cannot be combined with \fB\-\-force\fP\&\. @@ -715,7 +715,7 @@ Print output in JSON format\. There are two versions: \fBv1\fP and \fBv2\fP\&\. Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\[u2019]s HEAD will only be checked for updates when a new stable or development version has been released\. .TP \fB\-g\fP, \fB\-\-greedy\fP -Also include outdated casks with \fBauto_updates true\fP or \fBversion :latest\fP\&\. +Also include outdated casks with \fBauto_updates true\fP or \fBversion :latest\fP\&\. Enabled by default if \fB$HOMEBREW_UPGRADE_GREEDY\fP is set\. .TP \fB\-\-greedy\-latest\fP Also include outdated casks including those with \fBversion :latest\fP\&\. @@ -767,7 +767,7 @@ Unless \fB$HOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then b If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. .TP \fB\-\-display\-times\fP -Print install times for each package at the end of the run\. +Print install times for each package at the end of the run\. Enabled by default if \fB$HOMEBREW_DISPLAY_INSTALL_TIMES\fP is set\. .TP \fB\-f\fP, \fB\-\-force\fP Install without checking for previously installed keg\-only or non\-migrated versions\. @@ -776,7 +776,7 @@ Install without checking for previously installed keg\-only or non\-migrated ver Print the verification and post\-install steps\. .TP \fB\-\-ask\fP -Ask for confirmation before downloading and upgrading formulae\. Print bottles and dependencies download size, install and net install size\. +Ask for confirmation before downloading and upgrading formulae\. Print download, install and net install sizes of bottles and dependencies\. Enabled by default if \fB$HOMEBREW_ASK\fP is set\. .TP \fB\-\-formula\fP Treat all named arguments as formulae\. @@ -803,13 +803,13 @@ Create a Git repository, useful for creating patches to the software\. Treat all named arguments as casks\. .TP \fB\-\-[no\-]binaries\fP -Disable/enable linking of helper executables (default: enabled)\. +Disable/enable linking of helper executables (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_BINARIES\fP is set\. .TP \fB\-\-require\-sha\fP -Require all casks to have a checksum\. +Require all casks to have a checksum\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_REQUIRE_SHA\fP is set\. .TP \fB\-\-[no\-]quarantine\fP -Disable/enable quarantining of downloads (default: enabled)\. +Disable/enable quarantining of downloads (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_QUARANTINE\fP is set\. .TP \fB\-\-adopt\fP Adopt existing artifacts in the destination that are identical to those being installed\. Cannot be combined with \fB\-\-force\fP\&\. @@ -920,9 +920,9 @@ Installs and configures Homebrew\[u2019]s Ruby\. If \fBcommand\fP is passed, it .SS "\fBshellenv\fP \fR[\fIshell\fP \.\.\.]" Valid shells: bash|csh|fish|pwsh|sh|tcsh|zsh .P -Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fP, \fBMANPATH\fP, and \fBINFOPATH\fP\&\. +Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fB$PATH\fP, \fB$MANPATH\fP, and \fB$INFOPATH\fP\&\. .P -The variables \fB$HOMEBREW_PREFIX\fP, \fB$HOMEBREW_CELLAR\fP and \fB$HOMEBREW_REPOSITORY\fP are also exported to avoid querying them multiple times\. To help guarantee idempotence, this command produces no output when Homebrew\[u2019]s \fBbin\fP and \fBsbin\fP directories are first and second respectively in your \fBPATH\fP\&\. Consider adding evaluation of this command\[u2019]s output to your dotfiles (e\.g\. \fB~/\.bash_profile\fP or ~/\.zprofile\fB on macOS and ~/\.bashrc\fP or ~/\.zshrc\fB on Linux) with: \fPeval \[u201c]$(brew shellenv)\[u201d]` +The variables \fB$HOMEBREW_PREFIX\fP, \fB$HOMEBREW_CELLAR\fP and \fB$HOMEBREW_REPOSITORY\fP are also exported to avoid querying them multiple times\. To help guarantee idempotence, this command produces no output when Homebrew\[u2019]s \fBbin\fP and \fBsbin\fP directories are first and second respectively in your \fB$PATH\fP\&\. Consider adding evaluation of this command\[u2019]s output to your dotfiles (e\.g\. \fB~/\.bash_profile\fP or ~/\.zprofile\fB on macOS and ~/\.bashrc\fP or ~/\.zshrc\fB on Linux) with: \fPeval \[u201c]$(brew shellenv)\[u201d]` .P The shell can be specified explicitly with a supported shell name parameter\. Unknown shells will output POSIX exports\. .SS "\fBtab\fP \fR[\fIoptions\fP] \fIinstalled_formula\fP|\fIinstalled_cask\fP \fR[\.\.\.]" @@ -1034,7 +1034,7 @@ Unless \fB$HOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then b If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. .TP \fB\-\-display\-times\fP -Print install times for each package at the end of the run\. +Print install times for each package at the end of the run\. Enabled by default if \fB$HOMEBREW_DISPLAY_INSTALL_TIMES\fP is set\. .TP \fB\-f\fP, \fB\-\-force\fP Install formulae without checking for previously installed keg\-only or non\-migrated versions\. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask)\. @@ -1046,7 +1046,7 @@ Print the verification and post\-install steps\. Show what would be upgraded, but do not actually upgrade anything\. .TP \fB\-\-ask\fP -Ask for confirmation before downloading and upgrading formulae\. Print bottles and dependencies download size, install and net install size\. +Ask for confirmation before downloading and upgrading formulae\. Print download, install and net install sizes of bottles and dependencies\. Enabled by default if \fB$HOMEBREW_ASK\fP is set\. .TP \fB\-\-formula\fP Treat all named arguments as formulae\. If no named arguments are specified, upgrade only outdated formulae\. @@ -1088,13 +1088,13 @@ Also include casks with \fBversion :latest\fP\&\. Also include casks with \fBauto_updates true\fP\&\. .TP \fB\-\-[no\-]binaries\fP -Disable/enable linking of helper executables (default: enabled)\. +Disable/enable linking of helper executables (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_BINARIES\fP is set\. .TP \fB\-\-require\-sha\fP -Require all casks to have a checksum\. +Require all casks to have a checksum\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_REQUIRE_SHA\fP is set\. .TP \fB\-\-[no\-]quarantine\fP -Disable/enable quarantining of downloads (default: enabled)\. +Disable/enable quarantining of downloads (default: enabled)\. Enabled by default if \fB$HOMEBREW_CASK_OPTS_QUARANTINE\fP is set\. .SS "\fBuses\fP \fR[\fIoptions\fP] \fIformula\fP \fR[\.\.\.]" Show formulae and casks that specify \fIformula\fP as a dependency; that is, show dependents of \fIformula\fP\&\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fP\&\. By default, \fBuses\fP shows all formulae and casks that specify \fIformula\fP as a required or recommended dependency for their stable builds\. .P @@ -1223,7 +1223,7 @@ Run additional, slower style checks that require a network connection\. Only check formulae and casks that are currently installed\. .TP \fB\-\-eval\-all\fP -Evaluate all available formulae and casks, whether installed or not, to audit them\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\. +Evaluate all available formulae and casks, whether installed or not, to audit them\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\. .TP \fB\-\-new\fP Run various additional style checks to determine if a new formula or cask is eligible for Homebrew\. This should be used when creating new formulae or casks and implies \fB\-\-strict\fP and \fB\-\-online\fP\&\. @@ -1621,7 +1621,7 @@ Dispatch bottle for Linux x86_64 (using self\-hosted runner)\. \fB\-\-linux\-wheezy\fP Use Debian Wheezy container for building the bottle on Linux\. .SS "\fBedit\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP|\fItap\fP \.\.\.]" -Open a \fIformula\fP, \fIcask\fP or \fItap\fP in the editor set by \fBEDITOR\fP or \fBHOMEBREW_EDITOR\fP, or open the Homebrew repository for editing if no argument is provided\. +Open a \fIformula\fP, \fIcask\fP or \fItap\fP in the editor set by \fB$EDITOR\fP or \fB$HOMEBREW_EDITOR\fP, or open the Homebrew repository for editing if no argument is provided\. .TP \fB\-\-formula\fP Treat all named arguments as formulae\. @@ -1729,7 +1729,7 @@ Enter the interactive Homebrew Ruby shell\. Show several examples\. .TP \fB\-\-pry\fP -Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fP is set\. +Use Pry instead of IRB\. Enabled by default if \fB$HOMEBREW_PRY\fP is set\. .SS "\fBlinkage\fP \fR[\fIoptions\fP] \fR[\fIinstalled_formula\fP \.\.\.]" Check the library links from the given \fIformula\fP kegs\. If no \fIformula\fP are provided, check all kegs\. Raises an error if run on uninstalled formulae\. .TP @@ -1743,9 +1743,9 @@ Exit with a non\-zero status if any undeclared dependencies with linkage are fou For every library that a keg references, print its dylib path followed by the binaries that link to it\. .TP \fB\-\-cached\fP -Print the cached linkage values stored in \fBHOMEBREW_CACHE\fP, set by a previous \fBbrew linkage\fP run\. +Print the cached linkage values stored in \fB$HOMEBREW_CACHE\fP, set by a previous \fBbrew linkage\fP run\. .SS "\fBlivecheck\fP, \fBlc\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP \.\.\.]" -Check for newer versions of formulae and/or casks from upstream\. If no formula or cask argument is passed, the list of formulae and casks to check is taken from \fBHOMEBREW_LIVECHECK_WATCHLIST\fP or \fB~/\.homebrew/livecheck_watchlist\.txt\fP\&\. +Check for newer versions of formulae and/or casks from upstream\. If no formula or cask argument is passed, the list of formulae and casks to check is taken from \fB$HOMEBREW_LIVECHECK_WATCHLIST\fP or \fB~/\.homebrew/livecheck_watchlist\.txt\fP\&\. .TP \fB\-\-full\-name\fP Print formulae and casks with fully\-qualified names\. @@ -1954,10 +1954,10 @@ Only generate public API documentation\. \fB\-\-open\fP Open generated documentation in a browser\. .SS "\fBsh\fP \fR[\fB\-\-env=\fP] \fR[\fB\-\-cmd=\fP] \fR[\fIfile\fP]" -Enter an interactive shell for Homebrew\[u2019]s build environment\. Use years\-battle\-hardened build logic to help your \fB\&\./configure && make && make install\fP and even your \fBgem install\fP succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fP to your \fBPATH\fP which build systems would not find otherwise\. +Enter an interactive shell for Homebrew\[u2019]s build environment\. Use years\-battle\-hardened build logic to help your \fB\&\./configure && make && make install\fP and even your \fBgem install\fP succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fP to your \fB$PATH\fP which build systems would not find otherwise\. .TP \fB\-\-env\fP -Use the standard \fBPATH\fP instead of superenv\[u2019]s when \fBstd\fP is passed\. +Use the standard \fB$PATH\fP instead of superenv\[u2019]s when \fBstd\fP is passed\. .TP \fB\-c\fP, \fB\-\-cmd\fP Execute commands in a non\-interactive shell\. @@ -2087,7 +2087,7 @@ Print the number of unbottled and total formulae\. Print the \fBhomebrew/core\fP commits where bottles were lost in the last week\. .TP \fB\-\-eval\-all\fP -Evaluate all available formulae and casks, whether installed or not, to check them\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\. +Evaluate all available formulae and casks, whether installed or not, to check them\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\. .SS "\fBunpack\fP \fR[\fIoptions\fP] \fIformula\fP \fR[\.\.\.]" Unpack the source files for \fIformula\fP into subdirectories of the current working directory\. .TP @@ -2141,7 +2141,7 @@ Update the list of GitHub Sponsors in the \fBHomebrew/brew\fP README\. Run a test of \fBbrew update\fP with a new repository clone\. If no options are passed, use \fBorigin/master\fP as the start commit\. .TP \fB\-\-to\-tag\fP -Set \fBHOMEBREW_UPDATE_TO_TAG\fP to test updating between tags\. +Set \fB$HOMEBREW_UPDATE_TO_TAG\fP to test updating between tags\. .TP \fB\-\-keep\-tmp\fP Retain the temporary directory containing the new repository clone\. @@ -2401,7 +2401,7 @@ Evaluate all installed taps, rather than just the core tap\. \fB\-\-max\-downloads\fP Specify a maximum number of formulae to download and update\. .SH "CUSTOM EXTERNAL COMMANDS" -Homebrew, like \fBgit\fP(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fP, named \fBbrew\-\fP\fIcmdname\fP or \fBbrew\-\fP\fIcmdname\fP\fB\&\.rb\fP, which can be invoked like \fBbrew\fP \fIcmdname\fP\&\. This allows you to create your own commands without modifying Homebrew\[u2019]s internals\. +Homebrew, like \fBgit\fP(1), supports external commands\. These are executable scripts that reside somewhere in the \fB$PATH\fP, named \fBbrew\-\fP\fIcmdname\fP or \fBbrew\-\fP\fIcmdname\fP\fB\&\.rb\fP, which can be invoked like \fBbrew\fP \fIcmdname\fP\&\. This allows you to create your own commands without modifying Homebrew\[u2019]s internals\. .P Instructions for creating your own commands can be found in the docs: .UR https://docs\.brew\.sh/External\-Commands @@ -2427,7 +2427,7 @@ Note that environment variables must have a value set to be detected\. For examp .IP \(bu 4 \fB$XDG_CONFIG_HOME/homebrew/brew\.env\fP if \fB$XDG_CONFIG_HOME\fP is set or \fB~/\.homebrew/brew\.env\fP otherwise (user\-specific) .P -User\-specific environment files take precedence over prefix\-specific files and prefix\-specific files take precedence over system\-wide files (unless \fBHOMEBREW_SYSTEM_ENV_TAKES_PRIORITY\fP is set, see below)\. +User\-specific environment files take precedence over prefix\-specific files and prefix\-specific files take precedence over system\-wide files (unless \fB$HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY\fP is set, see below)\. .P Note that these files do not support shell variable expansion e\.g\. \fB$HOME\fP or command execution e\.g\. \fB$(cat file)\fP\&\. .TP @@ -2836,7 +2836,7 @@ If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fP .RE .TP \fBHOMEBREW_SUDO_THROUGH_SUDO_USER\fP -If set, Homebrew will use the \fBSUDO_USER\fP environment variable to define the user to \fBsudo\fP(8) through when running \fBsudo\fP(8)\. +If set, Homebrew will use the \fB$SUDO_USER\fP environment variable to define the user to \fBsudo\fP(8) through when running \fBsudo\fP(8)\. .TP \fBHOMEBREW_SVN\fP Use this as the \fBsvn\fP(1) binary\.