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

man page: finer-grained markup

Browse Source 
Closes Homebrew/homebrew#44769

Closes Homebrew/homebrew#46676.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
This commit is contained in:
Andrew Janke 2015-10-09 02:44:10 -04:00
parent 267465ea6f
commit 5230ed2117
3 changed files with 246 additions and 248 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
Library/Homebrew/manpages/brew.1.md
View File

@ -3,8 +3,8 @@ brew(1) -- The missing package manager for OS X
## SYNOPSIS
`brew` --version<br>
`brew` command [--verbose|-v] [options] [formula] ...
`brew` `--version`<br>
`brew` <command> [`--verbose`|`-v`] [<options>] [<formula>] ...
## DESCRIPTION
@ -13,10 +13,9 @@ didn't include with OS X.
## ESSENTIAL COMMANDS
For the full command list, see the COMMANDS section.
For the full command list, see the [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>.
@ -30,7 +29,7 @@ Note that these flags should only appear after a command.
* `list`:
List all installed formulae.
* `search` <text>|/<text>/:
* `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.
@ -38,7 +37,7 @@ Note that these flags should only appear after a command.
## COMMANDS
* `audit` [--strict] [--online] [<formulae>]:
* `audit` [`--strict`] [`--online`] [<formulae>]:
Check <formulae> for Homebrew coding style violations. This should be
run before submitting a new formula.
@ -56,26 +55,26 @@ Note that these flags should only appear after a command.
* `cat` <formula>:
Display the source to <formula>.
* `cleanup [--force] [--prune=<days>] [-ns]` [<formulae>]:
* `cleanup` [`--force`] [`--prune=`<days>] [`-n`] [`-s`] [<formulae>]:
For all installed or specific formulae, remove any older versions from the
cellar. By default, does not remove out-of-date keg-only brews, as other
software may link directly to specific versions. In addition old downloads from
software may link directly to specific versions. In addition, old downloads from
the Homebrew download-cache are deleted.
If `--force` is passed, remove out-of-date keg-only brews as well.
If `--prune=<days>` is specified, remove all cache files older than <days>.
If `--prune=`<days> is specified, remove all cache files older than <days>.
If `-n` is passed, show what would be removed, but do not actually remove anything.
If `-s` is passed, scrubs the cache, removing downloads for even the latest
versions of formula. Note downloads for any installed formula will still not be
versions of formulae. Note downloads for any installed formulae will still not be
deleted. If you want to delete those too: `rm -rf $(brew --cache)`
* `command` <cmd>:
Display the path to the file which is used when invoking `brew <cmd>`.
Display the path to the file which is used when invoking `brew` <cmd>.
* `commands [--quiet [--include-aliases]]`:
* `commands` [`--quiet` [`--include-aliases`]]:
Show a list of built-in and external commands.
If `--quiet` is passed, list only the names of commands without the header.
@ -86,10 +85,10 @@ Note that these flags should only appear after a command.
a bug report, you will likely be asked for this information if you do not
provide it.
* `create <URL> [--autotools|--cmake] [--no-fetch] [--set-name <name>] [--set-version <version>]`:
* `create` <URL> [`--autotools`|`--cmake`] [`--no-fetch`] [`--set-name` <name>] [`--set-version` <version>]:
Generate a formula for the downloadable file at <URL> and open it in the editor.
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The wget
and version, but if it fails, you'll have to make your own template. The `wget`
formula serves as a simple example. For the complete API have a look at
<http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula>
@ -103,7 +102,7 @@ Note that these flags should only appear after a command.
The options `--set-name` and `--set-version` each take an argument and allow
you to explicitly set the name and version of the package you are creating.
* `deps [--1] [-n] [--union] [--tree] [--all] [--installed] [--skip-build] [--skip-optional]` <formulae>:
* `deps` [`--1`] [`-n`] [`--union`] [`--tree`] [`--all`] [`--installed`] [`--skip-build`] [`--skip-optional`] <formulae>:
Show dependencies for <formulae>. When given multiple formula arguments,
show the intersection of dependencies for <formulae>, except when passed
`--tree`, `--all`, or `--installed`.
@ -129,20 +128,20 @@ Note that these flags should only appear after a command.
* `desc` <formula>:
Display <formula>'s name and one-line description.
* `desc [-s|-n|-d] <pattern>`:
* `desc` [`-s`|`-n`|`-d`] <pattern>:
Search both name and description (`-s`), just the names (`-n`), or just the
descriptions (`-d`) for `<pattern>`. `<pattern>` is by default interpreted
as a literal string; if flanked by slashes, it is instead interpreted as a
regular expression. Formula descriptions are cached; the cache is created on
the first search, making that search slower than subsequent ones.
* `diy [--name=<name>] [--version=<version>]`:
* `diy` [`--name=`<name>] [`--version=`<version>]:
Automatically determine the installation prefix for non-Homebrew software.
Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with `brew link`.
The options `--name=<name>` and `--version=<version>` each take an argument
The options `--name=`<name> and `--version=`<version> each take an argument
and allow you to explicitly set the name and version of the package you are
installing.
@ -156,9 +155,9 @@ Note that these flags should only appear after a command.
* `edit` <formula>:
Open <formula> in the editor.
* `fetch [--force] [-v] [--devel|--HEAD] [--deps] [--build-from-source|--force-bottle]` <formulae>:
* `fetch` [`--force`] [`-v`] [`--devel`|`--HEAD`] [`--deps`] [`--build-from-source`|`--force-bottle`] <formulae>:
Download the source packages for the given <formulae>.
For tarballs, also print SHA1 and SHA-256 checksums.
For tarballs, also print SHA-1 and SHA-256 checksums.
If `--HEAD` or `--devel` is passed, fetch that version instead of the
stable version.
@ -185,12 +184,12 @@ Note that these flags should only appear after a command.
* `info` <formula>:
Display information about <formula>.
* `info --github` <formula>:
* `info` `--github` <formula>:
Open a browser to the GitHub History page for formula <formula>.
To view formula history locally: `brew log -p <formula>`.
* `info --json=<version>` (--all|--installed|<formulae>):
* `info --json=`<version>` (`--all`|`--installed`|<formulae>):
Print a JSON representation of <formulae>. Currently the only accepted value
for <version> is `v1`.
@ -200,7 +199,7 @@ Note that these flags should only appear after a command.
See the docs for examples of using the JSON:
<https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md>
* `install [--debug] [--env=<std|super>] [--ignore-dependencies] [--only-dependencies] [--cc=<compiler>] [--build-from-source|--force-bottle] [--devel|--HEAD]` <formula>:
* `install` [`--debug`] [`--env=`<std>|<super>] [`--ignore-dependencies`] [`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] <formula>:
Install <formula>.
<formula> is usually the name of the formula to install, but it can be specified
@ -221,7 +220,7 @@ Note that these flags should only appear after a command.
If `--only-dependencies` is passed, install the dependencies with specified
options but do not install the specified formula.
If `--cc=<compiler>` is passed, attempt to compile using <compiler>.
If `--cc=`<compiler> is passed, attempt to compile using <compiler>.
<compiler> should be the name of the compiler's executable, for instance
`gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC
4.9.
@ -240,7 +239,7 @@ Note that these flags should only appear after a command.
To install a newer version of HEAD use
`brew rm <foo> && brew install --HEAD <foo>`.
* `install --interactive [--git]` <formula>:
* `install --interactive` [`--git`] <formula>:
Download and patch <formula>, then open a shell. This allows the user to
run `./configure --help` and otherwise determine how to turn the software
package into a Homebrew formula.
@ -248,7 +247,7 @@ Note that these flags should only appear after a command.
If `--git` is passed, Homebrew will create a Git repository, useful for
creating patches to the software.
* `irb [--examples]`:
* `irb` [`--examples`]:
Enter the interactive Homebrew Ruby shell.
If `--examples` is passed, several examples will be shown.
@ -256,7 +255,7 @@ Note that these flags should only appear after a command.
* `leaves`:
Show installed formulae that are not dependencies of another installed formula.
* `ln`, `link [--overwrite] [--dry-run] [--force]` <formula>:
* `ln`, `link` [`--overwrite`] [`--dry-run`] [`--force`] <formula>:
Symlink all of <formula>'s installed files into the Homebrew prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.
@ -270,7 +269,7 @@ Note that these flags should only appear after a command.
If `--force` is passed, Homebrew will allow keg-only formulae to be linked.
* `linkapps [--local]` [<formulae>]:
* `linkapps` [`--local`] [<formulae>]:
Find installed formulae that have compiled `.app`-style "application"
packages for OS X, and symlink those apps into `/Applications`, allowing
for easier access.
@ -280,14 +279,14 @@ Note that these flags should only appear after a command.
If provided, `--local` will move them into the user's `~/Applications`
directory instead of the system directory. It may need to be created, first.
* `ls`, `list [--full-name]`
* `ls`, `list` [`--full-name`]
List all installed formulae. If `--full-name` is passed, print formulae with
full-qualified names.
* `ls`, `list --unbrewed`
List all files in the Homebrew prefix not installed by Homebrew.
* `ls`, `list [--versions [--multiple]] [--pinned]` [<formulae>]:
* `ls`, `list` [`--versions` [`--multiple`]] [`--pinned`] [<formulae>]:
List the installed files for <formulae>. Combined with `--verbose`, recursively
list the contents of all subdirectories in each <formula>'s keg.
@ -299,7 +298,7 @@ Note that these flags should only appear after a command.
specified (pinned) formulae if <formulae> are given.
See also `pin`, `unpin`.
* `log [git-log-options]` <formula> ...:
* `log` [`git-log-options`] <formula> ...:
Show the git log for the given formulae. Options that `git-log`(1)
recognizes can be passed before the formula list.
@ -308,14 +307,14 @@ Note that these flags should only appear after a command.
If no <formulae> are given, check all installed brews.
* `migrate [--force]` <formulae>:
* `migrate` [`--force`] <formulae>:
Migrate renamed packages to new name, where <formulae> are old names of
packages.
If `--force` is passed, then treat installed <formulae> and passed <formulae>
like if they are from same taps and migrate them anyway.
* `options [--compact] [--all] [--installed]` <formula>:
* `options` [`--compact`] [`--all`] [`--installed`] <formula>:
Display install options specific to <formula>.
If `--compact` is passed, show all options on a single line separated by
@ -325,7 +324,7 @@ Note that these flags should only appear after a command.
If `--installed` is passed, show options for all installed formulae.
* `outdated [--quiet | --verbose | --json=v1 ]`:
* `outdated` [`--quiet` | `--verbose` | `--json=v1` ]:
Show formulae that have an updated version available.
By default, version information is displayed in interactive shells, and
@ -336,7 +335,7 @@ Note that these flags should only appear after a command.
If `--verbose` is passed, display detailed version information.
If `--json=<version>` is passed, the output will be in JSON format. The only
If `--json=`<version> is passed, the output will be in JSON format. The only
valid version is `v1`.
* `pin` <formulae>:
@ -350,7 +349,7 @@ Note that these flags should only appear after a command.
* `reinstall` <formula>:
Uninstall then install <formula>
* `rm`, `remove`, `uninstall [--force]` <formula>:
* `rm`, `remove`, `uninstall` [`--force`] <formula>:
Uninstall <formula>.
If `--force` is passed, and there are multiple versions of <formula>
@ -360,7 +359,7 @@ Note that these flags should only appear after a command.
Display all locally available formulae for brewing (including tapped ones).
No online search is performed if called without arguments.
* `search`, `-S` <text>|/<text>/:
* `search`, `-S` <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.
@ -368,27 +367,27 @@ Note that these flags should only appear after a command.
* `search --debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu` <text>:
Search for <text> in the given package manager's list.
* `sh [--env=std]`:
* `sh` [`--env=std`]:
Instantiate a Homebrew build environment. Uses our years-battle-hardened
Homebrew build logic to help your `./configure && make && make install`
or even your `gem install` succeed. Especially handy if you run Homebrew
in a Xcode-only configuration since it adds tools like make to your PATH
in an Xcode-only configuration since it adds tools like `make` to your `PATH`
which otherwise build-systems would not find.
* `switch` <name> <version>:
Symlink all of the specific <version> of <name>'s install to Homebrew prefix.
* `tap` [--full] [<user/repo>] [<URL>]:
* `tap` [`--full`] <user>`/`<repo> [<URL>]:
Tap a formula repository or list existing taps. This command can be invoked
in three ways.
+ `tap` without arguments displays existing taps.
+ `tap <user/repo>` taps a formula repository from GitHub using HTTPS.
+ `tap` <user>`/`<repo>` taps a formula repository from GitHub using HTTPS.
Since so many taps are hosted on GitHub, this command is a shortcut for
`tap user/repo https://github.com/#{user}/homebrew-#{repo}`.
`tap <user>/<repo> https://github.com/<user>/homebrew-<repo>`.
+ `tap <user/repo> <URL>` taps a formula repository from anywhere, using
+ `tap` <user>`/`<repo> <URL> taps a formula repository from anywhere, using
any transport protocol that `git` handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
@ -409,7 +408,7 @@ Note that these flags should only appear after a command.
* `tap-info` <tap>:
Display information about <tap>.
* `tap-info --json=<version>` (--installed|<taps>):
* `tap-info` `--json=`<version> (`--installed`|<taps>):
Print a JSON representation of <taps>. Currently the only accepted value
for <version> is `v1`.
@ -425,8 +424,8 @@ Note that these flags should only appear after a command.
* `tap-unpin` <tap>:
Unpin <tap> so its formulae are no longer prioritized. See also `tap-pin`.
* `test` [--devel|--HEAD] [--debug] <formula>:
A few formulae provide a test method. `brew test <formula>` runs this
* `test` [`--devel`|`--HEAD`] [`--debug`] <formula>:
A few formulae provide a test method. `brew test` <formula> runs this
test method. There is no standard output or return code, but it should
generally indicate to the user if something is wrong with the installed
formula.
@ -439,7 +438,7 @@ Note that these flags should only appear after a command.
Example: `brew install jruby && brew test jruby`
* `unlink [--dry-run]` <formula>:
* `unlink` [`--dry-run`] <formula>:
Remove symlinks for <formula> from the Homebrew prefix. This can be useful
for temporarily disabling a formula:
`brew unlink foo && commands && brew link foo`.
@ -447,14 +446,14 @@ Note that these flags should only appear after a command.
If `--dry-run` or `-n` is passed, Homebrew will list all files which would
be unlinked, but will not actually unlink or delete any files.
* `unlinkapps [--local]` [<formulae>]:
* `unlinkapps` [`--local`] [<formulae>]:
Removes links created by `brew linkapps`.
If no <formulae> are provided, all linked app will be removed.
* `unpack [--git|--patch] [--destdir=<path>]` <formulae>:
* `unpack` [`--git`|`--patch`] [`--destdir=`<path>] <formulae>:
Unpack the source files for <formulae> into subdirectories of the current
working directory. If `--destdir=<path>` is given, the subdirectories will
working directory. If `--destdir=`<path> is given, the subdirectories will
be created in the directory named by `<path>` instead.
If `--patch` is passed, patches for <formulae> will be applied to the
@ -470,13 +469,13 @@ Note that these flags should only appear after a command.
* `untap` <tap>:
Remove a tapped repository.
* `update [--rebase]`:
* `update` [`--rebase`]:
Fetch the newest version of Homebrew and all formulae from GitHub using
`git`(1).
If `--rebase` is specified then `git pull --rebase` is used.
* `upgrade [install-options] [--cleanup]` [<formulae>]:
* `upgrade` [<install-options>] [`--cleanup`] [<formulae>]:
Upgrade outdated, unpinned brews.
Options for the `install` command are also valid here.
@ -486,7 +485,7 @@ Note that these flags should only appear after a command.
If <formulae> are given, upgrade only the specified brews (but do so even
if they are pinned; see `pin`, `unpin`).
* `uses [--installed] [--recursive] [--skip-build] [--skip-optional] [--devel|--HEAD]` <formulae>:
* `uses` [`--installed`] [`--recursive`] [`--skip-build`] [`--skip-optional`] [`--devel`|`--HEAD`] <formulae>:
Show the formulae that specify <formulae> as a dependency. When given
multiple formula arguments, show the intersection of formulae that use
<formulae>.
@ -536,8 +535,8 @@ Note that these flags should only appear after a command.
## EXTERNAL COMMANDS
Homebrew, like `git`(1), supports external commands. These are executable
scripts that reside somewhere in the PATH, named `brew-<cmdname>` or
`brew-<cmdname>.rb`, which can be invoked like `brew cmdname`. This allows you
scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
`brew-`<cmdname>`.rb`, which can be invoked like `brew` <cmdname>. This allows you
to create your own commands without modifying Homebrew's internals.
Instructions for creating your own commands can be found in the docs:
@ -552,7 +551,7 @@ can take several different forms:
e.g. `git`, `node`, `wget`.
* The fully-qualified name of a tapped formula:
Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew.
Sometimes a formula from a tapped repository may conflict with one in `Homebrew/homebrew`.
You can still access these formulae by using a special syntax, e.g.
`homebrew/dupes/vim` or `homebrew/versions/node4`.
@ -563,65 +562,65 @@ can take several different forms:
## ENVIRONMENT
* AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY:
When using the S3 download strategy, Homebrew will look in
* `AWS_ACCESS_KEY_ID`, `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
the `S3` download strategy will download with a public
(unsigned) URL.
* BROWSER:
* `BROWSER`:
If set, and `HOMEBREW_BROWSER` is not, use `BROWSER` as the web browser
when opening project homepages.
* EDITOR:
* `EDITOR`:
If set, and `HOMEBREW_EDITOR` and `VISUAL` are not, use `EDITOR` as the text editor.
* GIT:
* `GIT`:
When using Git, Homebrew will use `GIT` if set,
a Homebrew-built Git if installed, or the system-provided binary.
Set this to force Homebrew to use a particular git binary.
* HOMEBREW\_BOTTLE\_DOMAIN:
* `HOMEBREW_BOTTLE_DOMAIN`:
If set, instructs Homebrew to use the given URL as a download mirror for bottles.
* HOMEBREW\_BROWSER:
* `HOMEBREW_BROWSER`:
If set, uses this setting as the browser when opening project 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
provides a bottle.
* HOMEBREW\_CACHE:
* `HOMEBREW_CACHE`:
If set, instructs Homebrew to use the given directory as the download cache.
*Default:* `~/Library/Caches/Homebrew` if it exists; otherwise,
`/Library/Caches/Homebrew`.
* HOMEBREW\_CURL\_VERBOSE:
* `HOMEBREW_CURL_VERBOSE`:
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
* HOMEBREW\_DEBUG:
* `HOMEBREW_DEBUG`:
If set, any commands that can emit debugging information will do so.
* HOMEBREW\_DEBUG\_INSTALL:
* `HOMEBREW_DEBUG_INSTALL`:
When `brew install -d` or `brew install -i` drops into a shell,
`HOMEBREW_DEBUG_INSTALL` will be set to the name of the formula being
brewed.
* HOMEBREW\_DEBUG\_PREFIX:
* `HOMEBREW_DEBUG_PREFIX`:
When `brew install -d` or `brew install -i` drops into a shell,
`HOMEBREW_DEBUG_PREFIX` will be set to the target prefix in the Cellar
of the formula being brewed.
* HOMEBREW\_DEVELOPER:
* `HOMEBREW_DEVELOPER`:
If set, Homebrew will print warnings that are only relevant to Homebrew
developers (active or budding).
* HOMEBREW\_EDITOR:
* `HOMEBREW_EDITOR`:
If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory.
@ -629,7 +628,7 @@ can take several different forms:
directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case.
* HOMEBREW\_GITHUB\_API\_TOKEN:
* `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
@ -638,22 +637,22 @@ can take several different forms:
*NOTE*: Homebrew doesn't require permissions for any of the scopes.
* HOMEBREW\_LOGS:
* `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files.
* HOMEBREW\_MAKE\_JOBS:
* `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\_EMOJI:
* `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 Lion or newer.
* HOMEBREW\_NO\_INSECURE\_REDIRECT:
* `HOMEBREW_NO_INSECURE_REDIRECT`:
If set, Homebrew will not permit redirects from secure HTTPS
to insecure HTTP.
@ -664,21 +663,21 @@ can take several different forms:
Apache formulae are currently unaffected by this variable and
can redirect to plaintext.
* HOMEBREW\_NO\_GITHUB\_API:
* `HOMEBREW_NO_GITHUB_API`:
If set, Homebrew will not use the GitHub API for e.g searches or
fetching relevant issues on a failed install.
* HOMEBREW\_INSTALL\_BADGE:
* `HOMEBREW_INSTALL_BADGE`:
Text printed before the installation summary of each successful build.
Defaults to the beer emoji.
* HOMEBREW\_SVN:
* `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.
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
for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as OS X has trouble moving
@ -687,15 +686,15 @@ can take several different forms:
This issue typically occurs when using FileVault or custom SSD
configurations.
* HOMEBREW\_VERBOSE:
* `HOMEBREW_VERBOSE`:
If set, Homebrew always assumes `--verbose` when running commands.
* VISUAL:
* `VISUAL`:
If set, and `HOMEBREW_EDITOR` is not, use `VISUAL` as the text editor.
## USING HOMEBREW BEHIND A PROXY
Homebrew uses several commands for downloading files (e.g. curl, git, svn).
Homebrew uses several commands for downloading files (e.g. `curl`, `git`, `svn`).
Many of these tools can download via a proxy. It's common for these tools
to read proxy parameters from environment variables.

173
share/doc/homebrew/brew.1.html
View File

@ -6,8 +6,8 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>brew</code> --version<br />
<code>brew</code> command [--verbose|-v] [options] [formula] ...</p>
<p><code>brew</code> <code>--version</code><br />
<code>brew</code> <var>command</var> [<code>--verbose</code>|<code>-v</code>] [<var>options</var>] [<var>formula</var>] ...</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -16,17 +16,16 @@ didn't include with OS X.</p>
<h2 id="ESSENTIAL-COMMANDS">ESSENTIAL COMMANDS</h2>
<p>For the full command list, see the COMMANDS section.</p>
<p>For the full command list, see the <a href="#COMMANDS" title="COMMANDS" data-bare-link="true">COMMANDS</a> section.</p>
<p>With <code>--verbose</code> or <code>-v</code>, many commands print extra debugging information.
Note that these flags should only appear after a command.</p>
<p>With <code>--verbose</code> or <code>-v</code>, many commands print extra debugging information. Note that these flags should only appear after a command.</p>
<dl>
<dt><code>install</code> <var>formula</var></dt><dd><p>Install <var>formula</var>.</p></dd>
<dt><code>remove</code> <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p></dd>
<dt class="flush"><code>update</code></dt><dd><p>Fetch the newest version of Homebrew from GitHub using <code>git</code>(1).</p></dd>
<dt class="flush"><code>list</code></dt><dd><p>List all installed formulae.</p></dd>
<dt><code>search</code> <var>text</var>|/<var>text</var>/</dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
<dt><code>search</code> <var>text</var> | <code>/</code><var>text</var><code>/</code></dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
surrounded with slashes, then it is interpreted as a regular expression.
The search for <var>text</var> is extended online to some popular taps.
If no search term is given, all locally available formulae are listed.</p></dd>
@ -36,7 +35,7 @@ If no search term is given, all locally available formulae are listed.</p></dd>
<h2 id="COMMANDS">COMMANDS</h2>
<ul>
<li><p><code>audit</code> [--strict] [--online] [<var>formulae</var>]:
<li><p><code>audit</code> [<code>--strict</code>] [<code>--online</code>] [<var>formulae</var>]:
Check <var>formulae</var> for Homebrew coding style violations. This should be
run before submitting a new formula.</p>
@ -52,24 +51,24 @@ connection are run. This should be used when creating for new formulae.</p>
for instance, for implementing pre-commit hooks.</p></li>
<li><p><code>cat</code> <var>formula</var>:
Display the source to <var>formula</var>.</p></li>
<li><p><code>cleanup [--force] [--prune=&lt;days>] [-ns]</code> [<var>formulae</var>]:
<li><p><code>cleanup</code> [<code>--force</code>] [<code>--prune=</code><var>days</var>] [<code>-n</code>] [<code>-s</code>] [<var>formulae</var>]:
For all installed or specific formulae, remove any older versions from the
cellar. By default, does not remove out-of-date keg-only brews, as other
software may link directly to specific versions. In addition old downloads from
software may link directly to specific versions. In addition, old downloads from
the Homebrew download-cache are deleted.</p>
<p>If <code>--force</code> is passed, remove out-of-date keg-only brews as well.</p>
<p>If <code>--prune=&lt;days></code> is specified, remove all cache files older than <var>days</var>.</p>
<p>If <code>--prune=</code><var>days</var> is specified, remove all cache files older than <var>days</var>.</p>
<p>If <code>-n</code> is passed, show what would be removed, but do not actually remove anything.</p>
<p>If <code>-s</code> is passed, scrubs the cache, removing downloads for even the latest
versions of formula. Note downloads for any installed formula will still not be
versions of formulae. Note downloads for any installed formulae will still not be
deleted. If you want to delete those too: <code>rm -rf $(brew --cache)</code></p></li>
<li><p><code>command</code> <var>cmd</var>:
Display the path to the file which is used when invoking <code>brew &lt;cmd></code>.</p></li>
<li><p><code>commands [--quiet [--include-aliases]]</code>:
Display the path to the file which is used when invoking <code>brew</code> <var>cmd</var>.</p></li>
<li><p><code>commands</code> [<code>--quiet</code> [<code>--include-aliases</code>]]:
Show a list of built-in and external commands.</p>
<p>If <code>--quiet</code> is passed, list only the names of commands without the header.
@ -78,10 +77,10 @@ With <code>--include-aliases</code>, the aliases of internal commands will be in
Show Homebrew and system configuration useful for debugging. If you file
a bug report, you will likely be asked for this information if you do not
provide it.</p></li>
<li><p><code>create &lt;URL> [--autotools|--cmake] [--no-fetch] [--set-name &lt;name>] [--set-version &lt;version>]</code>:
<li><p><code>create</code> <var>URL</var> [<code>--autotools</code>|<code>--cmake</code>] [<code>--no-fetch</code>] [<code>--set-name</code> <var>name</var>] [<code>--set-version</code> <var>version</var>]:
Generate a formula for the downloadable file at <var>URL</var> and open it in the editor.
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The wget
and version, but if it fails, you'll have to make your own template. The <code>wget</code>
formula serves as a simple example. For the complete API have a look at</p>
<p><a href="http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula" data-bare-link="true">http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula</a></p>
@ -94,7 +93,7 @@ will thus not add the SHA256 to the formula for you.</p>
<p>The options <code>--set-name</code> and <code>--set-version</code> each take an argument and allow
you to explicitly set the name and version of the package you are creating.</p></li>
<li><p><code>deps [--1] [-n] [--union] [--tree] [--all] [--installed] [--skip-build] [--skip-optional]</code> <var>formulae</var>:
<li><p><code>deps</code> [<code>--1</code>] [<code>-n</code>] [<code>--union</code>] [<code>--tree</code>] [<code>--all</code>] [<code>--installed</code>] [<code>--skip-build</code>] [<code>--skip-optional</code>] <var>formulae</var>:
Show dependencies for <var>formulae</var>. When given multiple formula arguments,
show the intersection of dependencies for <var>formulae</var>, except when passed
<code>--tree</code>, <code>--all</code>, or <code>--installed</code>.</p>
@ -118,19 +117,19 @@ type dependencies, pass <code>--skip-build</code>. Similarly, pass <code>--skip-
to skip <code>:optional</code> dependencies.</p></li>
<li><p><code>desc</code> <var>formula</var>:
Display <var>formula</var>'s name and one-line description.</p></li>
<li><p><code>desc [-s|-n|-d] &lt;pattern></code>:
<li><p><code>desc</code> [<code>-s</code>|<code>-n</code>|<code>-d</code>] <var>pattern</var>:
Search both name and description (<code>-s</code>), just the names (<code>-n</code>), or just the
descriptions (<code>-d</code>) for <code>&lt;pattern></code>. <code>&lt;pattern></code> is by default interpreted
as a literal string; if flanked by slashes, it is instead interpreted as a
regular expression. Formula descriptions are cached; the cache is created on
the first search, making that search slower than subsequent ones.</p></li>
<li><p><code>diy [--name=&lt;name>] [--version=&lt;version>]</code>:
<li><p><code>diy</code> [<code>--name=</code><var>name</var>] [<code>--version=</code><var>version</var>]:
Automatically determine the installation prefix for non-Homebrew software.</p>
<p>Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with <code>brew link</code>.</p>
<p>The options <code>--name=&lt;name></code> and <code>--version=&lt;version></code> each take an argument
<p>The options <code>--name=</code><var>name</var> and <code>--version=</code><var>version</var> each take an argument
and allow you to explicitly set the name and version of the package you are
installing.</p></li>
<li><p><code>doctor</code>:
@ -140,9 +139,9 @@ if any problems are found.</p></li>
Open all of Homebrew for editing.</p></li>
<li><p><code>edit</code> <var>formula</var>:
Open <var>formula</var> in the editor.</p></li>
<li><p><code>fetch [--force] [-v] [--devel|--HEAD] [--deps] [--build-from-source|--force-bottle]</code> <var>formulae</var>:
<li><p><code>fetch</code> [<code>--force</code>] [<code>-v</code>] [<code>--devel</code>|<code>--HEAD</code>] [<code>--deps</code>] [<code>--build-from-source</code>|<code>--force-bottle</code>] <var>formulae</var>:
Download the source packages for the given <var>formulae</var>.
For tarballs, also print SHA1 and SHA-256 checksums.</p>
For tarballs, also print SHA-1 and SHA-256 checksums.</p>
<p>If <code>--HEAD</code> or <code>--devel</code> is passed, fetch that version instead of the
stable version.</p>
@ -165,20 +164,20 @@ Open Homebrew's own homepage in a browser.</p></li>
Open <var>formula</var>'s homepage in a browser.</p></li>
<li><p><code>info</code> <var>formula</var>:
Display information about <var>formula</var>.</p></li>
<li><p><code>info --github</code> <var>formula</var>:
<li><p><code>info</code> <code>--github</code> <var>formula</var>:
Open a browser to the GitHub History page for formula <var>formula</var>.</p>
<p>To view formula history locally: <code>brew log -p &lt;formula></code>.</p></li>
<li><p><code>info --json=&lt;version></code> (--all|--installed|<var>formulae</var>):
Print a JSON representation of <var>formulae</var>. Currently the only accepted value
for <var>version</var> is <code>v1</code>.</p>
<li><p><code>info --json=</code><var>version</var><code>(</code>--all<code>|</code>--installed<code>|&lt;formulae>):
Print a JSON representation of &lt;formulae>. Currently the only accepted value
for &lt;version> is</code>v1`.</p>
<p>Pass <code>--all</code> to get information on all formulae, or <code>--installed</code> to get
information on all installed formulae.</p>
<p>See the docs for examples of using the JSON:
<a href="https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md</a></p></li>
<li><p><code>install [--debug] [--env=&lt;std|super>] [--ignore-dependencies] [--only-dependencies] [--cc=&lt;compiler>] [--build-from-source|--force-bottle] [--devel|--HEAD]</code> <var>formula</var>:
<li><p><code>install</code> [<code>--debug</code>] [<code>--env=</code><var>std</var>|<var>super</var>] [<code>--ignore-dependencies</code>] [<code>--only-dependencies</code>] [<code>--cc=</code><var>compiler</var>] [<code>--build-from-source</code>|<code>--force-bottle</code>] [<code>--devel</code>|<code>--HEAD</code>] <var>formula</var>:
Install <var>formula</var>.</p>
<p><var>formula</var> is usually the name of the formula to install, but it can be specified
@ -199,7 +198,7 @@ to install.</p>
<p>If <code>--only-dependencies</code> is passed, install the dependencies with specified
options but do not install the specified formula.</p>
<p>If <code>--cc=&lt;compiler></code> is passed, attempt to compile using <var>compiler</var>.
<p>If <code>--cc=</code><var>compiler</var> is passed, attempt to compile using <var>compiler</var>.
<var>compiler</var> should be the name of the compiler's executable, for instance
<code>gcc-4.2</code> for Apple's GCC 4.2, or <code>gcc-4.9</code> for a Homebrew-provided GCC
4.9.</p>
@ -217,20 +216,20 @@ aka master, trunk, unstable.</p>
<p>To install a newer version of HEAD use
<code>brew rm &lt;foo> &amp;&amp; brew install --HEAD &lt;foo></code>.</p></li>
<li><p><code>install --interactive [--git]</code> <var>formula</var>:
<li><p><code>install --interactive</code> [<code>--git</code>] <var>formula</var>:
Download and patch <var>formula</var>, then open a shell. This allows the user to
run <code>./configure --help</code> and otherwise determine how to turn the software
package into a Homebrew formula.</p>
<p>If <code>--git</code> is passed, Homebrew will create a Git repository, useful for
creating patches to the software.</p></li>
<li><p><code>irb [--examples]</code>:
<li><p><code>irb</code> [<code>--examples</code>]:
Enter the interactive Homebrew Ruby shell.</p>
<p>If <code>--examples</code> is passed, several examples will be shown.</p></li>
<li><p><code>leaves</code>:
Show installed formulae that are not dependencies of another installed formula.</p></li>
<li><p><code>ln</code>, <code>link [--overwrite] [--dry-run] [--force]</code> <var>formula</var>:
<li><p><code>ln</code>, <code>link</code> [<code>--overwrite</code>] [<code>--dry-run</code>] [<code>--force</code>] <var>formula</var>:
Symlink all of <var>formula</var>'s installed files into the Homebrew prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.</p>
@ -243,7 +242,7 @@ be linked or which would be deleted by <code>brew link --overwrite</code>, but w
actually link or delete any files.</p>
<p>If <code>--force</code> is passed, Homebrew will allow keg-only formulae to be linked.</p></li>
<li><p><code>linkapps [--local]</code> [<var>formulae</var>]:
<li><p><code>linkapps</code> [<code>--local</code>] [<var>formulae</var>]:
Find installed formulae that have compiled <code>.app</code>-style "application"
packages for OS X, and symlink those apps into <code>/Applications</code>, allowing
for easier access.</p>
@ -252,12 +251,12 @@ for easier access.</p>
<p>If provided, <code>--local</code> will move them into the user's <code>~/Applications</code>
directory instead of the system directory. It may need to be created, first.</p></li>
<li><p><code>ls</code>, <code>list [--full-name]</code>
<li><p><code>ls</code>, <code>list</code> [<code>--full-name</code>]
List all installed formulae. If <code>--full-name</code> is passed, print formulae with
full-qualified names.</p></li>
<li><p><code>ls</code>, <code>list --unbrewed</code>
List all files in the Homebrew prefix not installed by Homebrew.</p></li>
<li><p><code>ls</code>, <code>list [--versions [--multiple]] [--pinned]</code> [<var>formulae</var>]:
<li><p><code>ls</code>, <code>list</code> [<code>--versions</code> [<code>--multiple</code>]] [<code>--pinned</code>] [<var>formulae</var>]:
List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively
list the contents of all subdirectories in each <var>formula</var>'s keg.</p>
@ -268,20 +267,20 @@ only show formulae with multiple versions installed.</p>
<p>If <code>--pinned</code> is passed, show the versions of pinned formulae, or only the
specified (pinned) formulae if <var>formulae</var> are given.
See also <code>pin</code>, <code>unpin</code>.</p></li>
<li><p><code>log [git-log-options]</code> <var>formula</var> ...:
<li><p><code>log</code> [<code>git-log-options</code>] <var>formula</var> ...:
Show the git log for the given formulae. Options that <code>git-log</code>(1)
recognizes can be passed before the formula list.</p></li>
<li><p><code>missing</code> [<var>formulae</var>]:
Check the given <var>formulae</var> for missing dependencies.</p>
<p>If no <var>formulae</var> are given, check all installed brews.</p></li>
<li><p><code>migrate [--force]</code> <var>formulae</var>:
<li><p><code>migrate</code> [<code>--force</code>] <var>formulae</var>:
Migrate renamed packages to new name, where <var>formulae</var> are old names of
packages.</p>
<p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var>
like if they are from same taps and migrate them anyway.</p></li>
<li><p><code>options [--compact] [--all] [--installed]</code> <var>formula</var>:
<li><p><code>options</code> [<code>--compact</code>] [<code>--all</code>] [<code>--installed</code>] <var>formula</var>:
Display install options specific to <var>formula</var>.</p>
<p>If <code>--compact</code> is passed, show all options on a single line separated by
@ -290,7 +289,7 @@ spaces.</p>
<p>If <code>--all</code> is passed, show options for all formulae.</p>
<p>If <code>--installed</code> is passed, show options for all installed formulae.</p></li>
<li><p><code>outdated [--quiet | --verbose | --json=v1 ]</code>:
<li><p><code>outdated</code> [<code>--quiet</code> | <code>--verbose</code> | <code>--json=v1</code> ]:
Show formulae that have an updated version available.</p>
<p>By default, version information is displayed in interactive shells, and
@ -301,7 +300,7 @@ precedence over <code>--verbose</code>).</p>
<p>If <code>--verbose</code> is passed, display detailed version information.</p>
<p>If <code>--json=&lt;version></code> is passed, the output will be in JSON format. The only
<p>If <code>--json=</code><var>version</var> is passed, the output will be in JSON format. The only
valid version is <code>v1</code>.</p></li>
<li><p><code>pin</code> <var>formulae</var>:
Pin the specified <var>formulae</var>, preventing them from being upgraded when
@ -311,7 +310,7 @@ Remove dead symlinks from the Homebrew prefix. This is generally not
needed, but can be useful when doing DIY installations.</p></li>
<li><p><code>reinstall</code> <var>formula</var>:
Uninstall then install <var>formula</var></p></li>
<li><p><code>rm</code>, <code>remove</code>, <code>uninstall [--force]</code> <var>formula</var>:
<li><p><code>rm</code>, <code>remove</code>, <code>uninstall</code> [<code>--force</code>] <var>formula</var>:
Uninstall <var>formula</var>.</p>
<p>If <code>--force</code> is passed, and there are multiple versions of <var>formula</var>
@ -319,30 +318,30 @@ installed, delete all installed versions.</p></li>
<li><p><code>search</code>, <code>-S</code>:
Display all locally available formulae for brewing (including tapped ones).
No online search is performed if called without arguments.</p></li>
<li><p><code>search</code>, <code>-S</code> <var>text</var>|/<var>text</var>/:
<li><p><code>search</code>, <code>-S</code> <var>text</var>|<code>/</code><var>text</var><code>/</code>:
Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
surrounded with slashes, then it is interpreted as a regular expression.
The search for <var>text</var> is extended online to some popular taps.</p></li>
<li><p><code>search --debian</code>|<code>--fedora</code>|<code>--fink</code>|<code>--macports</code>|<code>--opensuse</code>|<code>--ubuntu</code> <var>text</var>:
Search for <var>text</var> in the given package manager's list.</p></li>
<li><p><code>sh [--env=std]</code>:
<li><p><code>sh</code> [<code>--env=std</code>]:
Instantiate a Homebrew build environment. Uses our years-battle-hardened
Homebrew build logic to help your <code>./configure &amp;&amp; make &amp;&amp; make install</code>
or even your <code>gem install</code> succeed. Especially handy if you run Homebrew
in a Xcode-only configuration since it adds tools like make to your PATH
in an Xcode-only configuration since it adds tools like <code>make</code> to your <code>PATH</code>
which otherwise build-systems would not find.</p></li>
<li><p><code>switch</code> <var>name</var> <var>version</var>:
Symlink all of the specific <var>version</var> of <var>name</var>'s install to Homebrew prefix.</p></li>
<li><p><code>tap</code> [--full] [<user/repo>] [<var>URL</var>]:
<li><p><code>tap</code> [<code>--full</code>] <var>user</var><code>/</code><var>repo</var> [<var>URL</var>]:
Tap a formula repository or list existing taps. This command can be invoked
in three ways.</p>
<ul>
<li><p><code>tap</code> without arguments displays existing taps.</p></li>
<li><p><code>tap &lt;user/repo&gt;</code> taps a formula repository from GitHub using HTTPS.
<li><p><code>tap</code> <var>user</var><code>/</code><var>repo</var><code>taps a formula repository from GitHub using HTTPS.
Since so many taps are hosted on GitHub, this command is a shortcut for
<code>tap user/repo https://github.com/#{user}/homebrew-#{repo}</code>.</p></li>
<li><p><code>tap &lt;user/repo&gt; &lt;URL></code> taps a formula repository from anywhere, using
</code>tap <var>user</var>/<var>repo</var> https://github.com/<var>user</var>/homebrew-<var>repo</var>`.</p></li>
<li><p><code>tap</code> <var>user</var><code>/</code><var>repo</var> <var>URL</var> taps a formula repository from anywhere, using
any transport protocol that <code>git</code> handles. The one-argument form of <code>tap</code>
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
@ -360,7 +359,7 @@ List all official taps.</p></li>
List all pinned taps.</p></li>
<li><p><code>tap-info</code> <var>tap</var>:
Display information about <var>tap</var>.</p></li>
<li><p><code>tap-info --json=&lt;version></code> (--installed|<var>taps</var>):
<li><p><code>tap-info</code> <code>--json=</code><var>version</var> (<code>--installed</code>|<var>taps</var>):
Print a JSON representation of <var>taps</var>. Currently the only accepted value
for <var>version</var> is <code>v1</code>.</p>
@ -373,8 +372,8 @@ Pin <var>tap</var>, prioritizing its formulae over core when formula names are s
by the user. See also <code>tap-unpin</code>.</p></li>
<li><p><code>tap-unpin</code> <var>tap</var>:
Unpin <var>tap</var> so its formulae are no longer prioritized. See also <code>tap-pin</code>.</p></li>
<li><p><code>test</code> [--devel|--HEAD] [--debug] <var>formula</var>:
A few formulae provide a test method. <code>brew test &lt;formula></code> runs this
<li><p><code>test</code> [<code>--devel</code>|<code>--HEAD</code>] [<code>--debug</code>] <var>formula</var>:
A few formulae provide a test method. <code>brew test</code> <var>formula</var> runs this
test method. There is no standard output or return code, but it should
generally indicate to the user if something is wrong with the installed
formula.</p>
@ -386,20 +385,20 @@ formula.</p>
launched with access to IRB or a shell inside the temporary test directory.</p>
<p>Example: <code>brew install jruby &amp;&amp; brew test jruby</code></p></li>
<li><p><code>unlink [--dry-run]</code> <var>formula</var>:
<li><p><code>unlink</code> [<code>--dry-run</code>] <var>formula</var>:
Remove symlinks for <var>formula</var> from the Homebrew prefix. This can be useful
for temporarily disabling a formula:
<code>brew unlink foo &amp;&amp; commands &amp;&amp; brew link foo</code>.</p>
<p>If <code>--dry-run</code> or <code>-n</code> is passed, Homebrew will list all files which would
be unlinked, but will not actually unlink or delete any files.</p></li>
<li><p><code>unlinkapps [--local]</code> [<var>formulae</var>]:
<li><p><code>unlinkapps</code> [<code>--local</code>] [<var>formulae</var>]:
Removes links created by <code>brew linkapps</code>.</p>
<p>If no <var>formulae</var> are provided, all linked app will be removed.</p></li>
<li><p><code>unpack [--git|--patch] [--destdir=&lt;path>]</code> <var>formulae</var>:
<li><p><code>unpack</code> [<code>--git</code>|<code>--patch</code>] [<code>--destdir=</code><var>path</var>] <var>formulae</var>:
Unpack the source files for <var>formulae</var> into subdirectories of the current
working directory. If <code>--destdir=&lt;path></code> is given, the subdirectories will
working directory. If <code>--destdir=</code><var>path</var> is given, the subdirectories will
be created in the directory named by <code>&lt;path></code> instead.</p>
<p>If <code>--patch</code> is passed, patches for <var>formulae</var> will be applied to the
@ -412,12 +411,12 @@ Unpin <var>formulae</var>, allowing them to be upgraded by <code>brew upgrade</c
<code>pin</code>.</p></li>
<li><p><code>untap</code> <var>tap</var>:
Remove a tapped repository.</p></li>
<li><p><code>update [--rebase]</code>:
<li><p><code>update</code> [<code>--rebase</code>]:
Fetch the newest version of Homebrew and all formulae from GitHub using
<code>git</code>(1).</p>
<p>If <code>--rebase</code> is specified then <code>git pull --rebase</code> is used.</p></li>
<li><p><code>upgrade [install-options] [--cleanup]</code> [<var>formulae</var>]:
<li><p><code>upgrade</code> [<var>install-options</var>] [<code>--cleanup</code>] [<var>formulae</var>]:
Upgrade outdated, unpinned brews.</p>
<p>Options for the <code>install</code> command are also valid here.</p>
@ -426,7 +425,7 @@ Upgrade outdated, unpinned brews.</p>
<p>If <var>formulae</var> are given, upgrade only the specified brews (but do so even
if they are pinned; see <code>pin</code>, <code>unpin</code>).</p></li>
<li><p><code>uses [--installed] [--recursive] [--skip-build] [--skip-optional] [--devel|--HEAD]</code> <var>formulae</var>:
<li><p><code>uses</code> [<code>--installed</code>] [<code>--recursive</code>] [<code>--skip-build</code>] [<code>--skip-optional</code>] [<code>--devel</code>|<code>--HEAD</code>] <var>formulae</var>:
Show the formulae that specify <var>formulae</var> as a dependency. When given
multiple formula arguments, show the intersection of formulae that use
<var>formulae</var>.</p>
@ -469,8 +468,8 @@ Print the version number of brew to standard error and exit.</p></li>
<h2 id="EXTERNAL-COMMANDS">EXTERNAL COMMANDS</h2>
<p>Homebrew, like <code>git</code>(1), supports external commands. These are executable
scripts that reside somewhere in the PATH, named <code>brew-&lt;cmdname></code> or
<code>brew-&lt;cmdname>.rb</code>, which can be invoked like <code>brew cmdname</code>. This allows you
scripts that reside somewhere in the <code>PATH</code>, named <code>brew-</code><var>cmdname</var> or
<code>brew-</code><var>cmdname</var><code>.rb</code>, which can be invoked like <code>brew</code> <var>cmdname</var>. This allows you
to create your own commands without modifying Homebrew's internals.</p>
<p>Instructions for creating your own commands can be found in the docs:
@ -483,7 +482,7 @@ can take several different forms:</p>
<dl>
<dt>The name of a formula</dt><dd><p>e.g. <code>git</code>, <code>node</code>, <code>wget</code>.</p></dd>
<dt>The fully-qualified name of a tapped formula</dt><dd><p>Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew.
<dt>The fully-qualified name of a tapped formula</dt><dd><p>Sometimes a formula from a tapped repository may conflict with one in <code>Homebrew/homebrew</code>.
You can still access these formulae by using a special syntax, e.g.
<code>homebrew/dupes/vim</code> or <code>homebrew/versions/node4</code>.</p></dd>
<dt>An arbitrary URL</dt><dd><p>Homebrew can install formulae via URL, e.g.
@ -495,61 +494,61 @@ The formula file will be cached for later use.</p></dd>
<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
<dl>
<dt>AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY</dt><dd><p>When using the S3 download strategy, Homebrew will look in
<dt><code>AWS_ACCESS_KEY_ID</code>, <code>AWS_SECRET_ACCESS_KEY</code></dt><dd><p>When using the <code>S3</code> download strategy, Homebrew will look in
these variables for access credentials (see
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment" data-bare-link="true">https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment</a>
to retrieve these access credentials from AWS). If they are not set,
the S3 download strategy will download with a public
the <code>S3</code> download strategy will download with a public
(unsigned) URL.</p></dd>
<dt class="flush">BROWSER</dt><dd><p>If set, and <code>HOMEBREW_BROWSER</code> is not, use <code>BROWSER</code> as the web browser
<dt class="flush"><code>BROWSER</code></dt><dd><p>If set, and <code>HOMEBREW_BROWSER</code> is not, use <code>BROWSER</code> as the web browser
when opening project homepages.</p></dd>
<dt class="flush">EDITOR</dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> and <code>VISUAL</code> are not, use <code>EDITOR</code> as the text editor.</p></dd>
<dt class="flush">GIT</dt><dd><p>When using Git, Homebrew will use <code>GIT</code> if set,
<dt class="flush"><code>EDITOR</code></dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> and <code>VISUAL</code> are not, use <code>EDITOR</code> as the text editor.</p></dd>
<dt class="flush"><code>GIT</code></dt><dd><p>When using Git, Homebrew will use <code>GIT</code> if set,
a Homebrew-built Git if installed, or the system-provided binary.</p>
<p>Set this to force Homebrew to use a particular git binary.</p></dd>
<dt>HOMEBREW_BOTTLE_DOMAIN</dt><dd><p>If set, instructs Homebrew to use the given URL as a download mirror for bottles.</p></dd>
<dt>HOMEBREW_BROWSER</dt><dd><p>If set, uses this setting as the browser when opening project homepages,
<dt><code>HOMEBREW_BOTTLE_DOMAIN</code></dt><dd><p>If set, instructs Homebrew to use the given URL as a download mirror for bottles.</p></dd>
<dt><code>HOMEBREW_BROWSER</code></dt><dd><p>If set, uses this setting as the browser when opening project homepages,
instead of the OS default browser.</p></dd>
<dt>HOMEBREW_BUILD_FROM_SOURCE</dt><dd><p>If set, instructs Homebrew to compile from source even when a formula
<dt><code>HOMEBREW_BUILD_FROM_SOURCE</code></dt><dd><p>If set, instructs Homebrew to compile from source even when a formula
provides a bottle.</p></dd>
<dt>HOMEBREW_CACHE</dt><dd><p>If set, instructs Homebrew to use the given directory as the download cache.</p>
<dt><code>HOMEBREW_CACHE</code></dt><dd><p>If set, instructs Homebrew to use the given directory as the download cache.</p>
<p><em>Default:</em> <code>~/Library/Caches/Homebrew</code> if it exists; otherwise,
<code>/Library/Caches/Homebrew</code>.</p></dd>
<dt>HOMEBREW_CURL_VERBOSE</dt><dd><p>If set, Homebrew will pass <code>--verbose</code> when invoking <code>curl</code>(1).</p></dd>
<dt>HOMEBREW_DEBUG</dt><dd><p>If set, any commands that can emit debugging information will do so.</p></dd>
<dt>HOMEBREW_DEBUG_INSTALL</dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<dt><code>HOMEBREW_CURL_VERBOSE</code></dt><dd><p>If set, Homebrew will pass <code>--verbose</code> when invoking <code>curl</code>(1).</p></dd>
<dt><code>HOMEBREW_DEBUG</code></dt><dd><p>If set, any commands that can emit debugging information will do so.</p></dd>
<dt><code>HOMEBREW_DEBUG_INSTALL</code></dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<code>HOMEBREW_DEBUG_INSTALL</code> will be set to the name of the formula being
brewed.</p></dd>
<dt>HOMEBREW_DEBUG_PREFIX</dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<dt><code>HOMEBREW_DEBUG_PREFIX</code></dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<code>HOMEBREW_DEBUG_PREFIX</code> will be set to the target prefix in the Cellar
of the formula being brewed.</p></dd>
<dt>HOMEBREW_DEVELOPER</dt><dd><p>If set, Homebrew will print warnings that are only relevant to Homebrew
<dt><code>HOMEBREW_DEVELOPER</code></dt><dd><p>If set, Homebrew will print warnings that are only relevant to Homebrew
developers (active or budding).</p></dd>
<dt>HOMEBREW_EDITOR</dt><dd><p>If set, Homebrew will use this editor when editing a single formula, or
<dt><code>HOMEBREW_EDITOR</code></dt><dd><p>If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory.</p>
<p><em>NOTE</em>: <code>brew edit</code> 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.</p></dd>
<dt>HOMEBREW_GITHUB_API_TOKEN</dt><dd><p>A personal access token for the GitHub API, which you can create at
<dt><code>HOMEBREW_GITHUB_API_TOKEN</code></dt><dd><p>A personal access token for the GitHub API, which you can create at
<a href="https://github.com/settings/tokens" data-bare-link="true">https://github.com/settings/tokens</a>. If set, GitHub will allow you a
greater number of API requests. See
<a href="https://developer.github.com/v3/#rate-limiting" data-bare-link="true">https://developer.github.com/v3/#rate-limiting</a> for more information.
Homebrew uses the GitHub API for features such as <code>brew search</code>.</p>
<p><em>NOTE</em>: Homebrew doesn't require permissions for any of the scopes.</p></dd>
<dt>HOMEBREW_LOGS</dt><dd><p>If set, Homebrew will use the given directory to store log files.</p></dd>
<dt>HOMEBREW_MAKE_JOBS</dt><dd><p>If set, instructs Homebrew to use the value of <code>HOMEBREW_MAKE_JOBS</code> as
<dt><code>HOMEBREW_LOGS</code></dt><dd><p>If set, Homebrew will use the given directory to store log files.</p></dd>
<dt><code>HOMEBREW_MAKE_JOBS</code></dt><dd><p>If set, instructs Homebrew to use the value of <code>HOMEBREW_MAKE_JOBS</code> as
the number of parallel jobs to run when building with <code>make</code>(1).</p>
<p><em>Default:</em> the number of available CPU cores.</p></dd>
<dt>HOMEBREW_NO_EMOJI</dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a
<dt><code>HOMEBREW_NO_EMOJI</code></dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a
successful build.</p>
<p><em>Note:</em> Homebrew will only try to print emoji on Lion or newer.</p></dd>
<dt>HOMEBREW_NO_INSECURE_REDIRECT</dt><dd><p>If set, Homebrew will not permit redirects from secure HTTPS
<dt><code>HOMEBREW_NO_INSECURE_REDIRECT</code></dt><dd><p>If set, Homebrew will not permit redirects from secure HTTPS
to insecure HTTP.</p>
<p>While ensuring your downloads are fully secure, this is likely
@ -558,29 +557,29 @@ to fail to download.</p>
<p>Apache formulae are currently unaffected by this variable and
can redirect to plaintext.</p></dd>
<dt>HOMEBREW_NO_GITHUB_API</dt><dd><p>If set, Homebrew will not use the GitHub API for e.g searches or
<dt><code>HOMEBREW_NO_GITHUB_API</code></dt><dd><p>If set, Homebrew will not use the GitHub API for e.g searches or
fetching relevant issues on a failed install.</p></dd>
<dt>HOMEBREW_INSTALL_BADGE</dt><dd><p>Text printed before the installation summary of each successful build.
<dt><code>HOMEBREW_INSTALL_BADGE</code></dt><dd><p>Text printed before the installation summary of each successful build.
Defaults to the beer emoji.</p></dd>
<dt>HOMEBREW_SVN</dt><dd><p>When exporting from Subversion, Homebrew will use <code>HOMEBREW_SVN</code> if set,
<dt><code>HOMEBREW_SVN</code></dt><dd><p>When exporting from Subversion, Homebrew will use <code>HOMEBREW_SVN</code> if set,
a Homebrew-built Subversion if installed, or the system-provided binary.</p>
<p>Set this to force Homebrew to use a particular svn binary.</p></dd>
<dt>HOMEBREW_TEMP</dt><dd><p>If set, instructs Homebrew to use <code>HOMEBREW_TEMP</code> as the temporary directory
<p>Set this to force Homebrew to use a particular <code>svn</code> binary.</p></dd>
<dt><code>HOMEBREW_TEMP</code></dt><dd><p>If set, instructs Homebrew to use <code>HOMEBREW_TEMP</code> as the temporary directory
for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as OS X has trouble moving
symlinks across volumes when the target does not yet exist.</p>
<p>This issue typically occurs when using FileVault or custom SSD
configurations.</p></dd>
<dt>HOMEBREW_VERBOSE</dt><dd><p>If set, Homebrew always assumes <code>--verbose</code> when running commands.</p></dd>
<dt class="flush">VISUAL</dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> is not, use <code>VISUAL</code> as the text editor.</p></dd>
<dt><code>HOMEBREW_VERBOSE</code></dt><dd><p>If set, Homebrew always assumes <code>--verbose</code> when running commands.</p></dd>
<dt class="flush"><code>VISUAL</code></dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> is not, use <code>VISUAL</code> as the text editor.</p></dd>
</dl>
<h2 id="USING-HOMEBREW-BEHIND-A-PROXY">USING HOMEBREW BEHIND A PROXY</h2>
<p>Homebrew uses several commands for downloading files (e.g. curl, git, svn).
<p>Homebrew uses several commands for downloading files (e.g. <code>curl</code>, <code>git</code>, <code>svn</code>).
Many of these tools can download via a proxy. It's common for these tools
to read proxy parameters from environment variables.</p>

150
share/man/man1/brew.1
View File

@ -7,16 +7,16 @@
\fBbrew\fR \- The missing package manager for OS X
.
.SH "SYNOPSIS"
\fBbrew\fR \-\-version
\fBbrew\fR \fB\-\-version\fR
.
.br
\fBbrew\fR command [\-\-verbose|\-v] [options] [formula] \.\.\.
\fBbrew\fR \fIcommand\fR [\fB\-\-verbose\fR|\fB\-v\fR] [\fIoptions\fR] [\fIformula\fR] \.\.\.
.
.SH "DESCRIPTION"
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with OS X\.
.
.SH "ESSENTIAL COMMANDS"
For the full command list, see the COMMANDS section\.
For the full command list, see the \fICOMMANDS\fR section\.
.
.P
With \fB\-\-verbose\fR or \fB\-v\fR, many commands print extra debugging information\. Note that these flags should only appear after a command\.
@ -38,13 +38,13 @@ Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\.
List all installed formulae\.
.
.TP
\fBsearch\fR \fItext\fR|/\fItext\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\.
.
.SH "COMMANDS"
.
.IP "\(bu" 4
\fBaudit\fR [\-\-strict] [\-\-online] [\fIformulae\fR]: Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fIformulae\fR]: Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
.
.IP
If no \fIformulae\fR are provided, all of them are checked\.
@ -62,25 +62,25 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c
\fBcat\fR \fIformula\fR: Display the source to \fIformula\fR\.
.
.IP "\(bu" 4
\fBcleanup [\-\-force] [\-\-prune=<days>] [\-ns]\fR [\fIformulae\fR]: For all installed or specific formulae, remove any older versions from the cellar\. By default, does not remove out\-of\-date keg\-only brews, as other software may link directly to specific versions\. In addition old downloads from the Homebrew download\-cache are deleted\.
\fBcleanup\fR [\fB\-\-force\fR] [\fB\-\-prune=\fR\fIdays\fR] [\fB\-n\fR] [\fB\-s\fR] [\fIformulae\fR]: For all installed or specific formulae, remove any older versions from the cellar\. By default, does not remove out\-of\-date keg\-only brews, as other software may link directly to specific versions\. In addition, old downloads from the Homebrew download\-cache are deleted\.
.
.IP
If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\.
.
.IP
If \fB\-\-prune=<days>\fR is specified, remove all cache files older than \fIdays\fR\.
If \fB\-\-prune=\fR\fIdays\fR is specified, remove all cache files older than \fIdays\fR\.
.
.IP
If \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\.
.
.IP
If \fB\-s\fR is passed, scrubs the cache, removing downloads for even the latest versions of formula\. Note downloads for any installed formula will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR
If \fB\-s\fR is passed, scrubs the cache, removing downloads for even the latest versions of formulae\. Note downloads for any installed formulae will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR
.
.IP "\(bu" 4
\fBcommand\fR \fIcmd\fR: Display the path to the file which is used when invoking \fBbrew <cmd>\fR\.
\fBcommand\fR \fIcmd\fR: Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\.
.
.IP "\(bu" 4
\fBcommands [\-\-quiet [\-\-include\-aliases]]\fR: Show a list of built\-in and external commands\.
\fBcommands\fR [\fB\-\-quiet\fR [\fB\-\-include\-aliases\fR]]: Show a list of built\-in and external commands\.
.
.IP
If \fB\-\-quiet\fR is passed, list only the names of commands without the header\. With \fB\-\-include\-aliases\fR, the aliases of internal commands will be included\.
@ -89,7 +89,7 @@ If \fB\-\-quiet\fR is passed, list only the names of commands without the header
\fBconfig\fR: Show Homebrew and system configuration useful for debugging\. If you file a bug report, you will likely be asked for this information if you do not provide it\.
.
.IP "\(bu" 4
\fBcreate <URL> [\-\-autotools|\-\-cmake] [\-\-no\-fetch] [\-\-set\-name <name>] [\-\-set\-version <version>]\fR: Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The wget formula serves as a simple example\. For the complete API have a look at
\fBcreate\fR \fIURL\fR [\fB\-\-autotools\fR|\fB\-\-cmake\fR] [\fB\-\-no\-fetch\fR] [\fB\-\-set\-name\fR \fIname\fR] [\fB\-\-set\-version\fR \fIversion\fR]: Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at
.
.IP
\fIhttp://www\.rubydoc\.info/github/Homebrew/homebrew/master/Formula\fR
@ -104,7 +104,7 @@ If \fB\-\-no\-fetch\fR is passed, Homebrew will not download \fIURL\fR to the ca
The options \fB\-\-set\-name\fR and \fB\-\-set\-version\fR each take an argument and allow you to explicitly set the name and version of the package you are creating\.
.
.IP "\(bu" 4
\fBdeps [\-\-1] [\-n] [\-\-union] [\-\-tree] [\-\-all] [\-\-installed] [\-\-skip\-build] [\-\-skip\-optional]\fR \fIformulae\fR: Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR, except when passed \fB\-\-tree\fR, \fB\-\-all\fR, or \fB\-\-installed\fR\.
\fBdeps\fR [\fB\-\-1\fR] [\fB\-n\fR] [\fB\-\-union\fR] [\fB\-\-tree\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] \fIformulae\fR: Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR, except when passed \fB\-\-tree\fR, \fB\-\-all\fR, or \fB\-\-installed\fR\.
.
.IP
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
@ -131,16 +131,16 @@ By default, \fBdeps\fR shows dependencies for \fIformulae\fR\. To skip the \fB:b
\fBdesc\fR \fIformula\fR: Display \fIformula\fR\'s name and one\-line description\.
.
.IP "\(bu" 4
\fBdesc [\-s|\-n|\-d] <pattern>\fR: Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fB<pattern>\fR\. \fB<pattern>\fR is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
\fBdesc\fR [\fB\-s\fR|\fB\-n\fR|\fB\-d\fR] \fIpattern\fR: Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fB<pattern>\fR\. \fB<pattern>\fR is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
.
.IP "\(bu" 4
\fBdiy [\-\-name=<name>] [\-\-version=<version>]\fR: Automatically determine the installation prefix for non\-Homebrew software\.
\fBdiy\fR [\fB\-\-name=\fR\fIname\fR] [\fB\-\-version=\fR\fIversion\fR]: Automatically determine the installation prefix for non\-Homebrew software\.
.
.IP
Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew\'s prefix with \fBbrew link\fR\.
.
.IP
The options \fB\-\-name=<name>\fR and \fB\-\-version=<version>\fR each take an argument and allow you to explicitly set the name and version of the package you are installing\.
The options \fB\-\-name=\fR\fIname\fR and \fB\-\-version=\fR\fIversion\fR each take an argument and allow you to explicitly set the name and version of the package you are installing\.
.
.IP "\(bu" 4
\fBdoctor\fR: Check your system for potential problems\. Doctor exits with a non\-zero status if any problems are found\.
@ -152,7 +152,7 @@ The options \fB\-\-name=<name>\fR and \fB\-\-version=<version>\fR each take an a
\fBedit\fR \fIformula\fR: Open \fIformula\fR in the editor\.
.
.IP "\(bu" 4
\fBfetch [\-\-force] [\-v] [\-\-devel|\-\-HEAD] [\-\-deps] [\-\-build\-from\-source|\-\-force\-bottle]\fR \fIformulae\fR: Download the source packages for the given \fIformulae\fR\. For tarballs, also print SHA1 and SHA\-256 checksums\.
\fBfetch\fR [\fB\-\-force\fR] [\fB\-v\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-deps\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] \fIformulae\fR: Download the source packages for the given \fIformulae\fR\. For tarballs, also print SHA\-1 and SHA\-256 checksums\.
.
.IP
If \fB\-\-HEAD\fR or \fB\-\-devel\fR is passed, fetch that version instead of the stable version\.
@ -182,13 +182,13 @@ If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the cur
\fBinfo\fR \fIformula\fR: Display information about \fIformula\fR\.
.
.IP "\(bu" 4
\fBinfo \-\-github\fR \fIformula\fR: Open a browser to the GitHub History page for formula \fIformula\fR\.
\fBinfo\fR \fB\-\-github\fR \fIformula\fR: Open a browser to the GitHub History page for formula \fIformula\fR\.
.
.IP
To view formula history locally: \fBbrew log \-p <formula>\fR\.
.
.IP "\(bu" 4
\fBinfo \-\-json=<version>\fR (\-\-all|\-\-installed|\fIformulae\fR): Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
\fBinfo \-\-json=\fR\fIversion\fR\fB(\fR\-\-all\fB|\fR\-\-installed\fB|<formulae>): Print a JSON representation of <formulae>\. Currently the only accepted value for <version> is\fRv1`\.
.
.IP
Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\.
@ -197,7 +197,7 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to
See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR
.
.IP "\(bu" 4
\fBinstall [\-\-debug] [\-\-env=<std|super>] [\-\-ignore\-dependencies] [\-\-only\-dependencies] [\-\-cc=<compiler>] [\-\-build\-from\-source|\-\-force\-bottle] [\-\-devel|\-\-HEAD]\fR \fIformula\fR: Install \fIformula\fR\.
\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR\fIstd\fR|\fIsuper\fR] [\fB\-\-ignore\-dependencies\fR] [\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformula\fR: Install \fIformula\fR\.
.
.IP
\fIformula\fR is usually the name of the formula to install, but it can be specified several different ways\. See \fISPECIFYING FORMULAE\fR\.
@ -218,7 +218,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of
If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\.
.
.IP
If \fB\-\-cc=<compiler>\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\.
If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\.
.
.IP
If \fB\-\-build\-from\-source\fR is passed, compile from source even if a bottle is provided for \fIformula\fR\.
@ -236,13 +236,13 @@ If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD vers
To install a newer version of HEAD use \fBbrew rm <foo> && brew install \-\-HEAD <foo>\fR\.
.
.IP "\(bu" 4
\fBinstall \-\-interactive [\-\-git]\fR \fIformula\fR: Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\.
\fBinstall \-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR: Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\.
.
.IP
If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
.
.IP "\(bu" 4
\fBirb [\-\-examples]\fR: Enter the interactive Homebrew Ruby shell\.
\fBirb\fR [\fB\-\-examples\fR]: Enter the interactive Homebrew Ruby shell\.
.
.IP
If \fB\-\-examples\fR is passed, several examples will be shown\.
@ -251,7 +251,7 @@ If \fB\-\-examples\fR is passed, several examples will be shown\.
\fBleaves\fR: Show installed formulae that are not dependencies of another installed formula\.
.
.IP "\(bu" 4
\fBln\fR, \fBlink [\-\-overwrite] [\-\-dry\-run] [\-\-force]\fR \fIformula\fR: Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
\fBln\fR, \fBlink\fR [\fB\-\-overwrite\fR] [\fB\-\-dry\-run\fR] [\fB\-\-force\fR] \fIformula\fR: Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.IP
If \fB\-\-overwrite\fR is passed, Homebrew will delete files which already exist in the prefix while linking\.
@ -263,7 +263,7 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which
If \fB\-\-force\fR is passed, Homebrew will allow keg\-only formulae to be linked\.
.
.IP "\(bu" 4
\fBlinkapps [\-\-local]\fR [\fIformulae\fR]: Find installed formulae that have compiled \fB\.app\fR\-style "application" packages for OS X, and symlink those apps into \fB/Applications\fR, allowing for easier access\.
\fBlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR]: Find installed formulae that have compiled \fB\.app\fR\-style "application" packages for OS X, and symlink those apps into \fB/Applications\fR, allowing for easier access\.
.
.IP
If no \fIformulae\fR are provided, all of them will have their \.apps symlinked\.
@ -272,13 +272,13 @@ If no \fIformulae\fR are provided, all of them will have their \.apps symlinked\
If provided, \fB\-\-local\fR will move them into the user\'s \fB~/Applications\fR directory instead of the system directory\. It may need to be created, first\.
.
.IP "\(bu" 4
\fBls\fR, \fBlist [\-\-full\-name]\fR List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\.
\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR] List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\.
.
.IP "\(bu" 4
\fBls\fR, \fBlist \-\-unbrewed\fR List all files in the Homebrew prefix not installed by Homebrew\.
.
.IP "\(bu" 4
\fBls\fR, \fBlist [\-\-versions [\-\-multiple]] [\-\-pinned]\fR [\fIformulae\fR]: List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\.
\fBls\fR, \fBlist\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR]: List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\.
.
.IP
If \fB\-\-versions\fR is passed, show the version number for installed formulae, or only the specified formulae if \fIformulae\fR are given\. With \fB\-\-multiple\fR, only show formulae with multiple versions installed\.
@ -287,7 +287,7 @@ If \fB\-\-versions\fR is passed, show the version number for installed formulae,
If \fB\-\-pinned\fR is passed, show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformulae\fR are given\. See also \fBpin\fR, \fBunpin\fR\.
.
.IP "\(bu" 4
\fBlog [git\-log\-options]\fR \fIformula\fR \.\.\.: Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
\fBlog\fR [\fBgit\-log\-options\fR] \fIformula\fR \.\.\.: Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
.
.IP "\(bu" 4
\fBmissing\fR [\fIformulae\fR]: Check the given \fIformulae\fR for missing dependencies\.
@ -296,13 +296,13 @@ If \fB\-\-pinned\fR is passed, show the versions of pinned formulae, or only the
If no \fIformulae\fR are given, check all installed brews\.
.
.IP "\(bu" 4
\fBmigrate [\-\-force]\fR \fIformulae\fR: Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\.
\fBmigrate\fR [\fB\-\-force\fR] \fIformulae\fR: Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\.
.
.IP
If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fIformulae\fR like if they are from same taps and migrate them anyway\.
.
.IP "\(bu" 4
\fBoptions [\-\-compact] [\-\-all] [\-\-installed]\fR \fIformula\fR: Display install options specific to \fIformula\fR\.
\fBoptions\fR [\fB\-\-compact\fR] [\fB\-\-all\fR] [\fB\-\-installed\fR] \fIformula\fR: Display install options specific to \fIformula\fR\.
.
.IP
If \fB\-\-compact\fR is passed, show all options on a single line separated by spaces\.
@ -314,7 +314,7 @@ If \fB\-\-all\fR is passed, show options for all formulae\.
If \fB\-\-installed\fR is passed, show options for all installed formulae\.
.
.IP "\(bu" 4
\fBoutdated [\-\-quiet | \-\-verbose | \-\-json=v1 ]\fR: Show formulae that have an updated version available\.
\fBoutdated\fR [\fB\-\-quiet\fR | \fB\-\-verbose\fR | \fB\-\-json=v1\fR ]: Show formulae that have an updated version available\.
.
.IP
By default, version information is displayed in interactive shells, and suppressed otherwise\.
@ -326,7 +326,7 @@ If \fB\-\-quiet\fR is passed, list only the names of outdated brews (takes prece
If \fB\-\-verbose\fR is passed, display detailed version information\.
.
.IP
If \fB\-\-json=<version>\fR is passed, the output will be in JSON format\. The only valid version is \fBv1\fR\.
If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. The only valid version is \fBv1\fR\.
.
.IP "\(bu" 4
\fBpin\fR \fIformulae\fR: Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\.
@ -338,7 +338,7 @@ If \fB\-\-json=<version>\fR is passed, the output will be in JSON format\. The o
\fBreinstall\fR \fIformula\fR: Uninstall then install \fIformula\fR
.
.IP "\(bu" 4
\fBrm\fR, \fBremove\fR, \fBuninstall [\-\-force]\fR \fIformula\fR: Uninstall \fIformula\fR\.
\fBrm\fR, \fBremove\fR, \fBuninstall\fR [\fB\-\-force\fR] \fIformula\fR: Uninstall \fIformula\fR\.
.
.IP
If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
@ -347,28 +347,28 @@ If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR i
\fBsearch\fR, \fB\-S\fR: Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\.
.
.IP "\(bu" 4
\fBsearch\fR, \fB\-S\fR \fItext\fR|/\fItext\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\.
\fBsearch\fR, \fB\-S\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\.
.
.IP "\(bu" 4
\fBsearch \-\-debian\fR|\fB\-\-fedora\fR|\fB\-\-fink\fR|\fB\-\-macports\fR|\fB\-\-opensuse\fR|\fB\-\-ubuntu\fR \fItext\fR: Search for \fItext\fR in the given package manager\'s list\.
.
.IP "\(bu" 4
\fBsh [\-\-env=std]\fR: Instantiate a Homebrew build environment\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in a Xcode\-only configuration since it adds tools like make to your PATH which otherwise build\-systems would not find\.
\fBsh\fR [\fB\-\-env=std\fR]: Instantiate a Homebrew build environment\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build\-systems would not find\.
.
.IP "\(bu" 4
\fBswitch\fR \fIname\fR \fIversion\fR: Symlink all of the specific \fIversion\fR of \fIname\fR\'s install to Homebrew prefix\.
.
.IP "\(bu" 4
\fBtap\fR [\-\-full] [<user/repo>] [\fIURL\fR]: Tap a formula repository or list existing taps\. This command can be invoked in three ways\.
\fBtap\fR [\fB\-\-full\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]: Tap a formula repository or list existing taps\. This command can be invoked in three ways\.
.
.IP "\(bu" 4
\fBtap\fR without arguments displays existing taps\.
.
.IP "\(bu" 4
\fBtap <user/repo>\fR taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBtap user/repo https://github\.com/#{user}/homebrew\-#{repo}\fR\.
\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR\fBtaps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for\fRtap \fIuser\fR/\fIrepo\fR https://github\.com/\fIuser\fR/homebrew\-\fIrepo\fR`\.
.
.IP "\(bu" 4
\fBtap <user/repo> <URL>\fR taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\.
\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fIURL\fR taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\.
.
.IP "" 0
.
@ -388,7 +388,7 @@ By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR), but
\fBtap\-info\fR \fItap\fR: Display information about \fItap\fR\.
.
.IP "\(bu" 4
\fBtap\-info \-\-json=<version>\fR (\-\-installed|\fItaps\fR): Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
\fBtap\-info\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-installed\fR|\fItaps\fR): Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
.
.IP
Pass \fB\-\-installed\fR to get information on installed taps\.
@ -403,7 +403,7 @@ See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/hom
\fBtap\-unpin\fR \fItap\fR: Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\.
.
.IP "\(bu" 4
\fBtest\fR [\-\-devel|\-\-HEAD] [\-\-debug] \fIformula\fR: A few formulae provide a test method\. \fBbrew test <formula>\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\.
\fBtest\fR [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-debug\fR] \fIformula\fR: A few formulae provide a test method\. \fBbrew test\fR \fIformula\fR runs this test method\. There is no standard output or return code, but it should generally indicate to the user if something is wrong with the installed formula\.
.
.IP
To test the development or head version of a formula, use \fB\-\-devel\fR or \fB\-\-HEAD\fR\.
@ -415,19 +415,19 @@ If \fB\-\-debug\fR is passed and the test fails, an interactive debugger will be
Example: \fBbrew install jruby && brew test jruby\fR
.
.IP "\(bu" 4
\fBunlink [\-\-dry\-run]\fR \fIformula\fR: Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
\fBunlink\fR [\fB\-\-dry\-run\fR] \fIformula\fR: Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
.
.IP
If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which would be unlinked, but will not actually unlink or delete any files\.
.
.IP "\(bu" 4
\fBunlinkapps [\-\-local]\fR [\fIformulae\fR]: Removes links created by \fBbrew linkapps\fR\.
\fBunlinkapps\fR [\fB\-\-local\fR] [\fIformulae\fR]: Removes links created by \fBbrew linkapps\fR\.
.
.IP
If no \fIformulae\fR are provided, all linked app will be removed\.
.
.IP "\(bu" 4
\fBunpack [\-\-git|\-\-patch] [\-\-destdir=<path>]\fR \fIformulae\fR: Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=<path>\fR is given, the subdirectories will be created in the directory named by \fB<path>\fR instead\.
\fBunpack\fR [\fB\-\-git\fR|\fB\-\-patch\fR] [\fB\-\-destdir=\fR\fIpath\fR] \fIformulae\fR: Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=\fR\fIpath\fR is given, the subdirectories will be created in the directory named by \fB<path>\fR instead\.
.
.IP
If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the unpacked source\.
@ -442,13 +442,13 @@ If \fB\-\-git\fR is passed, a Git repository will be initalized in the unpacked
\fBuntap\fR \fItap\fR: Remove a tapped repository\.
.
.IP "\(bu" 4
\fBupdate [\-\-rebase]\fR: Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\.
\fBupdate\fR [\fB\-\-rebase\fR]: Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\.
.
.IP
If \fB\-\-rebase\fR is specified then \fBgit pull \-\-rebase\fR is used\.
.
.IP "\(bu" 4
\fBupgrade [install\-options] [\-\-cleanup]\fR [\fIformulae\fR]: Upgrade outdated, unpinned brews\.
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fIformulae\fR]: Upgrade outdated, unpinned brews\.
.
.IP
Options for the \fBinstall\fR command are also valid here\.
@ -460,7 +460,7 @@ If \fB\-\-cleanup\fR is specified then remove previously installed \fIformula\fR
If \fIformulae\fR are given, upgrade only the specified brews (but do so even if they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.IP "\(bu" 4
\fBuses [\-\-installed] [\-\-recursive] [\-\-skip\-build] [\-\-skip\-optional] [\-\-devel|\-\-HEAD]\fR \fIformulae\fR: Show the formulae that specify \fIformulae\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformulae\fR\.
\fBuses\fR [\fB\-\-installed\fR] [\fB\-\-recursive\fR] [\fB\-\-skip\-build\fR] [\fB\-\-skip\-optional\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformulae\fR: Show the formulae that specify \fIformulae\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformulae\fR\.
.
.IP
Use \fB\-\-recursive\fR to resolve more than one level of dependencies\.
@ -504,7 +504,7 @@ By default, \fBuses\fR shows usages of \fBformula\fR by stable builds\. To find
.IP "" 0
.
.SH "EXTERNAL COMMANDS"
Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the PATH, named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR, which can be invoked like \fBbrew cmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.
Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fR, named \fBbrew\-\fR\fIcmdname\fR or \fBbrew\-\fR\fIcmdname\fR\fB\.rb\fR, which can be invoked like \fBbrew\fR \fIcmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.
.
.P
Instructions for creating your own commands can be found in the docs: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External\-Commands\.md\fR
@ -518,7 +518,7 @@ e\.g\. \fBgit\fR, \fBnode\fR, \fBwget\fR\.
.
.TP
The fully\-qualified name of a tapped formula
Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\.
Sometimes a formula from a tapped repository may conflict with one in \fBHomebrew/homebrew\fR\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\.
.
.TP
An arbitrary URL
@ -527,97 +527,97 @@ Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/Homebr
.SH "ENVIRONMENT"
.
.TP
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
When using the S3 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 S3 download strategy will download with a public (unsigned) URL\.
\fBAWS_ACCESS_KEY_ID\fR, \fBAWS_SECRET_ACCESS_KEY\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\.
.
.TP
BROWSER
\fBBROWSER\fR
If set, and \fBHOMEBREW_BROWSER\fR is not, use \fBBROWSER\fR as the web browser when opening project homepages\.
.
.TP
EDITOR
\fBEDITOR\fR
If set, and \fBHOMEBREW_EDITOR\fR and \fBVISUAL\fR are not, use \fBEDITOR\fR as the text editor\.
.
.TP
GIT
\fBGIT\fR
When using Git, Homebrew will use \fBGIT\fR if set, a Homebrew\-built Git if installed, or the system\-provided binary\.
.
.IP
Set this to force Homebrew to use a particular git binary\.
.
.TP
HOMEBREW_BOTTLE_DOMAIN
\fBHOMEBREW_BOTTLE_DOMAIN\fR
If set, instructs Homebrew to use the given URL as a download mirror for bottles\.
.
.TP
HOMEBREW_BROWSER
\fBHOMEBREW_BROWSER\fR
If set, uses this setting as the browser when opening project homepages, instead of the OS default browser\.
.
.TP
HOMEBREW_BUILD_FROM_SOURCE
\fBHOMEBREW_BUILD_FROM_SOURCE\fR
If set, instructs Homebrew to compile from source even when a formula provides a bottle\.
.
.TP
HOMEBREW_CACHE
\fBHOMEBREW_CACHE\fR
If set, instructs Homebrew to use the given directory as the download cache\.
.
.IP
\fIDefault:\fR \fB~/Library/Caches/Homebrew\fR if it exists; otherwise, \fB/Library/Caches/Homebrew\fR\.
.
.TP
HOMEBREW_CURL_VERBOSE
\fBHOMEBREW_CURL_VERBOSE\fR
If set, Homebrew will pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\.
.
.TP
HOMEBREW_DEBUG
\fBHOMEBREW_DEBUG\fR
If set, any commands that can emit debugging information will do so\.
.
.TP
HOMEBREW_DEBUG_INSTALL
\fBHOMEBREW_DEBUG_INSTALL\fR
When \fBbrew install \-d\fR or \fBbrew install \-i\fR drops into a shell, \fBHOMEBREW_DEBUG_INSTALL\fR will be set to the name of the formula being brewed\.
.
.TP
HOMEBREW_DEBUG_PREFIX
\fBHOMEBREW_DEBUG_PREFIX\fR
When \fBbrew install \-d\fR or \fBbrew install \-i\fR drops into a shell, \fBHOMEBREW_DEBUG_PREFIX\fR will be set to the target prefix in the Cellar of the formula being brewed\.
.
.TP
HOMEBREW_DEVELOPER
\fBHOMEBREW_DEVELOPER\fR
If set, Homebrew will print warnings that are only relevant to Homebrew developers (active or budding)\.
.
.TP
HOMEBREW_EDITOR
\fBHOMEBREW_EDITOR\fR
If set, Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
.
.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\.
.
.TP
HOMEBREW_GITHUB_API_TOKEN
\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\.
.
.IP
\fINOTE\fR: Homebrew doesn\'t require permissions for any of the scopes\.
.
.TP
HOMEBREW_LOGS
\fBHOMEBREW_LOGS\fR
If set, Homebrew will use the given directory to store log files\.
.
.TP
HOMEBREW_MAKE_JOBS
\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)\.
.
.IP
\fIDefault:\fR the number of available CPU cores\.
.
.TP
HOMEBREW_NO_EMOJI
\fBHOMEBREW_NO_EMOJI\fR
If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
.
.IP
\fINote:\fR Homebrew will only try to print emoji on Lion or newer\.
.
.TP
HOMEBREW_NO_INSECURE_REDIRECT
\fBHOMEBREW_NO_INSECURE_REDIRECT\fR
If set, Homebrew will not permit redirects from secure HTTPS to insecure HTTP\.
.
.IP
@ -627,37 +627,37 @@ While ensuring your downloads are fully secure, this is likely to cause from\-so
Apache formulae are currently unaffected by this variable and can redirect to plaintext\.
.
.TP
HOMEBREW_NO_GITHUB_API
\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\.
.
.TP
HOMEBREW_INSTALL_BADGE
\fBHOMEBREW_INSTALL_BADGE\fR
Text printed before the installation summary of each successful build\. Defaults to the beer emoji\.
.
.TP
HOMEBREW_SVN
\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\.
.
.IP
Set this to force Homebrew to use a particular svn binary\.
Set this to force Homebrew to use a particular \fBsvn\fR binary\.
.
.TP
HOMEBREW_TEMP
\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 OS X has trouble moving symlinks across volumes when the target does not yet exist\.
.
.IP
This issue typically occurs when using FileVault or custom SSD configurations\.
.
.TP
HOMEBREW_VERBOSE
\fBHOMEBREW_VERBOSE\fR
If set, Homebrew always assumes \fB\-\-verbose\fR when running commands\.
.
.TP
VISUAL
\fBVISUAL\fR
If set, and \fBHOMEBREW_EDITOR\fR is not, use \fBVISUAL\fR as the text editor\.
.
.SH "USING HOMEBREW BEHIND A PROXY"
Homebrew uses several commands for downloading files (e\.g\. curl, git, svn)\. Many of these tools can download via a proxy\. It\'s common for these tools to read proxy parameters from environment variables\.
Homebrew uses several commands for downloading files (e\.g\. \fBcurl\fR, \fBgit\fR, \fBsvn\fR)\. Many of these tools can download via a proxy\. It\'s common for these tools to read proxy parameters from environment variables\.
.
.P
For the majority of cases setting \fBhttp_proxy\fR is enough\. You can set this in your shell profile, or you can use it before a brew command: