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

docs: fix Official External Commands section

Browse Source 
Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
This commit is contained in:
EricFromCanada 2018-10-02 21:56:00 -04:00
parent 88837353fb
commit 997a207889
7 changed files with 339 additions and 361 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,7 +2,7 @@
#: Display all locally available formulae (including tapped ones).
#: No online search is performed.
#:
#: * `search` `--casks`
#: * `search` `--casks`:
#: Display all locally available casks (including tapped ones).
#: No online search is performed.
#:

2
Library/Homebrew/dev-cmd/extract.rb
View File

@ -99,7 +99,7 @@ module Homebrew
def extract_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`extract` [<options>] <formula> <tap>
`extract` [<options>] <formula> <tap>:
Looks through repository history to find the <version> of <formula> and
creates a copy in <tap>/Formula/<formula>@<version>.rb. If the tap is

7
Library/Homebrew/dev-cmd/man.rb
View File

@ -156,10 +156,13 @@ module Homebrew
ronn.close_write
ronn_output = ronn.read
odie "Got no output from ronn!" unless ronn_output
ronn_output.gsub!(%r{</var>`(?=[.!?,;:]?\s)}, "").gsub!(%r{</?var>}, "`") if format_flag == "--markdown"
unless format_flag == "--markdown"
if format_flag == "--markdown"
ronn_output = ronn_output.gsub(%r{</var>`(?=[.!?,;:]?\s)}, "")
.gsub(%r{</?var>}, "`")
elsif format_flag == "--roff"
ronn_output = ronn_output.gsub(%r{<code>(.*?)</code>}, "\\fB\\1\\fR")
.gsub(%r{<var>(.*?)</var>}, "\\fI\\1\\fR")
.gsub(/(^\[?\\fB.+): /, "\\1\n ")
end
target.atomic_write ronn_output
end

3
Library/Homebrew/dev-cmd/pull.rb
View File

@ -1,5 +1,4 @@
#: * `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] [`--warn-on-publish-failure`] [`--bintray-org=`<bintray-org>] [`--test-bot-user=`<test-bot-user>] <patch-source> [<patch-source>]:
#:
#: Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
#: Optionally, installs the formulae changed by the patch.
#:
@ -75,7 +74,7 @@ module Homebrew
def pull_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
pull [<options>] <formula>:
`pull` [<options>] <formula>:
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.

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

@ -60,21 +60,20 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## OFFICIAL EXTERNAL COMMANDS
<%= homebrew_bundle.join("\n ").strip %>
<%= homebrew_bundle.join.strip %>
Homebrew/homebrew-bundle <https://github.com/Homebrew/homebrew-bundle>
**Homebrew/homebrew-bundle**: <https://github.com/Homebrew/homebrew-bundle>
* `cask` [`--version` | `audit` | `cat` | `cleanup` | `create` | `doctor` | `edit` | `fetch` | `home` | `info`]:
Install macOS applications distributed as binaries.
**Homebrew/homebrew-cask**: <https://github.com/Homebrew/homebrew-cask>
Homebrew/homebrew-cask <https://github.com/Homebrew/homebrew-cask>
<%= homebrew_services.join("\n ").strip %>
<%= homebrew_services.join.strip %>
Homebrew/homebrew-services <https://github.com/Homebrew/homebrew-services>
**Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services>
## CUSTOM EXTERNAL COMMANDS
@ -329,6 +328,8 @@ Homebrew Documentation: <https://docs.brew.sh>
See our issues on GitHub:
* Homebrew/brew <https://github.com/Homebrew/brew/issues>
* **Homebrew/brew**:
<https://github.com/Homebrew/brew/issues>
* Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues>
* **Homebrew/homebrew-core**:
<https://github.com/Homebrew/homebrew-core/issues>

161
docs/Manpage.md
View File

@ -455,7 +455,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
Display all locally available formulae (including tapped ones).
No online search is performed.
* `search` `--casks`
* `search` `--casks`:
Display all locally available casks (including tapped ones).
No online search is performed.
@ -794,7 +794,7 @@ Takes a tap [`user``/``repo`] as argument and generates the formula in the speci
no `formula` is provided.
###`extract` [`options`] `formula` `tap`
###`extract` [`options`] `formula` `tap`:
Looks through repository history to find the `version` of `formula` and
creates a copy in `tap`/Formula/`formula`@`version`.rb. If the tap is
@ -850,7 +850,7 @@ Reuploads the stable URL for a formula to Bintray to use it as a mirror.
For example:
brew prof readall
###pull [`options`] `formula`:
###`pull` [`options`] `formula`:
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.
@ -979,140 +979,79 @@ Override warnings and enable potentially unsafe operations.
## OFFICIAL EXTERNAL COMMANDS
* `bundle` `command`:
Bundler for non-Ruby dependencies from Homebrew.
Bundler for non-Ruby dependencies from Homebrew.
`brew bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]:
Install or upgrade all dependencies in a Brewfile.
`brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`]:
Write all installed casks/formulae/taps into a Brewfile.
`bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]:
`brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`]:
Uninstall all dependencies not listed in a Brewfile.
Install or upgrade all dependencies in a Brewfile.
`brew bundle check` [`--no-upgrade`] [`--file=``path`|`--global`] [`--verbose`]:
Check if all dependencies are installed in a Brewfile. Missing dependencies are listed in verbose mode.
`check` will exit on the first category missing a dependency unless in verbose mode.
`brew bundle exec` `command`:
Run an external command in an isolated build environment.
`brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`]
`brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`]:
List all dependencies present in a Brewfile, optionally limiting by types.
By default, only brew dependencies are output.
Write all installed casks/formulae/taps into a Brewfile.
If `-v` or `--verbose` are passed, print verbose output.
If `--no-upgrade` is passed, don't run `brew upgrade` on outdated dependencies.
Note they may still be upgraded by `brew install` if needed.
`brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`]
If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile.
Uninstall all dependencies not listed in a Brewfile.
If `--zap` is passed, casks will be removed using the `zap` command instead of `uninstall`.
If `--file=``path` is passed, the Brewfile path is set accordingly.
Use `--file=-` to output to console.
`brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`] [`--verbose`]
If `--global` is passed, set the Brewfile path to `~/.Brewfile`.
Check if all dependencies are installed in a Brewfile. Missing dependencies are listed in verbose mode. `check` will exit on the first category missing a dependency unless in verbose mode.
If `--describe` is passed, output a description comment above each line.
This comment will not be output if the dependency does not have a description.
If `-h` or `--help` are passed, print this help message and exit.
`brew bundle exec` `command`
Run an external command in an isolated build environment.
`brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`]
List all dependencies present in a Brewfile, optionally limiting by types.
By default, only brew dependencies are output.
If `-v` or `--verbose` are passed, print verbose output.
If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies.
Note they may still be upgraded by `brew install` if needed.
If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile.
If `--zap` is passed, casks will be removed using the `zap` command instead of `uninstall`.
If `--file=`path is passed, the Brewfile path is set accordingly
Use `--file=-` to output to console.
If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`.
If `--describe` is passed, output a description comment above each line.
This comment will not be output if the dependency does not have a description.
If `-h` or `--help` are passed, print this help message and exit.
Homebrew/homebrew-bundle <https://github.com/Homebrew/homebrew-bundle>
**Homebrew/homebrew-bundle**: <https://github.com/Homebrew/homebrew-bundle>
* `cask` [`--version` | `audit` | `cat` | `cleanup` | `create` | `doctor` | `edit` | `fetch` | `home` | `info`]:
Install macOS applications distributed as binaries.
Homebrew/homebrew-cask <https://github.com/Homebrew/homebrew-cask>
**Homebrew/homebrew-cask**: <https://github.com/Homebrew/homebrew-cask>
* `services` `command`:
Integrates Homebrew formulae with macOS' `launchctl` manager.
Integrates Homebrew formulae with macOS' `launchctl` manager.
[`sudo`] `brew services list`:
List all running services for the current user (or root).
[`sudo`] `brew services run` (`formula`|`--all`):
Run the service `formula` without registering to launch at login (or boot).
[`sudo`] `brew services list`
[`sudo`] `brew services start` (`formula`|`--all`):
Start the service `formula` immediately and register it to launch at login (or boot).
List all running services for the current user (or `root`)
[`sudo`] `brew services stop` (`formula`|`--all`):
Stop the service `formula` immediately and unregister it from launching at login (or boot).
[`sudo`] `brew services restart` (`formula`|`--all`):
Stop (if necessary) and start the service `formula` immediately and register it to launch at login (or boot).
[`sudo`] `brew services run` `formula|--all`
[`sudo`] `brew services cleanup`:
Remove all unused services.
Run the service `formula` without starting at login (or boot).
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents` (started at login).
[`sudo`] `brew services` `start` `formula|--all`
Start the service `formula` immediately and register it to launch at login (or `boot`).
[`sudo`] `brew services` `stop` `formula|--all`
Stop the service `formula` immediately and unregister it from launching at login (or `boot`).
[`sudo`] `brew services` `restart` `formula|--all`
Stop (if necessary) and start the service immediately and register it to launch at login (or `boot`).
[`sudo`] `brew services` `cleanup`
Remove all unused services.
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents (started at login)`.
Homebrew/homebrew-services <https://github.com/Homebrew/homebrew-services>
**Homebrew/homebrew-services**: <https://github.com/Homebrew/homebrew-services>
## CUSTOM EXTERNAL COMMANDS
@ -1367,9 +1306,11 @@ Former maintainers with significant contributions include Dominyk Tiller, Tim Sm
See our issues on GitHub:
* Homebrew/brew <https://github.com/Homebrew/brew/issues>
* **Homebrew/brew**:
<https://github.com/Homebrew/brew/issues>
* Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues>
* **Homebrew/homebrew-core**:
<https://github.com/Homebrew/homebrew-core/issues>
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"

508
manpages/brew.1
View File

@ -43,20 +43,25 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
.
.SH "COMMANDS"
.
.IP "\(bu" 4
\fB\-\-cache\fR: Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
.TP
\fB\-\-cache\fR
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
.
.IP "\(bu" 4
\fB\-\-cache\fR [\fB\-\-build\-from\-source\fR|\fB\-s\fR] [\fB\-\-force\-bottle\fR] \fIformula\fR: Display the file or directory used to cache \fIformula\fR\.
.TP
\fB\-\-cache\fR [\fB\-\-build\-from\-source\fR|\fB\-s\fR] [\fB\-\-force\-bottle\fR] \fIformula\fR
Display the file or directory used to cache \fIformula\fR\.
.
.IP "\(bu" 4
\fB\-\-cellar\fR: Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\.
.TP
\fB\-\-cellar\fR
Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\.
.
.IP "\(bu" 4
\fB\-\-cellar\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.TP
\fB\-\-cellar\fR \fIformula\fR
Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.IP "\(bu" 4
\fB\-\-env\fR [\fB\-\-shell=\fR(\fIshell\fR|\fBauto\fR)|\fB\-\-plain\fR]: Show a summary of the Homebrew build environment as a plain list\.
.TP
\fB\-\-env\fR [\fB\-\-shell=\fR(\fIshell\fR|\fBauto\fR)|\fB\-\-plain\fR]
Show a summary of the Homebrew build environment as a plain list\.
.
.IP
Pass \fB\-\-shell=\fR\fIshell\fR to generate a list of environment variables for the specified shell, or \fB\-\-shell=auto\fR to detect the current shell\.
@ -64,35 +69,45 @@ Pass \fB\-\-shell=\fR\fIshell\fR to generate a list of environment variables for
.IP
If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\.
.
.IP "\(bu" 4
\fB\-\-prefix\fR: Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux
.TP
\fB\-\-prefix\fR
Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux
.
.IP "\(bu" 4
\fB\-\-prefix\fR \fIformula\fR: Display the location in the cellar where \fIformula\fR is or would be installed\.
.TP
\fB\-\-prefix\fR \fIformula\fR
Display the location in the cellar where \fIformula\fR is or would be installed\.
.
.IP "\(bu" 4
\fB\-\-repository\fR: Display where Homebrew\'s \fB\.git\fR directory is located\.
.TP
\fB\-\-repository\fR
Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.IP "\(bu" 4
\fB\-\-repository\fR \fIuser\fR\fB/\fR\fIrepo\fR: Display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.TP
\fB\-\-repository\fR \fIuser\fR\fB/\fR\fIrepo\fR
Display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.IP "\(bu" 4
\fB\-\-version\fR: Print the version number of Homebrew to standard output and exit\.
.TP
\fB\-\-version\fR
Print the version number of Homebrew to standard output and exit\.
.
.IP "\(bu" 4
\fBanalytics\fR [\fBstate\fR]: Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.TP
\fBanalytics\fR [\fBstate\fR]
Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.IP "\(bu" 4
\fBanalytics\fR (\fBon\fR|\fBoff\fR): Turn on/off Homebrew\'s analytics\.
.TP
\fBanalytics\fR (\fBon\fR|\fBoff\fR)
Turn on/off Homebrew\'s analytics\.
.
.IP "\(bu" 4
\fBanalytics\fR \fBregenerate\-uuid\fR: Regenerate UUID used in Homebrew\'s analytics\.
.TP
\fBanalytics\fR \fBregenerate\-uuid\fR
Regenerate UUID used in Homebrew\'s analytics\.
.
.IP "\(bu" 4
\fBcat\fR \fIformula\fR: Display the source to \fIformula\fR\.
.TP
\fBcat\fR \fIformula\fR
Display the source to \fIformula\fR\.
.
.IP "\(bu" 4
\fBcleanup\fR [\fB\-\-prune=\fR\fIdays\fR] [\fB\-\-dry\-run\fR] [\fB\-s\fR] [<formula/cask> \.\.\.]: Remove stale lock files and outdated downloads for formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the specified formulae and casks\.
.TP
\fBcleanup\fR [\fB\-\-prune=\fR\fIdays\fR] [\fB\-\-dry\-run\fR] [\fB\-s\fR] [<formula/cask> \.\.\.]
Remove stale lock files and outdated downloads for formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the specified formulae and casks\.
.
.IP
If \fB\-\-prune=\fR\fIdays\fR is specified, remove all cache files older than \fIdays\fR\.
@ -103,20 +118,24 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do
.IP
If \fB\-s\fR is passed, scrub the cache, including downloads for even the latest versions\. Note downloads for any installed formula or cask 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\fR \fIcmd\fR\.
.TP
\fBcommand\fR \fIcmd\fR
Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\.
.
.IP "\(bu" 4
\fBcommands\fR [\fB\-\-quiet\fR [\fB\-\-include\-aliases\fR]]: Show a list of built\-in and external commands\.
.TP
\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\.
.
.IP "\(bu" 4
\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\.
.TP
\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
\fBdeps\fR [\fB\-\-1\fR] [\fB\-n\fR] [\fB\-\-union\fR] [\fB\-\-full\-name\fR] [\fB\-\-installed\fR] [\fB\-\-include\-build\fR] [\fB\-\-include\-optional\fR] [\fB\-\-skip\-recommended\fR] [\fB\-\-include\-requirements\fR] \fIformulae\fR: Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR\.
.TP
\fBdeps\fR [\fB\-\-1\fR] [\fB\-n\fR] [\fB\-\-union\fR] [\fB\-\-full\-name\fR] [\fB\-\-installed\fR] [\fB\-\-include\-build\fR] [\fB\-\-include\-optional\fR] [\fB\-\-skip\-recommended\fR] [\fB\-\-include\-requirements\fR] \fIformulae\fR
Show dependencies for \fIformulae\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformulae\fR\.
.
.IP
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
@ -136,8 +155,9 @@ If \fB\-\-installed\fR is passed, only list those dependencies that are currentl
.IP
By default, \fBdeps\fR shows required and recommended dependencies for \fIformulae\fR\. To include the \fB:build\fR type dependencies, pass \fB\-\-include\-build\fR\. Similarly, pass \fB\-\-include\-optional\fR to include \fB:optional\fR dependencies or \fB\-\-include\-test\fR to include (non\-recursive) \fB:test\fR dependencies\. To skip \fB:recommended\fR type dependencies, pass \fB\-\-skip\-recommended\fR\. To include requirements in addition to dependencies, pass \fB\-\-include\-requirements\fR\.
.
.IP "\(bu" 4
\fBdeps\fR \fB\-\-tree\fR [\fB\-\-1\fR] [\fIfilters\fR] [\fB\-\-annotate\fR] (\fIformulae\fR|\fB\-\-installed\fR): Show dependencies as a tree\. When given multiple formula arguments, output individual trees for every formula\.
.TP
\fBdeps\fR \fB\-\-tree\fR [\fB\-\-1\fR] [\fIfilters\fR] [\fB\-\-annotate\fR] (\fIformulae\fR|\fB\-\-installed\fR)
Show dependencies as a tree\. When given multiple formula arguments, output individual trees for every formula\.
.
.IP
If \fB\-\-1\fR is passed, only one level of children is displayed\.
@ -151,20 +171,24 @@ The \fIfilters\fR placeholder is any combination of options \fB\-\-include\-buil
.IP
If \fB\-\-annotate\fR is passed, the build, optional, and recommended dependencies are marked as such in the output\.
.
.IP "\(bu" 4
\fBdeps\fR [\fIfilters\fR] (\fB\-\-installed\fR|\fB\-\-all\fR): Show dependencies for installed or all available formulae\. Every line of output starts with the formula name, followed by a colon and all direct dependencies of that formula\.
.TP
\fBdeps\fR [\fIfilters\fR] (\fB\-\-installed\fR|\fB\-\-all\fR)
Show dependencies for installed or all available formulae\. Every line of output starts with the formula name, followed by a colon and all direct dependencies of that formula\.
.
.IP
The \fIfilters\fR placeholder is any combination of options \fB\-\-include\-build\fR, \fB\-\-include\-optional\fR, \fB\-\-include\-test\fR, and \fB\-\-skip\-recommended\fR as documented above\.
.
.IP "\(bu" 4
\fBdesc\fR \fIformula\fR: Display \fIformula\fR\'s name and one\-line description\.
.TP
\fBdesc\fR \fIformula\fR
Display \fIformula\fR\'s name and one\-line description\.
.
.IP "\(bu" 4
\fBdesc\fR [\fB\-\-search\fR|\fB\-\-name\fR|\fB\-\-description\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR): Search both name and description (\fB\-\-search\fR or \fB\-s\fR), just the names (\fB\-\-name\fR or \fB\-n\fR), or just the descriptions (\fB\-\-description\fR or \fB\-d\fR) for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
.TP
\fBdesc\fR [\fB\-\-search\fR|\fB\-\-name\fR|\fB\-\-description\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR)
Search both name and description (\fB\-\-search\fR or \fB\-s\fR), just the names (\fB\-\-name\fR or \fB\-n\fR), or just the descriptions (\fB\-\-description\fR or \fB\-d\fR) for \fItext\fR\. If \fItext\fR is flanked by slashes, it is 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\fR [\fB\-\-name=\fR\fIname\fR] [\fB\-\-version=\fR\fIversion\fR]: Automatically determine the installation prefix for non\-Homebrew software\.
.TP
\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\.
@ -172,11 +196,13 @@ Using the output from this command, you can install your own software into the C
.IP
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 potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
.TP
\fBdoctor\fR
Check your system for potential problems\. Doctor exits with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
.
.IP "\(bu" 4
\fBfetch\fR [\fB\-\-force\fR] [\fB\-\-retry\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\-256 checksums\.
.TP
\fBfetch\fR [\fB\-\-force\fR] [\fB\-\-retry\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\-256 checksums\.
.
.IP
If \fB\-\-HEAD\fR or \fB\-\-devel\fR is passed, fetch that version instead of the stable version\.
@ -199,8 +225,9 @@ If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, download the source r
.IP
If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
.
.IP "\(bu" 4
\fBgist\-logs\fR [\fB\-\-new\-issue\fR|\fB\-n\fR] \fIformula\fR: Upload logs for a failed build of \fIformula\fR to a new Gist\.
.TP
\fBgist\-logs\fR [\fB\-\-new\-issue\fR|\fB\-n\fR] \fIformula\fR
Upload logs for a failed build of \fIformula\fR to a new Gist\.
.
.IP
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\. See \fISPECIFYING FORMULAE\fR\.
@ -214,29 +241,35 @@ If \fB\-\-new\-issue\fR is passed, automatically create a new issue in the appro
.IP
If no logs are found, an error message is presented\.
.
.IP "\(bu" 4
\fBhome\fR: Open Homebrew\'s own homepage in a browser\.
.TP
\fBhome\fR
Open Homebrew\'s own homepage in a browser\.
.
.IP "\(bu" 4
\fBhome\fR \fIformula\fR: Open \fIformula\fR\'s homepage in a browser\.
.TP
\fBhome\fR \fIformula\fR
Open \fIformula\fR\'s homepage in a browser\.
.
.IP "\(bu" 4
\fBinfo\fR: Display brief statistics for your Homebrew installation\.
.TP
\fBinfo\fR
Display brief statistics for your Homebrew installation\.
.
.IP "\(bu" 4
\fBinfo\fR \fIformula\fR (\fB\-\-verbose\fR): Display information about \fIformula\fR and analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)
.TP
\fBinfo\fR \fIformula\fR (\fB\-\-verbose\fR)
Display information about \fIformula\fR and analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)
.
.IP
Pass \fB\-\-verbose\fR to see more detailed analytics data\.
.
.IP "\(bu" 4
\fBinfo\fR \fB\-\-github\fR \fIformula\fR: Open a browser to the GitHub History page for \fIformula\fR\.
.TP
\fBinfo\fR \fB\-\-github\fR \fIformula\fR
Open a browser to the GitHub History page for \fIformula\fR\.
.
.IP
To view formula history locally: \fBbrew log \-p <formula>\fR
.
.IP "\(bu" 4
\fBinfo\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR): Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
.TP
\fBinfo\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR)
Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\.
.
.IP
Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\.
@ -244,8 +277,9 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to
.IP
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.IP "\(bu" 4
\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-include\-test\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] [\fB\-\-display\-times\fR] \fIformula\fR [\fIoptions\fR \.\.\.]: Install \fIformula\fR\.
.TP
\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-include\-test\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] [\fB\-\-display\-times\fR] \fIformula\fR [\fIoptions\fR \.\.\.]
Install \fIformula\fR\.
.
.IP
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\. See \fISPECIFYING FORMULAE\fR\.
@ -304,17 +338,20 @@ If \fB\-\-display\-times\fR is passed, install times for each formula are printe
.IP
Installation options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\.
.
.IP "\(bu" 4
\fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR: If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, 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\.
.TP
\fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR
If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, 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 (or \fB\-g\fR) is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
.
.IP "\(bu" 4
\fBleaves\fR: Show installed formulae that are not dependencies of another installed formula\.
.TP
\fBleaves\fR
Show installed formulae that are not dependencies of another installed formula\.
.
.IP "\(bu" 4
\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\.
.TP
\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\.
@ -325,14 +362,17 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which
.IP
If \fB\-\-force\fR (or \fB\-f\fR) is passed, Homebrew will allow keg\-only formulae to be linked\.
.
.IP "\(bu" 4
\fBlist\fR, \fBls\fR [\fB\-\-full\-name\fR] [\fB\-1\fR] [\fB\-l\fR] [\fB\-t\fR] [\fB\-r\fR]: List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-t\fR and \fB\-r\fR) are passed to \fBls\fR which produces the actual output\.
.TP
\fBlist\fR, \fBls\fR [\fB\-\-full\-name\fR] [\fB\-1\fR] [\fB\-l\fR] [\fB\-t\fR] [\fB\-r\fR]
List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-t\fR and \fB\-r\fR) are passed to \fBls\fR which produces the actual output\.
.
.IP "\(bu" 4
\fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR: List all files in the Homebrew prefix not installed by Homebrew\.
.TP
\fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR
List all files in the Homebrew prefix not installed by Homebrew\.
.
.IP "\(bu" 4
\fBlist\fR, \fBls\fR [\fB\-\-verbose\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\.
.TP
\fBlist\fR, \fBls\fR [\fB\-\-verbose\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\.
@ -340,17 +380,20 @@ If \fB\-\-versions\fR is passed, show the version number for installed formulae,
.IP
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\fR [\fIgit\-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\.
.TP
\fBlog\fR [\fIgit\-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
\fBmigrate\fR [\fB\-\-force\fR] \fIformulae\fR: Migrate renamed packages to new name, where \fIformulae\fR are old names of packages\.
.TP
\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 (or \fB\-f\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
\fBmissing\fR [\fB\-\-hide=\fR\fIhidden\fR] [\fIformulae\fR]: Check the given \fIformulae\fR for missing dependencies\. If no \fIformulae\fR are given, check all installed brews\.
.TP
\fBmissing\fR [\fB\-\-hide=\fR\fIhidden\fR] [\fIformulae\fR]
Check the given \fIformulae\fR for missing dependencies\. If no \fIformulae\fR are given, check all installed brews\.
.
.IP
If \fB\-\-hide=\fR\fIhidden\fR is passed, act as if none of \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
@ -358,8 +401,9 @@ If \fB\-\-hide=\fR\fIhidden\fR is passed, act as if none of \fIhidden\fR are ins
.IP
\fBmissing\fR exits with a non\-zero status if any formulae are missing dependencies\.
.
.IP "\(bu" 4
\fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR): Display install options specific to \fIformulae\fR\.
.TP
\fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR)
Display install options specific to \fIformulae\fR\.
.
.IP
If \fB\-\-compact\fR is passed, show all options on a single line separated by spaces\.
@ -370,8 +414,9 @@ If \fB\-\-all\fR is passed, show options for all formulae\.
.IP
If \fB\-\-installed\fR is passed, show options for all installed formulae\.
.
.IP "\(bu" 4
\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=\fR\fIversion\fR] [\fB\-\-fetch\-HEAD\fR]: Show formulae that have an updated version available\.
.TP
\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=\fR\fIversion\fR] [\fB\-\-fetch\-HEAD\fR]
Show formulae that have an updated version available\.
.
.IP
By default, version information is displayed in interactive shells, and suppressed otherwise\.
@ -388,20 +433,24 @@ If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. C
.IP
If \fB\-\-fetch\-HEAD\fR is passed, fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or devel version has been released\.
.
.IP "\(bu" 4
\fBpin\fR \fIformulae\fR: Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade <formulae>\fR command\. See also \fBunpin\fR\.
.TP
\fBpin\fR \fIformulae\fR
Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade <formulae>\fR command\. See also \fBunpin\fR\.
.
.IP "\(bu" 4
\fBpostinstall\fR \fIformula\fR: Rerun the post\-install steps for \fIformula\fR\.
.TP
\fBpostinstall\fR \fIformula\fR
Rerun the post\-install steps for \fIformula\fR\.
.
.IP "\(bu" 4
\fBprune\fR [\fB\-\-dry\-run\fR]: Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
.TP
\fBprune\fR [\fB\-\-dry\-run\fR]
Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
.
.IP
If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\.
.
.IP "\(bu" 4
\fBreadall\fR [\fB\-\-aliases\fR] [\fB\-\-syntax\fR] [\fItaps\fR]: Import all formulae from specified \fItaps\fR (defaults to all installed taps)\.
.TP
\fBreadall\fR [\fB\-\-aliases\fR] [\fB\-\-syntax\fR] [\fItaps\fR]
Import all formulae from specified \fItaps\fR (defaults to all installed taps)\.
.
.IP
This can be useful for debugging issues across all formulae when making significant changes to \fBformula\.rb\fR, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues\.
@ -412,35 +461,42 @@ If \fB\-\-aliases\fR is passed, also verify any alias symlinks in each tap\.
.IP
If \fB\-\-syntax\fR is passed, also syntax\-check all of Homebrew\'s Ruby files\.
.
.IP "\(bu" 4
\fBreinstall\fR [\fB\-\-display\-times\fR] \fIformula\fR: Uninstall and then install \fIformula\fR (with existing install options)\.
.TP
\fBreinstall\fR [\fB\-\-display\-times\fR] \fIformula\fR
Uninstall and then install \fIformula\fR (with existing install options)\.
.
.IP
If \fB\-\-display\-times\fR is passed, install times for each formula are printed at the end of the run\.
.
.IP "\(bu" 4
\fBsearch\fR, \fB\-S\fR: Display all locally available formulae (including tapped ones)\. No online search is performed\.
.TP
\fBsearch\fR, \fB\-S\fR
Display all locally available formulae (including tapped ones)\. No online search is performed\.
.
.IP "\(bu" 4
\fBsearch\fR \fB\-\-casks\fR Display all locally available casks (including tapped ones)\. No online search is performed\.
.TP
\fBsearch\fR \fB\-\-casks\fR
Display all locally available casks (including tapped ones)\. No online search is performed\.
.
.IP "\(bu" 4
\fBsearch\fR [\fB\-\-desc\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR): Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to official taps\.
.TP
\fBsearch\fR [\fB\-\-desc\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR)
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to official taps\.
.
.IP
If \fB\-\-desc\fR is passed, search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
.
.IP "\(bu" 4
\fBsearch\fR (\fB\-\-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\.
.TP
\fBsearch\fR (\fB\-\-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\fR [\fB\-\-env=std\fR]: Start a Homebrew build environment shell\. 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\.
.TP
\fBsh\fR [\fB\-\-env=std\fR]
Start a Homebrew build environment shell\. 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
If \fB\-\-env=std\fR is passed, use the standard \fBPATH\fR instead of superenv\'s\.
.
.IP "\(bu" 4
\fBstyle\fR [\fB\-\-fix\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-only\-cops=\fR\fIcops\fR|\fB\-\-except\-cops=\fR\fIcops\fR] [\fIfiles\fR|\fItaps\fR|\fIformulae\fR]: Check formulae or files for conformance to Homebrew style guidelines\.
.TP
\fBstyle\fR [\fB\-\-fix\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-only\-cops=\fR\fIcops\fR|\fB\-\-except\-cops=\fR\fIcops\fR] [\fIfiles\fR|\fItaps\fR|\fIformulae\fR]
Check formulae or files for conformance to Homebrew style guidelines\.
.
.IP
Lists of \fIfiles\fR, \fItaps\fR and \fIformulae\fR may not be combined\. If none are provided, \fBstyle\fR will run style checks on the whole Homebrew library, including core code and all formulae\.
@ -457,20 +513,24 @@ Passing \fB\-\-only\-cops=\fR\fIcops\fR will check for violations of only the li
.IP
Exits with a non\-zero status if any style violations are found\.
.
.IP "\(bu" 4
\fBswitch\fR \fIformula\fR \fIversion\fR: Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\.
.TP
\fBswitch\fR \fIformula\fR \fIversion\fR
Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\.
.
.IP "\(bu" 4
\fBtap\-info\fR: Display a brief summary of all installed taps\.
.TP
\fBtap\-info\fR
Display a brief summary of all installed taps\.
.
.IP "\(bu" 4
\fBtap\-info\fR (\fB\-\-installed\fR|\fItaps\fR): Display detailed information about one or more \fItaps\fR\.
.TP
\fBtap\-info\fR (\fB\-\-installed\fR|\fItaps\fR)
Display detailed information about one or more \fItaps\fR\.
.
.IP
Pass \fB\-\-installed\fR to display information on all installed taps\.
.
.IP "\(bu" 4
\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\.
.TP
\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\.
@ -478,17 +538,21 @@ Pass \fB\-\-installed\fR to get information on installed taps\.
.IP
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.IP "\(bu" 4
\fBtap\-pin\fR \fItap\fR: Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\.
.TP
\fBtap\-pin\fR \fItap\fR
Pin \fItap\fR, prioritizing its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\.
.
.IP "\(bu" 4
\fBtap\-unpin\fR \fItap\fR: Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\.
.TP
\fBtap\-unpin\fR \fItap\fR
Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\fR\.
.
.IP "\(bu" 4
\fBtap\fR: List all installed taps\.
.TP
\fBtap\fR
List all installed taps\.
.
.IP "\(bu" 4
\fBtap\fR [\fB\-\-full\fR] [\fB\-\-force\-auto\-update\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]: Tap a formula repository\.
.TP
\fBtap\fR [\fB\-\-full\fR] [\fB\-\-force\-auto\-update\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]
Tap a formula repository\.
.
.IP
With \fIURL\fR unspecified, 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\.
@ -505,14 +569,17 @@ By default, only taps hosted on GitHub are auto\-updated (for performance reason
.IP
\fBtap\fR is re\-runnable and exits successfully if there\'s nothing to do\. However, retapping with a different \fIURL\fR will cause an exception, so first \fBuntap\fR if you need to modify the \fIURL\fR\.
.
.IP "\(bu" 4
\fBtap\fR \fB\-\-repair\fR: Migrate tapped formulae from symlink\-based to directory\-based structure\.
.TP
\fBtap\fR \fB\-\-repair\fR
Migrate tapped formulae from symlink\-based to directory\-based structure\.
.
.IP "\(bu" 4
\fBtap\fR \fB\-\-list\-pinned\fR: List all pinned taps\.
.TP
\fBtap\fR \fB\-\-list\-pinned\fR
List all pinned taps\.
.
.IP "\(bu" 4
\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fB\-\-force\fR] [\fB\-\-ignore\-dependencies\fR] \fIformula\fR: Uninstall \fIformula\fR\.
.TP
\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fB\-\-force\fR] [\fB\-\-ignore\-dependencies\fR] \fIformula\fR
Uninstall \fIformula\fR\.
.
.IP
If \fB\-\-force\fR (or \fB\-f\fR) is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
@ -520,14 +587,16 @@ If \fB\-\-force\fR (or \fB\-f\fR) is passed, and there are multiple versions of
.IP
If \fB\-\-ignore\-dependencies\fR is passed, uninstalling won\'t fail, even if formulae depending on \fIformula\fR would still be installed\.
.
.IP "\(bu" 4
\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 <formula> && <commands> && brew link <formula>\fR
.TP
\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 <formula> && <commands> && brew link <formula>\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
\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 \fIpath\fR instead\.
.TP
\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 \fIpath\fR instead\.
.
.IP
If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the unpacked source\.
@ -535,14 +604,17 @@ If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the
.IP
If \fB\-\-git\fR (or \fB\-g\fR) is passed, a Git repository will be initialized in the unpacked source\. This is useful for creating patches for the software\.
.
.IP "\(bu" 4
\fBunpin\fR \fIformulae\fR: Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade <formulae>\fR\. See also \fBpin\fR\.
.TP
\fBunpin\fR \fIformulae\fR
Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade <formulae>\fR\. See also \fBpin\fR\.
.
.IP "\(bu" 4
\fBuntap\fR \fItap\fR: Remove a tapped repository\.
.TP
\fBuntap\fR \fItap\fR
Remove a tapped repository\.
.
.IP "\(bu" 4
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fB\-\-ignore\-pinned\fR] [\fB\-\-display\-times\fR] [\fIformulae\fR]: Upgrade outdated, unpinned brews (with existing install options)\.
.TP
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fB\-\-ignore\-pinned\fR] [\fB\-\-display\-times\fR] [\fIformulae\fR]
Upgrade outdated, unpinned brews (with existing install options)\.
.
.IP
Options for the \fBinstall\fR command are also valid here\.
@ -562,8 +634,9 @@ If \fB\-\-display\-times\fR is passed, install times for each formula are printe
.IP
If \fIformulae\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.IP "\(bu" 4
\fBuses\fR [\fB\-\-installed\fR] [\fB\-\-recursive\fR] [\fB\-\-include\-build\fR] [\fB\-\-include\-test\fR] [\fB\-\-include\-optional\fR] [\fB\-\-skip\-recommended\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\.
.TP
\fBuses\fR [\fB\-\-installed\fR] [\fB\-\-recursive\fR] [\fB\-\-include\-build\fR] [\fB\-\-include\-test\fR] [\fB\-\-include\-optional\fR] [\fB\-\-skip\-recommended\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\.
@ -577,8 +650,9 @@ By default, \fBuses\fR shows all formulae that specify \fIformulae\fR as a requi
.IP
By default, \fBuses\fR shows usage of \fIformulae\fR by stable builds\. To find cases where \fIformulae\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\.
.
.IP "\(bu" 4
\fBshellenv\fR: Prints export statements \- run them in a shell and this installation of Homebrew will be included into your PATH, MANPATH, and INFOPATH\.
.TP
\fBshellenv\fR
Prints export statements \- run them in a shell and this installation of Homebrew will be included into your PATH, MANPATH, and INFOPATH\.
.
.IP
HOMEBREW_PREFIX, HOMEBREW_CELLAR and HOMEBREW_REPOSITORY are also exported to save multiple queries of those variables\.
@ -586,11 +660,13 @@ HOMEBREW_PREFIX, HOMEBREW_CELLAR and HOMEBREW_REPOSITORY are also exported to sa
.IP
Consider adding evaluating the output in your dotfiles (e\.g\. \fB~/\.profile\fR) with \fBeval $(brew shellenv)\fR
.
.IP "\(bu" 4
\fBupdate\-reset\fR [\fIrepositories\fR]: Fetches and resets Homebrew and all tap repositories (or the specified \fBrepositories\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
.TP
\fBupdate\-reset\fR [\fIrepositories\fR]
Fetches and resets Homebrew and all tap repositories (or the specified \fBrepositories\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
.
.IP "\(bu" 4
\fBupdate\fR [\fB\-\-merge\fR] [\fB\-\-force\fR]: Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
.TP
\fBupdate\fR [\fB\-\-merge\fR] [\fB\-\-force\fR]
Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
.
.IP
If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
@ -598,8 +674,6 @@ If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates
.IP
If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\.
.
.IP "" 0
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] \fIformulae\fR:"
@ -794,7 +868,7 @@ Takes a tap [\fIuser\fR\fB/\fR\fIrepo\fR] as argument and generates the formula
.SS "\fBedit\fR \fIformula\fR:"
Open \fIformula\fR in the editor\. Open all of Homebrew for editing if no \fIformula\fR is provided\.
.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR"
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR:"
Looks through repository history to find the \fIversion\fR of \fIformula\fR and creates a copy in \fItap\fR/Formula/\fIformula\fR@\fIversion\fR\.rb\. If the tap is not installed yet, attempts to install/clone the tap before continuing\.
.
.TP
@ -851,7 +925,7 @@ Reuploads the stable URL for a formula to Bintray to use it as a mirror\.
\fBprof\fR [\fIruby options\fR]
Run Homebrew with the Ruby profiler\. For example: brew prof readall
.
.SS "pull [\fIoptions\fR] \fIformula\fR:"
.SS "\fBpull\fR [\fIoptions\fR] \fIformula\fR:"
Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\.
.
.P
@ -1014,58 +1088,38 @@ Override warnings and enable potentially unsafe operations\.
.SH "OFFICIAL EXTERNAL COMMANDS"
.
.TP
\fBbundle\fR \fIcommand\fR:
.
.IP
\fBbundle\fR \fIcommand\fR
Bundler for non\-Ruby dependencies from Homebrew\.
.
.IP
\fBbundle\fR [\fBinstall\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-\-no\-upgrade\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR]:
.
.IP
Install or upgrade all dependencies in a Brewfile\.
\fBbrew bundle\fR [\fBinstall\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-\-no\-upgrade\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR]
Install or upgrade all dependencies in a Brewfile\.
.
.IP
\fBbrew bundle dump\fR [\fB\-\-force\fR] [\fB\-\-describe\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR]
.
.IP
Write all installed casks/formulae/taps into a Brewfile\.
Write all installed casks/formulae/taps into a Brewfile\.
.
.IP
\fBbrew bundle cleanup\fR [\fB\-\-force\fR] [\fB\-\-zap\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR]
Uninstall all dependencies not listed in a Brewfile\.
.
.IP
Uninstall all dependencies not listed in a Brewfile\.
.
.IP
\fBbrew bundle check\fR [\fB\-\-no\-upgrade\fR] [\fB\-\-file\fR=\fIpath\fR|\fB\-\-global\fR] [\fB\-\-verbose\fR]
.
.IP
Check if all dependencies are installed in a Brewfile\. Missing dependencies are listed in verbose mode\. \fBcheck\fR will exit on the first category missing a dependency unless in verbose mode\.
\fBbrew bundle check\fR [\fB\-\-no\-upgrade\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR] [\fB\-\-verbose\fR]
Check if all dependencies are installed in a Brewfile\. Missing dependencies are listed in verbose mode\. \fBcheck\fR will exit on the first category missing a dependency unless in verbose mode\.
.
.IP
\fBbrew bundle exec\fR \fIcommand\fR
.
.IP
Run an external command in an isolated build environment\.
Run an external command in an isolated build environment\.
.
.IP
\fBbrew bundle list\fR [\fB\-\-all\fR|\fB\-\-brews\fR|\fB\-\-casks\fR|\fB\-\-taps\fR|\fB\-\-mas\fR] [\fB\-\-file=\fR\fIpath\fR|\fB\-\-global\fR]
.
.IP
List all dependencies present in a Brewfile, optionally limiting by types\.
.
.IP
By default, only brew dependencies are output\.
List all dependencies present in a Brewfile, optionally limiting by types\. By default, only brew dependencies are output\.
.
.IP
If \fB\-v\fR or \fB\-\-verbose\fR are passed, print verbose output\.
.
.IP
If \fB\-\-no\-upgrade\fR is passed, don\'t run \fBbrew upgrade\fR outdated dependencies\.
.
.IP
Note they may still be upgraded by \fBbrew install\fR if needed\.
If \fB\-\-no\-upgrade\fR is passed, don\'t run \fBbrew upgrade\fR on outdated dependencies\. Note they may still be upgraded by \fBbrew install\fR if needed\.
.
.IP
If \fB\-\-force\fR is passed, uninstall dependencies or overwrite an existing Brewfile\.
@ -1074,83 +1128,63 @@ If \fB\-\-force\fR is passed, uninstall dependencies or overwrite an existing Br
If \fB\-\-zap\fR is passed, casks will be removed using the \fBzap\fR command instead of \fBuninstall\fR\.
.
.IP
If \fB\-\-file=<path>\fR is passed, the Brewfile path is set accordingly
If \fB\-\-file=\fR\fIpath\fR is passed, the Brewfile path is set accordingly\. Use \fB\-\-file=\-\fR to output to console\.
.
.IP
Use \fB\-\-file=\-\fR to output to console\.
If \fB\-\-global\fR is passed, set the Brewfile path to \fB~/\.Brewfile\fR\.
.
.IP
If \fB\-\-global\fR is passed, set Brewfile path to \fB$HOME/\.Brewfile\fR\.
.
.IP
If \fB\-\-describe\fR is passed, output a description comment above each line\.
.
.IP
This comment will not be output if the dependency does not have a description\.
If \fB\-\-describe\fR is passed, output a description comment above each line\. This comment will not be output if the dependency does not have a description\.
.
.IP
If \fB\-h\fR or \fB\-\-help\fR are passed, print this help message and exit\.
.
.P
Homebrew/homebrew\-bundle \fIhttps://github\.com/Homebrew/homebrew\-bundle\fR
.IP
\fBHomebrew/homebrew\-bundle\fR
\fIhttps://github\.com/Homebrew/homebrew\-bundle\fR
.
.TP
\fBcask\fR [\fB\-\-version\fR | \fBaudit\fR | \fBcat\fR | \fBcleanup\fR | \fBcreate\fR | \fBdoctor\fR | \fBedit\fR | \fBfetch\fR | \fBhome\fR | \fBinfo\fR]
Install macOS applications distributed as binaries\.
.
.P
Homebrew/homebrew\-cask \fIhttps://github\.com/Homebrew/homebrew\-cask\fR
.IP
\fBHomebrew/homebrew\-cask\fR
\fIhttps://github\.com/Homebrew/homebrew\-cask\fR
.
.TP
\fBservices\fR \fIcommand\fR:
.
.IP
\fBservices\fR \fIcommand\fR
Integrates Homebrew formulae with macOS\' \fBlaunchctl\fR manager\.
.
.IP
[\fIsudo\fR] \fBbrew services list\fR
[\fBsudo\fR] \fBbrew services list\fR
List all running services for the current user (or root)\.
.
.IP
List all running services for the current user (or \fIroot\fR)
[\fBsudo\fR] \fBbrew services run\fR (\fIformula\fR|\fB\-\-all\fR)
Run the service \fIformula\fR without registering to launch at login (or boot)\.
.
.IP
[\fIsudo\fR] \fBbrew services run\fR \fIformula|\-\-all\fR
[\fBsudo\fR] \fBbrew services start\fR (\fIformula\fR|\fB\-\-all\fR)
Start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
.
.IP
Run the service \fIformula\fR without starting at login (or boot)\.
[\fBsudo\fR] \fBbrew services stop\fR (\fIformula\fR|\fB\-\-all\fR)
Stop the service \fIformula\fR immediately and unregister it from launching at login (or boot)\.
.
.IP
[\fIsudo\fR] \fBbrew services\fR \fBstart\fR \fIformula|\-\-all\fR
[\fBsudo\fR] \fBbrew services restart\fR (\fIformula\fR|\fB\-\-all\fR)
Stop (if necessary) and start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
.
.IP
Start the service \fIformula\fR immediately and register it to launch at login (or \fIboot\fR)\.
[\fBsudo\fR] \fBbrew services cleanup\fR
Remove all unused services\.
.
.IP
[\fIsudo\fR] \fBbrew services\fR \fBstop\fR \fIformula|\-\-all\fR
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR (started at login)\.
.
.IP
Stop the service \fIformula\fR immediately and unregister it from launching at login (or \fIboot\fR)\.
.
.IP
[\fIsudo\fR] \fBbrew services\fR \fBrestart\fR \fIformula|\-\-all\fR
.
.IP
Stop (if necessary) and start the service immediately and register it to launch at login (or \fIboot\fR)\.
.
.IP
[\fIsudo\fR] \fBbrew services\fR \fBcleanup\fR
.
.IP
Remove all unused services\.
.
.IP
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\.
.
.IP
Otherwise, operate on \fB~/Library/LaunchAgents (started at login)\fR\.
.
.P
Homebrew/homebrew\-services \fIhttps://github\.com/Homebrew/homebrew\-services\fR
\fBHomebrew/homebrew\-services\fR
\fIhttps://github\.com/Homebrew/homebrew\-services\fR
.
.SH "CUSTOM EXTERNAL COMMANDS"
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\.
@ -1416,11 +1450,11 @@ Former maintainers with significant contributions include Dominyk Tiller, Tim Sm
.SH "BUGS"
See our issues on GitHub:
.
.IP "\(bu" 4
Homebrew/brew \fIhttps://github\.com/Homebrew/brew/issues\fR
.TP
\fBHomebrew/brew\fR
\fIhttps://github\.com/Homebrew/brew/issues\fR
.
.IP "\(bu" 4
Homebrew/homebrew\-core \fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR
.
.IP "" 0
.TP
\fBHomebrew/homebrew\-core\fR
\fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR