admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: update man page text

Browse Source
This commit is contained in:
EricFromCanada 2018-12-03 21:23:06 -05:00
parent c89f6c8f8c
commit 799086f548
5 changed files with 98 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9,7 +9,7 @@
#: * `search` [`--desc`] (<text>|`/`<text>`/`): #: * `search` [`--desc`] (<text>|`/`<text>`/`):
#: Perform a substring search of cask tokens and formula names for <text>. If <text> #: Perform a substring search of cask tokens and formula names for <text>. If <text>
#: is surrounded with slashes, then it is interpreted as a regular expression. #: is surrounded with slashes, then it is interpreted as a regular expression.
#: The search for <text> is extended online to official taps. #: The search for <text> is extended online to `homebrew/core` and `homebrew/cask`.
#: #:
#: If `--desc` is passed, search formulae with a description matching <text> and #: If `--desc` is passed, search formulae with a description matching <text> and
#: casks with a name matching <text>. #: casks with a name matching <text>.

71
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -26,7 +26,8 @@ didn't include with macOS.
For the full command list, see the [COMMANDS](#commands) section. For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `-v`, many commands print extra debugging information. Note that these flags should only appear after a command. With `--verbose` or `-v`, many commands print extra debugging information. Note that
these flags should only appear after a command.
* `install` <formula>: * `install` <formula>:
Install <formula>. Install <formula>.
@ -41,9 +42,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
List all installed formulae. List all installed formulae.
* `search` (<text>|`/`<text>`/`): * `search` (<text>|`/`<text>`/`):
Perform a substring search of formula names for <text>. If <text> is Perform a substring search of cask tokens and formula names for <text>. If <text>
surrounded with slashes, then it is interpreted as a regular expression. is surrounded with slashes, then it is interpreted as a regular expression.
The search for <text> is extended online to some popular taps. The search for <text> is extended online to `homebrew/core` and `homebrew/cask`.
If no search term is given, all locally available formulae are listed. If no search term is given, all locally available formulae are listed.
## COMMANDS ## COMMANDS
@ -101,19 +102,21 @@ can take several different forms:
* An arbitrary file or URL: * An arbitrary file or URL:
Homebrew can install formulae via URL, e.g. Homebrew can install formulae via URL, e.g.
`https://raw.github.com/Homebrew/homebrew-core/master/Formula/git.rb`, `https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`,
or from a local path. It could point to either a formula file or a bottle. or from a local path. It could point to either a formula file or a bottle.
In the case of a URL, the downloaded file will be cached for later use. In the case of a URL, the downloaded file will be cached for later use.
## ENVIRONMENT ## ENVIRONMENT
Note that environment variables must have a value set to be detected. For example, `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. Note that environment variables must have a value set to be detected. For example,
`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
`export HOMEBREW_NO_INSECURE_REDIRECT`.
* `HOMEBREW_ARTIFACT_DOMAIN`: * `HOMEBREW_ARTIFACT_DOMAIN`:
If set, instructs Homebrew to prefix all download URLs, including those If set, instructs Homebrew to prefix all download URLs, including those for bottles,
for bottles, with this variable. For example, a formula with a URL of with this variable. For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080`
`https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a formula with the URL `https://example.com/foo.tar.gz` to instead
would instead download from `http://localhost:8080/example.com/foo.tar.gz`. 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. If set, Homebrew will only check for autoupdates once per this seconds interval.
@ -125,18 +128,17 @@ Note that environment variables must have a value set to be detected. For exampl
these variables for access credentials (see these variables for access credentials (see
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment> <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, to retrieve these access credentials from AWS). If they are not set,
the `S3` download strategy will download with a public the `S3` download strategy will download with a public (unsigned) URL.
(unsigned) URL.
* `HOMEBREW_BOTTLE_DOMAIN`: * `HOMEBREW_BOTTLE_DOMAIN`:
By default, Homebrew uses `https://homebrew.bintray.com/` as its download By default, Homebrew uses `https://homebrew.bintray.com/` as its download
mirror for bottles. If set, instructs Homebrew to instead use the given mirror for bottles. If set, instructs Homebrew to instead use the specified
URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will
cause all bottles to download from the prefix `http://localhost:8080/`. cause all bottles to download from the prefix `http://localhost:8080/`.
* `HOMEBREW_BROWSER`: * `HOMEBREW_BROWSER`:
If set, uses this setting as the browser when opening project homepages, If set, Homebrew uses this setting as the browser when opening project
instead of the OS default browser. homepages, instead of the OS default browser.
* `HOMEBREW_BUILD_FROM_SOURCE`: * `HOMEBREW_BUILD_FROM_SOURCE`:
If set, instructs Homebrew to compile from source even when a formula If set, instructs Homebrew to compile from source even when a formula
@ -145,7 +147,7 @@ Note that environment variables must have a value set to be detected. For exampl
using this environment variable. using this environment variable.
* `HOMEBREW_CACHE`: * `HOMEBREW_CACHE`:
If set, instructs Homebrew to use the given directory as the download cache. If set, instructs Homebrew to use the specified directory as the download cache.
*Default:* `~/Library/Caches/Homebrew`. *Default:* `~/Library/Caches/Homebrew`.
@ -161,7 +163,7 @@ Note that environment variables must have a value set to be detected. For exampl
* `HOMEBREW_DEVELOPER`: * `HOMEBREW_DEVELOPER`:
If set, Homebrew will tweak behaviour to be more relevant for Homebrew If set, 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_EDITOR`: * `HOMEBREW_EDITOR`:
If set, Homebrew will use this editor when editing a single formula, or If set, Homebrew will use this editor when editing a single formula, or
@ -184,20 +186,20 @@ Note that environment variables must have a value set to be detected. For exampl
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_GITHUB_API_TOKEN`: * `HOMEBREW_GITHUB_API_TOKEN`:
A personal access token for the GitHub API, which you can create at A personal access token for the GitHub API, used by Homebrew for features
<https://github.com/settings/tokens>. If set, GitHub will allow you a such as `brew search`. You can create one at <https://github.com/settings/tokens>.
greater number of API requests. See If set, GitHub will allow you a greater number of API requests. For more
<https://developer.github.com/v3/#rate-limiting> for more information. information, see: <https://developer.github.com/v3/#rate-limiting>
Homebrew uses the GitHub API for features such as `brew search`.
*Note:* Homebrew doesn't require permissions for any of the scopes. *Note:* Homebrew doesn't require permissions for any of the scopes.
* `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.
Defaults to the beer emoji.
*Default:* the beer emoji.
* `HOMEBREW_LOGS`: * `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files. If set, Homebrew will use the specified directory to store log files.
* `HOMEBREW_MAKE_JOBS`: * `HOMEBREW_MAKE_JOBS`:
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
@ -219,7 +221,7 @@ Note that environment variables must have a value set to be detected. For exampl
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
successful build. successful build.
*Note:* Homebrew will only try to print emoji on Lion or newer. *Note:* Homebrew will only try to print emoji on OS X Lion or newer.
* `HOMEBREW_NO_INSECURE_REDIRECT`: * `HOMEBREW_NO_INSECURE_REDIRECT`:
If set, Homebrew will not permit redirects from secure HTTPS If set, Homebrew will not permit redirects from secure HTTPS
@ -230,11 +232,11 @@ Note that environment variables must have a value set to be detected. For exampl
formulae to fail to download. formulae to fail to download.
* `HOMEBREW_NO_GITHUB_API`: * `HOMEBREW_NO_GITHUB_API`:
If set, Homebrew will not use the GitHub API for e.g searches or If set, 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_PRY`: * `HOMEBREW_PRY`:
If set, Homebrew will use `pry` for the `brew irb` command. If set, Homebrew will use Pry for the `brew irb` command.
* `HOMEBREW_SVN`: * `HOMEBREW_SVN`:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set, When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
@ -245,11 +247,10 @@ Note that environment variables must have a value set to be detected. For exampl
* `HOMEBREW_TEMP`: * `HOMEBREW_TEMP`:
If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory 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 for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as macOS has trouble moving Homebrew prefix are on different volumes, as macOS has trouble moving
symlinks across volumes when the target does not yet exist. symlinks across volumes when the target does not yet exist.
This issue typically occurs when using FileVault or custom SSD This issue typically occurs when using FileVault or custom SSD configurations.
configurations.
* `HOMEBREW_UPDATE_TO_TAG`: * `HOMEBREW_UPDATE_TO_TAG`:
If set, instructs Homebrew to always use the latest stable tag (even if If set, instructs Homebrew to always use the latest stable tag (even if
@ -278,13 +279,15 @@ Note that environment variables must have a value set to be detected. For exampl
through Homebrew. through Homebrew.
* `no_proxy`: * `no_proxy`:
Sets the comma-separated list of hostnames and domain names that should be excluded from proxying Sets the comma-separated list of hostnames and domain names that should be excluded
by `curl`, `git` and `svn` 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
Use the `http_proxy`, `https_proxy`, `all_proxy`, `no_proxy` and/or `ftp_proxy` documented above.
For example, for an unauthenticated HTTP or SOCKS5 proxy: Set the `http_proxy`, `https_proxy`, `all_proxy`, `ftp_proxy` and/or `no_proxy`
environment variables documented above.
For example, to use an unauthenticated HTTP or SOCKS5 proxy:
export http_proxy=http://$HOST:$PORT export http_proxy=http://$HOST:$PORT

73
docs/Manpage.md
View File

@ -15,7 +15,8 @@ didn't include with macOS.
For the full command list, see the [COMMANDS](#commands) section. For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `-v`, many commands print extra debugging information. Note that these flags should only appear after a command. With `--verbose` or `-v`, many commands print extra debugging information. Note that
these flags should only appear after a command.
* `install` *`formula`*: * `install` *`formula`*:
Install *`formula`*. Install *`formula`*.
@ -30,9 +31,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
List all installed formulae. List all installed formulae.
* `search` (*`text`*|`/`*`text`*`/`): * `search` (*`text`*|`/`*`text`*`/`):
Perform a substring search of formula names for *`text`*. If *`text`* is Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
surrounded with slashes, then it is interpreted as a regular expression. is surrounded with slashes, then it is interpreted as a regular expression.
The search for *`text`* is extended online to some popular taps. The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`.
If no search term is given, all locally available formulae are listed. If no search term is given, all locally available formulae are listed.
## COMMANDS ## COMMANDS
@ -445,7 +446,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `search` [`--desc`] (*`text`*|`/`*`text`*`/`): * `search` [`--desc`] (*`text`*|`/`*`text`*`/`):
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
is surrounded with slashes, then it is interpreted as a regular expression. is surrounded with slashes, then it is interpreted as a regular expression.
The search for *`text`* is extended online to official taps. The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`.
If `--desc` is passed, search formulae with a description matching *`text`* and If `--desc` is passed, search formulae with a description matching *`text`* and
casks with a name matching *`text`*. casks with a name matching *`text`*.
@ -1102,19 +1103,21 @@ can take several different forms:
* An arbitrary file or URL: * An arbitrary file or URL:
Homebrew can install formulae via URL, e.g. Homebrew can install formulae via URL, e.g.
`https://raw.github.com/Homebrew/homebrew-core/master/Formula/git.rb`, `https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`,
or from a local path. It could point to either a formula file or a bottle. or from a local path. It could point to either a formula file or a bottle.
In the case of a URL, the downloaded file will be cached for later use. In the case of a URL, the downloaded file will be cached for later use.
## ENVIRONMENT ## ENVIRONMENT
Note that environment variables must have a value set to be detected. For example, `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. Note that environment variables must have a value set to be detected. For example,
`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
`export HOMEBREW_NO_INSECURE_REDIRECT`.
* `HOMEBREW_ARTIFACT_DOMAIN`: * `HOMEBREW_ARTIFACT_DOMAIN`:
If set, instructs Homebrew to prefix all download URLs, including those If set, instructs Homebrew to prefix all download URLs, including those for bottles,
for bottles, with this variable. For example, a formula with a URL of with this variable. For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080`
`https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a formula with the URL `https://example.com/foo.tar.gz` to instead
would instead download from `http://localhost:8080/example.com/foo.tar.gz`. 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. If set, Homebrew will only check for autoupdates once per this seconds interval.
@ -1126,18 +1129,17 @@ Note that environment variables must have a value set to be detected. For exampl
these variables for access credentials (see these variables for access credentials (see
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment> <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, to retrieve these access credentials from AWS). If they are not set,
the `S3` download strategy will download with a public the `S3` download strategy will download with a public (unsigned) URL.
(unsigned) URL.
* `HOMEBREW_BOTTLE_DOMAIN`: * `HOMEBREW_BOTTLE_DOMAIN`:
By default, Homebrew uses `https://homebrew.bintray.com/` as its download By default, Homebrew uses `https://homebrew.bintray.com/` as its download
mirror for bottles. If set, instructs Homebrew to instead use the given mirror for bottles. If set, instructs Homebrew to instead use the specified
URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will
cause all bottles to download from the prefix `http://localhost:8080/`. cause all bottles to download from the prefix `http://localhost:8080/`.
* `HOMEBREW_BROWSER`: * `HOMEBREW_BROWSER`:
If set, uses this setting as the browser when opening project homepages, If set, Homebrew uses this setting as the browser when opening project
instead of the OS default browser. homepages, instead of the OS default browser.
* `HOMEBREW_BUILD_FROM_SOURCE`: * `HOMEBREW_BUILD_FROM_SOURCE`:
If set, instructs Homebrew to compile from source even when a formula If set, instructs Homebrew to compile from source even when a formula
@ -1146,7 +1148,7 @@ Note that environment variables must have a value set to be detected. For exampl
using this environment variable. using this environment variable.
* `HOMEBREW_CACHE`: * `HOMEBREW_CACHE`:
If set, instructs Homebrew to use the given directory as the download cache. If set, instructs Homebrew to use the specified directory as the download cache.
*Default:* `~/Library/Caches/Homebrew`. *Default:* `~/Library/Caches/Homebrew`.
@ -1162,7 +1164,7 @@ Note that environment variables must have a value set to be detected. For exampl
* `HOMEBREW_DEVELOPER`: * `HOMEBREW_DEVELOPER`:
If set, Homebrew will tweak behaviour to be more relevant for Homebrew If set, 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_EDITOR`: * `HOMEBREW_EDITOR`:
If set, Homebrew will use this editor when editing a single formula, or If set, Homebrew will use this editor when editing a single formula, or
@ -1185,20 +1187,20 @@ Note that environment variables must have a value set to be detected. For exampl
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_GITHUB_API_TOKEN`: * `HOMEBREW_GITHUB_API_TOKEN`:
A personal access token for the GitHub API, which you can create at A personal access token for the GitHub API, used by Homebrew for features
<https://github.com/settings/tokens>. If set, GitHub will allow you a such as `brew search`. You can create one at <https://github.com/settings/tokens>.
greater number of API requests. See If set, GitHub will allow you a greater number of API requests. For more
<https://developer.github.com/v3/#rate-limiting> for more information. information, see: <https://developer.github.com/v3/#rate-limiting>
Homebrew uses the GitHub API for features such as `brew search`.
*Note:* Homebrew doesn't require permissions for any of the scopes. *Note:* Homebrew doesn't require permissions for any of the scopes.
* `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.
Defaults to the beer emoji.
*Default:* the beer emoji.
* `HOMEBREW_LOGS`: * `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files. If set, Homebrew will use the specified directory to store log files.
* `HOMEBREW_MAKE_JOBS`: * `HOMEBREW_MAKE_JOBS`:
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
@ -1220,7 +1222,7 @@ Note that environment variables must have a value set to be detected. For exampl
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
successful build. successful build.
*Note:* Homebrew will only try to print emoji on Lion or newer. *Note:* Homebrew will only try to print emoji on OS X Lion or newer.
* `HOMEBREW_NO_INSECURE_REDIRECT`: * `HOMEBREW_NO_INSECURE_REDIRECT`:
If set, Homebrew will not permit redirects from secure HTTPS If set, Homebrew will not permit redirects from secure HTTPS
@ -1231,11 +1233,11 @@ Note that environment variables must have a value set to be detected. For exampl
formulae to fail to download. formulae to fail to download.
* `HOMEBREW_NO_GITHUB_API`: * `HOMEBREW_NO_GITHUB_API`:
If set, Homebrew will not use the GitHub API for e.g searches or If set, 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_PRY`: * `HOMEBREW_PRY`:
If set, Homebrew will use `pry` for the `brew irb` command. If set, Homebrew will use Pry for the `brew irb` command.
* `HOMEBREW_SVN`: * `HOMEBREW_SVN`:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set, When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
@ -1246,11 +1248,10 @@ Note that environment variables must have a value set to be detected. For exampl
* `HOMEBREW_TEMP`: * `HOMEBREW_TEMP`:
If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory 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 for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as macOS has trouble moving Homebrew prefix are on different volumes, as macOS has trouble moving
symlinks across volumes when the target does not yet exist. symlinks across volumes when the target does not yet exist.
This issue typically occurs when using FileVault or custom SSD This issue typically occurs when using FileVault or custom SSD configurations.
configurations.
* `HOMEBREW_UPDATE_TO_TAG`: * `HOMEBREW_UPDATE_TO_TAG`:
If set, instructs Homebrew to always use the latest stable tag (even if If set, instructs Homebrew to always use the latest stable tag (even if
@ -1279,13 +1280,15 @@ Note that environment variables must have a value set to be detected. For exampl
through Homebrew. through Homebrew.
* `no_proxy`: * `no_proxy`:
Sets the comma-separated list of hostnames and domain names that should be excluded from proxying Sets the comma-separated list of hostnames and domain names that should be excluded
by `curl`, `git` and `svn` 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
Use the `http_proxy`, `https_proxy`, `all_proxy`, `no_proxy` and/or `ftp_proxy` documented above.
For example, for an unauthenticated HTTP or SOCKS5 proxy: Set the `http_proxy`, `https_proxy`, `all_proxy`, `ftp_proxy` and/or `no_proxy`
environment variables documented above.
For example, to use an unauthenticated HTTP or SOCKS5 proxy:
export http_proxy=http://$HOST:$PORT export http_proxy=http://$HOST:$PORT

2
manpages/brew-cask.1
View File

@ -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" "November 2018" "Homebrew" "brew-cask" .TH "BREW\-CASK" "1" "December 2018" "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

39
manpages/brew.1
View File

@ -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" "November 2018" "Homebrew" "brew" .TH "BREW" "1" "December 2018" "Homebrew" "brew"
. .
.SH "NAME" .SH "NAME"
\fBbrew\fR \- The missing package manager for macOS \fBbrew\fR \- The missing package manager for macOS
@ -39,7 +39,7 @@ List all installed formulae\.
. .
.TP .TP
\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) \fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR)
Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to some popular taps\. If no search term is given, all locally available formulae are listed\. Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is given, all locally available formulae are listed\.
. .
.SH "COMMANDS" .SH "COMMANDS"
. .
@ -454,7 +454,7 @@ Display all locally available casks (including tapped ones)\. No online search i
. .
.TP .TP
\fBsearch\fR [\fB\-\-desc\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) \fBsearch\fR [\fB\-\-desc\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR)
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to official taps\. Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\.
. .
.IP .IP
If \fB\-\-desc\fR is passed, search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\. If \fB\-\-desc\fR is passed, search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
@ -1231,14 +1231,14 @@ Sometimes a formula from a tapped repository may conflict with one in \fBhomebre
. .
.TP .TP
An arbitrary file or URL An arbitrary file or URL
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/Homebrew/homebrew\-core/master/Formula/git\.rb\fR, or from a local path\. It could point to either a formula file or a bottle\. In the case of a URL, the downloaded file will be cached for later use\. Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.githubusercontent\.com/Homebrew/homebrew\-core/master/Formula/git\.rb\fR, or from a local path\. It could point to either a formula file or a bottle\. In the case of a URL, the downloaded file will be cached for later use\.
. .
.SH "ENVIRONMENT" .SH "ENVIRONMENT"
Note that environment variables must have a value set to be detected\. For example, \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\fR\. Note that environment variables must have a value set to be detected\. For example, \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\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, a formula with a URL of \fBhttps://example\.com/foo\.tar\.gz\fR but \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR would instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\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\.
. .
.TP .TP
\fBHOMEBREW_AUTO_UPDATE_SECS\fR \fBHOMEBREW_AUTO_UPDATE_SECS\fR
@ -1253,11 +1253,11 @@ When using the \fBS3\fR download strategy, Homebrew will look in these variables
. .
.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 given URL\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\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\.
. .
.TP .TP
\fBHOMEBREW_BROWSER\fR \fBHOMEBREW_BROWSER\fR
If set, uses this setting as the browser when opening project homepages, instead of the OS default browser\. If set, Homebrew uses this setting as the browser when opening project homepages, instead of the OS default browser\.
. .
.TP .TP
\fBHOMEBREW_BUILD_FROM_SOURCE\fR \fBHOMEBREW_BUILD_FROM_SOURCE\fR
@ -1265,7 +1265,7 @@ If set, instructs Homebrew to compile from source even when a formula provides a
. .
.TP .TP
\fBHOMEBREW_CACHE\fR \fBHOMEBREW_CACHE\fR
If set, instructs Homebrew to use the given directory as the download cache\. If set, instructs Homebrew to use the specified directory as the download cache\.
. .
.IP .IP
\fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\. \fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\.
@ -1284,7 +1284,7 @@ If set, any commands that can emit debugging information will do so\.
. .
.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\. If set, Homebrew will tweak behaviour to be more relevant for Homebrew developers (active or budding), e\.g\. turning warnings into errors\.
. .
.TP .TP
\fBHOMEBREW_EDITOR\fR \fBHOMEBREW_EDITOR\fR
@ -1307,18 +1307,21 @@ If set, Homebrew will always use a Homebrew\-installed \fBgit\fR rather than the
. .
.TP .TP
\fBHOMEBREW_GITHUB_API_TOKEN\fR \fBHOMEBREW_GITHUB_API_TOKEN\fR
A personal access token for the GitHub API, which you can create at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. See \fIhttps://developer\.github\.com/v3/#rate\-limiting\fR for more information\. Homebrew uses the GitHub API for features such as \fBbrew search\fR\. A personal access token for the GitHub API, used by Homebrew for features such as \fBbrew search\fR\. You can create one at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. For more information, see: \fIhttps://developer\.github\.com/v3/#rate\-limiting\fR
. .
.IP .IP
\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_INSTALL_BADGE\fR \fBHOMEBREW_INSTALL_BADGE\fR
Text printed before the installation summary of each successful build\. Defaults to the beer emoji\. Text printed before the installation summary of each successful build\.
.
.IP
\fIDefault:\fR the beer emoji\.
. .
.TP .TP
\fBHOMEBREW_LOGS\fR \fBHOMEBREW_LOGS\fR
If set, Homebrew will use the given directory to store log files\. If set, Homebrew will use the specified directory to store log files\.
. .
.TP .TP
\fBHOMEBREW_MAKE_JOBS\fR \fBHOMEBREW_MAKE_JOBS\fR
@ -1344,7 +1347,7 @@ If set, Homebrew will not print text with color added\.
If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\. If set, 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 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_INSECURE_REDIRECT\fR
@ -1355,11 +1358,11 @@ While ensuring your downloads are fully secure, this is likely to cause from\-so
. .
.TP .TP
\fBHOMEBREW_NO_GITHUB_API\fR \fBHOMEBREW_NO_GITHUB_API\fR
If set, Homebrew will not use the GitHub API for e\.g searches or fetching relevant issues on a failed install\. If set, Homebrew will not use the GitHub API, e\.g\. for searches or fetching relevant issues on a failed install\.
. .
.TP .TP
\fBHOMEBREW_PRY\fR \fBHOMEBREW_PRY\fR
If set, Homebrew will use \fBpry\fR for the \fBbrew irb\fR command\. If set, Homebrew will use Pry for the \fBbrew irb\fR command\.
. .
.TP .TP
\fBHOMEBREW_SVN\fR \fBHOMEBREW_SVN\fR
@ -1370,7 +1373,7 @@ 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\. 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\.
. .
.IP .IP
This issue typically occurs when using FileVault or custom SSD configurations\. This issue typically occurs when using FileVault or custom SSD configurations\.
@ -1408,10 +1411,10 @@ Sets the FTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downlo
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, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
. .
.SH "USING HOMEBREW BEHIND A PROXY" .SH "USING HOMEBREW BEHIND A PROXY"
Use the \fBhttp_proxy\fR, \fBhttps_proxy\fR, \fBall_proxy\fR, \fBno_proxy\fR and/or \fBftp_proxy\fR 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\.
. .
.P .P
For example, for an unauthenticated HTTP or SOCKS5 proxy: For example, to use an unauthenticated HTTP or SOCKS5 proxy:
. .
.IP "" 4 .IP "" 4
. .