mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

env_config: use environment variables consistently

Browse Source 
- use e.g. `$HOMEBREW_*` for cases where only the environment variable
  is the entire backtick-quoted string
- use e.g. `${HOMEBREW_*}` for cases where the environment variable is
  part of a backtick-quoted string to make clear what parts are variable
  and what parts are not
- use `export HOMEBREW_*=...` for cases where we're talking about
  setting the environment variable (because it likely needs to be
  exported to work how they want)

Inspired by https://github.com/Homebrew/homebrew-bundle/pull/1579 making
similar changes for Homebrew/homebrew-bundle.
This commit is contained in:
Mike McQuaid 2025-01-27 14:21:27 +00:00
parent 9fd2b27a35
commit bbf5a9f479
No known key found for this signature in database
24 changed files with 384 additions and 369 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Library/Homebrew/cask/config.rb
View File

@ -16,19 +16,19 @@ module Cask
{
appdir: "/Applications",
keyboard_layoutdir: "/Library/Keyboard Layouts",
colorpickerdir: "~/Library/ColorPickers",
prefpanedir: "~/Library/PreferencePanes",
qlplugindir: "~/Library/QuickLook",
mdimporterdir: "~/Library/Spotlight",
dictionarydir: "~/Library/Dictionaries",
fontdir: "~/Library/Fonts",
servicedir: "~/Library/Services",
input_methoddir: "~/Library/Input Methods",
internet_plugindir: "~/Library/Internet Plug-Ins",
audio_unit_plugindir: "~/Library/Audio/Plug-Ins/Components",
vst_plugindir: "~/Library/Audio/Plug-Ins/VST",
vst3_plugindir: "~/Library/Audio/Plug-Ins/VST3",
screen_saverdir: "~/Library/Screen Savers",
colorpickerdir: "${HOME}/Library/ColorPickers",
prefpanedir: "${HOME}/Library/PreferencePanes",
qlplugindir: "${HOME}/Library/QuickLook",
mdimporterdir: "${HOME}/Library/Spotlight",
dictionarydir: "${HOME}/Library/Dictionaries",
fontdir: "${HOME}/Library/Fonts",
servicedir: "${HOME}/Library/Services",
input_methoddir: "${HOME}/Library/Input Methods",
internet_plugindir: "${HOME}/Library/Internet Plug-Ins",
audio_unit_plugindir: "${HOME}/Library/Audio/Plug-Ins/Components",
vst_plugindir: "${HOME}/Library/Audio/Plug-Ins/VST",
vst3_plugindir: "${HOME}/Library/Audio/Plug-Ins/VST3",
screen_saverdir: "${HOME}/Library/Screen Savers",
}.freeze,
T::Hash[Symbol, String],
)

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

@ -15,7 +15,7 @@ module Homebrew
cmd_args do
description <<~EOS
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
Display Homebrew's download cache. See also `$HOMEBREW_CACHE`.
If a <formula> or <cask> is provided, display the file or directory used to cache it.
EOS

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

@ -13,7 +13,7 @@ module Homebrew
Remove stale lock files and outdated downloads for all formulae and casks,
and remove old versions of installed formulae. If arguments are specified,
only do this for the given formulae and casks. Removes all downloads more than
#{days} days old. This can be adjusted with `HOMEBREW_CLEANUP_MAX_AGE_DAYS`.
#{days} days old. This can be adjusted with `$HOMEBREW_CLEANUP_MAX_AGE_DAYS`.
EOS
flag "--prune=",
description: "Remove all cache files older than specified <days>. " \

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

@ -25,7 +25,7 @@ module Homebrew
"it is interpreted as a regular expression."
switch "--eval-all",
description: "Evaluate all available formulae and casks, whether installed or not, to search their " \
"descriptions. Implied if `HOMEBREW_EVAL_ALL` is set."
"descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set."
switch "--formula", "--formulae",
description: "Treat all named arguments as formulae."
switch "--cask", "--casks",
@ -48,7 +48,7 @@ module Homebrew
if search_type.present?
if !args.eval_all? && !Homebrew::EnvConfig.eval_all? && Homebrew::EnvConfig.no_install_from_api?
raise UsageError, "`brew desc --search` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!"
raise UsageError, "`brew desc --search` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
end
query = args.named.join(" ")

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

@ -27,8 +27,8 @@ module Homebrew
EOS
switch "--analytics",
description: "List global Homebrew analytics data or, if specified, installation and " \
"build error data for <formula> (provided neither `HOMEBREW_NO_ANALYTICS` " \
"nor `HOMEBREW_NO_GITHUB_API` are set)."
"build error data for <formula> (provided neither `$HOMEBREW_NO_ANALYTICS` " \
"nor `$HOMEBREW_NO_GITHUB_API` are set)."
flag "--days=",
depends_on: "--analytics",
description: "How many days of analytics data to retrieve. " \
@ -57,7 +57,7 @@ module Homebrew
switch "--eval-all",
depends_on: "--json",
description: "Evaluate all available formulae and casks, whether installed or not, to print their " \
"JSON. Implied if `HOMEBREW_EVAL_ALL` is set."
"JSON. Implied if `$HOMEBREW_EVAL_ALL` is set."
switch "--variations",
depends_on: "--json",
description: "Include the variations hash in each formula's JSON output."

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

@ -20,13 +20,13 @@ module Homebrew
Install a <formula> or <cask>. Additional options specific to a <formula> may be
appended to the command.
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
outdated dependents and dependents with broken linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the installed formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` <formula> will upgrade <formula> if it
Unless `$HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` <formula> will upgrade <formula> if it
is already installed but outdated.
EOS
switch "-d", "--debug",

2
Library/Homebrew/cmd/nodenv-sync.rb
View File

@ -9,7 +9,7 @@ module Homebrew
class NodenvSync < AbstractCommand
cmd_args do
description <<~EOS
Create symlinks for Homebrew's installed NodeJS versions in `~/.nodenv/versions`.
Create symlinks for Homebrew's installed NodeJS versions in `${HOME}/.nodenv/versions`.
Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will
also be symlinked to 19.0.0.

2
Library/Homebrew/cmd/pyenv-sync.rb
View File

@ -9,7 +9,7 @@ module Homebrew
class PyenvSync < AbstractCommand
cmd_args do
description <<~EOS
Create symlinks for Homebrew's installed Python versions in `~/.pyenv/versions`.
Create symlinks for Homebrew's installed Python versions in `${HOME}/.pyenv/versions`.
Note that older patch version symlinks will be created and linked to the minor
version so e.g. Python 3.11.0 will also be symlinked to 3.11.3.

2
Library/Homebrew/cmd/rbenv-sync.rb
View File

@ -9,7 +9,7 @@ module Homebrew
class RbenvSync < AbstractCommand
cmd_args do
description <<~EOS
Create symlinks for Homebrew's installed Ruby versions in `~/.rbenv/versions`.
Create symlinks for Homebrew's installed Ruby versions in `${HOME}/.rbenv/versions`.
Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will
also be symlinked to 3.2.0.

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

@ -25,7 +25,7 @@ module Homebrew
description: "Syntax-check all of Homebrew's Ruby files (if no <tap> is passed)."
switch "--eval-all",
description: "Evaluate all available formulae and casks, whether installed or not. " \
"Implied if `HOMEBREW_EVAL_ALL` is set."
"Implied if `$HOMEBREW_EVAL_ALL` is set."
switch "--no-simulate",
description: "Don't simulate other system configurations when checking formulae and casks."
@ -50,7 +50,7 @@ module Homebrew
taps = if args.no_named?
if !args.eval_all? && !Homebrew::EnvConfig.eval_all?
raise UsageError, "`brew readall` needs a tap or `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!"
raise UsageError, "`brew readall` needs a tap or `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
end
Tap.installed

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

@ -22,10 +22,10 @@ module Homebrew
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>.
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
outdated dependents and dependents with broken linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
reinstalled formulae or, every 30 days, for all formulae.
EOS
switch "-d", "--debug",

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

@ -40,7 +40,7 @@ module Homebrew
switch "--eval-all",
depends_on: "--desc",
description: "Evaluate all available formulae and casks, whether installed or not, to search their " \
"descriptions. Implied if `HOMEBREW_EVAL_ALL` is set."
"descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set."
switch "--pull-request",
description: "Search for GitHub pull requests containing <text>."
switch "--open",
@ -71,7 +71,7 @@ module Homebrew
if args.desc?
if !args.eval_all? && !Homebrew::EnvConfig.eval_all? && Homebrew::EnvConfig.no_install_from_api?
raise UsageError, "`brew search --desc` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!"
raise UsageError, "`brew search --desc` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
end
Search.search_descriptions(string_or_regex, args)

13
Library/Homebrew/cmd/shellenv.rb
View File

@ -15,12 +15,15 @@ module Homebrew
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 your dotfiles (e.g. `~/.bash_profile` or
`~/.zprofile` on macOS and `~/.bashrc` or `~/.zshrc` on Linux) with: `eval "$(brew shellenv)"`
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
your dotfiles (e.g. `${HOME}/.bash_profile` or `${HOME}/.zprofile` on macOS and `${HOME}/.bashrc` or
`${HOME}/.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.
The shell can be specified explicitly with a supported shell name parameter. Unknown shells will output
POSIX exports.
EOS
named_args :shell
end

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

@ -41,7 +41,7 @@ module Homebrew
description: "Migrate tapped formulae from symlink-based to directory-based structure."
switch "--eval-all",
description: "Evaluate all the formulae, casks and aliases in the new tap to check validity. " \
"Implied if `HOMEBREW_EVAL_ALL` is set."
"Implied if `$HOMEBREW_EVAL_ALL` is set."
switch "-f", "--force",
description: "Force install core taps even under API mode."

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

@ -19,10 +19,10 @@ module Homebrew
installed with, plus any appended brew formula options. If <cask> or <formula> are specified,
upgrade only the given <cask> or <formula> kegs (unless they are pinned; see `pin`, `unpin`).
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew reinstall` will be run for
outdated dependents and dependents with broken linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
upgraded formulae or, every 30 days, for all formulae.
EOS
switch "-d", "--debug",

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

@ -122,7 +122,7 @@ module Homebrew
all = args.eval_all?
if !args.installed? && !(all || Homebrew::EnvConfig.eval_all?)
raise UsageError, "`brew uses` needs `--installed` or `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!"
raise UsageError, "`brew uses` needs `--installed` or `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
end
if show_formulae_and_casks || args.formula?

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

@ -14,7 +14,7 @@ module Homebrew
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`.
`${HOME}/.homebrew/livecheck_watchlist.txt`.
EOS
switch "--full-name",
description: "Print formulae and casks with fully-qualified names."

72
Library/Homebrew/env_config.rb
View File

@ -16,8 +16,8 @@ module Homebrew
},
HOMEBREW_API_AUTO_UPDATE_SECS: {
description: "Check Homebrew's API for new formulae or cask data every " \
"`HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API auto-update " \
"checks entirely with `HOMEBREW_NO_AUTO_UPDATE`.",
"`$HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API auto-update " \
"checks entirely with `$HOMEBREW_NO_AUTO_UPDATE`.",
default: 450,
},
HOMEBREW_API_DOMAIN: {
@ -33,7 +33,7 @@ module Homebrew
},
HOMEBREW_ARTIFACT_DOMAIN: {
description: "Prefix all download URLs, including those for bottles, with this value. " \
"For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a " \
"For example, `export HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a " \
"formula with the URL `https://example.com/foo.tar.gz` to instead download from " \
"`http://localhost:8080/https://example.com/foo.tar.gz`. " \
"Bottle URLs however, have their domain replaced with this prefix. " \
@ -43,17 +43,17 @@ module Homebrew
"`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`",
},
HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK: {
description: "If `HOMEBREW_ARTIFACT_DOMAIN` and `HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are both set, " \
"if the request to `HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew will error rather than " \
description: "If `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are both set, " \
"if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew will error rather than " \
"trying any other/default URLs.",
boolean: true,
},
HOMEBREW_AUTO_UPDATE_SECS: {
description: "Run `brew update` once every `HOMEBREW_AUTO_UPDATE_SECS` seconds before some commands, " \
description: "Run `brew update` once every `$HOMEBREW_AUTO_UPDATE_SECS` seconds before some commands, " \
"e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, " \
"disable auto-update entirely with `HOMEBREW_NO_AUTO_UPDATE`.",
"disable auto-update entirely with `$HOMEBREW_NO_AUTO_UPDATE`.",
default_text: "`86400` (24 hours), `3600` (1 hour) if a developer command has been run " \
"or `300` (5 minutes) if `HOMEBREW_NO_INSTALL_FROM_API` is set.",
"or `300` (5 minutes) if `$HOMEBREW_NO_INSTALL_FROM_API` is set.",
},
HOMEBREW_BAT: {
description: "If set, use `bat` for the `brew cat` command.",
@ -76,9 +76,9 @@ module Homebrew
description: "Use this URL as the download mirror for bottles. " \
"If bottles at that URL are temporarily unavailable, " \
"the default bottle domain will be used as a fallback mirror. " \
"For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to " \
"download from the prefix `http://localhost:8080/`. " \
"If bottles are not available at `HOMEBREW_BOTTLE_DOMAIN` " \
"For example, `export HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles " \
"to download from the prefix `http://localhost:8080/`. " \
"If bottles are not available at `$HOMEBREW_BOTTLE_DOMAIN` " \
"they will be downloaded from the default bottle domain.",
default_text: "`https://ghcr.io/v2/homebrew/core`.",
default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN,
@ -107,8 +107,8 @@ module Homebrew
description: "Append these options to all `cask` commands. All `--*dir` options, " \
"`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported. " \
"For example, you might add something like the following to your " \
"`~/.profile`, `~/.bash_profile`, or `~/.zshenv`:" \
"\n\n `export HOMEBREW_CASK_OPTS=\"--appdir=~/Applications --fontdir=/Library/Fonts\"`",
"`${HOME}/.profile`, `${HOME}/.bash_profile`, or `${HOME}/.zshenv`:" \
"\n\n `export HOMEBREW_CASK_OPTS=\"--appdir=${HOME}/Applications --fontdir=/Library/Fonts\"`",
},
HOMEBREW_CLEANUP_MAX_AGE_DAYS: {
description: "Cleanup all cached files older than this many days.",
@ -175,11 +175,12 @@ module Homebrew
},
HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN: {
description: "Use this base64 encoded username and password for authenticating with a Docker registry " \
"proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead.",
"proxying GitHub Packages. " \
"If `$HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead.",
},
HOMEBREW_DOCKER_REGISTRY_TOKEN: {
description: "Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. " \
"Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.",
"Preferred over `$HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.",
},
HOMEBREW_EDITOR: {
description: "Use this editor when editing a single formula, or several formulae in the " \
@ -211,11 +212,11 @@ module Homebrew
"formula if it or any of its dependencies has a license on this list.",
},
HOMEBREW_FORBIDDEN_OWNER: {
description: "The person who has set any `HOMEBREW_FORBIDDEN_*` variables.",
description: "The person who has set any `$HOMEBREW_FORBIDDEN_*` variables.",
default: "you",
},
HOMEBREW_FORBIDDEN_OWNER_CONTACT: {
description: "How to contact the `HOMEBREW_FORBIDDEN_OWNER`, if set and necessary.",
description: "How to contact the `$HOMEBREW_FORBIDDEN_OWNER`, if set and necessary.",
},
HOMEBREW_FORBIDDEN_TAPS: {
description: "A space-separated list of taps. Homebrew will refuse to install a " \
@ -227,7 +228,8 @@ module Homebrew
boolean: true,
},
HOMEBREW_FORCE_API_AUTO_UPDATE: {
description: "If set, update the Homebrew API formula or cask data even if `HOMEBREW_NO_AUTO_UPDATE` is set.",
description: "If set, update the Homebrew API formula or cask data even if " \
"`$HOMEBREW_NO_AUTO_UPDATE` is set.",
boolean: true,
},
HOMEBREW_FORCE_BREWED_CA_CERTIFICATES: {
@ -246,8 +248,8 @@ module Homebrew
boolean: true,
},
HOMEBREW_FORCE_BREW_WRAPPER: {
description: "If set, require `HOMEBREW_BREW_WRAPPER` to be set to the same value as " \
"`HOMEBREW_FORCE_BREW_WRAPPER` for non-trivial `brew` commands.",
description: "If set, require `$HOMEBREW_BREW_WRAPPER` to be set to the same value as " \
"`$HOMEBREW_FORCE_BREW_WRAPPER` for non-trivial `brew` commands.",
},
HOMEBREW_FORCE_VENDOR_RUBY: {
description: "If set, always use Homebrew's vendored, relocatable Ruby version even if the system version " \
@ -291,11 +293,11 @@ module Homebrew
description: "Set the Git committer name to this value.",
},
HOMEBREW_GIT_EMAIL: {
description: "Set the Git author name and, if `HOMEBREW_GIT_COMMITTER_EMAIL` is unset, committer email to " \
description: "Set the Git author name and, if `$HOMEBREW_GIT_COMMITTER_EMAIL` is unset, committer email to " \
"this value.",
},
HOMEBREW_GIT_NAME: {
description: "Set the Git author name and, if `HOMEBREW_GIT_COMMITTER_NAME` is unset, committer name to " \
description: "Set the Git author name and, if `$HOMEBREW_GIT_COMMITTER_NAME` is unset, committer name to " \
"this value.",
},
HOMEBREW_GIT_PATH: {
@ -314,8 +316,8 @@ module Homebrew
HOMEBREW_LIVECHECK_WATCHLIST: {
description: "Consult this file for the list of formulae to check by default when no formula argument " \
"is passed to `brew livecheck`.",
default_text: "`$XDG_CONFIG_HOME/homebrew/livecheck_watchlist.txt` if `$XDG_CONFIG_HOME` is set " \
"or `$HOME/.homebrew/livecheck_watchlist.txt` otherwise.",
default_text: "`${XDG_CONFIG_HOME}/homebrew/livecheck_watchlist.txt` if `$XDG_CONFIG_HOME` is set " \
"or `${HOME}/.homebrew/livecheck_watchlist.txt` otherwise.",
default: "#{ENV.fetch("HOMEBREW_USER_CONFIG_HOME")}/livecheck_watchlist.txt",
},
HOMEBREW_LOCK_CONTEXT: {
@ -324,8 +326,8 @@ module Homebrew
},
HOMEBREW_LOGS: {
description: "Use this directory to store log files.",
default_text: "macOS: `$HOME/Library/Logs/Homebrew`, " \
"Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.",
default_text: "macOS: `${HOME}/Library/Logs/Homebrew`, " \
"Linux: `${XDG_CACHE_HOME}/Homebrew/Logs` or `${HOME}/.cache/Homebrew/Logs`.",
default: HOMEBREW_DEFAULT_LOGS,
},
HOMEBREW_MAKE_JOBS: {
@ -350,7 +352,7 @@ module Homebrew
HOMEBREW_NO_AUTO_UPDATE: {
description: "If set, do not automatically update before running some commands, e.g. " \
"`brew install`, `brew upgrade` and `brew tap`. Preferably, " \
"run this less often by setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the " \
"run this less often by setting `$HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the " \
"default. Note that setting this and e.g. tapping new taps may result in a broken " \
"configuration. Please ensure you always run `brew update` before reporting any issues.",
boolean: true,
@ -369,7 +371,7 @@ module Homebrew
boolean: true,
},
HOMEBREW_NO_EMOJI: {
description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build.",
description: "If set, do not print `$HOMEBREW_INSTALL_BADGE` on a successful build.",
boolean: true,
},
HOMEBREW_NO_ENV_HINTS: {
@ -377,7 +379,7 @@ module Homebrew
boolean: true,
},
HOMEBREW_NO_FORCE_BREW_WRAPPER: {
description: "If set, disables `HOMEBREW_FORCE_BREW_WRAPPER` behaviour, even if set.",
description: "If set, disables `$HOMEBREW_FORCE_BREW_WRAPPER` behaviour, even if set.",
boolean: true,
},
HOMEBREW_NO_GITHUB_API: {
@ -401,7 +403,7 @@ module Homebrew
HOMEBREW_NO_INSTALL_CLEANUP: {
description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically " \
"cleanup installed/upgraded/reinstalled formulae or all formulae every " \
"`HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `HOMEBREW_NO_CLEANUP_FORMULAE` " \
"`$HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `$HOMEBREW_NO_CLEANUP_FORMULAE` " \
"allows specifying specific formulae to not clean up.",
boolean: true,
},
@ -438,19 +440,19 @@ module Homebrew
boolean: true,
},
HOMEBREW_SKIP_OR_LATER_BOTTLES: {
description: "If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \
description: "If set along with `$HOMEBREW_DEVELOPER`, do not use bottles from older versions " \
"of macOS. This is useful in development on new macOS versions.",
boolean: true,
},
HOMEBREW_SORBET_RUNTIME: {
description: "If set, enable runtime typechecking using Sorbet. " \
"Set by default for `HOMEBREW_DEVELOPER` or when running some developer commands.",
"Set by default for `$HOMEBREW_DEVELOPER` or when running some developer commands.",
boolean: true,
},
HOMEBREW_SSH_CONFIG_PATH: {
description: "If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching " \
"Git repositories over SSH.",
default_text: "`$HOME/.ssh/config`",
description: "If set, Homebrew will use the given config file instead of `${HOME}/.ssh/config` when " \
"fetching Git repositories over SSH.",
default_text: "`${HOME}/.ssh/config`",
},
HOMEBREW_SUDO_THROUGH_SUDO_USER: {
description: "If set, Homebrew will use the `SUDO_USER` environment variable to define the user to " \

2
Library/Homebrew/formula.rb
View File

@ -1109,7 +1109,7 @@ class Formula
end
# A subdirectory of `etc` with the formula name suffixed.
# e.g. `$HOMEBREW_PREFIX/etc/openssl@1.1`
# e.g. `${HOMEBREW_PREFIX}/etc/openssl@1.1`
# Anything using `pkgetc.install` will not overwrite other files on
# e.g. upgrades but will write a new file named `*.default`.
#

2
Library/Homebrew/test/cmd/desc_spec.rb
View File

@ -19,7 +19,7 @@ RSpec.describe Homebrew::Cmd::Desc do
setup_test_formula "testball"
expect { brew "desc", "--search", "testball" }
.to output(/`brew desc --search` needs `--eval-all` passed or `HOMEBREW_EVAL_ALL` set!/).to_stderr
.to output(/`brew desc --search` needs `--eval-all` passed or `\$HOMEBREW_EVAL_ALL` set!/).to_stderr
.and be_a_failure
end

128
completions/fish/brew.fish
View File

@ -277,7 +277,7 @@ __fish_brew_complete_arg '-S' -l closed -d 'Search for only closed GitHub pull r
__fish_brew_complete_arg '-S' -l debian -d 'Search for text in the given database'
__fish_brew_complete_arg '-S' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg '-S' -l desc -d 'Search for formulae with a description matching text and casks with a name or description matching text'
__fish_brew_complete_arg '-S' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg '-S' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg '-S' -l fedora -d 'Search for text in the given database'
__fish_brew_complete_arg '-S' -l fink -d 'Search for text in the given database'
__fish_brew_complete_arg '-S' -l formula -d 'Search for formulae'
@ -300,12 +300,12 @@ __fish_brew_complete_arg '-v' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'abv' 'Display brief statistics for your Homebrew installation'
__fish_brew_complete_arg 'abv' -l analytics -d 'List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set)'
__fish_brew_complete_arg 'abv' -l analytics -d 'List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `$HOMEBREW_NO_ANALYTICS` nor `$HOMEBREW_NO_GITHUB_API` are set)'
__fish_brew_complete_arg 'abv' -l cask -d 'Treat all named arguments as casks'
__fish_brew_complete_arg 'abv' -l category -d 'Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`'
__fish_brew_complete_arg 'abv' -l days -d 'How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`'
__fish_brew_complete_arg 'abv' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'abv' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'abv' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'abv' -l fetch-manifest -d 'Fetch GitHub Packages manifest for extra information when formula is not installed'
__fish_brew_complete_arg 'abv' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'abv' -l github -d 'Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask'
@ -631,7 +631,7 @@ __fish_brew_complete_cmd 'desc' 'Display formula\'s name and one-line descriptio
__fish_brew_complete_arg 'desc' -l cask -d 'Treat all named arguments as casks'
__fish_brew_complete_arg 'desc' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'desc' -l description -d 'Search just descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression'
__fish_brew_complete_arg 'desc' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'desc' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'desc' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'desc' -l help -d 'Show this message'
__fish_brew_complete_arg 'desc' -l name -d 'Search just names for text. If text is flanked by slashes, it is interpreted as a regular expression'
@ -849,12 +849,12 @@ __fish_brew_complete_arg 'homepage; and not __fish_seen_argument -l formula -l f
__fish_brew_complete_cmd 'info' 'Display brief statistics for your Homebrew installation'
__fish_brew_complete_arg 'info' -l analytics -d 'List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set)'
__fish_brew_complete_arg 'info' -l analytics -d 'List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `$HOMEBREW_NO_ANALYTICS` nor `$HOMEBREW_NO_GITHUB_API` are set)'
__fish_brew_complete_arg 'info' -l cask -d 'Treat all named arguments as casks'
__fish_brew_complete_arg 'info' -l category -d 'Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`'
__fish_brew_complete_arg 'info' -l days -d 'How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`'
__fish_brew_complete_arg 'info' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'info' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'info' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'info' -l fetch-manifest -d 'Fetch GitHub Packages manifest for extra information when formula is not installed'
__fish_brew_complete_arg 'info' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'info' -l github -d 'Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask'
@ -871,21 +871,21 @@ __fish_brew_complete_arg 'info; and not __fish_seen_argument -l formula -l formu
__fish_brew_complete_arg 'instal' -l HEAD -d 'If formula defines it, install the HEAD version, aka. main, trunk, unstable, master'
__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 audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)'
__fish_brew_complete_arg 'instal' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `${HOME}/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 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'
__fish_brew_complete_arg 'instal' -l cask -d 'Treat all named arguments as casks'
__fish_brew_complete_arg 'instal' -l cc -d 'Attempt to compile using the specified compiler, which should be the name of the compiler\'s executable, e.g. `gcc-9` for GCC 9. In order to use LLVM\'s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option'
__fish_brew_complete_arg 'instal' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)'
__fish_brew_complete_arg 'instal' -l colorpickerdir -d 'Target location for Color Pickers (default: `${HOME}/Library/ColorPickers`)'
__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 dictionarydir -d 'Target location for Dictionaries (default: `${HOME}/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 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`)'
__fish_brew_complete_arg 'instal' -l fontdir -d 'Target location for Fonts (default: `${HOME}/Library/Fonts`)'
__fish_brew_complete_arg 'instal' -l force -d '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)'
__fish_brew_complete_arg 'instal' -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'
__fish_brew_complete_arg 'instal' -l formula -d 'Treat all named arguments as formulae'
@ -893,30 +893,30 @@ __fish_brew_complete_arg 'instal' -l git -d 'Create a Git repository, useful for
__fish_brew_complete_arg 'instal' -l help -d 'Show this message'
__fish_brew_complete_arg 'instal' -l ignore-dependencies -d 'An unsupported Homebrew development option to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If you\'re not developing Homebrew, consider adjusting your PATH rather than using this option'
__fish_brew_complete_arg 'instal' -l include-test -d 'Install testing dependencies required to run `brew test` formula'
__fish_brew_complete_arg 'instal' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'instal' -l input-methoddir -d 'Target location for Input Methods (default: `${HOME}/Library/Input Methods`)'
__fish_brew_complete_arg 'instal' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
__fish_brew_complete_arg 'instal' -l internet-plugindir -d 'Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'instal' -l internet-plugindir -d 'Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'instal' -l keep-tmp -d 'Retain the temporary files created during installation'
__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 mdimporterdir -d 'Target location for Spotlight Plugins (default: `${HOME}/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 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 prefpanedir -d 'Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)'
__fish_brew_complete_arg 'instal' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)'
__fish_brew_complete_arg 'instal' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)'
__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 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 screen-saverdir -d 'Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)'
__fish_brew_complete_arg 'instal' -l servicedir -d 'Target location for Services (default: `${HOME}/Library/Services`)'
__fish_brew_complete_arg 'instal' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'instal' -l skip-link -d 'Install but skip linking the keg into the prefix'
__fish_brew_complete_arg 'instal' -l skip-post-install -d 'Install but skip any post-install steps'
__fish_brew_complete_arg 'instal' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'instal' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'instal' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'instal' -l vst-plugindir -d 'Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'instal' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'instal' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
__fish_brew_complete_arg 'instal; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_arg 'instal; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_all)'
@ -926,21 +926,21 @@ __fish_brew_complete_cmd 'install' 'Install a formula or cask'
__fish_brew_complete_arg 'install' -l HEAD -d 'If formula defines it, install the HEAD version, aka. main, trunk, unstable, master'
__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 audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)'
__fish_brew_complete_arg 'install' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `${HOME}/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 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'
__fish_brew_complete_arg 'install' -l cask -d 'Treat all named arguments as casks'
__fish_brew_complete_arg 'install' -l cc -d 'Attempt to compile using the specified compiler, which should be the name of the compiler\'s executable, e.g. `gcc-9` for GCC 9. In order to use LLVM\'s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option'
__fish_brew_complete_arg 'install' -l colorpickerdir -d 'Target location for Color Pickers (default: `~/Library/ColorPickers`)'
__fish_brew_complete_arg 'install' -l colorpickerdir -d 'Target location for Color Pickers (default: `${HOME}/Library/ColorPickers`)'
__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 dictionarydir -d 'Target location for Dictionaries (default: `${HOME}/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 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`)'
__fish_brew_complete_arg 'install' -l fontdir -d 'Target location for Fonts (default: `${HOME}/Library/Fonts`)'
__fish_brew_complete_arg 'install' -l force -d '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)'
__fish_brew_complete_arg 'install' -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'
__fish_brew_complete_arg 'install' -l formula -d 'Treat all named arguments as formulae'
@ -948,30 +948,30 @@ __fish_brew_complete_arg 'install' -l git -d 'Create a Git repository, useful fo
__fish_brew_complete_arg 'install' -l help -d 'Show this message'
__fish_brew_complete_arg 'install' -l ignore-dependencies -d 'An unsupported Homebrew development option to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If you\'re not developing Homebrew, consider adjusting your PATH rather than using this option'
__fish_brew_complete_arg 'install' -l include-test -d 'Install testing dependencies required to run `brew test` formula'
__fish_brew_complete_arg 'install' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'install' -l input-methoddir -d 'Target location for Input Methods (default: `${HOME}/Library/Input Methods`)'
__fish_brew_complete_arg 'install' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
__fish_brew_complete_arg 'install' -l internet-plugindir -d 'Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'install' -l internet-plugindir -d 'Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'install' -l keep-tmp -d 'Retain the temporary files created during installation'
__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 mdimporterdir -d 'Target location for Spotlight Plugins (default: `${HOME}/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 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 prefpanedir -d 'Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)'
__fish_brew_complete_arg 'install' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)'
__fish_brew_complete_arg 'install' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)'
__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 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 screen-saverdir -d 'Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)'
__fish_brew_complete_arg 'install' -l servicedir -d 'Target location for Services (default: `${HOME}/Library/Services`)'
__fish_brew_complete_arg 'install' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'install' -l skip-link -d 'Install but skip linking the keg into the prefix'
__fish_brew_complete_arg 'install' -l skip-post-install -d 'Install but skip any post-install steps'
__fish_brew_complete_arg 'install' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'install' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'install' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'install' -l vst-plugindir -d 'Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'install' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'install' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
__fish_brew_complete_arg 'install; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_arg 'install; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_all)'
@ -1164,7 +1164,7 @@ __fish_brew_complete_arg 'missing' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_arg 'missing' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_cmd 'nodenv-sync' 'Create symlinks for Homebrew\'s installed NodeJS versions in `~/.nodenv/versions`'
__fish_brew_complete_cmd 'nodenv-sync' 'Create symlinks for Homebrew\'s installed NodeJS versions in `${HOME}/.nodenv/versions`'
__fish_brew_complete_arg 'nodenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'nodenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'nodenv-sync' -l quiet -d 'Make some output more quiet'
@ -1302,14 +1302,14 @@ __fish_brew_complete_arg 'prof' -l vernier -d 'Use `vernier` instead of `ruby-pr
__fish_brew_complete_arg 'prof' -a '(__fish_brew_suggest_commands)'
__fish_brew_complete_cmd 'pyenv-sync' 'Create symlinks for Homebrew\'s installed Python versions in `~/.pyenv/versions`'
__fish_brew_complete_cmd 'pyenv-sync' 'Create symlinks for Homebrew\'s installed Python versions in `${HOME}/.pyenv/versions`'
__fish_brew_complete_arg 'pyenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'pyenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'pyenv-sync' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'pyenv-sync' -l verbose -d 'Make some output more verbose'
__fish_brew_complete_cmd 'rbenv-sync' 'Create symlinks for Homebrew\'s installed Ruby versions in `~/.rbenv/versions`'
__fish_brew_complete_cmd 'rbenv-sync' 'Create symlinks for Homebrew\'s installed Ruby versions in `${HOME}/.rbenv/versions`'
__fish_brew_complete_arg 'rbenv-sync' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'rbenv-sync' -l help -d 'Show this message'
__fish_brew_complete_arg 'rbenv-sync' -l quiet -d 'Make some output more quiet'
@ -1320,7 +1320,7 @@ __fish_brew_complete_cmd 'readall' 'Import all items from the specified tap, or
__fish_brew_complete_arg 'readall' -l aliases -d 'Verify any alias symlinks in each tap'
__fish_brew_complete_arg 'readall' -l arch -d 'Read using the given CPU architecture. (Pass `all` to simulate all architectures.)'
__fish_brew_complete_arg 'readall' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'readall' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'readall' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'readall' -l help -d 'Show this message'
__fish_brew_complete_arg 'readall' -l no-simulate -d 'Don\'t simulate other system configurations when checking formulae and casks'
__fish_brew_complete_arg 'readall' -l os -d 'Read using the given operating system. (Pass `all` to simulate all operating systems.)'
@ -1333,41 +1333,41 @@ __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 audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)'
__fish_brew_complete_arg 'reinstall' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `${HOME}/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 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 colorpickerdir -d 'Target location for Color Pickers (default: `${HOME}/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 dictionarydir -d 'Target location for Dictionaries (default: `${HOME}/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 fontdir -d 'Target location for Fonts (default: `~/Library/Fonts`)'
__fish_brew_complete_arg 'reinstall' -l fontdir -d 'Target location for Fonts (default: `${HOME}/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'
__fish_brew_complete_arg 'reinstall' -l formula -d 'Treat all named arguments as formulae'
__fish_brew_complete_arg 'reinstall' -l git -d 'Create a Git repository, useful for creating patches to the software'
__fish_brew_complete_arg 'reinstall' -l help -d 'Show this message'
__fish_brew_complete_arg 'reinstall' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'reinstall' -l input-methoddir -d 'Target location for Input Methods (default: `${HOME}/Library/Input Methods`)'
__fish_brew_complete_arg 'reinstall' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
__fish_brew_complete_arg 'reinstall' -l internet-plugindir -d 'Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'reinstall' -l internet-plugindir -d 'Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'reinstall' -l keep-tmp -d 'Retain the temporary files created during installation'
__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 mdimporterdir -d 'Target location for Spotlight Plugins (default: `${HOME}/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 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 prefpanedir -d 'Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)'
__fish_brew_complete_arg 'reinstall' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)'
__fish_brew_complete_arg 'reinstall' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)'
__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 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 screen-saverdir -d 'Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)'
__fish_brew_complete_arg 'reinstall' -l servicedir -d 'Target location for Services (default: `${HOME}/Library/Services`)'
__fish_brew_complete_arg 'reinstall' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'reinstall' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'reinstall' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'reinstall' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'reinstall' -l vst-plugindir -d 'Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'reinstall' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'reinstall' -l zap -d 'For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*'
__fish_brew_complete_arg 'reinstall; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_all)'
__fish_brew_complete_arg 'reinstall; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_all)'
@ -1442,7 +1442,7 @@ __fish_brew_complete_arg 'search' -l closed -d 'Search for only closed GitHub pu
__fish_brew_complete_arg 'search' -l debian -d 'Search for text in the given database'
__fish_brew_complete_arg 'search' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'search' -l desc -d 'Search for formulae with a description matching text and casks with a name or description matching text'
__fish_brew_complete_arg 'search' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'search' -l eval-all -d 'Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'search' -l fedora -d 'Search for text in the given database'
__fish_brew_complete_arg 'search' -l fink -d 'Search for text in the given database'
__fish_brew_complete_arg 'search' -l formula -d 'Search for formulae'
@ -1513,7 +1513,7 @@ __fish_brew_complete_arg 'tab; and not __fish_seen_argument -l formula -l formul
__fish_brew_complete_cmd 'tap' 'Tap a formula repository'
__fish_brew_complete_arg 'tap' -l custom-remote -d 'Install or change a tap with a custom remote. Useful for mirrors'
__fish_brew_complete_arg 'tap' -l debug -d 'Display any debugging information'
__fish_brew_complete_arg 'tap' -l eval-all -d 'Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'tap' -l eval-all -d 'Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `$HOMEBREW_EVAL_ALL` is set'
__fish_brew_complete_arg 'tap' -l force -d 'Force install core taps even under API mode'
__fish_brew_complete_arg 'tap' -l help -d 'Show this message'
__fish_brew_complete_arg 'tap' -l quiet -d 'Make some output more quiet'
@ -1766,18 +1766,18 @@ __fish_brew_complete_arg 'update-test' -l verbose -d 'Make some output more verb
__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 audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)'
__fish_brew_complete_arg 'upgrade' -l audio-unit-plugindir -d 'Target location for Audio Unit Plugins (default: `${HOME}/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 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 colorpickerdir -d 'Target location for Color Pickers (default: `${HOME}/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 dictionarydir -d 'Target location for Dictionaries (default: `${HOME}/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 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`)'
__fish_brew_complete_arg 'upgrade' -l fontdir -d 'Target location for Fonts (default: `${HOME}/Library/Fonts`)'
__fish_brew_complete_arg 'upgrade' -l force -d '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)'
__fish_brew_complete_arg 'upgrade' -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'
__fish_brew_complete_arg 'upgrade' -l formula -d 'Treat all named arguments as formulae. If no named arguments are specified, upgrade only outdated formulae'
@ -1785,27 +1785,27 @@ __fish_brew_complete_arg 'upgrade' -l greedy -d 'Also include casks with `auto_u
__fish_brew_complete_arg 'upgrade' -l greedy-auto-updates -d 'Also include casks with `auto_updates true`'
__fish_brew_complete_arg 'upgrade' -l greedy-latest -d 'Also include casks with `version :latest`'
__fish_brew_complete_arg 'upgrade' -l help -d 'Show this message'
__fish_brew_complete_arg 'upgrade' -l input-methoddir -d 'Target location for Input Methods (default: `~/Library/Input Methods`)'
__fish_brew_complete_arg 'upgrade' -l input-methoddir -d 'Target location for Input Methods (default: `${HOME}/Library/Input Methods`)'
__fish_brew_complete_arg 'upgrade' -l interactive -d 'Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package'
__fish_brew_complete_arg 'upgrade' -l internet-plugindir -d 'Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'upgrade' -l internet-plugindir -d 'Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)'
__fish_brew_complete_arg 'upgrade' -l keep-tmp -d 'Retain the temporary files created during installation'
__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 mdimporterdir -d 'Target location for Spotlight Plugins (default: `${HOME}/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 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 prefpanedir -d 'Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)'
__fish_brew_complete_arg 'upgrade' -l qlplugindir -d 'Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)'
__fish_brew_complete_arg 'upgrade' -l quarantine -d 'Disable/enable quarantining of downloads (default: enabled)'
__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 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 screen-saverdir -d 'Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)'
__fish_brew_complete_arg 'upgrade' -l servicedir -d 'Target location for Services (default: `${HOME}/Library/Services`)'
__fish_brew_complete_arg 'upgrade' -l skip-cask-deps -d 'Skip installing cask dependencies'
__fish_brew_complete_arg 'upgrade' -l verbose -d 'Print the verification and post-install steps'
__fish_brew_complete_arg 'upgrade' -l vst-plugindir -d 'Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'upgrade' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'upgrade' -l vst-plugindir -d 'Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)'
__fish_brew_complete_arg 'upgrade' -l vst3-plugindir -d 'Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)'
__fish_brew_complete_arg 'upgrade; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_installed)'
__fish_brew_complete_arg 'upgrade; and not __fish_seen_argument -l formula -l formulae' -a '(__fish_brew_suggest_casks_installed)'

128
completions/zsh/_brew
View File

@ -189,7 +189,7 @@ __brew_internal_commands() {
'log:Show the `git log` for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided'
'migrate:Migrate renamed packages to new names, where formula are old names of packages'
'missing:Check the given formula kegs for missing dependencies'
'nodenv-sync:Create symlinks for Homebrew'\''s installed NodeJS versions in `~/.nodenv/versions`'
'nodenv-sync:Create symlinks for Homebrew'\''s installed NodeJS versions in `${HOME}/.nodenv/versions`'
'options:Show install options specific to formula'
'outdated:List installed casks and formulae that have an updated version available'
'pin:Pin the specified formula, preventing them from being upgraded when issuing the `brew upgrade` formula command'
@ -199,8 +199,8 @@ __brew_internal_commands() {
'pr-pull:Download and publish bottles and apply the bottle commit from a pull request with artifacts generated by GitHub Actions'
'pr-upload:Apply the bottle commit and publish bottles to a host'
'prof:Run Homebrew with a Ruby profiler'
'pyenv-sync:Create symlinks for Homebrew'\''s installed Python versions in `~/.pyenv/versions`'
'rbenv-sync:Create symlinks for Homebrew'\''s installed Ruby versions in `~/.rbenv/versions`'
'pyenv-sync:Create symlinks for Homebrew'\''s installed Python versions in `${HOME}/.pyenv/versions`'
'rbenv-sync:Create symlinks for Homebrew'\''s installed Ruby versions in `${HOME}/.rbenv/versions`'
'readall:Import all items from the specified tap, or from all installed taps if none is provided'
'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'
'release:Create a new draft Homebrew/brew release with the appropriate version number and release notes'
@ -383,7 +383,7 @@ _brew__s() {
'(--repology --macports --fink --opensuse --fedora --archlinux --ubuntu)--debian[Search for text in the given database]' \
'--debug[Display any debugging information]' \
'(--pull-request)--desc[Search for formulae with a description matching text and casks with a name or description matching text]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'(--repology --macports --fink --opensuse --archlinux --debian --ubuntu)--fedora[Search for text in the given database]' \
'(--repology --macports --opensuse --fedora --archlinux --debian --ubuntu)--fink[Search for text in the given database]' \
'--formula[Search for formulae]' \
@ -410,11 +410,11 @@ _brew__v() {
# brew abv
_brew_abv() {
_arguments \
'--analytics[List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set)]' \
'--analytics[List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `$HOMEBREW_NO_ANALYTICS` nor `$HOMEBREW_NO_GITHUB_API` are set)]' \
'--category[Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`]' \
'--days[How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`]' \
'--debug[Display any debugging information]' \
'(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'(--cask --json)--fetch-manifest[Fetch GitHub Packages manifest for extra information when formula is not installed]' \
'--github[Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask]' \
'--help[Show this message]' \
@ -801,7 +801,7 @@ _brew_desc() {
_arguments \
'--debug[Display any debugging information]' \
'(--search --name)--description[Search just descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'--help[Show this message]' \
'(--search --description)--name[Search just names for text. If text is flanked by slashes, it is interpreted as a regular expression]' \
'--quiet[Make some output more quiet]' \
@ -1079,11 +1079,11 @@ _brew_homepage() {
# brew info
_brew_info() {
_arguments \
'--analytics[List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `HOMEBREW_NO_ANALYTICS` nor `HOMEBREW_NO_GITHUB_API` are set)]' \
'--analytics[List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither `$HOMEBREW_NO_ANALYTICS` nor `$HOMEBREW_NO_GITHUB_API` are set)]' \
'--category[Which type of analytics data to retrieve. The value for category must be `install`, `install-on-request` or `build-error`; `cask-install` or `os-version` may be specified if formula is not. The default is `install`]' \
'--days[How many days of analytics data to retrieve. The value for days must be `30`, `90` or `365`. The default is `30`]' \
'--debug[Display any debugging information]' \
'(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'(--installed)--eval-all[Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'(--cask --json)--fetch-manifest[Fetch GitHub Packages manifest for extra information when formula is not installed]' \
'--github[Open the GitHub source page for formula and cask in a browser. To view the history locally: `brew log -p` formula or cask]' \
'--help[Show this message]' \
@ -1106,50 +1106,50 @@ _brew_instal() {
'(--cask)--HEAD[If formula defines it, install the HEAD version, aka. main, trunk, unstable, master]' \
'(--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`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `${HOME}/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \
'(--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]' \
'(--cask)--cc[Attempt to compile using the specified compiler, which should be the name of the compiler'\''s executable, e.g. `gcc-9` for GCC 9. In order to use LLVM'\''s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `${HOME}/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`)]' \
'(--formula)--dictionarydir[Target location for Dictionaries (default: `${HOME}/Library/Dictionaries`)]' \
'--display-times[Print install times for each package at the end of the run]' \
'--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`)]' \
'(--formula)--fontdir[Target location for Fonts (default: `${HOME}/Library/Fonts`)]' \
'(--adopt)--force[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)]' \
'(--cask --build-from-source --build-bottle)--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]' \
'(--cask)--git[Create a Git repository, useful for creating patches to the software]' \
'--help[Show this message]' \
'(--cask --only-dependencies)--ignore-dependencies[An unsupported Homebrew development option to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If you'\''re not developing Homebrew, consider adjusting your PATH rather than using this option]' \
'(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `${HOME}/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)]' \
'(--cask)--keep-tmp[Retain the temporary files created during installation]' \
'(--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`)]' \
'(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `${HOME}/Library/Spotlight`)]' \
'--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \
'--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'(--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)--prefpanedir[Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)]' \
'(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)]' \
'(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'--quiet[Make some output more quiet]' \
'(--formula)--require-sha[Require all casks to have a checksum]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `${HOME}/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'(--cask)--skip-link[Install but skip linking the keg into the prefix]' \
'(--cask)--skip-post-install[Install but skip any post-install steps]' \
'--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
- formula \
'(--casks --binaries --require-sha --quarantine --adopt --skip-cask-deps --zap --appdir --keyboard-layoutdir --colorpickerdir --prefpanedir --qlplugindir --mdimporterdir --dictionarydir --fontdir --servicedir --input-methoddir --internet-plugindir --audio-unit-plugindir --vst-plugindir --vst3-plugindir --screen-saverdir --language)--formula[Treat all named arguments as formulae]' \
@ -1165,50 +1165,50 @@ _brew_install() {
'(--cask)--HEAD[If formula defines it, install the HEAD version, aka. main, trunk, unstable, master]' \
'(--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`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `${HOME}/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \
'(--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]' \
'(--cask)--cc[Attempt to compile using the specified compiler, which should be the name of the compiler'\''s executable, e.g. `gcc-9` for GCC 9. In order to use LLVM'\''s clang, specify `llvm_clang`. To use the Apple-provided clang, specify `clang`. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `~/Library/ColorPickers`)]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `${HOME}/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`)]' \
'(--formula)--dictionarydir[Target location for Dictionaries (default: `${HOME}/Library/Dictionaries`)]' \
'--display-times[Print install times for each package at the end of the run]' \
'--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`)]' \
'(--formula)--fontdir[Target location for Fonts (default: `${HOME}/Library/Fonts`)]' \
'(--adopt)--force[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)]' \
'(--cask --build-from-source --build-bottle)--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]' \
'(--cask)--git[Create a Git repository, useful for creating patches to the software]' \
'--help[Show this message]' \
'(--cask --only-dependencies)--ignore-dependencies[An unsupported Homebrew development option to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If you'\''re not developing Homebrew, consider adjusting your PATH rather than using this option]' \
'(--cask)--include-test[Install testing dependencies required to run `brew test` formula]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `${HOME}/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)]' \
'(--cask)--keep-tmp[Retain the temporary files created during installation]' \
'(--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`)]' \
'(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `${HOME}/Library/Spotlight`)]' \
'--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \
'--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'(--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)--prefpanedir[Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)]' \
'(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)]' \
'(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'--quiet[Make some output more quiet]' \
'(--formula)--require-sha[Require all casks to have a checksum]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `${HOME}/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'(--cask)--skip-link[Install but skip linking the keg into the prefix]' \
'(--cask)--skip-post-install[Install but skip any post-install steps]' \
'--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
- formula \
'(--casks --binaries --require-sha --quarantine --adopt --skip-cask-deps --zap --appdir --keyboard-layoutdir --colorpickerdir --prefpanedir --qlplugindir --mdimporterdir --dictionarydir --fontdir --servicedir --input-methoddir --internet-plugindir --audio-unit-plugindir --vst-plugindir --vst3-plugindir --screen-saverdir --language)--formula[Treat all named arguments as formulae]' \
@ -1638,7 +1638,7 @@ _brew_readall() {
'--aliases[Verify any alias symlinks in each tap]' \
'--arch[Read using the given CPU architecture. (Pass `all` to simulate all architectures.)]' \
'--debug[Display any debugging information]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'--help[Show this message]' \
'--no-simulate[Don'\''t simulate other system configurations when checking formulae and casks]' \
'--os[Read using the given operating system. (Pass `all` to simulate all operating systems.)]' \
@ -1654,39 +1654,39 @@ _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`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `${HOME}/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \
'(--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`)]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `${HOME}/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`)]' \
'(--formula)--dictionarydir[Target location for Dictionaries (default: `${HOME}/Library/Dictionaries`)]' \
'--display-times[Print install times for each package at the end of the run]' \
'(--formula)--fontdir[Target location for Fonts (default: `~/Library/Fonts`)]' \
'(--formula)--fontdir[Target location for Fonts (default: `${HOME}/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]' \
'(--cask)--git[Create a Git repository, useful for creating patches to the software]' \
'--help[Show this message]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `${HOME}/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)]' \
'(--cask)--keep-tmp[Retain the temporary files created during installation]' \
'(--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`)]' \
'(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `${HOME}/Library/Spotlight`)]' \
'--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \
'--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'(--formula)--prefpanedir[Target location for Preference Panes (default: `~/Library/PreferencePanes`)]' \
'(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `~/Library/QuickLook`)]' \
'(--formula)--prefpanedir[Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)]' \
'(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)]' \
'(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'--quiet[Make some output more quiet]' \
'(--formula)--require-sha[Require all casks to have a checksum]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `${HOME}/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--zap[For use with `brew reinstall --cask`. Remove all files associated with a cask. *May remove files which are shared between applications.*]' \
- formula \
'(--casks --binaries --require-sha --quarantine --adopt --skip-cask-deps --zap --appdir --keyboard-layoutdir --colorpickerdir --prefpanedir --qlplugindir --mdimporterdir --dictionarydir --fontdir --servicedir --input-methoddir --internet-plugindir --audio-unit-plugindir --vst-plugindir --vst3-plugindir --screen-saverdir --language)--formula[Treat all named arguments as formulae]' \
@ -1785,7 +1785,7 @@ _brew_search() {
'(--repology --macports --fink --opensuse --fedora --archlinux --ubuntu)--debian[Search for text in the given database]' \
'--debug[Display any debugging information]' \
'(--pull-request)--desc[Search for formulae with a description matching text and casks with a name or description matching text]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--eval-all[Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'(--repology --macports --fink --opensuse --archlinux --debian --ubuntu)--fedora[Search for text in the given database]' \
'(--repology --macports --opensuse --fedora --archlinux --debian --ubuntu)--fink[Search for text in the given database]' \
'--formula[Search for formulae]' \
@ -1878,7 +1878,7 @@ _brew_tap() {
_arguments \
'--custom-remote[Install or change a tap with a custom remote. Useful for mirrors]' \
'--debug[Display any debugging information]' \
'--eval-all[Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `HOMEBREW_EVAL_ALL` is set]' \
'--eval-all[Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if `$HOMEBREW_EVAL_ALL` is set]' \
'--force[Force install core taps even under API mode]' \
'--help[Show this message]' \
'--quiet[Make some output more quiet]' \
@ -2195,44 +2195,44 @@ _brew_update_test() {
_brew_upgrade() {
_arguments \
'(--formula)--appdir[Target location for Applications (default: `/Applications`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `~/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--audio-unit-plugindir[Target location for Audio Unit Plugins (default: `${HOME}/Library/Audio/Plug-Ins/Components`)]' \
'(--formula)--binaries[Disable/enable linking of helper executables (default: enabled)]' \
'(--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`)]' \
'(--formula)--colorpickerdir[Target location for Color Pickers (default: `${HOME}/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`)]' \
'(--formula)--dictionarydir[Target location for Dictionaries (default: `${HOME}/Library/Dictionaries`)]' \
'--display-times[Print install times for each package at the end of the run]' \
'--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`)]' \
'(--formula)--fontdir[Target location for Fonts (default: `${HOME}/Library/Fonts`)]' \
'--force[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)]' \
'(--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]' \
'(--formula)--greedy[Also include casks with `auto_updates true` or `version :latest`]' \
'(--formula)--greedy-auto-updates[Also include casks with `auto_updates true`]' \
'(--formula)--greedy-latest[Also include casks with `version :latest`]' \
'--help[Show this message]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `~/Library/Input Methods`)]' \
'(--formula)--input-methoddir[Target location for Input Methods (default: `${HOME}/Library/Input Methods`)]' \
'(--cask)--interactive[Download and patch formula, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`)]' \
'(--formula)--internet-plugindir[Target location for Internet Plugins (default: `${HOME}/Library/Internet Plug-Ins`)]' \
'(--cask)--keep-tmp[Retain the temporary files created during installation]' \
'(--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`)]' \
'(--formula)--mdimporterdir[Target location for Spotlight Plugins (default: `${HOME}/Library/Spotlight`)]' \
'--no-binaries[Disable/enable linking of helper executables (default: enabled)]' \
'--no-quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'(--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)--prefpanedir[Target location for Preference Panes (default: `${HOME}/Library/PreferencePanes`)]' \
'(--formula)--qlplugindir[Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`)]' \
'(--formula)--quarantine[Disable/enable quarantining of downloads (default: enabled)]' \
'--quiet[Make some output more quiet]' \
'(--formula)--require-sha[Require all casks to have a checksum]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `~/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `~/Library/Services`)]' \
'(--formula)--screen-saverdir[Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`)]' \
'(--formula)--servicedir[Target location for Services (default: `${HOME}/Library/Services`)]' \
'(--formula)--skip-cask-deps[Skip installing cask dependencies]' \
'--verbose[Print the verification and post-install steps]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`)]' \
'(--formula)--vst-plugindir[Target location for VST Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST`)]' \
'(--formula)--vst3-plugindir[Target location for VST3 Plugins (default: `${HOME}/Library/Audio/Plug-Ins/VST3`)]' \
- installed_formula \
'(--casks --skip-cask-deps --greedy --greedy-latest --greedy-auto-updates --binaries --require-sha --quarantine --appdir --keyboard-layoutdir --colorpickerdir --prefpanedir --qlplugindir --mdimporterdir --dictionarydir --fontdir --servicedir --input-methoddir --internet-plugindir --audio-unit-plugindir --vst-plugindir --vst3-plugindir --screen-saverdir --language)--formula[Treat all named arguments as formulae. If no named arguments are specified, upgrade only outdated formulae]' \
'*::installed_formula:__brew_installed_formulae' \

198
docs/Manpage.md
View File

@ -131,7 +131,7 @@ List all locally installable casks including short names.
Remove stale lock files and outdated downloads for all formulae and casks, and
remove old versions of installed formulae. If arguments are specified, only do
this for the given formulae and casks. Removes all downloads more than 120 days
old. This can be adjusted with `HOMEBREW_CLEANUP_MAX_AGE_DAYS`.
old. This can be adjusted with `$HOMEBREW_CLEANUP_MAX_AGE_DAYS`.
`--prune`
@ -322,7 +322,7 @@ first search, making that search slower than subsequent ones.
`--eval-all`
: Evaluate all available formulae and casks, whether installed or not, to search
their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set.
their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set.
`--formula`
@ -484,8 +484,8 @@ Display brief statistics for your Homebrew installation. If a *`formula`* or
`--analytics`
: List global Homebrew analytics data or, if specified, installation and build
error data for *`formula`* (provided neither `HOMEBREW_NO_ANALYTICS` nor
`HOMEBREW_NO_GITHUB_API` are set).
error data for *`formula`* (provided neither `$HOMEBREW_NO_ANALYTICS` nor
`$HOMEBREW_NO_GITHUB_API` are set).
`--days`
@ -521,7 +521,7 @@ Display brief statistics for your Homebrew installation. If a *`formula`* or
`--eval-all`
: Evaluate all available formulae and casks, whether installed or not, to print
their JSON. Implied if `HOMEBREW_EVAL_ALL` is set.
their JSON. Implied if `$HOMEBREW_EVAL_ALL` is set.
`--variations`
@ -544,14 +544,14 @@ Display brief statistics for your Homebrew installation. If a *`formula`* or
Install a *`formula`* or *`cask`*. Additional options specific to a *`formula`*
may be appended to the command.
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
reinstall` will be run for outdated dependents and dependents with broken
linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the installed formulae or, every 30 days, for all formulae.
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run
for the installed formulae or, every 30 days, for all formulae.
Unless `HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` *`formula`* will
Unless `$HOMEBREW_NO_INSTALL_UPGRADE` is set, `brew install` *`formula`* will
upgrade *`formula`* if it is already installed but outdated.
`-d`, `--debug`
@ -871,7 +871,7 @@ to be missing dependencies.
### `nodenv-sync`
Create symlinks for Homebrew's installed NodeJS versions in
`~/.nodenv/versions`.
`${HOME}/.nodenv/versions`.
Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will
also be symlinked to 19.0.0.
@ -957,14 +957,16 @@ Rerun the post-install steps for *`formula`*.
### `pyenv-sync`
Create symlinks for Homebrew's installed Python versions in `~/.pyenv/versions`.
Create symlinks for Homebrew's installed Python versions in
`${HOME}/.pyenv/versions`.
Note that older patch version symlinks will be created and linked to the minor
version so e.g. Python 3.11.0 will also be symlinked to 3.11.3.
### `rbenv-sync`
Create symlinks for Homebrew's installed Ruby versions in `~/.rbenv/versions`.
Create symlinks for Homebrew's installed Ruby versions in
`${HOME}/.rbenv/versions`.
Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will
also be symlinked to 3.2.0.
@ -997,7 +999,7 @@ all items or checking if any current formulae/casks have Ruby issues.
`--eval-all`
: Evaluate all available formulae and casks, whether installed or not. Implied
if `HOMEBREW_EVAL_ALL` is set.
if `$HOMEBREW_EVAL_ALL` is set.
`--no-simulate`
@ -1009,12 +1011,12 @@ 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`*.
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
reinstall` will be run for outdated dependents and dependents with broken
linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the reinstalled formulae or, every 30 days, for all formulae.
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run
for the reinstalled formulae or, every 30 days, for all formulae.
`-d`, `--debug`
@ -1116,7 +1118,7 @@ Perform a substring search of cask tokens and formula names for *`text`*. If
`--eval-all`
: Evaluate all available formulae and casks, whether installed or not, to search
their descriptions. Implied if `HOMEBREW_EVAL_ALL` is set.
their descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set.
`--pull-request`
@ -1174,13 +1176,13 @@ 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`.
The variables `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are
also exported to avoid querying them multiple times. To help guarantee
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 your dotfiles (e.g. `~/.bash_profile` or
`~/.zprofile` on macOS and `~/.bashrc` or `~/.zshrc` on Linux) with: `eval
"$(brew shellenv)"`
evaluation of this command's output to your dotfiles (e.g.
`${HOME}/.bash_profile` or `${HOME}/.zprofile` on macOS and `${HOME}/.bashrc` or
`${HOME}/.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.
@ -1235,7 +1237,7 @@ HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
`--eval-all`
: Evaluate all the formulae, casks and aliases in the new tap to check validity.
Implied if `HOMEBREW_EVAL_ALL` is set.
Implied if `$HOMEBREW_EVAL_ALL` is set.
`-f`, `--force`
@ -1346,12 +1348,12 @@ they were originally installed with, plus any appended brew formula options. If
*`cask`* or *`formula`* are specified, upgrade only the given *`cask`* or
*`formula`* kegs (unless they are pinned; see `pin`, `unpin`).
Unless `HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
Unless `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set, `brew upgrade` or `brew
reinstall` will be run for outdated dependents and dependents with broken
linkage, respectively.
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for
the upgraded formulae or, every 30 days, for all formulae.
Unless `$HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run
for the upgraded formulae or, every 30 days, for all formulae.
`-d`, `--debug`
@ -1505,7 +1507,7 @@ dependency for their stable builds.
### `--cache` \[*`options`*\] \[*`formula`*\|*`cask`* ...\]
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
Display Homebrew's download cache. See also `$HOMEBREW_CACHE`.
If a *`formula`* or *`cask`* is provided, display the file or directory used to
cache it.
@ -2341,7 +2343,8 @@ provided, check all kegs. Raises an error if run on uninstalled formulae.
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
`${HOME}/.homebrew/livecheck_watchlist.txt`.
`--full-name`
@ -2980,56 +2983,60 @@ subcommands with the `--cask` switch.
`--colorpickerdir`
: Target location for Color Pickers (default: `~/Library/ColorPickers`).
: Target location for Color Pickers (default: `${HOME}/Library/ColorPickers`).
`--prefpanedir`
: Target location for Preference Panes (default: `~/Library/PreferencePanes`).
: Target location for Preference Panes (default:
`${HOME}/Library/PreferencePanes`).
`--qlplugindir`
: Target location for Quick Look Plugins (default: `~/Library/QuickLook`).
: Target location for Quick Look Plugins (default: `${HOME}/Library/QuickLook`).
`--mdimporterdir`
: Target location for Spotlight Plugins (default: `~/Library/Spotlight`).
: Target location for Spotlight Plugins (default: `${HOME}/Library/Spotlight`).
`--dictionarydir`
: Target location for Dictionaries (default: `~/Library/Dictionaries`).
: Target location for Dictionaries (default: `${HOME}/Library/Dictionaries`).
`--fontdir`
: Target location for Fonts (default: `~/Library/Fonts`).
: Target location for Fonts (default: `${HOME}/Library/Fonts`).
`--servicedir`
: Target location for Services (default: `~/Library/Services`).
: Target location for Services (default: `${HOME}/Library/Services`).
`--input-methoddir`
: Target location for Input Methods (default: `~/Library/Input Methods`).
: Target location for Input Methods (default: `${HOME}/Library/Input Methods`).
`--internet-plugindir`
: Target location for Internet Plugins (default: `~/Library/Internet Plug-Ins`).
: Target location for Internet Plugins (default: `${HOME}/Library/Internet
Plug-Ins`).
`--audio-unit-plugindir`
: Target location for Audio Unit Plugins (default:
`~/Library/Audio/Plug-Ins/Components`).
`${HOME}/Library/Audio/Plug-Ins/Components`).
`--vst-plugindir`
: Target location for VST Plugins (default: `~/Library/Audio/Plug-Ins/VST`).
: Target location for VST Plugins (default:
`${HOME}/Library/Audio/Plug-Ins/VST`).
`--vst3-plugindir`
: Target location for VST3 Plugins (default: `~/Library/Audio/Plug-Ins/VST3`).
: Target location for VST3 Plugins (default:
`${HOME}/Library/Audio/Plug-Ins/VST3`).
`--screen-saverdir`
: Target location for Screen Savers (default: `~/Library/Screen Savers`).
: Target location for Screen Savers (default: `${HOME}/Library/Screen Savers`).
`--language`
@ -3078,13 +3085,13 @@ Whalebrew and Visual Studio Code.
: Install and upgrade (by default) all dependencies from the `Brewfile`.
You can specify the `Brewfile` location using `--file` or by setting the
`HOMEBREW_BUNDLE_FILE` environment variable.
`$HOMEBREW_BUNDLE_FILE` environment variable.
You can skip the installation of dependencies by adding space-separated values
to one or more of the following environment variables:
`HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`,
`HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`,
`HOMEBREW_BUNDLE_TAP_SKIP`.
`$HOMEBREW_BUNDLE_BREW_SKIP`, `$HOMEBREW_BUNDLE_CASK_SKIP`,
`$HOMEBREW_BUNDLE_MAS_SKIP`, `$HOMEBREW_BUNDLE_WHALEBREW_SKIP`,
`$HOMEBREW_BUNDLE_TAP_SKIP`.
`brew bundle upgrade`
@ -3149,8 +3156,9 @@ flags which will help with finding keg-only dependencies like `openssl`,
`--global`
: Read the `Brewfile` from `~/.Brewfile`, in the `HOMEBREW_USER_CONFIG_HOME`
directory, or the `HOMEBREW_BUNDLE_FILE_GLOBAL` environment variable, if set.
: Read the `Brewfile` from `$HOMEBREW_BUNDLE_FILE_GLOBAL` (if set),
`${XDG_CONFIG_HOME}/homebrew/Brewfile` (if `$XDG_CONFIG_HOME` is set),
`${HOME}/.homebrew/Brewfile` or `${HOME}/.Brewfile` otherwise.
`-v`, `--verbose`
@ -3161,13 +3169,13 @@ 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. This is enabled by default if
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
`--upgrade`
: `install` runs `brew upgrade` on outdated dependencies, even if
`HOMEBREW_BUNDLE_NO_UPGRADE` is set.
`$HOMEBREW_BUNDLE_NO_UPGRADE` is set.
`-f`, `--force`
@ -3177,7 +3185,7 @@ 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
is enabled by default if `$HOMEBREW_BUNDLE_INSTALL_CLEANUP` is set and
`--global` is passed.
`--all`
@ -3211,13 +3219,13 @@ flags which will help with finding keg-only dependencies like `openssl`,
`--no-vscode`
: `dump` without VSCode extensions. This is enabled by default if
`HOMEBREW_BUNDLE_DUMP_NO_VSCODE` is set.
`$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.
`$HOMEBREW_BUNDLE_DUMP_DESCRIBE` is set.
`--no-restart`
@ -3239,7 +3247,8 @@ Manage background services with macOS' `launchctl`(1) daemon manager or Linux's
If `sudo` is passed, operate on `/Library/LaunchDaemons` or
`/usr/lib/systemd/system` (started at boot). Otherwise, operate on
`~/Library/LaunchAgents` or `~/.config/systemd/user` (started at login).
`${HOME}/Library/LaunchAgents` or `${HOME}/.config/systemd/user` (started at
login).
\[`sudo`\] `brew services` \[`list`\] (`--json`) (`--debug`)
@ -3599,8 +3608,8 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_API_AUTO_UPDATE_SECS`
: Check Homebrew's API for new formulae or cask data every
`HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API
auto-update checks entirely with `HOMEBREW_NO_AUTO_UPDATE`.
`$HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API
auto-update checks entirely with `$HOMEBREW_NO_AUTO_UPDATE`.
*Default:* `450`.
@ -3622,8 +3631,8 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_ARTIFACT_DOMAIN`
: Prefix all download URLs, including those for bottles, with this value. For
example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a formula
with the URL `https://example.com/foo.tar.gz` to instead download from
example, `export HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a
formula with the URL `https://example.com/foo.tar.gz` to instead download from
`http://localhost:8080/https://example.com/foo.tar.gz`. Bottle URLs however,
have their domain replaced with this prefix. This results in e.g.
`https://ghcr.io/v2/homebrew/core/gettext/manifests/0.21` to instead be
@ -3632,18 +3641,18 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK`
: If `HOMEBREW_ARTIFACT_DOMAIN` and `HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are
both set, if the request to `HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew
: If `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are
both set, if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew
will error rather than trying any other/default URLs.
`HOMEBREW_AUTO_UPDATE_SECS`
: Run `brew update` once every `HOMEBREW_AUTO_UPDATE_SECS` seconds before some
: Run `brew update` once every `$HOMEBREW_AUTO_UPDATE_SECS` seconds before some
commands, e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively,
disable auto-update entirely with `HOMEBREW_NO_AUTO_UPDATE`.
disable auto-update entirely with `$HOMEBREW_NO_AUTO_UPDATE`.
*Default:* `86400` (24 hours), `3600` (1 hour) if a developer command has been
run or `300` (5 minutes) if `HOMEBREW_NO_INSTALL_FROM_API` is set.
run or `300` (5 minutes) if `$HOMEBREW_NO_INSTALL_FROM_API` is set.
`HOMEBREW_BAT`
@ -3670,10 +3679,10 @@ command execution e.g. `$(cat file)`.
: Use this URL as the download mirror for bottles. If bottles at that URL are
temporarily unavailable, the default bottle domain will be used as a fallback
mirror. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause
all bottles to download from the prefix `http://localhost:8080/`. If bottles
are not available at `HOMEBREW_BOTTLE_DOMAIN` they will be downloaded from the
default bottle domain.
mirror. For example, `export HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080`
will cause all bottles to download from the prefix `http://localhost:8080/`.
If bottles are not available at `$HOMEBREW_BOTTLE_DOMAIN` they will be
downloaded from the default bottle domain.
*Default:* `https://ghcr.io/v2/homebrew/core`.
@ -3709,9 +3718,10 @@ command execution e.g. `$(cat file)`.
: Append these options to all `cask` commands. All `--*dir` options,
`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are
supported. For example, you might add something like the following to your
`~/.profile`, `~/.bash_profile`, or `~/.zshenv`:
`${HOME}/.profile`, `${HOME}/.bash_profile`, or `${HOME}/.zshenv`:
`export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"`
`export HOMEBREW_CASK_OPTS="--appdir=${HOME}/Applications
--fontdir=/Library/Fonts"`
`HOMEBREW_CLEANUP_MAX_AGE_DAYS`
@ -3792,13 +3802,13 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`
: Use this base64 encoded username and password for authenticating with a Docker
registry proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set,
it will be used instead.
registry proxying GitHub Packages. If `$HOMEBREW_DOCKER_REGISTRY_TOKEN` is
set, it will be used instead.
`HOMEBREW_DOCKER_REGISTRY_TOKEN`
: Use this bearer token for authenticating with a Docker registry proxying
GitHub Packages. Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.
GitHub Packages. Preferred over `$HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.
`HOMEBREW_EDITOR`
@ -3840,13 +3850,13 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_FORBIDDEN_OWNER`
: The person who has set any `HOMEBREW_FORBIDDEN_*` variables.
: The person who has set any `$HOMEBREW_FORBIDDEN_*` variables.
*Default:* `you`.
`HOMEBREW_FORBIDDEN_OWNER_CONTACT`
: How to contact the `HOMEBREW_FORBIDDEN_OWNER`, if set and necessary.
: How to contact the `$HOMEBREW_FORBIDDEN_OWNER`, if set and necessary.
`HOMEBREW_FORBIDDEN_TAPS`
@ -3861,7 +3871,7 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_FORCE_API_AUTO_UPDATE`
: If set, update the Homebrew API formula or cask data even if
`HOMEBREW_NO_AUTO_UPDATE` is set.
`$HOMEBREW_NO_AUTO_UPDATE` is set.
`HOMEBREW_FORCE_BREWED_CA_CERTIFICATES`
@ -3880,8 +3890,8 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_FORCE_BREW_WRAPPER`
: If set, require `HOMEBREW_BREW_WRAPPER` to be set to the same value as
`HOMEBREW_FORCE_BREW_WRAPPER` for non-trivial `brew` commands.
: If set, require `$HOMEBREW_BREW_WRAPPER` to be set to the same value as
`$HOMEBREW_FORCE_BREW_WRAPPER` for non-trivial `brew` commands.
`HOMEBREW_FORCE_VENDOR_RUBY`
@ -3939,12 +3949,12 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_GIT_EMAIL`
: Set the Git author name and, if `HOMEBREW_GIT_COMMITTER_EMAIL` is unset,
: Set the Git author name and, if `$HOMEBREW_GIT_COMMITTER_EMAIL` is unset,
committer email to this value.
`HOMEBREW_GIT_NAME`
: Set the Git author name and, if `HOMEBREW_GIT_COMMITTER_NAME` is unset,
: Set the Git author name and, if `$HOMEBREW_GIT_COMMITTER_NAME` is unset,
committer name to this value.
`HOMEBREW_GIT_PATH`
@ -3970,8 +3980,8 @@ command execution e.g. `$(cat file)`.
: Consult this file for the list of formulae to check by default when no formula
argument is passed to `brew livecheck`.
*Default:* `$XDG_CONFIG_HOME/homebrew/livecheck_watchlist.txt` if
`$XDG_CONFIG_HOME` is set or `$HOME/.homebrew/livecheck_watchlist.txt`
*Default:* `${XDG_CONFIG_HOME}/homebrew/livecheck_watchlist.txt` if
`$XDG_CONFIG_HOME` is set or `${HOME}/.homebrew/livecheck_watchlist.txt`
otherwise.
`HOMEBREW_LOCK_CONTEXT`
@ -3983,8 +3993,8 @@ command execution e.g. `$(cat file)`.
: Use this directory to store log files.
*Default:* macOS: `$HOME/Library/Logs/Homebrew`, Linux:
`$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.
*Default:* macOS: `${HOME}/Library/Logs/Homebrew`, Linux:
`${XDG_CACHE_HOME}/Homebrew/Logs` or `${HOME}/.cache/Homebrew/Logs`.
`HOMEBREW_MAKE_JOBS`
@ -4007,7 +4017,7 @@ command execution e.g. `$(cat file)`.
: If set, do not automatically update before running some commands, e.g. `brew
install`, `brew upgrade` and `brew tap`. Preferably, run this less often by
setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default. Note
setting `$HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default. Note
that setting this and e.g. tapping new taps may result in a broken
configuration. Please ensure you always run `brew update` before reporting any
issues.
@ -4029,7 +4039,7 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_NO_EMOJI`
: If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build.
: If set, do not print `$HOMEBREW_INSTALL_BADGE` on a successful build.
`HOMEBREW_NO_ENV_HINTS`
@ -4038,7 +4048,7 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_NO_FORCE_BREW_WRAPPER`
: If set, disables `HOMEBREW_FORCE_BREW_WRAPPER` behaviour, even if set.
: If set, disables `$HOMEBREW_FORCE_BREW_WRAPPER` behaviour, even if set.
`HOMEBREW_NO_GITHUB_API`
@ -4065,8 +4075,8 @@ command execution e.g. `$(cat file)`.
: If set, `brew install`, `brew upgrade` and `brew reinstall` will never
automatically cleanup installed/upgraded/reinstalled formulae or all formulae
every `HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively,
`HOMEBREW_NO_CLEANUP_FORMULAE` allows specifying specific formulae to not
every `$HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively,
`$HOMEBREW_NO_CLEANUP_FORMULAE` allows specifying specific formulae to not
clean up.
`HOMEBREW_NO_INSTALL_FROM_API`
@ -4107,20 +4117,20 @@ command execution e.g. `$(cat file)`.
`HOMEBREW_SKIP_OR_LATER_BOTTLES`
: If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions
of macOS. This is useful in development on new macOS versions.
: If set along with `$HOMEBREW_DEVELOPER`, do not use bottles from older
versions of macOS. This is useful in development on new macOS versions.
`HOMEBREW_SORBET_RUNTIME`
: If set, enable runtime typechecking using Sorbet. Set by default for
`HOMEBREW_DEVELOPER` or when running some developer commands.
`$HOMEBREW_DEVELOPER` or when running some developer commands.
`HOMEBREW_SSH_CONFIG_PATH`
: If set, Homebrew will use the given config file instead of `~/.ssh/config`
when fetching Git repositories over SSH.
: If set, Homebrew will use the given config file instead of
`${HOME}/.ssh/config` when fetching Git repositories over SSH.
*Default:* `$HOME/.ssh/config`
*Default:* `${HOME}/.ssh/config`
`HOMEBREW_SUDO_THROUGH_SUDO_USER`

136
manpages/brew.1
View File

@ -80,7 +80,7 @@ List what would be uninstalled, but do not actually uninstall anything\.
.SS "\fBcasks\fP"
List all locally installable casks including short names\.
.SS "\fBcleanup\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP \.\.\.]"
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fP\&\.
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fB$HOMEBREW_CLEANUP_MAX_AGE_DAYS\fP\&\.
.TP
\fB\-\-prune\fP
Remove all cache files older than specified \fIdays\fP\&\. If you want to remove everything, use \fB\-\-prune=all\fP\&\.
@ -203,7 +203,7 @@ Search just names for \fItext\fP\&\. If \fItext\fP is flanked by slashes, it is
Search just descriptions for \fItext\fP\&\. If \fItext\fP is flanked by slashes, it is interpreted as a regular expression\.
.TP
\fB\-\-eval\-all\fP
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\.
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\.
.TP
\fB\-\-formula\fP
Treat all named arguments as formulae\.
@ -304,7 +304,7 @@ Treat all named arguments as casks\.
Display brief statistics for your Homebrew installation\. If a \fIformula\fP or \fIcask\fP is provided, show summary of information about it\.
.TP
\fB\-\-analytics\fP
List global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fP (provided neither \fBHOMEBREW_NO_ANALYTICS\fP nor \fBHOMEBREW_NO_GITHUB_API\fP are set)\.
List global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fP (provided neither \fB$HOMEBREW_NO_ANALYTICS\fP nor \fB$HOMEBREW_NO_GITHUB_API\fP are set)\.
.TP
\fB\-\-days\fP
How many days of analytics data to retrieve\. The value for \fIdays\fP must be \fB30\fP, \fB90\fP or \fB365\fP\&\. The default is \fB30\fP\&\.
@ -327,7 +327,7 @@ Print a JSON representation\. Currently the default value for \fIversion\fP is \
Print JSON of formulae that are currently installed\.
.TP
\fB\-\-eval\-all\fP
Evaluate all available formulae and casks, whether installed or not, to print their JSON\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\.
Evaluate all available formulae and casks, whether installed or not, to print their JSON\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\.
.TP
\fB\-\-variations\fP
Include the variations hash in each formula\[u2019]s JSON output\.
@ -343,11 +343,11 @@ Treat all named arguments as casks\.
.SS "\fBinstall\fP \fR[\fIoptions\fP] \fIformula\fP|\fIcask\fP \fR[\.\.\.]"
Install a \fIformula\fP or \fIcask\fP\&\. Additional options specific to a \fIformula\fP may be appended to the command\.
.P
Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
Unless \fB$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the installed formulae or, every 30 days, for all formulae\.
Unless \fB$HOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the installed formulae or, every 30 days, for all formulae\.
.P
Unless \fBHOMEBREW_NO_INSTALL_UPGRADE\fP is set, \fBbrew install\fP \fIformula\fP will upgrade \fIformula\fP if it is already installed but outdated\.
Unless \fB$HOMEBREW_NO_INSTALL_UPGRADE\fP is set, \fBbrew install\fP \fIformula\fP will upgrade \fIformula\fP if it is already installed but outdated\.
.TP
\fB\-d\fP, \fB\-\-debug\fP
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
@ -547,7 +547,7 @@ Check the given \fIformula\fP kegs for missing dependencies\. If no \fIformula\f
\fB\-\-hide\fP
Act as if none of the specified \fIhidden\fP are installed\. \fIhidden\fP should be a comma\-separated list of formulae\.
.SS "\fBnodenv\-sync\fP"
Create symlinks for Homebrew\[u2019]s installed NodeJS versions in \fB~/\.nodenv/versions\fP\&\.
Create symlinks for Homebrew\[u2019]s installed NodeJS versions in \fB${HOME}/\.nodenv/versions\fP\&\.
.P
Note that older version symlinks will also be created so e\.g\. NodeJS 19\.1\.0 will also be symlinked to 19\.0\.0\.
.SS "\fBoptions\fP \fR[\fIoptions\fP] \fR[\fIformula\fP \.\.\.]"
@ -600,11 +600,11 @@ Pin the specified \fIformula\fP, preventing them from being upgraded when issuin
.SS "\fBpostinstall\fP, \fBpost_install\fP \fIinstalled_formula\fP \fR[\.\.\.]"
Rerun the post\-install steps for \fIformula\fP\&\.
.SS "\fBpyenv\-sync\fP"
Create symlinks for Homebrew\[u2019]s installed Python versions in \fB~/\.pyenv/versions\fP\&\.
Create symlinks for Homebrew\[u2019]s installed Python versions in \fB${HOME}/\.pyenv/versions\fP\&\.
.P
Note that older patch version symlinks will be created and linked to the minor version so e\.g\. Python 3\.11\.0 will also be symlinked to 3\.11\.3\.
.SS "\fBrbenv\-sync\fP"
Create symlinks for Homebrew\[u2019]s installed Ruby versions in \fB~/\.rbenv/versions\fP\&\.
Create symlinks for Homebrew\[u2019]s installed Ruby versions in \fB${HOME}/\.rbenv/versions\fP\&\.
.P
Note that older version symlinks will also be created so e\.g\. Ruby 3\.2\.1 will also be symlinked to 3\.2\.0\.
.SS "\fBreadall\fP \fR[\fIoptions\fP] \fR[\fItap\fP \.\.\.]"
@ -623,16 +623,16 @@ Verify any alias symlinks in each tap\.
Syntax\-check all of Homebrew\[u2019]s Ruby files (if no \fItap\fP is passed)\.
.TP
\fB\-\-eval\-all\fP
Evaluate all available formulae and casks, whether installed or not\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\.
Evaluate all available formulae and casks, whether installed or not\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\.
.TP
\fB\-\-no\-simulate\fP
Don\[u2019]t simulate other system configurations when checking formulae and casks\.
.SS "\fBreinstall\fP \fR[\fIoptions\fP] \fIformula\fP|\fIcask\fP \fR[\.\.\.]"
Uninstall and then reinstall a \fIformula\fP or \fIcask\fP using the same options it was originally installed with, plus any appended options specific to a \fIformula\fP\&\.
.P
Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
Unless \fB$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the reinstalled formulae or, every 30 days, for all formulae\.
Unless \fB$HOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the reinstalled formulae or, every 30 days, for all formulae\.
.TP
\fB\-d\fP, \fB\-\-debug\fP
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
@ -700,7 +700,7 @@ Search for casks\.
Search for formulae with a description matching \fItext\fP and casks with a name or description matching \fItext\fP\&\.
.TP
\fB\-\-eval\-all\fP
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\.
Evaluate all available formulae and casks, whether installed or not, to search their descriptions\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\.
.TP
\fB\-\-pull\-request\fP
Search for GitHub pull requests containing \fItext\fP\&\.
@ -741,7 +741,7 @@ 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\&\.
.P
The variables \fBHOMEBREW_PREFIX\fP, \fBHOMEBREW_CELLAR\fP and \fBHOMEBREW_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 \fB~/\.zprofile\fP on macOS and \fB~/\.bashrc\fP or \fB~/\.zshrc\fP on Linux) with: \fBeval "$(brew shellenv)"\fP
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${HOME}/\.bash_profile\fP or \fB${HOME}/\.zprofile\fP on macOS and \fB${HOME}/\.bashrc\fP or \fB${HOME}/\.zshrc\fP on Linux) with: \fBeval "$(brew shellenv)"\fP
.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[\.\.\.]"
@ -774,7 +774,7 @@ Install or change a tap with a custom remote\. Useful for mirrors\.
Migrate tapped formulae from symlink\-based to directory\-based structure\.
.TP
\fB\-\-eval\-all\fP
Evaluate all the formulae, casks and aliases in the new tap to check validity\. Implied if \fBHOMEBREW_EVAL_ALL\fP is set\.
Evaluate all the formulae, casks and aliases in the new tap to check validity\. Implied if \fB$HOMEBREW_EVAL_ALL\fP is set\.
.TP
\fB\-f\fP, \fB\-\-force\fP
Force install core taps even under API mode\.
@ -841,9 +841,9 @@ Fetch and reset Homebrew and all tap repositories (or any specified \fIrepositor
.SS "\fBupgrade\fP \fR[\fIoptions\fP] \fR[\fIinstalled_formula\fP|\fIinstalled_cask\fP \.\.\.]"
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options\. If \fIcask\fP or \fIformula\fP are specified, upgrade only the given \fIcask\fP or \fIformula\fP kegs (unless they are pinned; see \fBpin\fP, \fBunpin\fP)\.
.P
Unless \fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
Unless \fB$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP is set, \fBbrew upgrade\fP or \fBbrew reinstall\fP will be run for outdated dependents and dependents with broken linkage, respectively\.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the upgraded formulae or, every 30 days, for all formulae\.
Unless \fB$HOMEBREW_NO_INSTALL_CLEANUP\fP is set, \fBbrew cleanup\fP will then be run for the upgraded formulae or, every 30 days, for all formulae\.
.TP
\fB\-d\fP, \fB\-\-debug\fP
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
@ -945,7 +945,7 @@ Include only formulae\.
\fB\-\-cask\fP
Include only casks\.
.SS "\fB\-\-cache\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP \.\.\.]"
Display Homebrew\[u2019]s download cache\. See also \fBHOMEBREW_CACHE\fP\&\.
Display Homebrew\[u2019]s download cache\. See also \fB$HOMEBREW_CACHE\fP\&\.
.P
If a \fIformula\fP or \fIcask\fP is provided, display the file or directory used to cache it\.
.TP
@ -1488,7 +1488,7 @@ For every library that a keg references, print its dylib path followed by the bi
\fB\-\-cached\fP
Print the cached linkage values stored in \fBHOMEBREW_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 \fBHOMEBREW_LIVECHECK_WATCHLIST\fP or \fB${HOME}/\.homebrew/livecheck_watchlist\.txt\fP\&\.
.TP
\fB\-\-full\-name\fP
Print formulae and casks with fully\-qualified names\.
@ -1909,43 +1909,43 @@ Target location for Applications (default: \fB/Applications\fP)\.
Target location for Keyboard Layouts (default: \fB/Library/Keyboard Layouts\fP)\.
.TP
\fB\-\-colorpickerdir\fP
Target location for Color Pickers (default: \fB~/Library/ColorPickers\fP)\.
Target location for Color Pickers (default: \fB${HOME}/Library/ColorPickers\fP)\.
.TP
\fB\-\-prefpanedir\fP
Target location for Preference Panes (default: \fB~/Library/PreferencePanes\fP)\.
Target location for Preference Panes (default: \fB${HOME}/Library/PreferencePanes\fP)\.
.TP
\fB\-\-qlplugindir\fP
Target location for Quick Look Plugins (default: \fB~/Library/QuickLook\fP)\.
Target location for Quick Look Plugins (default: \fB${HOME}/Library/QuickLook\fP)\.
.TP
\fB\-\-mdimporterdir\fP
Target location for Spotlight Plugins (default: \fB~/Library/Spotlight\fP)\.
Target location for Spotlight Plugins (default: \fB${HOME}/Library/Spotlight\fP)\.
.TP
\fB\-\-dictionarydir\fP
Target location for Dictionaries (default: \fB~/Library/Dictionaries\fP)\.
Target location for Dictionaries (default: \fB${HOME}/Library/Dictionaries\fP)\.
.TP
\fB\-\-fontdir\fP
Target location for Fonts (default: \fB~/Library/Fonts\fP)\.
Target location for Fonts (default: \fB${HOME}/Library/Fonts\fP)\.
.TP
\fB\-\-servicedir\fP
Target location for Services (default: \fB~/Library/Services\fP)\.
Target location for Services (default: \fB${HOME}/Library/Services\fP)\.
.TP
\fB\-\-input\-methoddir\fP
Target location for Input Methods (default: \fB~/Library/Input Methods\fP)\.
Target location for Input Methods (default: \fB${HOME}/Library/Input Methods\fP)\.
.TP
\fB\-\-internet\-plugindir\fP
Target location for Internet Plugins (default: \fB~/Library/Internet Plug\-Ins\fP)\.
Target location for Internet Plugins (default: \fB${HOME}/Library/Internet Plug\-Ins\fP)\.
.TP
\fB\-\-audio\-unit\-plugindir\fP
Target location for Audio Unit Plugins (default: \fB~/Library/Audio/Plug\-Ins/Components\fP)\.
Target location for Audio Unit Plugins (default: \fB${HOME}/Library/Audio/Plug\-Ins/Components\fP)\.
.TP
\fB\-\-vst\-plugindir\fP
Target location for VST Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST\fP)\.
Target location for VST Plugins (default: \fB${HOME}/Library/Audio/Plug\-Ins/VST\fP)\.
.TP
\fB\-\-vst3\-plugindir\fP
Target location for VST3 Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST3\fP)\.
Target location for VST3 Plugins (default: \fB${HOME}/Library/Audio/Plug\-Ins/VST3\fP)\.
.TP
\fB\-\-screen\-saverdir\fP
Target location for Screen Savers (default: \fB~/Library/Screen Savers\fP)\.
Target location for Screen Savers (default: \fB${HOME}/Library/Screen Savers\fP)\.
.TP
\fB\-\-language\fP
Comma\-separated list of language codes to prefer for cask installation\. The first matching language is used, otherwise it reverts to the cask\[u2019]s default language\. The default value is the language of your system\.
@ -1975,9 +1975,9 @@ Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store,
\fBbrew bundle\fP [\fBinstall\fP]
Install and upgrade (by default) all dependencies from the \fBBrewfile\fP\&\.
.P
You can specify the \fBBrewfile\fP location using \fB\-\-file\fP or by setting the \fBHOMEBREW_BUNDLE_FILE\fP environment variable\.
You can specify the \fBBrewfile\fP location using \fB\-\-file\fP or by setting the \fB$HOMEBREW_BUNDLE_FILE\fP environment variable\.
.P
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fBHOMEBREW_BUNDLE_BREW_SKIP\fP, \fBHOMEBREW_BUNDLE_CASK_SKIP\fP, \fBHOMEBREW_BUNDLE_MAS_SKIP\fP, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fP, \fBHOMEBREW_BUNDLE_TAP_SKIP\fP\&\.
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fB$HOMEBREW_BUNDLE_BREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_CASK_SKIP\fP, \fB$HOMEBREW_BUNDLE_MAS_SKIP\fP, \fB$HOMEBREW_BUNDLE_WHALEBREW_SKIP\fP, \fB$HOMEBREW_BUNDLE_TAP_SKIP\fP\&\.
.TP
\fBbrew bundle upgrade\fP
Shorthand for \fBbrew bundle install \-\-upgrade\fP\&\.
@ -2020,22 +2020,22 @@ Print the environment variables that would be set in a \fBbrew bundle exec\fP en
Read the \fBBrewfile\fP from this location\. Use \fB\-\-file=\-\fP to pipe to stdin/stdout\.
.TP
\fB\-\-global\fP
Read the \fBBrewfile\fP from \fB~/\.Brewfile\fP, in the \fBHOMEBREW_USER_CONFIG_HOME\fP directory, or the \fBHOMEBREW_BUNDLE_FILE_GLOBAL\fP environment variable, if set\.
Read the \fBBrewfile\fP from \fB$HOMEBREW_BUNDLE_FILE_GLOBAL\fP (if set), \fB${XDG_CONFIG_HOME}/homebrew/Brewfile\fP (if \fB$XDG_CONFIG_HOME\fP is set), \fB${HOME}/\.homebrew/Brewfile\fP or \fB${HOME}/\.Brewfile\fP otherwise\.
.TP
\fB\-v\fP, \fB\-\-verbose\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 \fBHOMEBREW_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\. This is 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 \fBHOMEBREW_BUNDLE_NO_UPGRADE\fP is set\.
\fBinstall\fP runs \fBbrew upgrade\fP on outdated dependencies, even if \fB$HOMEBREW_BUNDLE_NO_UPGRADE\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 \fBHOMEBREW_BUNDLE_INSTALL_CLEANUP\fP is set and \fB\-\-global\fP is passed\.
\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\.
.TP
\fB\-\-all\fP
\fBlist\fP all dependencies\.
@ -2059,10 +2059,10 @@ Read the \fBBrewfile\fP from \fB~/\.Brewfile\fP, in the \fBHOMEBREW_USER_CONFIG_
\fBlist\fP or \fBdump\fP VSCode extensions\.
.TP
\fB\-\-no\-vscode\fP
\fBdump\fP without VSCode extensions\. This is enabled by default if \fBHOMEBREW_BUNDLE_DUMP_NO_VSCODE\fP is set\.
\fBdump\fP without VSCode extensions\. This is 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 \fBHOMEBREW_BUNDLE_DUMP_DESCRIBE\fP is set\.
\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\.
.TP
\fB\-\-no\-restart\fP
\fBdump\fP does not add \fBrestart_service\fP to formula lines\.
@ -2074,7 +2074,7 @@ Print instructions for setting up the command\-not\-found hook for your shell\.
.SS "\fBservices\fP \fR[\fIsubcommand\fP]"
Manage background services with macOS\[u2019] \fBlaunchctl\fP(1) daemon manager or Linux\[u2019]s \fBsystemctl\fP(1) service manager\.
.P
If \fBsudo\fP is passed, operate on \fB/Library/LaunchDaemons\fP or \fB/usr/lib/systemd/system\fP (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fP or \fB~/\.config/systemd/user\fP (started at login)\.
If \fBsudo\fP is passed, operate on \fB/Library/LaunchDaemons\fP or \fB/usr/lib/systemd/system\fP (started at boot)\. Otherwise, operate on \fB${HOME}/Library/LaunchAgents\fP or \fB${HOME}/\.config/systemd/user\fP (started at login)\.
.TP
[\fBsudo\fP] \fBbrew services\fP [\fBlist\fP] (\fB\-\-json\fP) (\fB\-\-debug\fP)
List information about all managed services for the current user (or root)\. Provides more output from Homebrew and \fBlaunchctl\fP(1) or \fBsystemctl\fP(1) if run with \fB\-\-debug\fP\&\.
@ -2306,7 +2306,7 @@ Note that these files do not support shell variable expansion e\.g\. \fB$HOME\fP
A space\-separated list of taps\. Homebrew will refuse to install a formula unless it and all of its dependencies are in an official tap or in a tap on this list\.
.TP
\fBHOMEBREW_API_AUTO_UPDATE_SECS\fP
Check Homebrew\[u2019]s API for new formulae or cask data every \fBHOMEBREW_API_AUTO_UPDATE_SECS\fP seconds\. Alternatively, disable API auto\-update checks entirely with \fBHOMEBREW_NO_AUTO_UPDATE\fP\&\.
Check Homebrew\[u2019]s API for new formulae or cask data every \fB$HOMEBREW_API_AUTO_UPDATE_SECS\fP seconds\. Alternatively, disable API auto\-update checks entirely with \fB$HOMEBREW_NO_AUTO_UPDATE\fP\&\.
.RS
.P
\fIDefault:\fP \fB450\fP\&\.
@ -2327,16 +2327,16 @@ Linux only: Pass this value to a type name representing the compiler\[u2019]s \f
.RE
.TP
\fBHOMEBREW_ARTIFACT_DOMAIN\fP
Prefix all download URLs, including those for bottles, with this value\. For example, \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fP will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fP to instead download from \fBhttp://localhost:8080/https://example\.com/foo\.tar\.gz\fP\&\. Bottle URLs however, have their domain replaced with this prefix\. This results in e\.g\. \fBhttps://ghcr\.io/v2/homebrew/core/gettext/manifests/0\.21\fP to instead be downloaded from \fBhttp://localhost:8080/v2/homebrew/core/gettext/manifests/0\.21\fP
Prefix all download URLs, including those for bottles, with this value\. For example, \fBexport HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fP will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fP to instead download from \fBhttp://localhost:8080/https://example\.com/foo\.tar\.gz\fP\&\. Bottle URLs however, have their domain replaced with this prefix\. This results in e\.g\. \fBhttps://ghcr\.io/v2/homebrew/core/gettext/manifests/0\.21\fP to instead be downloaded from \fBhttp://localhost:8080/v2/homebrew/core/gettext/manifests/0\.21\fP
.TP
\fBHOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP
If \fBHOMEBREW_ARTIFACT_DOMAIN\fP and \fBHOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP are both set, if the request to \fBHOMEBREW_ARTIFACT_DOMAIN\fP fails then it Homebrew will error rather than trying any other/default URLs\.
If \fB$HOMEBREW_ARTIFACT_DOMAIN\fP and \fB$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP are both set, if the request to \fB$HOMEBREW_ARTIFACT_DOMAIN\fP fails then it Homebrew will error rather than trying any other/default URLs\.
.TP
\fBHOMEBREW_AUTO_UPDATE_SECS\fP
Run \fBbrew update\fP once every \fBHOMEBREW_AUTO_UPDATE_SECS\fP seconds before some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Alternatively, disable auto\-update entirely with \fBHOMEBREW_NO_AUTO_UPDATE\fP\&\.
Run \fBbrew update\fP once every \fB$HOMEBREW_AUTO_UPDATE_SECS\fP seconds before some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Alternatively, disable auto\-update entirely with \fB$HOMEBREW_NO_AUTO_UPDATE\fP\&\.
.RS
.P
\fIDefault:\fP \fB86400\fP (24 hours), \fB3600\fP (1 hour) if a developer command has been run or \fB300\fP (5 minutes) if \fBHOMEBREW_NO_INSTALL_FROM_API\fP is set\.
\fIDefault:\fP \fB86400\fP (24 hours), \fB3600\fP (1 hour) if a developer command has been run or \fB300\fP (5 minutes) if \fB$HOMEBREW_NO_INSTALL_FROM_API\fP is set\.
.RE
.TP
\fBHOMEBREW_BAT\fP
@ -2360,7 +2360,7 @@ Use this as the \fBbat\fP theme for syntax highlighting\.
If set, use Bootsnap to speed up repeated \fBbrew\fP calls\. A no\-op on Linux when not using Homebrew\[u2019]s vendored, relocatable Ruby\.
.TP
\fBHOMEBREW_BOTTLE_DOMAIN\fP
Use this URL as the download mirror for bottles\. If bottles at that URL are temporarily unavailable, the default bottle domain will be used as a fallback mirror\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fP will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fP\&\. If bottles are not available at \fBHOMEBREW_BOTTLE_DOMAIN\fP they will be downloaded from the default bottle domain\.
Use this URL as the download mirror for bottles\. If bottles at that URL are temporarily unavailable, the default bottle domain will be used as a fallback mirror\. For example, \fBexport HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fP will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fP\&\. If bottles are not available at \fB$HOMEBREW_BOTTLE_DOMAIN\fP they will be downloaded from the default bottle domain\.
.RS
.P
\fIDefault:\fP \fBhttps://ghcr\.io/v2/homebrew/core\fP\&\.
@ -2394,10 +2394,10 @@ Use this directory as the download cache\.
.RE
.TP
\fBHOMEBREW_CASK_OPTS\fP
Append these options to all \fBcask\fP commands\. All \fB\-\-*dir\fP options, \fB\-\-language\fP, \fB\-\-require\-sha\fP, \fB\-\-no\-quarantine\fP and \fB\-\-no\-binaries\fP are supported\. For example, you might add something like the following to your \fB~/\.profile\fP, \fB~/\.bash_profile\fP, or \fB~/\.zshenv\fP:
Append these options to all \fBcask\fP commands\. All \fB\-\-*dir\fP options, \fB\-\-language\fP, \fB\-\-require\-sha\fP, \fB\-\-no\-quarantine\fP and \fB\-\-no\-binaries\fP are supported\. For example, you might add something like the following to your \fB${HOME}/\.profile\fP, \fB${HOME}/\.bash_profile\fP, or \fB${HOME}/\.zshenv\fP:
.RS
.P
\fBexport HOMEBREW_CASK_OPTS="\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts"\fP
\fBexport HOMEBREW_CASK_OPTS="\-\-appdir=${HOME}/Applications \-\-fontdir=/Library/Fonts"\fP
.RE
.TP
\fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fP
@ -2467,10 +2467,10 @@ Use this X11 display when opening a page in a browser, for example with \fBbrew
If set, print install times for each formula at the end of the run\.
.TP
\fBHOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fP
Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages\. If \fBHOMEBREW_DOCKER_REGISTRY_TOKEN\fP is set, it will be used instead\.
Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages\. If \fB$HOMEBREW_DOCKER_REGISTRY_TOKEN\fP is set, it will be used instead\.
.TP
\fBHOMEBREW_DOCKER_REGISTRY_TOKEN\fP
Use this bearer token for authenticating with a Docker registry proxying GitHub Packages\. Preferred over \fBHOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fP\&\.
Use this bearer token for authenticating with a Docker registry proxying GitHub Packages\. Preferred over \fB$HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN\fP\&\.
.TP
\fBHOMEBREW_EDITOR\fP
Use this editor when editing a single formula, or several formulae in the same directory\.
@ -2501,14 +2501,14 @@ A space\-separated list of formulae\. Homebrew will refuse to install a formula
A space\-separated list of SPDX license identifiers\. Homebrew will refuse to install a formula if it or any of its dependencies has a license on this list\.
.TP
\fBHOMEBREW_FORBIDDEN_OWNER\fP
The person who has set any \fBHOMEBREW_FORBIDDEN_*\fP variables\.
The person who has set any \fB$HOMEBREW_FORBIDDEN_*\fP variables\.
.RS
.P
\fIDefault:\fP \fByou\fP\&\.
.RE
.TP
\fBHOMEBREW_FORBIDDEN_OWNER_CONTACT\fP
How to contact the \fBHOMEBREW_FORBIDDEN_OWNER\fP, if set and necessary\.
How to contact the \fB$HOMEBREW_FORBIDDEN_OWNER\fP, if set and necessary\.
.TP
\fBHOMEBREW_FORBIDDEN_TAPS\fP
A space\-separated list of taps\. Homebrew will refuse to install a formula if it or any of its dependencies is in a tap on this list\.
@ -2517,7 +2517,7 @@ A space\-separated list of taps\. Homebrew will refuse to install a formula if i
If set, Homebrew will refuse to read formulae or casks provided from file paths, e\.g\. \fBbrew install \./package\.rb\fP\&\.
.TP
\fBHOMEBREW_FORCE_API_AUTO_UPDATE\fP
If set, update the Homebrew API formula or cask data even if \fBHOMEBREW_NO_AUTO_UPDATE\fP is set\.
If set, update the Homebrew API formula or cask data even if \fB$HOMEBREW_NO_AUTO_UPDATE\fP is set\.
.TP
\fBHOMEBREW_FORCE_BREWED_CA_CERTIFICATES\fP
If set, always use a Homebrew\-installed \fBca\-certificates\fP rather than the system version\. Automatically set if the system version is too old\.
@ -2529,7 +2529,7 @@ If set, always use a Homebrew\-installed \fBcurl\fP(1) rather than the system ve
If set, always use a Homebrew\-installed \fBgit\fP(1) rather than the system version\. Automatically set if the system version of \fBgit\fP is too old\.
.TP
\fBHOMEBREW_FORCE_BREW_WRAPPER\fP
If set, require \fBHOMEBREW_BREW_WRAPPER\fP to be set to the same value as \fBHOMEBREW_FORCE_BREW_WRAPPER\fP for non\-trivial \fBbrew\fP commands\.
If set, require \fB$HOMEBREW_BREW_WRAPPER\fP to be set to the same value as \fB$HOMEBREW_FORCE_BREW_WRAPPER\fP for non\-trivial \fBbrew\fP commands\.
.TP
\fBHOMEBREW_FORCE_VENDOR_RUBY\fP
If set, always use Homebrew\[u2019]s vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
@ -2567,10 +2567,10 @@ Set the Git committer email to this value\.
Set the Git committer name to this value\.
.TP
\fBHOMEBREW_GIT_EMAIL\fP
Set the Git author name and, if \fBHOMEBREW_GIT_COMMITTER_EMAIL\fP is unset, committer email to this value\.
Set the Git author name and, if \fB$HOMEBREW_GIT_COMMITTER_EMAIL\fP is unset, committer email to this value\.
.TP
\fBHOMEBREW_GIT_NAME\fP
Set the Git author name and, if \fBHOMEBREW_GIT_COMMITTER_NAME\fP is unset, committer name to this value\.
Set the Git author name and, if \fB$HOMEBREW_GIT_COMMITTER_NAME\fP is unset, committer name to this value\.
.TP
\fBHOMEBREW_GIT_PATH\fP
Linux only: Set this value to a new enough \fBgit\fP executable for Homebrew to use\.
@ -2593,7 +2593,7 @@ If set, \fBbrew livecheck\fP will include data for packages that are autobumped
Consult this file for the list of formulae to check by default when no formula argument is passed to \fBbrew livecheck\fP\&\.
.RS
.P
\fIDefault:\fP \fB$XDG_CONFIG_HOME/homebrew/livecheck_watchlist\.txt\fP if \fB$XDG_CONFIG_HOME\fP is set or \fB$HOME/\.homebrew/livecheck_watchlist\.txt\fP otherwise\.
\fIDefault:\fP \fB${XDG_CONFIG_HOME}/homebrew/livecheck_watchlist\.txt\fP if \fB$XDG_CONFIG_HOME\fP is set or \fB${HOME}/\.homebrew/livecheck_watchlist\.txt\fP otherwise\.
.RE
.TP
\fBHOMEBREW_LOCK_CONTEXT\fP
@ -2603,7 +2603,7 @@ If set, Homebrew will add this output as additional context for locking errors\.
Use this directory to store log files\.
.RS
.P
\fIDefault:\fP macOS: \fB$HOME/Library/Logs/Homebrew\fP, Linux: \fB$XDG_CACHE_HOME/Homebrew/Logs\fP or \fB$HOME/\.cache/Homebrew/Logs\fP\&\.
\fIDefault:\fP macOS: \fB${HOME}/Library/Logs/Homebrew\fP, Linux: \fB${XDG_CACHE_HOME}/Homebrew/Logs\fP or \fB${HOME}/\.cache/Homebrew/Logs\fP\&\.
.RE
.TP
\fBHOMEBREW_MAKE_JOBS\fP
@ -2622,7 +2622,7 @@ If set, do not send analytics\. Google Analytics were destroyed\. For more infor
If set, calls to \fBbrew cleanup\fP and \fBbrew uninstall\fP will not automatically remove unused formula dependents\.
.TP
\fBHOMEBREW_NO_AUTO_UPDATE\fP
If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Preferably, run this less often by setting \fBHOMEBREW_AUTO_UPDATE_SECS\fP to a value higher than the default\. Note that setting this and e\.g\. tapping new taps may result in a broken configuration\. Please ensure you always run \fBbrew update\fP before reporting any issues\.
If set, do not automatically update before running some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Preferably, run this less often by setting \fB$HOMEBREW_AUTO_UPDATE_SECS\fP to a value higher than the default\. Note that setting this and e\.g\. tapping new taps may result in a broken configuration\. Please ensure you always run \fBbrew update\fP before reporting any issues\.
.TP
\fBHOMEBREW_NO_BOOTSNAP\fP
If set, do not use Bootsnap to speed up repeated \fBbrew\fP calls\.
@ -2638,13 +2638,13 @@ If set, do not print text with colour added\.
.RE
.TP
\fBHOMEBREW_NO_EMOJI\fP
If set, do not print \fBHOMEBREW_INSTALL_BADGE\fP on a successful build\.
If set, do not print \fB$HOMEBREW_INSTALL_BADGE\fP on a successful build\.
.TP
\fBHOMEBREW_NO_ENV_HINTS\fP
If set, do not print any hints about changing Homebrew\[u2019]s behaviour with environment variables\.
.TP
\fBHOMEBREW_NO_FORCE_BREW_WRAPPER\fP
If set, disables \fBHOMEBREW_FORCE_BREW_WRAPPER\fP behaviour, even if set\.
If set, disables \fB$HOMEBREW_FORCE_BREW_WRAPPER\fP behaviour, even if set\.
.TP
\fBHOMEBREW_NO_GITHUB_API\fP
If set, do not use the GitHub API, e\.g\. for searches or fetching relevant issues after a failed install\.
@ -2660,7 +2660,7 @@ If set, forbid redirects from secure HTTPS to insecure HTTP\.
If set, do not check for broken linkage of dependents or outdated dependents after installing, upgrading or reinstalling formulae\. This will result in fewer dependents (and their dependencies) being upgraded or reinstalled but may result in more breakage from running \fBbrew install\fP \fIformula\fP or \fBbrew upgrade\fP \fIformula\fP\&\.
.TP
\fBHOMEBREW_NO_INSTALL_CLEANUP\fP
If set, \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew reinstall\fP will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every \fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fP days\. Alternatively, \fBHOMEBREW_NO_CLEANUP_FORMULAE\fP allows specifying specific formulae to not clean up\.
If set, \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew reinstall\fP will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every \fB$HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fP days\. Alternatively, \fB$HOMEBREW_NO_CLEANUP_FORMULAE\fP allows specifying specific formulae to not clean up\.
.TP
\fBHOMEBREW_NO_INSTALL_FROM_API\fP
If set, do not install formulae and casks in homebrew/core and homebrew/cask taps using Homebrew\[u2019]s API and instead use (large, slow) local checkouts of these repositories\.
@ -2688,16 +2688,16 @@ If set, use Pry for the \fBbrew irb\fP command\.
If set, running Homebrew on Linux will simulate certain macOS code paths\. This is useful when auditing macOS formulae while on Linux\.
.TP
\fBHOMEBREW_SKIP_OR_LATER_BOTTLES\fP
If set along with \fBHOMEBREW_DEVELOPER\fP, do not use bottles from older versions of macOS\. This is useful in development on new macOS versions\.
If set along with \fB$HOMEBREW_DEVELOPER\fP, do not use bottles from older versions of macOS\. This is useful in development on new macOS versions\.
.TP
\fBHOMEBREW_SORBET_RUNTIME\fP
If set, enable runtime typechecking using Sorbet\. Set by default for \fBHOMEBREW_DEVELOPER\fP or when running some developer commands\.
If set, enable runtime typechecking using Sorbet\. Set by default for \fB$HOMEBREW_DEVELOPER\fP or when running some developer commands\.
.TP
\fBHOMEBREW_SSH_CONFIG_PATH\fP
If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fP when fetching Git repositories over SSH\.
If set, Homebrew will use the given config file instead of \fB${HOME}/\.ssh/config\fP when fetching Git repositories over SSH\.
.RS
.P
\fIDefault:\fP \fB$HOME/\.ssh/config\fP
\fIDefault:\fP \fB${HOME}/\.ssh/config\fP
.RE
.TP
\fBHOMEBREW_SUDO_THROUGH_SUDO_USER\fP