Alphabetize EnvConfig::ENVS and regenerate docs

This commit is contained in:
Issy Long 2024-04-11 17:54:09 +01:00
parent c72598d937
commit dd5ea99f58
No known key found for this signature in database
3 changed files with 127 additions and 127 deletions

View File

@ -11,6 +11,12 @@ module Homebrew
module_function module_function
ENVS = { ENVS = {
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`.",
default: 450,
},
HOMEBREW_API_DOMAIN: { HOMEBREW_API_DOMAIN: {
description: "Use this URL as the download mirror for Homebrew JSON API. " \ description: "Use this URL as the download mirror for Homebrew JSON API. " \
"If metadata files at that URL are temporarily unavailable, " \ "If metadata files at that URL are temporarily unavailable, " \
@ -33,11 +39,11 @@ module Homebrew
"to instead be downloaded from " \ "to instead be downloaded from " \
"`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`", "`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`",
}, },
HOMEBREW_API_AUTO_UPDATE_SECS: { HOMEBREW_AUTOREMOVE: {
description: "Check Homebrew's API for new formulae or cask data every " \ description: "If set, calls to `brew cleanup` and `brew uninstall` will automatically " \
"`HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API auto-update " \ "remove unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set, " \
"checks entirely with `HOMEBREW_NO_AUTO_UPDATE`.", "`brew cleanup` will start running `brew autoremove` periodically.",
default: 450, boolean: true,
}, },
HOMEBREW_AUTO_UPDATE_SECS: { 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, " \
@ -46,12 +52,6 @@ module Homebrew
default_text: "`86400` (24 hours), `3600` (1 hour) if a developer command has been run " \ 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_AUTOREMOVE: {
description: "If set, calls to `brew cleanup` and `brew uninstall` will automatically " \
"remove unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set, " \
"`brew cleanup` will start running `brew autoremove` periodically.",
boolean: true,
},
HOMEBREW_BAT: { HOMEBREW_BAT: {
description: "If set, use `bat` for the `brew cat` command.", description: "If set, use `bat` for the `brew cat` command.",
boolean: true, boolean: true,
@ -119,6 +119,12 @@ module Homebrew
default_text: "`https://github.com/Homebrew/homebrew-core`.", default_text: "`https://github.com/Homebrew/homebrew-core`.",
default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE, default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE,
}, },
HOMEBREW_CURLRC: {
description: "If set to an absolute path (i.e. beginning with `/`), pass it with `--config` when invoking " \
"`curl`(1). " \
"If set but _not_ a valid path, do not pass `--disable`, which disables the " \
"use of `.curlrc`.",
},
HOMEBREW_CURL_PATH: { HOMEBREW_CURL_PATH: {
description: "Linux only: Set this value to a new enough `curl` executable for Homebrew to use.", description: "Linux only: Set this value to a new enough `curl` executable for Homebrew to use.",
default: "curl", default: "curl",
@ -131,12 +137,6 @@ module Homebrew
description: "If set, pass `--verbose` when invoking `curl`(1).", description: "If set, pass `--verbose` when invoking `curl`(1).",
boolean: true, boolean: true,
}, },
HOMEBREW_CURLRC: {
description: "If set to an absolute path (i.e. beginning with `/`), pass it with `--config` when invoking " \
"`curl`(1). " \
"If set but _not_ a valid path, do not pass `--disable`, which disables the " \
"use of `.curlrc`.",
},
HOMEBREW_DEBUG: { HOMEBREW_DEBUG: {
description: "If set, always assume `--debug` when running commands.", description: "If set, always assume `--debug` when running commands.",
boolean: true, boolean: true,
@ -228,16 +228,6 @@ module Homebrew
"of Ruby is new enough.", "of Ruby is new enough.",
boolean: true, boolean: true,
}, },
HOMEBREW_GIT_EMAIL: {
description: "Set the Git author and committer email to this value.",
},
HOMEBREW_GIT_NAME: {
description: "Set the Git author and committer name to this value.",
},
HOMEBREW_GIT_PATH: {
description: "Linux only: Set this value to a new enough `git` executable for Homebrew to use.",
default: "git",
},
HOMEBREW_GITHUB_API_TOKEN: { HOMEBREW_GITHUB_API_TOKEN: {
description: "Use this personal access token for the GitHub API, for features such as " \ description: "Use this personal access token for the GitHub API, for features such as " \
"`brew search`. You can create one at <https://github.com/settings/tokens>. If set, " \ "`brew search`. You can create one at <https://github.com/settings/tokens>. If set, " \
@ -253,6 +243,16 @@ module Homebrew
HOMEBREW_GITHUB_PACKAGES_USER: { HOMEBREW_GITHUB_PACKAGES_USER: {
description: "Use this username when accessing the GitHub Packages Registry (where bottles may be stored).", description: "Use this username when accessing the GitHub Packages Registry (where bottles may be stored).",
}, },
HOMEBREW_GIT_EMAIL: {
description: "Set the Git author and committer email to this value.",
},
HOMEBREW_GIT_NAME: {
description: "Set the Git author and committer name to this value.",
},
HOMEBREW_GIT_PATH: {
description: "Linux only: Set this value to a new enough `git` executable for Homebrew to use.",
default: "git",
},
HOMEBREW_INSTALL_BADGE: { HOMEBREW_INSTALL_BADGE: {
description: "Print this text before the installation summary of each successful build.", description: "Print this text before the installation summary of each successful build.",
default_text: 'The "Beer Mug" emoji.', default_text: 'The "Beer Mug" emoji.',
@ -325,6 +325,13 @@ module Homebrew
"from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.", "from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: {
description: "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 `brew install` <formula> or `brew upgrade` <formula>.",
boolean: true,
},
HOMEBREW_NO_INSTALL_CLEANUP: { HOMEBREW_NO_INSTALL_CLEANUP: {
description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically " \ description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically " \
"cleanup installed/upgraded/reinstalled formulae or all formulae every " \ "cleanup installed/upgraded/reinstalled formulae or all formulae every " \
@ -342,13 +349,6 @@ module Homebrew
"outdated.", "outdated.",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: {
description: "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 `brew install` <formula> or `brew upgrade` <formula>.",
boolean: true,
},
HOMEBREW_NO_UPDATE_REPORT_NEW: { HOMEBREW_NO_UPDATE_REPORT_NEW: {
description: "If set, `brew update` will not show the list of newly added formulae/casks.", description: "If set, `brew update` will not show the list of newly added formulae/casks.",
boolean: true, boolean: true,
@ -361,10 +361,6 @@ module Homebrew
description: "If set, use Pry for the `brew irb` command.", description: "If set, use Pry for the `brew irb` command.",
boolean: true, boolean: true,
}, },
HOMEBREW_UPGRADE_GREEDY: {
description: "If set, pass `--greedy` to all cask upgrade commands.",
boolean: true,
},
HOMEBREW_SIMULATE_MACOS_ON_LINUX: { HOMEBREW_SIMULATE_MACOS_ON_LINUX: {
description: "If set, running Homebrew on Linux will simulate certain macOS code paths. This is useful " \ description: "If set, running Homebrew on Linux will simulate certain macOS code paths. This is useful " \
"when auditing macOS formulae while on Linux.", "when auditing macOS formulae while on Linux.",
@ -385,6 +381,11 @@ module Homebrew
"Git repositories over SSH.", "Git repositories over SSH.",
default_text: "`$HOME/.ssh/config`", 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 " \
"`sudo`(8) through when running `sudo`(8).",
boolean: true,
},
HOMEBREW_SVN: { HOMEBREW_SVN: {
description: "Use this as the `svn`(1) binary.", description: "Use this as the `svn`(1) binary.",
default_text: "A Homebrew-built Subversion (if installed), or the system-provided binary.", default_text: "A Homebrew-built Subversion (if installed), or the system-provided binary.",
@ -394,11 +395,6 @@ module Homebrew
"the system-wide environment file will be loaded last to override any prefix or user settings.", "the system-wide environment file will be loaded last to override any prefix or user settings.",
boolean: true, boolean: true,
}, },
HOMEBREW_SUDO_THROUGH_SUDO_USER: {
description: "If set, Homebrew will use the `SUDO_USER` environment variable to define the user to " \
"`sudo`(8) through when running `sudo`(8).",
boolean: true,
},
HOMEBREW_TEMP: { HOMEBREW_TEMP: {
description: "Use this path as the temporary directory for building packages. Changing " \ description: "Use this path as the temporary directory for building packages. Changing " \
"this may be needed if your system temporary directory and Homebrew prefix are on " \ "this may be needed if your system temporary directory and Homebrew prefix are on " \
@ -413,6 +409,10 @@ module Homebrew
"have been run).", "have been run).",
boolean: true, boolean: true,
}, },
HOMEBREW_UPGRADE_GREEDY: {
description: "If set, pass `--greedy` to all cask upgrade commands.",
boolean: true,
},
HOMEBREW_VERBOSE: { HOMEBREW_VERBOSE: {
description: "If set, always assume `--verbose` when running commands.", description: "If set, always assume `--verbose` when running commands.",
boolean: true, boolean: true,

View File

@ -3433,6 +3433,14 @@ prefix-specific files take precedence over system-wide files (unless
Note that these files do not support shell variable expansion e.g. `$HOME` or Note that these files do not support shell variable expansion e.g. `$HOME` or
command execution e.g. `$(cat file)`. 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`.
*Default:* `450`.
`HOMEBREW_API_DOMAIN` `HOMEBREW_API_DOMAIN`
: Use this URL as the download mirror for Homebrew JSON API. If metadata files : Use this URL as the download mirror for Homebrew JSON API. If metadata files
@ -3459,13 +3467,11 @@ command execution e.g. `$(cat file)`.
downloaded from downloaded from
`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21` `http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`
`HOMEBREW_API_AUTO_UPDATE_SECS` `HOMEBREW_AUTOREMOVE`
: Check Homebrew's API for new formulae or cask data every : If set, calls to `brew cleanup` and `brew uninstall` will automatically remove
`HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set,
auto-update checks entirely with `HOMEBREW_NO_AUTO_UPDATE`. `brew cleanup` will start running `brew autoremove` periodically.
*Default:* `450`.
`HOMEBREW_AUTO_UPDATE_SECS` `HOMEBREW_AUTO_UPDATE_SECS`
@ -3476,12 +3482,6 @@ command execution e.g. `$(cat file)`.
*Default:* `86400` (24 hours), `3600` (1 hour) if a developer command has been *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_AUTOREMOVE`
: If set, calls to `brew cleanup` and `brew uninstall` will automatically remove
unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set,
`brew cleanup` will start running `brew autoremove` periodically.
`HOMEBREW_BAT` `HOMEBREW_BAT`
: If set, use `bat` for the `brew cat` command. : If set, use `bat` for the `brew cat` command.
@ -3565,6 +3565,12 @@ command execution e.g. `$(cat file)`.
*Default:* `https://github.com/Homebrew/homebrew-core`. *Default:* `https://github.com/Homebrew/homebrew-core`.
`HOMEBREW_CURLRC`
: If set to an absolute path (i.e. beginning with `/`), pass it with `--config`
when invoking `curl`(1). If set but *not* a valid path, do not pass
`--disable`, which disables the use of `.curlrc`.
`HOMEBREW_CURL_PATH` `HOMEBREW_CURL_PATH`
: Linux only: Set this value to a new enough `curl` executable for Homebrew to : Linux only: Set this value to a new enough `curl` executable for Homebrew to
@ -3582,12 +3588,6 @@ command execution e.g. `$(cat file)`.
: If set, pass `--verbose` when invoking `curl`(1). : If set, pass `--verbose` when invoking `curl`(1).
`HOMEBREW_CURLRC`
: If set to an absolute path (i.e. beginning with `/`), pass it with `--config`
when invoking `curl`(1). If set but *not* a valid path, do not pass
`--disable`, which disables the use of `.curlrc`.
`HOMEBREW_DEBUG` `HOMEBREW_DEBUG`
: If set, always assume `--debug` when running commands. : If set, always assume `--debug` when running commands.
@ -3697,21 +3697,6 @@ command execution e.g. `$(cat file)`.
: If set, always use Homebrew's vendored, relocatable Ruby version even if the : If set, always use Homebrew's vendored, relocatable Ruby version even if the
system version of Ruby is new enough. system version of Ruby is new enough.
`HOMEBREW_GIT_EMAIL`
: Set the Git author and committer email to this value.
`HOMEBREW_GIT_NAME`
: Set the Git author and committer name to this value.
`HOMEBREW_GIT_PATH`
: Linux only: Set this value to a new enough `git` executable for Homebrew to
use.
*Default:* `git`.
`HOMEBREW_GITHUB_API_TOKEN` `HOMEBREW_GITHUB_API_TOKEN`
: Use this personal access token for the GitHub API, for features such as `brew : Use this personal access token for the GitHub API, for features such as `brew
@ -3732,6 +3717,21 @@ command execution e.g. `$(cat file)`.
: Use this username when accessing the GitHub Packages Registry (where bottles : Use this username when accessing the GitHub Packages Registry (where bottles
may be stored). may be stored).
`HOMEBREW_GIT_EMAIL`
: Set the Git author and committer email to this value.
`HOMEBREW_GIT_NAME`
: Set the Git author and committer name to this value.
`HOMEBREW_GIT_PATH`
: Linux only: Set this value to a new enough `git` executable for Homebrew to
use.
*Default:* `git`.
`HOMEBREW_INSTALL_BADGE` `HOMEBREW_INSTALL_BADGE`
: Print this text before the installation summary of each successful build. : Print this text before the installation summary of each successful build.
@ -3812,6 +3812,14 @@ command execution e.g. `$(cat file)`.
cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to
download. download.
`HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`
: 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 `brew install` *`formula`* or `brew
upgrade` *`formula`*.
`HOMEBREW_NO_INSTALL_CLEANUP` `HOMEBREW_NO_INSTALL_CLEANUP`
: If set, `brew install`, `brew upgrade` and `brew reinstall` will never : If set, `brew install`, `brew upgrade` and `brew reinstall` will never
@ -3831,14 +3839,6 @@ command execution e.g. `$(cat file)`.
: If set, `brew install` *`formula|cask`* will not upgrade *`formula|cask`* if : If set, `brew install` *`formula|cask`* will not upgrade *`formula|cask`* if
it is installed but outdated. it is installed but outdated.
`HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK`
: 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 `brew install` *`formula`* or `brew
upgrade` *`formula`*.
`HOMEBREW_NO_UPDATE_REPORT_NEW` `HOMEBREW_NO_UPDATE_REPORT_NEW`
: If set, `brew update` will not show the list of newly added formulae/casks. : If set, `brew update` will not show the list of newly added formulae/casks.
@ -3854,10 +3854,6 @@ command execution e.g. `$(cat file)`.
: If set, use Pry for the `brew irb` command. : If set, use Pry for the `brew irb` command.
`HOMEBREW_UPGRADE_GREEDY`
: If set, pass `--greedy` to all cask upgrade commands.
`HOMEBREW_SIMULATE_MACOS_ON_LINUX` `HOMEBREW_SIMULATE_MACOS_ON_LINUX`
: If set, running Homebrew on Linux will simulate certain macOS code paths. This : If set, running Homebrew on Linux will simulate certain macOS code paths. This
@ -3880,6 +3876,11 @@ command execution e.g. `$(cat file)`.
*Default:* `$HOME/.ssh/config` *Default:* `$HOME/.ssh/config`
`HOMEBREW_SUDO_THROUGH_SUDO_USER`
: If set, Homebrew will use the `SUDO_USER` environment variable to define the
user to `sudo`(8) through when running `sudo`(8).
`HOMEBREW_SVN` `HOMEBREW_SVN`
: Use this as the `svn`(1) binary. : Use this as the `svn`(1) binary.
@ -3893,11 +3894,6 @@ command execution e.g. `$(cat file)`.
the system-wide environment file will be loaded last to override any prefix or the system-wide environment file will be loaded last to override any prefix or
user settings. user settings.
`HOMEBREW_SUDO_THROUGH_SUDO_USER`
: If set, Homebrew will use the `SUDO_USER` environment variable to define the
user to `sudo`(8) through when running `sudo`(8).
`HOMEBREW_TEMP` `HOMEBREW_TEMP`
: Use this path as the temporary directory for building packages. Changing this : Use this path as the temporary directory for building packages. Changing this
@ -3913,6 +3909,10 @@ command execution e.g. `$(cat file)`.
: If set, always use the latest stable tag (even if developer commands have been : If set, always use the latest stable tag (even if developer commands have been
run). run).
`HOMEBREW_UPGRADE_GREEDY`
: If set, pass `--greedy` to all cask upgrade commands.
`HOMEBREW_VERBOSE` `HOMEBREW_VERBOSE`
: If set, always assume `--verbose` when running commands. : If set, always assume `--verbose` when running commands.

View File

@ -2191,6 +2191,13 @@ User\-specific environment files take precedence over prefix\-specific files and
.P .P
Note that these files do not support shell variable expansion e\.g\. \fB$HOME\fP or command execution e\.g\. \fB$(cat file)\fP\&\. Note that these files do not support shell variable expansion e\.g\. \fB$HOME\fP or command execution e\.g\. \fB$(cat file)\fP\&\.
.TP .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\&\.
.RS
.P
\fIDefault:\fP \fB450\fP\&\.
.RE
.TP
\fBHOMEBREW_API_DOMAIN\fP \fBHOMEBREW_API_DOMAIN\fP
Use this URL as the download mirror for Homebrew JSON API\. If metadata files at that URL are temporarily unavailable, the default API domain will be used as a fallback mirror\. Use this URL as the download mirror for Homebrew JSON API\. If metadata files at that URL are temporarily unavailable, the default API domain will be used as a fallback mirror\.
.RS .RS
@ -2208,12 +2215,8 @@ Linux only: Pass this value to a type name representing the compiler\[u2019]s \f
\fBHOMEBREW_ARTIFACT_DOMAIN\fP \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, \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
.TP .TP
\fBHOMEBREW_API_AUTO_UPDATE_SECS\fP \fBHOMEBREW_AUTOREMOVE\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\&\. If set, calls to \fBbrew cleanup\fP and \fBbrew uninstall\fP will automatically remove unused formula dependents and if \fBHOMEBREW_NO_INSTALL_CLEANUP\fP is not set, \fBbrew cleanup\fP will start running \fBbrew autoremove\fP periodically\.
.RS
.P
\fIDefault:\fP \fB450\fP\&\.
.RE
.TP .TP
\fBHOMEBREW_AUTO_UPDATE_SECS\fP \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 \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\&\.
@ -2222,9 +2225,6 @@ Run \fBbrew update\fP once every \fBHOMEBREW_AUTO_UPDATE_SECS\fP seconds before
\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 \fBHOMEBREW_NO_INSTALL_FROM_API\fP is set\.
.RE .RE
.TP .TP
\fBHOMEBREW_AUTOREMOVE\fP
If set, calls to \fBbrew cleanup\fP and \fBbrew uninstall\fP will automatically remove unused formula dependents and if \fBHOMEBREW_NO_INSTALL_CLEANUP\fP is not set, \fBbrew cleanup\fP will start running \fBbrew autoremove\fP periodically\.
.TP
\fBHOMEBREW_BAT\fP \fBHOMEBREW_BAT\fP
If set, use \fBbat\fP for the \fBbrew cat\fP command\. If set, use \fBbat\fP for the \fBbrew cat\fP command\.
.TP .TP
@ -2304,6 +2304,9 @@ Use this URL as the Homebrew/homebrew\-core \fBgit\fP(1) remote\.
\fIDefault:\fP \fBhttps://github\.com/Homebrew/homebrew\-core\fP\&\. \fIDefault:\fP \fBhttps://github\.com/Homebrew/homebrew\-core\fP\&\.
.RE .RE
.TP .TP
\fBHOMEBREW_CURLRC\fP
If set to an absolute path (i\.e\. beginning with \fB/\fP), pass it with \fB\-\-config\fP when invoking \fBcurl\fP(1)\. If set but \fInot\fP a valid path, do not pass \fB\-\-disable\fP, which disables the use of \fB\&\.curlrc\fP\&\.
.TP
\fBHOMEBREW_CURL_PATH\fP \fBHOMEBREW_CURL_PATH\fP
Linux only: Set this value to a new enough \fBcurl\fP executable for Homebrew to use\. Linux only: Set this value to a new enough \fBcurl\fP executable for Homebrew to use\.
.RS .RS
@ -2321,9 +2324,6 @@ Pass the given retry count to \fB\-\-retry\fP when invoking \fBcurl\fP(1)\.
\fBHOMEBREW_CURL_VERBOSE\fP \fBHOMEBREW_CURL_VERBOSE\fP
If set, pass \fB\-\-verbose\fP when invoking \fBcurl\fP(1)\. If set, pass \fB\-\-verbose\fP when invoking \fBcurl\fP(1)\.
.TP .TP
\fBHOMEBREW_CURLRC\fP
If set to an absolute path (i\.e\. beginning with \fB/\fP), pass it with \fB\-\-config\fP when invoking \fBcurl\fP(1)\. If set but \fInot\fP a valid path, do not pass \fB\-\-disable\fP, which disables the use of \fB\&\.curlrc\fP\&\.
.TP
\fBHOMEBREW_DEBUG\fP \fBHOMEBREW_DEBUG\fP
If set, always assume \fB\-\-debug\fP when running commands\. If set, always assume \fB\-\-debug\fP when running commands\.
.TP .TP
@ -2402,19 +2402,6 @@ If set, always use a Homebrew\-installed \fBgit\fP(1) rather than the system ver
\fBHOMEBREW_FORCE_VENDOR_RUBY\fP \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\. If set, always use Homebrew\[u2019]s vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
.TP .TP
\fBHOMEBREW_GIT_EMAIL\fP
Set the Git author and committer email to this value\.
.TP
\fBHOMEBREW_GIT_NAME\fP
Set the Git author and 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\.
.RS
.P
\fIDefault:\fP \fBgit\fP\&\.
.RE
.TP
\fBHOMEBREW_GITHUB_API_TOKEN\fP \fBHOMEBREW_GITHUB_API_TOKEN\fP
Use this personal access token for the GitHub API, for features such as \fBbrew search\fP\&\. You can create one at Use this personal access token for the GitHub API, for features such as \fBbrew search\fP\&\. You can create one at
.UR https://github\.com/settings/tokens .UR https://github\.com/settings/tokens
@ -2432,6 +2419,19 @@ Use this GitHub personal access token when accessing the GitHub Packages Registr
\fBHOMEBREW_GITHUB_PACKAGES_USER\fP \fBHOMEBREW_GITHUB_PACKAGES_USER\fP
Use this username when accessing the GitHub Packages Registry (where bottles may be stored)\. Use this username when accessing the GitHub Packages Registry (where bottles may be stored)\.
.TP .TP
\fBHOMEBREW_GIT_EMAIL\fP
Set the Git author and committer email to this value\.
.TP
\fBHOMEBREW_GIT_NAME\fP
Set the Git author and 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\.
.RS
.P
\fIDefault:\fP \fBgit\fP\&\.
.RE
.TP
\fBHOMEBREW_INSTALL_BADGE\fP \fBHOMEBREW_INSTALL_BADGE\fP
Print this text before the installation summary of each successful build\. Print this text before the installation summary of each successful build\.
.RS .RS
@ -2497,6 +2497,9 @@ If set, forbid redirects from secure HTTPS to insecure HTTP\.
\fINote:\fP while ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\. \fINote:\fP while ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\.
.RE .RE
.TP .TP
\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP
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 \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 \fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fP days\. Alternatively, \fBHOMEBREW_NO_CLEANUP_FORMULAE\fP allows specifying specific formulae to not clean up\.
.TP .TP
@ -2506,9 +2509,6 @@ If set, do not install formulae and casks in homebrew/core and homebrew/cask tap
\fBHOMEBREW_NO_INSTALL_UPGRADE\fP \fBHOMEBREW_NO_INSTALL_UPGRADE\fP
If set, \fBbrew install\fP \fIformula|cask\fP will not upgrade \fIformula|cask\fP if it is installed but outdated\. If set, \fBbrew install\fP \fIformula|cask\fP will not upgrade \fIformula|cask\fP if it is installed but outdated\.
.TP .TP
\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fP
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_UPDATE_REPORT_NEW\fP \fBHOMEBREW_NO_UPDATE_REPORT_NEW\fP
If set, \fBbrew update\fP will not show the list of newly added formulae/casks\. If set, \fBbrew update\fP will not show the list of newly added formulae/casks\.
.TP .TP
@ -2522,9 +2522,6 @@ If set, \fBbrew install\fP \fIformula\fP will use this URL to download PyPI pack
\fBHOMEBREW_PRY\fP \fBHOMEBREW_PRY\fP
If set, use Pry for the \fBbrew irb\fP command\. If set, use Pry for the \fBbrew irb\fP command\.
.TP .TP
\fBHOMEBREW_UPGRADE_GREEDY\fP
If set, pass \fB\-\-greedy\fP to all cask upgrade commands\.
.TP
\fBHOMEBREW_SIMULATE_MACOS_ON_LINUX\fP \fBHOMEBREW_SIMULATE_MACOS_ON_LINUX\fP
If set, running Homebrew on Linux will simulate certain macOS code paths\. This is useful when auditing macOS formulae while on Linux\. If set, running Homebrew on Linux will simulate certain macOS code paths\. This is useful when auditing macOS formulae while on Linux\.
.TP .TP
@ -2541,6 +2538,9 @@ If set, Homebrew will use the given config file instead of \fB~/\.ssh/config\fP
\fIDefault:\fP \fB$HOME/\.ssh/config\fP \fIDefault:\fP \fB$HOME/\.ssh/config\fP
.RE .RE
.TP .TP
\fBHOMEBREW_SUDO_THROUGH_SUDO_USER\fP
If set, Homebrew will use the \fBSUDO_USER\fP environment variable to define the user to \fBsudo\fP(8) through when running \fBsudo\fP(8)\.
.TP
\fBHOMEBREW_SVN\fP \fBHOMEBREW_SVN\fP
Use this as the \fBsvn\fP(1) binary\. Use this as the \fBsvn\fP(1) binary\.
.RS .RS
@ -2551,9 +2551,6 @@ Use this as the \fBsvn\fP(1) binary\.
\fBHOMEBREW_SYSTEM_ENV_TAKES_PRIORITY\fP \fBHOMEBREW_SYSTEM_ENV_TAKES_PRIORITY\fP
If set in Homebrew\[u2019]s system\-wide environment file (\fB/etc/homebrew/brew\.env\fP), the system\-wide environment file will be loaded last to override any prefix or user settings\. If set in Homebrew\[u2019]s system\-wide environment file (\fB/etc/homebrew/brew\.env\fP), the system\-wide environment file will be loaded last to override any prefix or user settings\.
.TP .TP
\fBHOMEBREW_SUDO_THROUGH_SUDO_USER\fP
If set, Homebrew will use the \fBSUDO_USER\fP environment variable to define the user to \fBsudo\fP(8) through when running \fBsudo\fP(8)\.
.TP
\fBHOMEBREW_TEMP\fP \fBHOMEBREW_TEMP\fP
Use this path as the temporary directory for building packages\. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\. This issue typically occurs when using FileVault or custom SSD configurations\. Use this path as the temporary directory for building packages\. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\. This issue typically occurs when using FileVault or custom SSD configurations\.
.RS .RS
@ -2564,6 +2561,9 @@ Use this path as the temporary directory for building packages\. Changing this m
\fBHOMEBREW_UPDATE_TO_TAG\fP \fBHOMEBREW_UPDATE_TO_TAG\fP
If set, always use the latest stable tag (even if developer commands have been run)\. If set, always use the latest stable tag (even if developer commands have been run)\.
.TP .TP
\fBHOMEBREW_UPGRADE_GREEDY\fP
If set, pass \fB\-\-greedy\fP to all cask upgrade commands\.
.TP
\fBHOMEBREW_VERBOSE\fP \fBHOMEBREW_VERBOSE\fP
If set, always assume \fB\-\-verbose\fP when running commands\. If set, always assume \fB\-\-verbose\fP when running commands\.
.TP .TP