mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
man: generate from Homebrew::EnvConfig.
This commit is contained in:
parent
3381cbf5c7
commit
ad75e40ce7
@ -63,6 +63,7 @@ module Homebrew
|
|||||||
variables[:developer_commands] = generate_cmd_manpages(Commands.internal_developer_commands_paths)
|
variables[:developer_commands] = generate_cmd_manpages(Commands.internal_developer_commands_paths)
|
||||||
variables[:official_external_commands] = generate_cmd_manpages(Commands.official_external_commands_paths)
|
variables[:official_external_commands] = generate_cmd_manpages(Commands.official_external_commands_paths)
|
||||||
variables[:global_options] = global_options_manpage
|
variables[:global_options] = global_options_manpage
|
||||||
|
variables[:environment_variables] = env_vars_manpage
|
||||||
|
|
||||||
readme = HOMEBREW_REPOSITORY/"README.md"
|
readme = HOMEBREW_REPOSITORY/"README.md"
|
||||||
variables[:lead] =
|
variables[:lead] =
|
||||||
@ -207,9 +208,24 @@ module Homebrew
|
|||||||
lines.join("\n")
|
lines.join("\n")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def env_vars_manpage
|
||||||
|
lines = Homebrew::EnvConfig::ENVS.flat_map do |env, hash|
|
||||||
|
entry = " * `#{env}`:\n #{hash[:description]}\n"
|
||||||
|
default = hash[:default_text]
|
||||||
|
default ||= "`#{hash[:default]}`." if hash[:default]
|
||||||
|
entry += "\n\n *Default:* #{default}\n" if default
|
||||||
|
|
||||||
|
entry
|
||||||
|
end
|
||||||
|
lines.join("\n")
|
||||||
|
end
|
||||||
|
|
||||||
def generate_option_doc(short, long, desc)
|
def generate_option_doc(short, long, desc)
|
||||||
comma = (short && long) ? ", " : ""
|
comma = (short && long) ? ", " : ""
|
||||||
"* #{format_short_opt(short)}" + comma + "#{format_long_opt(long)}:" + "\n " + desc + "\n"
|
<<~EOS
|
||||||
|
* #{format_short_opt(short)}#{comma}#{format_long_opt(long)}:
|
||||||
|
#{desc}
|
||||||
|
EOS
|
||||||
end
|
end
|
||||||
|
|
||||||
def format_short_opt(opt)
|
def format_short_opt(opt)
|
||||||
|
@ -109,205 +109,7 @@ Note that environment variables must have a value set to be detected. For exampl
|
|||||||
`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
|
`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
|
||||||
`export HOMEBREW_NO_INSECURE_REDIRECT`.
|
`export HOMEBREW_NO_INSECURE_REDIRECT`.
|
||||||
|
|
||||||
* `HOMEBREW_ARCH`:
|
<%= environment_variables %>
|
||||||
Linux only: If set, Homebrew will pass the set value to type name to the compiler's
|
|
||||||
`-march` option instead of using the default (`-march=native`).
|
|
||||||
|
|
||||||
* `HOMEBREW_ARTIFACT_DOMAIN`:
|
|
||||||
If set, instructs Homebrew to prefix all download URLs, including those for bottles,
|
|
||||||
with this variable. 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 `http://localhost:8080/example.com/foo.tar.gz`.
|
|
||||||
|
|
||||||
* `HOMEBREW_AUTO_UPDATE_SECS`:
|
|
||||||
If set, Homebrew will only check for autoupdates once per this seconds interval.
|
|
||||||
|
|
||||||
*Default:* `300`.
|
|
||||||
|
|
||||||
* `HOMEBREW_AWS_ACCESS_KEY_ID`, `HOMEBREW_AWS_SECRET_ACCESS_KEY`:
|
|
||||||
When using the `S3` download strategy, Homebrew will look in
|
|
||||||
these variables for access credentials (see
|
|
||||||
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment>
|
|
||||||
to retrieve these access credentials from AWS). If they are not set,
|
|
||||||
the `S3` download strategy will download with a public (unsigned) URL.
|
|
||||||
|
|
||||||
* `HOMEBREW_BAT`:
|
|
||||||
If set, Homebrew will use `bat` for the `brew cat` command.
|
|
||||||
|
|
||||||
* `HOMEBREW_BOTTLE_DOMAIN`:
|
|
||||||
By default, Homebrew uses `https://homebrew.bintray.com/` as its download
|
|
||||||
mirror for bottles. If set, instructs Homebrew to instead use the specified
|
|
||||||
URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will
|
|
||||||
cause all bottles to download from the prefix `http://localhost:8080/`.
|
|
||||||
|
|
||||||
* `HOMEBREW_BREW_GIT_REMOTE`:
|
|
||||||
By default, Homebrew uses `https://github.com/Homebrew/brew` as its
|
|
||||||
Homebrew/brew `git`(1) remote. If set, instructs Homebrew to instead use
|
|
||||||
the specified URL.
|
|
||||||
|
|
||||||
* `HOMEBREW_BROWSER`:
|
|
||||||
If set, Homebrew uses this setting as the browser when opening project
|
|
||||||
homepages, instead of the OS default browser.
|
|
||||||
|
|
||||||
* `HOMEBREW_CACHE`:
|
|
||||||
If set, instructs Homebrew to use the specified directory as the download cache.
|
|
||||||
|
|
||||||
*Default:* `~/Library/Caches/Homebrew`.
|
|
||||||
|
|
||||||
* `HOMEBREW_CORE_GIT_REMOTE`:
|
|
||||||
By default, Homebrew uses `https://github.com/Homebrew/homebrew-core` (or
|
|
||||||
`https://github.com/Homebrew/linuxbrew-core`) as its Homebrew/homebrew-core
|
|
||||||
`git`(1) remote. If set, instructs Homebrew to instead use the specified URL.
|
|
||||||
|
|
||||||
* `HOMEBREW_CURLRC`:
|
|
||||||
If set, Homebrew will not pass `--disable` when invoking `curl`(1), which disables
|
|
||||||
the use of `curlrc`.
|
|
||||||
|
|
||||||
* `HOMEBREW_CURL_VERBOSE`:
|
|
||||||
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
|
|
||||||
|
|
||||||
* `HOMEBREW_CURL_RETRIES`:
|
|
||||||
If set, Homebrew will pass the given retry count to `--retry` when invoking `curl`(1).
|
|
||||||
By default, `curl`(1) is invoked with `--retry 3`.
|
|
||||||
|
|
||||||
* `HOMEBREW_DEBUG`:
|
|
||||||
If set, any commands that can emit debugging information will do so.
|
|
||||||
|
|
||||||
* `HOMEBREW_DEVELOPER`:
|
|
||||||
If set, Homebrew will tweak behaviour to be more relevant for Homebrew
|
|
||||||
developers (active or budding), e.g. turning warnings into errors.
|
|
||||||
|
|
||||||
* `HOMEBREW_DISPLAY`:
|
|
||||||
If set, Homebrew will use this X11 display when opening a page in a browser,
|
|
||||||
for example with `brew home`. Primarily useful on Linux.
|
|
||||||
|
|
||||||
*Default:* the value of the user's `DISPLAY` environment variable.
|
|
||||||
|
|
||||||
* `HOMEBREW_DISPLAY_INSTALL_TIMES`:
|
|
||||||
If set, Homebrew will print install times for each formula at the end of the run.
|
|
||||||
|
|
||||||
* `HOMEBREW_EDITOR`:
|
|
||||||
If set, Homebrew will use this editor when editing a single formula, or
|
|
||||||
several formulae in the same directory.
|
|
||||||
|
|
||||||
*Note:* `brew edit` will open all of Homebrew as discontinuous files and
|
|
||||||
directories. TextMate can handle this correctly in project mode, but many
|
|
||||||
editors will do strange things in this case.
|
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_BREWED_CURL`:
|
|
||||||
If set, Homebrew will always use a Homebrew-installed `curl` rather than the
|
|
||||||
system version. Automatically set if the system version of `curl` is too old.
|
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_VENDOR_RUBY`:
|
|
||||||
If set, Homebrew will always use its vendored, relocatable Ruby version
|
|
||||||
even if the system version of Ruby is new enough.
|
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_BREWED_GIT`:
|
|
||||||
If set, Homebrew will always use a Homebrew-installed `git`(1) rather than the
|
|
||||||
system version. Automatically set if the system version of `git` is too old.
|
|
||||||
|
|
||||||
* `HOMEBREW_GITHUB_API_TOKEN`:
|
|
||||||
A personal access token for the GitHub API, used by Homebrew for features
|
|
||||||
such as `brew search`. You can create one at <https://github.com/settings/tokens>.
|
|
||||||
If set, GitHub will allow you a greater number of API requests. For more
|
|
||||||
information, see: <https://developer.github.com/v3/#rate-limiting>
|
|
||||||
|
|
||||||
*Note:* Homebrew doesn't require permissions for any of the scopes.
|
|
||||||
|
|
||||||
* `HOMEBREW_INSTALL_BADGE`:
|
|
||||||
Text printed before the installation summary of each successful build.
|
|
||||||
|
|
||||||
*Default:* the beer emoji.
|
|
||||||
|
|
||||||
* `HOMEBREW_LOGS`:
|
|
||||||
If set, Homebrew will use the specified directory to store log files.
|
|
||||||
|
|
||||||
* `HOMEBREW_MAKE_JOBS`:
|
|
||||||
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
|
|
||||||
the number of parallel jobs to run when building with `make`(1).
|
|
||||||
|
|
||||||
*Default:* the number of available CPU cores.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_ANALYTICS`:
|
|
||||||
If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics>
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_AUTO_UPDATE`:
|
|
||||||
If set, Homebrew will not auto-update before running `brew install`,
|
|
||||||
`brew upgrade` or `brew tap`.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK`:
|
|
||||||
If set, Homebrew will fail on the failure of installation from a bottle
|
|
||||||
rather than falling back to building from source.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_COLOR`:
|
|
||||||
If set, Homebrew will not print text with colour added.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_EMOJI`:
|
|
||||||
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
|
|
||||||
successful build.
|
|
||||||
|
|
||||||
*Note:* Homebrew will only try to print emoji on OS X Lion or newer.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_INSECURE_REDIRECT`:
|
|
||||||
If set, Homebrew will not permit redirects from secure HTTPS
|
|
||||||
to insecure HTTP.
|
|
||||||
|
|
||||||
While ensuring your downloads are fully secure, this is likely
|
|
||||||
to cause from-source SourceForge, some GNU & GNOME based
|
|
||||||
formulae to fail to download.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_GITHUB_API`:
|
|
||||||
If set, Homebrew will not use the GitHub API, e.g. for searches or
|
|
||||||
fetching relevant issues on a failed install.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_INSTALL_CLEANUP`:
|
|
||||||
If set, `brew install`, `brew upgrade` and `brew reinstall` will never
|
|
||||||
automatically cleanup the installed/upgraded/reinstalled formulae or all
|
|
||||||
formulae every 30 days.
|
|
||||||
|
|
||||||
* `HOMEBREW_PRY`:
|
|
||||||
If set, Homebrew will use Pry for the `brew irb` command.
|
|
||||||
|
|
||||||
* `HOMEBREW_SVN`:
|
|
||||||
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
|
|
||||||
a Homebrew-built Subversion if installed, or the system-provided binary.
|
|
||||||
|
|
||||||
Set this to force Homebrew to use a particular `svn` binary.
|
|
||||||
|
|
||||||
* `HOMEBREW_TEMP`:
|
|
||||||
If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory
|
|
||||||
for building packages. This may be needed if your system temp 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.
|
|
||||||
|
|
||||||
* `HOMEBREW_UPDATE_TO_TAG`:
|
|
||||||
If set, instructs Homebrew to always use the latest stable tag (even if
|
|
||||||
developer commands have been run).
|
|
||||||
|
|
||||||
* `HOMEBREW_VERBOSE`:
|
|
||||||
If set, Homebrew always assumes `--verbose` when running commands.
|
|
||||||
|
|
||||||
* `http_proxy`:
|
|
||||||
Sets the HTTP proxy to be used by `curl`, `git` and `svn` when downloading
|
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `https_proxy`:
|
|
||||||
Sets the HTTPS proxy to be used by `curl`, `git` and `svn` when downloading
|
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `all_proxy`:
|
|
||||||
Sets the SOCKS5 proxy to be used by `curl`, `git` and `svn` when downloading
|
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `ftp_proxy`:
|
|
||||||
Sets the FTP proxy to be used by `curl`, `git` and `svn` when downloading
|
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `no_proxy`:
|
|
||||||
Sets the comma-separated list of hostnames and domain names that should be excluded
|
|
||||||
from proxying by `curl`, `git` and `svn` when downloading through Homebrew.
|
|
||||||
|
|
||||||
## USING HOMEBREW BEHIND A PROXY
|
## USING HOMEBREW BEHIND A PROXY
|
||||||
|
|
||||||
|
228
docs/Manpage.md
228
docs/Manpage.md
@ -1176,204 +1176,206 @@ Note that environment variables must have a value set to be detected. For exampl
|
|||||||
`export HOMEBREW_NO_INSECURE_REDIRECT`.
|
`export HOMEBREW_NO_INSECURE_REDIRECT`.
|
||||||
|
|
||||||
* `HOMEBREW_ARCH`:
|
* `HOMEBREW_ARCH`:
|
||||||
Linux only: If set, Homebrew will pass the set value to type name to the compiler's
|
Linux only: Homebrew will pass the set value to type name to the compiler's `-march` option.
|
||||||
`-march` option instead of using the default (`-march=native`).
|
|
||||||
|
*Default:* `native`.
|
||||||
|
|
||||||
* `HOMEBREW_ARTIFACT_DOMAIN`:
|
* `HOMEBREW_ARTIFACT_DOMAIN`:
|
||||||
If set, instructs Homebrew to prefix all download URLs, including those for bottles,
|
Instructs Homebrew to prefix all download URLs, including those for bottles, with this variable. 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 `http://localhost:8080/example.com/foo.tar.gz`.
|
||||||
with this variable. 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 `http://localhost:8080/example.com/foo.tar.gz`.
|
|
||||||
|
|
||||||
* `HOMEBREW_AUTO_UPDATE_SECS`:
|
* `HOMEBREW_AUTO_UPDATE_SECS`:
|
||||||
If set, Homebrew will only check for autoupdates once per this seconds interval.
|
Homebrew will only check for autoupdates once per this seconds interval.
|
||||||
|
|
||||||
*Default:* `300`.
|
*Default:* `300`.
|
||||||
|
|
||||||
* `HOMEBREW_AWS_ACCESS_KEY_ID`, `HOMEBREW_AWS_SECRET_ACCESS_KEY`:
|
|
||||||
When using the `S3` download strategy, Homebrew will look in
|
|
||||||
these variables for access credentials (see
|
|
||||||
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment>
|
|
||||||
to retrieve these access credentials from AWS). If they are not set,
|
|
||||||
the `S3` download strategy will download with a public (unsigned) URL.
|
|
||||||
|
|
||||||
* `HOMEBREW_BAT`:
|
* `HOMEBREW_BAT`:
|
||||||
If set, Homebrew will use `bat` for the `brew cat` command.
|
Homebrew will use `bat` for the `brew cat` command.
|
||||||
|
|
||||||
|
* `HOMEBREW_BINTRAY_KEY`:
|
||||||
|
Homebrew uses this API key when accessing the Bintray API (where bottles are stored).
|
||||||
|
|
||||||
|
* `HOMEBREW_BINTRAY_USER`:
|
||||||
|
Homebrew uses this username when accessing the Bintray API (where bottles are stored).
|
||||||
|
|
||||||
* `HOMEBREW_BOTTLE_DOMAIN`:
|
* `HOMEBREW_BOTTLE_DOMAIN`:
|
||||||
By default, Homebrew uses `https://homebrew.bintray.com/` as its download
|
Instructs Homebrew to use the specified URL as its download mirror for bottles. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to download from the prefix `http://localhost:8080/`.
|
||||||
mirror for bottles. If set, instructs Homebrew to instead use the specified
|
|
||||||
URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will
|
*Default:* macOS: `https://homebrew.bintray.com/`, Linux: `https://linuxbrew.bintray.com/`.
|
||||||
cause all bottles to download from the prefix `http://localhost:8080/`.
|
|
||||||
|
|
||||||
* `HOMEBREW_BREW_GIT_REMOTE`:
|
* `HOMEBREW_BREW_GIT_REMOTE`:
|
||||||
By default, Homebrew uses `https://github.com/Homebrew/brew` as its
|
Instructs Homebrew to use the specified URL as its Homebrew/brew `git`(1) remote.
|
||||||
Homebrew/brew `git`(1) remote. If set, instructs Homebrew to instead use
|
|
||||||
the specified URL.
|
*Default:* `https://github.com/Homebrew/brew`.
|
||||||
|
|
||||||
* `HOMEBREW_BROWSER`:
|
* `HOMEBREW_BROWSER`:
|
||||||
If set, Homebrew uses this setting as the browser when opening project
|
Homebrew uses this setting as the browser when opening project homepages.
|
||||||
homepages, instead of the OS default browser.
|
|
||||||
|
*Default:* `$BROWSER` or the OS's default browser.
|
||||||
|
|
||||||
* `HOMEBREW_CACHE`:
|
* `HOMEBREW_CACHE`:
|
||||||
If set, instructs Homebrew to use the specified directory as the download cache.
|
Instructs Homebrew to use the specified directory as the download cache.
|
||||||
|
|
||||||
*Default:* `~/Library/Caches/Homebrew`.
|
*Default:* macOS: `$HOME/Library/Caches/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.
|
||||||
|
|
||||||
|
* `HOMEBREW_COLOR`:
|
||||||
|
Homebrew force colour output on non-TTY outputs.
|
||||||
|
|
||||||
* `HOMEBREW_CORE_GIT_REMOTE`:
|
* `HOMEBREW_CORE_GIT_REMOTE`:
|
||||||
By default, Homebrew uses `https://github.com/Homebrew/homebrew-core` (or
|
instructs Homebrew to use the specified URL as its Homebrew/homebrew-core `git`(1) remote.
|
||||||
`https://github.com/Homebrew/linuxbrew-core`) as its Homebrew/homebrew-core
|
|
||||||
`git`(1) remote. If set, instructs Homebrew to instead use the specified URL.
|
*Default:* macOS: `https://github.com/Homebrew/homebrew-core`, Linux: `https://github.com/Homebrew/linuxbrew-core`.
|
||||||
|
|
||||||
* `HOMEBREW_CURLRC`:
|
* `HOMEBREW_CURLRC`:
|
||||||
If set, Homebrew will not pass `--disable` when invoking `curl`(1), which disables
|
Homebrew will not pass `--disable` when invoking `curl`(1), which disables the use of `curlrc`.
|
||||||
the use of `curlrc`.
|
|
||||||
|
|
||||||
* `HOMEBREW_CURL_VERBOSE`:
|
|
||||||
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
|
|
||||||
|
|
||||||
* `HOMEBREW_CURL_RETRIES`:
|
* `HOMEBREW_CURL_RETRIES`:
|
||||||
If set, Homebrew will pass the given retry count to `--retry` when invoking `curl`(1).
|
Homebrew will pass the given retry count to `--retry` when invoking `curl`(1).
|
||||||
By default, `curl`(1) is invoked with `--retry 3`.
|
|
||||||
|
|
||||||
* `HOMEBREW_DEBUG`:
|
*Default:* `3`.
|
||||||
If set, any commands that can emit debugging information will do so.
|
|
||||||
|
* `HOMEBREW_CURL_VERBOSE`:
|
||||||
|
Homebrew will pass `--verbose` when invoking `curl`(1).
|
||||||
|
|
||||||
* `HOMEBREW_DEVELOPER`:
|
* `HOMEBREW_DEVELOPER`:
|
||||||
If set, Homebrew will tweak behaviour to be more relevant for Homebrew
|
Homebrew will tweak behaviour to be more relevant for Homebrew developers (active or budding), e.g. turning warnings into errors.
|
||||||
developers (active or budding), e.g. turning warnings into errors.
|
|
||||||
|
* `HOMEBREW_DISABLE_LOAD_FORMULA`:
|
||||||
|
Homebrew will refuse to load formulae. This is useful when formulae are not trusted (such as in pull requests).
|
||||||
|
|
||||||
* `HOMEBREW_DISPLAY`:
|
* `HOMEBREW_DISPLAY`:
|
||||||
If set, Homebrew will use this X11 display when opening a page in a browser,
|
Homebrew will use this X11 display when opening a page in a browser, for example with `brew home`. Primarily useful on Linux.
|
||||||
for example with `brew home`. Primarily useful on Linux.
|
|
||||||
|
|
||||||
*Default:* the value of the user's `DISPLAY` environment variable.
|
*Default:* `$DISPLAY`.
|
||||||
|
|
||||||
* `HOMEBREW_DISPLAY_INSTALL_TIMES`:
|
* `HOMEBREW_DISPLAY_INSTALL_TIMES`:
|
||||||
If set, Homebrew will print install times for each formula at the end of the run.
|
Homebrew will print install times for each formula at the end of the run.
|
||||||
|
|
||||||
* `HOMEBREW_EDITOR`:
|
* `HOMEBREW_EDITOR`:
|
||||||
If set, Homebrew will use this editor when editing a single formula, or
|
Homebrew will use this editor when editing a single formula, or several formulae in the same directory.
|
||||||
several formulae in the same directory.
|
|
||||||
|
|
||||||
*Note:* `brew edit` will open all of Homebrew as discontinuous files and
|
*Note:* `brew edit` will open all of Homebrew as discontinuous files and directories. Visual Studio Code can handle this correctly in project mode, but many editors will do strange things in this case.
|
||||||
directories. TextMate can handle this correctly in project mode, but many
|
|
||||||
editors will do strange things in this case.
|
*Default:* `$EDITOR` or `$VISUAL`.
|
||||||
|
|
||||||
|
* `HOMEBREW_FAIL_LOG_LINES`:
|
||||||
|
Homebrew will output this many lines of output on formula `system` failures.
|
||||||
|
|
||||||
|
*Default:* `15`.
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_BREWED_CURL`:
|
* `HOMEBREW_FORCE_BREWED_CURL`:
|
||||||
If set, Homebrew will always use a Homebrew-installed `curl` rather than the
|
Homebrew will always use a Homebrew-installed `curl`(1) rather than the system version. Automatically set if the system version of `curl` is too old.
|
||||||
system version. Automatically set if the system version of `curl` is too old.
|
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_VENDOR_RUBY`:
|
|
||||||
If set, Homebrew will always use its vendored, relocatable Ruby version
|
|
||||||
even if the system version of Ruby is new enough.
|
|
||||||
|
|
||||||
* `HOMEBREW_FORCE_BREWED_GIT`:
|
* `HOMEBREW_FORCE_BREWED_GIT`:
|
||||||
If set, Homebrew will always use a Homebrew-installed `git`(1) rather than the
|
Homebrew will always use a Homebrew-installed `git`(1) rather than the system version. Automatically set if the system version of `git` is too old.
|
||||||
system version. Automatically set if the system version of `git` is too old.
|
|
||||||
|
* `HOMEBREW_FORCE_HOMEBREW_ON_LINUX`:
|
||||||
|
Homebrew running on Linux will use URLs for Homebrew on macOS. This is useful when mergingpull requests on Linux for macOS.
|
||||||
|
|
||||||
|
* `HOMEBREW_FORCE_VENDOR_RUBY`:
|
||||||
|
Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough.
|
||||||
|
|
||||||
|
* `HOMEBREW_GITHUB_API_PASSWORD`:
|
||||||
|
GitHub password for authentication with the GitHub API, used by Homebrew for featuressuch as `brew search`. We strongly recommend using `HOMEBREW_GITHUB_API_TOKEN` instead.
|
||||||
|
|
||||||
* `HOMEBREW_GITHUB_API_TOKEN`:
|
* `HOMEBREW_GITHUB_API_TOKEN`:
|
||||||
A personal access token for the GitHub API, used by Homebrew for features
|
A personal access token for the GitHub API, used by Homebrew for features such as `brew search`. You can create one at <https://github.com/settings/tokens>. If set, GitHub will allow you a greater number of API requests. For more information, see: <https://developer.github.com/v3/#rate-limiting>
|
||||||
such as `brew search`. You can create one at <https://github.com/settings/tokens>.
|
|
||||||
If set, GitHub will allow you a greater number of API requests. For more
|
|
||||||
information, see: <https://developer.github.com/v3/#rate-limiting>
|
|
||||||
|
|
||||||
*Note:* Homebrew doesn't require permissions for any of the scopes.
|
*Note:* Homebrew doesn't require permissions for any of the scopes.
|
||||||
|
|
||||||
|
* `HOMEBREW_GITHUB_API_USERNAME`:
|
||||||
|
GitHub username for authentication with the GitHub API, used by Homebrew for features such as `brew search`. We strongly recommend using `HOMEBREW_GITHUB_API_TOKEN` instead.
|
||||||
|
|
||||||
|
* `HOMEBREW_GIT_EMAIL`:
|
||||||
|
Homebrew will set the Git author and committer name to this value.
|
||||||
|
|
||||||
|
* `HOMEBREW_GIT_NAME`:
|
||||||
|
Homebrew will set the Git author and committer email to this value.
|
||||||
|
|
||||||
* `HOMEBREW_INSTALL_BADGE`:
|
* `HOMEBREW_INSTALL_BADGE`:
|
||||||
Text printed before the installation summary of each successful build.
|
Text printed before the installation summary of each successful build.
|
||||||
|
|
||||||
*Default:* the beer emoji.
|
*Default:* The "Beer Mug" emoji.
|
||||||
|
|
||||||
* `HOMEBREW_LOGS`:
|
* `HOMEBREW_LOGS`:
|
||||||
If set, Homebrew will use the specified directory to store log files.
|
IHomebrew will use the specified directory to store log files.
|
||||||
|
|
||||||
|
*Default:* macOS: `$HOME/Library/Logs/Homebrew`, Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.
|
||||||
|
|
||||||
* `HOMEBREW_MAKE_JOBS`:
|
* `HOMEBREW_MAKE_JOBS`:
|
||||||
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
|
Instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as the number of parallel jobs to run when building with `make`(1).
|
||||||
the number of parallel jobs to run when building with `make`(1).
|
|
||||||
|
|
||||||
*Default:* the number of available CPU cores.
|
*Default:* The number of available CPU cores.
|
||||||
|
|
||||||
* `HOMEBREW_NO_ANALYTICS`:
|
* `HOMEBREW_NO_ANALYTICS`:
|
||||||
If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics>
|
Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics>.
|
||||||
|
|
||||||
* `HOMEBREW_NO_AUTO_UPDATE`:
|
* `HOMEBREW_NO_AUTO_UPDATE`:
|
||||||
If set, Homebrew will not auto-update before running `brew install`,
|
Homebrew will not auto-update before running `brew install`, `brew upgrade` or `brew tap`.
|
||||||
`brew upgrade` or `brew tap`.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK`:
|
* `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK`:
|
||||||
If set, Homebrew will fail on the failure of installation from a bottle
|
Homebrew will fail on the failure of installation from a bottle rather than falling back to building from source.
|
||||||
rather than falling back to building from source.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_COLOR`:
|
* `HOMEBREW_NO_COLOR`:
|
||||||
If set, Homebrew will not print text with colour added.
|
Homebrew will not print text with colour added.
|
||||||
|
|
||||||
|
*Default:* `$NO_COLOR`.
|
||||||
|
|
||||||
|
* `HOMEBREW_NO_COMPAT`:
|
||||||
|
Homebrew disables all use of legacy compatibility code.
|
||||||
|
|
||||||
* `HOMEBREW_NO_EMOJI`:
|
* `HOMEBREW_NO_EMOJI`:
|
||||||
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
|
Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a successful build.
|
||||||
successful build.
|
|
||||||
|
|
||||||
*Note:* Homebrew will only try to print emoji on OS X Lion or newer.
|
*Note:* Homebrew will only try to print emoji on OS X Lion or newer.
|
||||||
|
|
||||||
* `HOMEBREW_NO_INSECURE_REDIRECT`:
|
|
||||||
If set, Homebrew will not permit redirects from secure HTTPS
|
|
||||||
to insecure HTTP.
|
|
||||||
|
|
||||||
While ensuring your downloads are fully secure, this is likely
|
|
||||||
to cause from-source SourceForge, some GNU & GNOME based
|
|
||||||
formulae to fail to download.
|
|
||||||
|
|
||||||
* `HOMEBREW_NO_GITHUB_API`:
|
* `HOMEBREW_NO_GITHUB_API`:
|
||||||
If set, Homebrew will not use the GitHub API, e.g. for searches or
|
Homebrew will not use the GitHub API, e.g. for searches or fetching relevant issues on a failed install.
|
||||||
fetching relevant issues on a failed install.
|
|
||||||
|
* `HOMEBREW_NO_INSECURE_REDIRECT`:
|
||||||
|
Homebrew will not permit redirects from secure HTTPS to insecure HTTP.
|
||||||
|
|
||||||
|
*Note:* While ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download.
|
||||||
|
|
||||||
* `HOMEBREW_NO_INSTALL_CLEANUP`:
|
* `HOMEBREW_NO_INSTALL_CLEANUP`:
|
||||||
If set, `brew install`, `brew upgrade` and `brew reinstall` will never
|
`brew install`, `brew upgrade` and `brew reinstall` will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every 30 days.
|
||||||
automatically cleanup the installed/upgraded/reinstalled formulae or all
|
|
||||||
formulae every 30 days.
|
|
||||||
|
|
||||||
* `HOMEBREW_PRY`:
|
* `HOMEBREW_PRY`:
|
||||||
If set, Homebrew will use Pry for the `brew irb` command.
|
Homebrew will use Pry for the `brew irb` command.
|
||||||
|
|
||||||
|
* `HOMEBREW_SKIP_OR_LATER_BOTTLES`:
|
||||||
|
Along with `HOMEBREW_DEVELOPER` Homebrew will not use bottles from older versions of macOS. This is useful in Homebrew development on new macOS versions.
|
||||||
|
|
||||||
* `HOMEBREW_SVN`:
|
* `HOMEBREW_SVN`:
|
||||||
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
|
Forces Homebrew to use a particular `svn` binary. Otherwise, a Homebrew-built Subversion if installed, or the system-provided binary.
|
||||||
a Homebrew-built Subversion if installed, or the system-provided binary.
|
|
||||||
|
|
||||||
Set this to force Homebrew to use a particular `svn` binary.
|
|
||||||
|
|
||||||
* `HOMEBREW_TEMP`:
|
* `HOMEBREW_TEMP`:
|
||||||
If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory
|
Instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory for building packages. This may be needed if your system temp directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the targetdoes not yet exist. This issue typically occurs when using FileVault or custom SSDconfigurations.
|
||||||
for building packages. This may be needed if your system temp 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.
|
*Default:* macOS: `/private/tmp`, Linux: `/tmp`.
|
||||||
|
|
||||||
* `HOMEBREW_UPDATE_TO_TAG`:
|
* `HOMEBREW_UPDATE_TO_TAG`:
|
||||||
If set, instructs Homebrew to always use the latest stable tag (even if
|
Instructs Homebrew to always use the latest stable tag (even if developer commands have been run).
|
||||||
developer commands have been run).
|
|
||||||
|
|
||||||
* `HOMEBREW_VERBOSE`:
|
* `HOMEBREW_VERBOSE`:
|
||||||
If set, Homebrew always assumes `--verbose` when running commands.
|
Homebrew always assumes `--verbose` when running commands.
|
||||||
|
|
||||||
* `http_proxy`:
|
* `HOMEBREW_VERBOSE_USING_DOTS`:
|
||||||
Sets the HTTP proxy to be used by `curl`, `git` and `svn` when downloading
|
Homebrew's verbose output will print a `.` no more than once a minute. This can be useful to avoid long-running Homebrew commands being killed due to no output.
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `https_proxy`:
|
|
||||||
Sets the HTTPS proxy to be used by `curl`, `git` and `svn` when downloading
|
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `all_proxy`:
|
* `all_proxy`:
|
||||||
Sets the SOCKS5 proxy to be used by `curl`, `git` and `svn` when downloading
|
Sets the SOCKS5 proxy to be used by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.
|
||||||
through Homebrew.
|
|
||||||
|
|
||||||
* `ftp_proxy`:
|
* `ftp_proxy`:
|
||||||
Sets the FTP proxy to be used by `curl`, `git` and `svn` when downloading
|
Sets the FTP proxy to be used by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.
|
||||||
through Homebrew.
|
|
||||||
|
* `http_proxy`:
|
||||||
|
Sets the HTTP proxy to be used by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.
|
||||||
|
|
||||||
|
* `https_proxy`:
|
||||||
|
Sets the HTTPS proxy to be used by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.
|
||||||
|
|
||||||
* `no_proxy`:
|
* `no_proxy`:
|
||||||
Sets the comma-separated list of hostnames and domain names that should be excluded
|
Sets the comma-separated list of hostnames and domain names that should be excluded from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.
|
||||||
from proxying by `curl`, `git` and `svn` when downloading through Homebrew.
|
|
||||||
|
|
||||||
## USING HOMEBREW BEHIND A PROXY
|
## USING HOMEBREW BEHIND A PROXY
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "BREW\-CASK" "1" "March 2020" "Homebrew" "brew-cask"
|
.TH "BREW\-CASK" "1" "April 2020" "Homebrew" "brew-cask"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBbrew\-cask\fR \- a friendly binary installer for macOS
|
\fBbrew\-cask\fR \- a friendly binary installer for macOS
|
||||||
|
209
manpages/brew.1
209
manpages/brew.1
@ -1,7 +1,7 @@
|
|||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "BREW" "1" "March 2020" "Homebrew" "brew"
|
.TH "BREW" "1" "April 2020" "Homebrew" "brew"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBbrew\fR \- The Missing Package Manager for macOS
|
\fBbrew\fR \- The Missing Package Manager for macOS
|
||||||
@ -1492,99 +1492,143 @@ Note that environment variables must have a value set to be detected\. For examp
|
|||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_ARCH\fR
|
\fBHOMEBREW_ARCH\fR
|
||||||
Linux only: If set, Homebrew will pass the set value to type name to the compiler\'s \fB\-march\fR option instead of using the default (\fB\-march=native\fR)\.
|
Linux only: Homebrew will pass the set value to type name to the compiler\'s \fB\-march\fR option\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fBnative\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_ARTIFACT_DOMAIN\fR
|
\fBHOMEBREW_ARTIFACT_DOMAIN\fR
|
||||||
If set, instructs Homebrew to prefix all download URLs, including those for bottles, with this variable\. For example, \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fR to instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\fR\.
|
Instructs Homebrew to prefix all download URLs, including those for bottles, with this variable\. For example, \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fR to instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_AUTO_UPDATE_SECS\fR
|
\fBHOMEBREW_AUTO_UPDATE_SECS\fR
|
||||||
If set, Homebrew will only check for autoupdates once per this seconds interval\.
|
Homebrew will only check for autoupdates once per this seconds interval\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fIDefault:\fR \fB300\fR\.
|
\fIDefault:\fR \fB300\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_AWS_ACCESS_KEY_ID\fR, \fBHOMEBREW_AWS_SECRET_ACCESS_KEY\fR
|
\fBHOMEBREW_BAT\fR
|
||||||
When using the \fBS3\fR download strategy, Homebrew will look in these variables for access credentials (see \fIhttps://docs\.aws\.amazon\.com/cli/latest/userguide/cli\-chap\-getting\-started\.html#cli\-environment\fR to retrieve these access credentials from AWS)\. If they are not set, the \fBS3\fR download strategy will download with a public (unsigned) URL\.
|
Homebrew will use \fBbat\fR for the \fBbrew cat\fR command\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_BAT\fR
|
\fBHOMEBREW_BINTRAY_KEY\fR
|
||||||
If set, Homebrew will use \fBbat\fR for the \fBbrew cat\fR command\.
|
Homebrew uses this API key when accessing the Bintray API (where bottles are stored)\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_BINTRAY_USER\fR
|
||||||
|
Homebrew uses this username when accessing the Bintray API (where bottles are stored)\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_BOTTLE_DOMAIN\fR
|
\fBHOMEBREW_BOTTLE_DOMAIN\fR
|
||||||
By default, Homebrew uses \fBhttps://homebrew\.bintray\.com/\fR as its download mirror for bottles\. If set, instructs Homebrew to instead use the specified URL\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\.
|
Instructs Homebrew to use the specified URL as its download mirror for bottles\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR macOS: \fBhttps://homebrew\.bintray\.com/\fR, Linux: \fBhttps://linuxbrew\.bintray\.com/\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_BREW_GIT_REMOTE\fR
|
\fBHOMEBREW_BREW_GIT_REMOTE\fR
|
||||||
By default, Homebrew uses \fBhttps://github\.com/Homebrew/brew\fR as its Homebrew/brew \fBgit\fR(1) remote\. If set, instructs Homebrew to instead use the specified URL\.
|
Instructs Homebrew to use the specified URL as its Homebrew/brew \fBgit\fR(1) remote\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fBhttps://github\.com/Homebrew/brew\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_BROWSER\fR
|
\fBHOMEBREW_BROWSER\fR
|
||||||
If set, Homebrew uses this setting as the browser when opening project homepages, instead of the OS default browser\.
|
Homebrew uses this setting as the browser when opening project homepages\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fB$BROWSER\fR or the OS\'s default browser\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_CACHE\fR
|
\fBHOMEBREW_CACHE\fR
|
||||||
If set, instructs Homebrew to use the specified directory as the download cache\.
|
Instructs Homebrew to use the specified directory as the download cache\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\.
|
\fIDefault:\fR macOS: \fB$HOME/Library/Caches/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew\fR or \fB$HOME/\.cache/Homebrew\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_COLOR\fR
|
||||||
|
Homebrew force colour output on non\-TTY outputs\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_CORE_GIT_REMOTE\fR
|
\fBHOMEBREW_CORE_GIT_REMOTE\fR
|
||||||
By default, Homebrew uses \fBhttps://github\.com/Homebrew/homebrew\-core\fR (or \fBhttps://github\.com/Homebrew/linuxbrew\-core\fR) as its Homebrew/homebrew\-core \fBgit\fR(1) remote\. If set, instructs Homebrew to instead use the specified URL\.
|
instructs Homebrew to use the specified URL as its Homebrew/homebrew\-core \fBgit\fR(1) remote\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR macOS: \fBhttps://github\.com/Homebrew/homebrew\-core\fR, Linux: \fBhttps://github\.com/Homebrew/linuxbrew\-core\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_CURLRC\fR
|
\fBHOMEBREW_CURLRC\fR
|
||||||
If set, Homebrew will not pass \fB\-\-disable\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\.
|
Homebrew will not pass \fB\-\-disable\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\.
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBHOMEBREW_CURL_VERBOSE\fR
|
|
||||||
If set, Homebrew will pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_CURL_RETRIES\fR
|
\fBHOMEBREW_CURL_RETRIES\fR
|
||||||
If set, Homebrew will pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\. By default, \fBcurl\fR(1) is invoked with \fB\-\-retry 3\fR\.
|
Homebrew will pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fB3\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_DEBUG\fR
|
\fBHOMEBREW_CURL_VERBOSE\fR
|
||||||
If set, any commands that can emit debugging information will do so\.
|
Homebrew will pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_DEVELOPER\fR
|
\fBHOMEBREW_DEVELOPER\fR
|
||||||
If set, Homebrew will tweak behaviour to be more relevant for Homebrew developers (active or budding), e\.g\. turning warnings into errors\.
|
Homebrew will tweak behaviour to be more relevant for Homebrew developers (active or budding), e\.g\. turning warnings into errors\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_DISABLE_LOAD_FORMULA\fR
|
||||||
|
Homebrew will refuse to load formulae\. This is useful when formulae are not trusted (such as in pull requests)\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_DISPLAY\fR
|
\fBHOMEBREW_DISPLAY\fR
|
||||||
If set, Homebrew will use this X11 display when opening a page in a browser, for example with \fBbrew home\fR\. Primarily useful on Linux\.
|
Homebrew will use this X11 display when opening a page in a browser, for example with \fBbrew home\fR\. Primarily useful on Linux\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fIDefault:\fR the value of the user\'s \fBDISPLAY\fR environment variable\.
|
\fIDefault:\fR \fB$DISPLAY\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_DISPLAY_INSTALL_TIMES\fR
|
\fBHOMEBREW_DISPLAY_INSTALL_TIMES\fR
|
||||||
If set, Homebrew will print install times for each formula at the end of the run\.
|
Homebrew will print install times for each formula at the end of the run\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_EDITOR\fR
|
\fBHOMEBREW_EDITOR\fR
|
||||||
If set, Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
|
Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fINote:\fR \fBbrew edit\fR will open all of Homebrew as discontinuous files and directories\. TextMate can handle this correctly in project mode, but many editors will do strange things in this case\.
|
\fINote:\fR \fBbrew edit\fR will open all of Homebrew as discontinuous files and directories\. Visual Studio Code can handle this correctly in project mode, but many editors will do strange things in this case\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fB$EDITOR\fR or \fB$VISUAL\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_FAIL_LOG_LINES\fR
|
||||||
|
Homebrew will output this many lines of output on formula \fBsystem\fR failures\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fB15\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_FORCE_BREWED_CURL\fR
|
\fBHOMEBREW_FORCE_BREWED_CURL\fR
|
||||||
If set, Homebrew will always use a Homebrew\-installed \fBcurl\fR rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\.
|
Homebrew will always use a Homebrew\-installed \fBcurl\fR(1) rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\.
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBHOMEBREW_FORCE_VENDOR_RUBY\fR
|
|
||||||
If set, Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_FORCE_BREWED_GIT\fR
|
\fBHOMEBREW_FORCE_BREWED_GIT\fR
|
||||||
If set, Homebrew will always use a Homebrew\-installed \fBgit\fR(1) rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\.
|
Homebrew will always use a Homebrew\-installed \fBgit\fR(1) rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_FORCE_HOMEBREW_ON_LINUX\fR
|
||||||
|
Homebrew running on Linux will use URLs for Homebrew on macOS\. This is useful when mergingpull requests on Linux for macOS\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_FORCE_VENDOR_RUBY\fR
|
||||||
|
Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_GITHUB_API_PASSWORD\fR
|
||||||
|
GitHub password for authentication with the GitHub API, used by Homebrew for featuressuch as \fBbrew search\fR\. We strongly recommend using \fBHOMEBREW_GITHUB_API_TOKEN\fR instead\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_GITHUB_API_TOKEN\fR
|
\fBHOMEBREW_GITHUB_API_TOKEN\fR
|
||||||
@ -1594,106 +1638,133 @@ A personal access token for the GitHub API, used by Homebrew for features such a
|
|||||||
\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes\.
|
\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
|
\fBHOMEBREW_GITHUB_API_USERNAME\fR
|
||||||
|
GitHub username for authentication with the GitHub API, used by Homebrew for features such as \fBbrew search\fR\. We strongly recommend using \fBHOMEBREW_GITHUB_API_TOKEN\fR instead\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_GIT_EMAIL\fR
|
||||||
|
Homebrew will set the Git author and committer name to this value\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_GIT_NAME\fR
|
||||||
|
Homebrew will set the Git author and committer email to this value\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
\fBHOMEBREW_INSTALL_BADGE\fR
|
\fBHOMEBREW_INSTALL_BADGE\fR
|
||||||
Text printed before the installation summary of each successful build\.
|
Text printed before the installation summary of each successful build\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fIDefault:\fR the beer emoji\.
|
\fIDefault:\fR The "Beer Mug" emoji\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_LOGS\fR
|
\fBHOMEBREW_LOGS\fR
|
||||||
If set, Homebrew will use the specified directory to store log files\.
|
IHomebrew will use the specified directory to store log files\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR macOS: \fB$HOME/Library/Logs/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew/Logs\fR or \fB$HOME/\.cache/Homebrew/Logs\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_MAKE_JOBS\fR
|
\fBHOMEBREW_MAKE_JOBS\fR
|
||||||
If set, instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the number of parallel jobs to run when building with \fBmake\fR(1)\.
|
Instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the number of parallel jobs to run when building with \fBmake\fR(1)\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fIDefault:\fR the number of available CPU cores\.
|
\fIDefault:\fR The number of available CPU cores\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_ANALYTICS\fR
|
\fBHOMEBREW_NO_ANALYTICS\fR
|
||||||
If set, Homebrew will not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\fR
|
Homebrew will not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_AUTO_UPDATE\fR
|
\fBHOMEBREW_NO_AUTO_UPDATE\fR
|
||||||
If set, Homebrew will not auto\-update before running \fBbrew install\fR, \fBbrew upgrade\fR or \fBbrew tap\fR\.
|
Homebrew will not auto\-update before running \fBbrew install\fR, \fBbrew upgrade\fR or \fBbrew tap\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_BOTTLE_SOURCE_FALLBACK\fR
|
\fBHOMEBREW_NO_BOTTLE_SOURCE_FALLBACK\fR
|
||||||
If set, Homebrew will fail on the failure of installation from a bottle rather than falling back to building from source\.
|
Homebrew will fail on the failure of installation from a bottle rather than falling back to building from source\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_COLOR\fR
|
\fBHOMEBREW_NO_COLOR\fR
|
||||||
If set, Homebrew will not print text with colour added\.
|
Homebrew will not print text with colour added\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fIDefault:\fR \fB$NO_COLOR\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_NO_COMPAT\fR
|
||||||
|
Homebrew disables all use of legacy compatibility code\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_EMOJI\fR
|
\fBHOMEBREW_NO_EMOJI\fR
|
||||||
If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
|
Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
\fINote:\fR Homebrew will only try to print emoji on OS X Lion or newer\.
|
\fINote:\fR Homebrew will only try to print emoji on OS X Lion or newer\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_INSECURE_REDIRECT\fR
|
\fBHOMEBREW_NO_GITHUB_API\fR
|
||||||
If set, Homebrew will not permit redirects from secure HTTPS to insecure HTTP\.
|
Homebrew will not use the GitHub API, e\.g\. for searches or fetching relevant issues on a failed install\.
|
||||||
.
|
|
||||||
.IP
|
|
||||||
While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME based formulae to fail to download\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_GITHUB_API\fR
|
\fBHOMEBREW_NO_INSECURE_REDIRECT\fR
|
||||||
If set, Homebrew will not use the GitHub API, e\.g\. for searches or fetching relevant issues on a failed install\.
|
Homebrew will not permit redirects from secure HTTPS to insecure HTTP\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fINote:\fR While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME based formulae to fail to download\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR
|
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR
|
||||||
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup the installed/upgraded/reinstalled formulae or all formulae every 30 days\.
|
\fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every 30 days\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_PRY\fR
|
\fBHOMEBREW_PRY\fR
|
||||||
If set, Homebrew will use Pry for the \fBbrew irb\fR command\.
|
Homebrew will use Pry for the \fBbrew irb\fR command\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBHOMEBREW_SKIP_OR_LATER_BOTTLES\fR
|
||||||
|
Along with \fBHOMEBREW_DEVELOPER\fR Homebrew will not use bottles from older versions of macOS\. This is useful in Homebrew development on new macOS versions\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_SVN\fR
|
\fBHOMEBREW_SVN\fR
|
||||||
When exporting from Subversion, Homebrew will use \fBHOMEBREW_SVN\fR if set, a Homebrew\-built Subversion if installed, or the system\-provided binary\.
|
Forces Homebrew to use a particular \fBsvn\fR binary\. Otherwise, a Homebrew\-built Subversion if installed, or the system\-provided binary\.
|
||||||
.
|
|
||||||
.IP
|
|
||||||
Set this to force Homebrew to use a particular \fBsvn\fR binary\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_TEMP\fR
|
\fBHOMEBREW_TEMP\fR
|
||||||
If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary directory for building packages\. This may be needed if your system temp directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\.
|
Instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary directory for building packages\. This may be needed if your system temp directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the targetdoes not yet exist\. This issue typically occurs when using FileVault or custom SSDconfigurations\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
This issue typically occurs when using FileVault or custom SSD configurations\.
|
\fIDefault:\fR macOS: \fB/private/tmp\fR, Linux: \fB/tmp\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_UPDATE_TO_TAG\fR
|
\fBHOMEBREW_UPDATE_TO_TAG\fR
|
||||||
If set, instructs Homebrew to always use the latest stable tag (even if developer commands have been run)\.
|
Instructs Homebrew to always use the latest stable tag (even if developer commands have been run)\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBHOMEBREW_VERBOSE\fR
|
\fBHOMEBREW_VERBOSE\fR
|
||||||
If set, Homebrew always assumes \fB\-\-verbose\fR when running commands\.
|
Homebrew always assumes \fB\-\-verbose\fR when running commands\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBhttp_proxy\fR
|
\fBHOMEBREW_VERBOSE_USING_DOTS\fR
|
||||||
Sets the HTTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
|
Homebrew\'s verbose output will print a \fB\.\fR no more than once a minute\. This can be useful to avoid long\-running Homebrew commands being killed due to no output\.
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBhttps_proxy\fR
|
|
||||||
Sets the HTTPS proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBall_proxy\fR
|
\fBall_proxy\fR
|
||||||
Sets the SOCKS5 proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
|
Sets the SOCKS5 proxy to be used by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBftp_proxy\fR
|
\fBftp_proxy\fR
|
||||||
Sets the FTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
|
Sets the FTP proxy to be used by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBhttp_proxy\fR
|
||||||
|
Sets the HTTP proxy to be used by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBhttps_proxy\fR
|
||||||
|
Sets the HTTPS proxy to be used by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBno_proxy\fR
|
\fBno_proxy\fR
|
||||||
Sets the comma\-separated list of hostnames and domain names that should be excluded from proxying by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
|
Sets the comma\-separated list of hostnames and domain names that should be excluded from proxying by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
|
||||||
.
|
.
|
||||||
.SH "USING HOMEBREW BEHIND A PROXY"
|
.SH "USING HOMEBREW BEHIND A PROXY"
|
||||||
Set the \fBhttp_proxy\fR, \fBhttps_proxy\fR, \fBall_proxy\fR, \fBftp_proxy\fR and/or \fBno_proxy\fR environment variables documented above\.
|
Set the \fBhttp_proxy\fR, \fBhttps_proxy\fR, \fBall_proxy\fR, \fBftp_proxy\fR and/or \fBno_proxy\fR environment variables documented above\.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user