Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update other man page sections #5373

Merged
merged 1 commit into from
Dec 7, 2018
Merged

docs: update other man page sections #5373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Library/Homebrew/cmd/search.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#: * `search` [`--desc`] (<text>|`/`<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.
#: 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
#: casks with a name matching <text>.
Expand Down
71 changes: 37 additions & 34 deletions Library/Homebrew/manpages/brew.1.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ didn't include with macOS.

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>.
Expand All @@ -41,9 +42,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
List all installed formulae.

* `search` (<text>|`/`<text>`/`):
Perform a substring search of formula names for <text>. If <text> is
surrounded with slashes, then it is interpreted as a regular expression.
The search for <text> is extended online to some popular taps.
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.
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.

## COMMANDS
Expand Down Expand Up @@ -101,19 +102,21 @@ can take several different forms:

* An arbitrary file or URL:
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.
In the case of a URL, the downloaded file will be cached for later use.

## 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`:
If set, instructs Homebrew to prefix all download URLs, including those
for bottles, with this variable. For example, a formula with a URL of
`https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080`
would instead download from `http://localhost:8080/example.com/foo.tar.gz`.
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.
Expand All @@ -125,18 +128,17 @@ Note that environment variables must have a value set to be detected. For exampl
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.
the `S3` download strategy will download with a public (unsigned) URL.

* `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 given
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_BROWSER`:
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.

* `HOMEBREW_BUILD_FROM_SOURCE`:
If set, instructs Homebrew to compile from source even when a formula
Expand All @@ -145,7 +147,7 @@ Note that environment variables must have a value set to be detected. For exampl
using this environment variable.

* `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`.

Expand All @@ -161,7 +163,7 @@ Note that environment variables must have a value set to be detected. For exampl

* `HOMEBREW_DEVELOPER`:
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`:
If set, Homebrew will use this editor when editing a single formula, or
Expand All @@ -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.

* `HOMEBREW_GITHUB_API_TOKEN`:
A personal access token for the GitHub API, which you can create at
<https://github.com/settings/tokens>. If set, GitHub will allow you a
greater number of API requests. See
<https://developer.github.com/v3/#rate-limiting> for more information.
Homebrew uses the GitHub API for features such as `brew search`.
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.
Defaults to the beer emoji.

*Default:* the beer emoji.

* `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`:
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
Expand All @@ -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
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`:
If set, Homebrew will not permit redirects from secure HTTPS
Expand All @@ -230,11 +232,11 @@ Note that environment variables must have a value set to be detected. For exampl
formulae to fail to download.

* `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.

* `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`:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
Expand All @@ -245,11 +247,10 @@ Note that environment variables must have a value set to be detected. For exampl
* `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
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.
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
Expand Down Expand Up @@ -278,13 +279,15 @@ Note that environment variables must have a value set to be detected. For exampl
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.
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
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

Expand Down
73 changes: 38 additions & 35 deletions docs/Manpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ didn't include with macOS.

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`*.
Expand All @@ -30,9 +31,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
List all installed formulae.

* `search` (*`text`*|`/`*`text`*`/`):
Perform a substring search of formula names for *`text`*. If *`text`* is
surrounded with slashes, then it is interpreted as a regular expression.
The search for *`text`* is extended online to some popular taps.
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.
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.

## COMMANDS
Expand Down Expand Up @@ -445,7 +446,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `search` [`--desc`] (*`text`*|`/`*`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.
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
casks with a name matching *`text`*.
Expand Down Expand Up @@ -1102,19 +1103,21 @@ can take several different forms:

* An arbitrary file or URL:
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.
In the case of a URL, the downloaded file will be cached for later use.

## 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`:
If set, instructs Homebrew to prefix all download URLs, including those
for bottles, with this variable. For example, a formula with a URL of
`https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080`
would instead download from `http://localhost:8080/example.com/foo.tar.gz`.
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.
Expand All @@ -1126,18 +1129,17 @@ Note that environment variables must have a value set to be detected. For exampl
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.
the `S3` download strategy will download with a public (unsigned) URL.

* `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 given
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_BROWSER`:
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.

* `HOMEBREW_BUILD_FROM_SOURCE`:
If set, instructs Homebrew to compile from source even when a formula
Expand All @@ -1146,7 +1148,7 @@ Note that environment variables must have a value set to be detected. For exampl
using this environment variable.

* `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`.

Expand All @@ -1162,7 +1164,7 @@ Note that environment variables must have a value set to be detected. For exampl

* `HOMEBREW_DEVELOPER`:
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`:
If set, Homebrew will use this editor when editing a single formula, or
Expand All @@ -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.

* `HOMEBREW_GITHUB_API_TOKEN`:
A personal access token for the GitHub API, which you can create at
<https://github.com/settings/tokens>. If set, GitHub will allow you a
greater number of API requests. See
<https://developer.github.com/v3/#rate-limiting> for more information.
Homebrew uses the GitHub API for features such as `brew search`.
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.
Defaults to the beer emoji.

*Default:* the beer emoji.

* `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`:
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
Expand All @@ -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
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`:
If set, Homebrew will not permit redirects from secure HTTPS
Expand All @@ -1231,11 +1233,11 @@ Note that environment variables must have a value set to be detected. For exampl
formulae to fail to download.

* `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.

* `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`:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
Expand All @@ -1246,11 +1248,10 @@ Note that environment variables must have a value set to be detected. For exampl
* `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
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.
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
Expand Down Expand Up @@ -1279,13 +1280,15 @@ Note that environment variables must have a value set to be detected. For exampl
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.
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
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

Expand Down
2 changes: 1 addition & 1 deletion manpages/brew-cask.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.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"
\fBbrew\-cask\fR \- a friendly binary installer for macOS
Expand Down