From 2446aea729ec0ee60079372535d8d8bd582c11f2 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Wed, 30 Jan 2019 21:35:32 +0000 Subject: [PATCH] manpages: commit updates. --- docs/Manpage.md | 1239 +++++++++++++++++---------------------- manpages/brew.1 | 1466 +++++++++++++++++++++++------------------------ 2 files changed, 1243 insertions(+), 1462 deletions(-) diff --git a/docs/Manpage.md b/docs/Manpage.md index 0e9dcfdc09..7ecec9fa7f 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -18,706 +18,625 @@ For the full command list, see the [COMMANDS](#commands) section. With `--verbose` or `-v`, many commands print extra debugging information. Note that these flags should only appear after a command. - * `install` *`formula`*: - Install *`formula`*. +### `install` *`formula`*: - * `uninstall` *`formula`*: - Uninstall *`formula`*. +Install *`formula`*. - * `update`: - Fetch the newest version of Homebrew from GitHub using `git`(1). +### `uninstall` *`formula`*: - * `list`: - List all installed formulae. +Uninstall *`formula`*. - * `search` (*`text`*|`/`*`text`*`/`): - Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* - is surrounded with slashes, then it is interpreted as a regular expression. - The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`. - If no search term is given, all locally available formulae are listed. +### `list`: + +List all installed formulae. + +### `search` (*`text`*|`/`*`text`*`/`): +Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* +is surrounded with slashes, then it is interpreted as a regular expression. +The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`. +If no search term is given, all locally available formulae are listed. ## COMMANDS - * `analytics` [`state`]: - Display anonymous user behaviour analytics state. - Read more at . +### `analytics` (`on`|`off`) [`state`] [`regenerate-uuid`] - * `analytics` (`on`|`off`): - Turn on/off Homebrew's analytics. +If `on`|`off` is passed, turn Homebrew's analytics on or off respectively. - * `analytics` `regenerate-uuid`: - Regenerate UUID used in Homebrew's analytics. +If `state` is passed, display anonymous user behaviour analytics state. +Read more at . - * `cat` *`formula`*: - Display the source to *`formula`*. +If `regenerate-uuid` is passed, regenerate UUID used in Homebrew's analytics. - * `cleanup` [`--prune=`*`days`*] [`--dry-run`] [`-s`] [*`formulae`*|*`casks`*]: - 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. +### `cat` *`formula`* - If `--prune=`*`days`* is specified, remove all cache files older than *`days`*. +Display the source to *`formula`*. - If `--dry-run` or `-n` is passed, show what would be removed, but do not - actually remove anything. +### `cleanup` [*`options`*] [*`formula`*|*`cask`*] - If `-s` 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: `rm -rf "$(brew --cache)"` +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. - * `command` *`cmd`*: - Display the path to the file which is used when invoking `brew` *`cmd`*. +* `--prune`: + Remove all cache files older than specified *`days`*. +* `-n`, `--dry-run`: + Show what would be removed, but do not actually remove anything. +* `-s`: + 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: `rm -rf "$(brew --cache)"` + +### `command` *`cmd`* + +Display the path to the file which is used when invoking `brew` *`cmd`*. + +### `commands` [*`options`*] + +Show a list of built-in and external commands. + +* `--include-aliases`: + Include the aliases of internal commands. + +### `config` - * `commands` [`--quiet` [`--include-aliases`]]: - Show a list of built-in and external commands. +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. - If `--quiet` is passed, list only the names of commands without the header. - With `--include-aliases`, the aliases of internal commands will be included. +### `deps` [*`options`*] *`formula`* + +Show dependencies for *`formula`*. When given multiple formula arguments, +show the intersection of dependencies for *`formula`*. + +* `--1`: + Only show dependencies one level down, instead of recursing. +* `-n`: + Show dependencies in topological order. +* `--union`: + Show the union of dependencies for *`formula`*, instead of the intersection. +* `--full-name`: + List dependencies by their full name. +* `--installed`: + Only list those dependencies that are currently installed. +* `--all`: + List all the dependencies for all available formulae. +* `--include-build`: + Show `:build` type dependencies for *`formula`*. +* `--include-optional`: + Show `:optional` dependencies for *`formula`*. +* `--include-test`: + Show `:test` dependencies for *`formula`* (non-recursive). +* `--skip-recommended`: + Skip `:recommended` type dependencies for *`formula`*. +* `--include-requirements`: + Include requirements in addition to dependencies for *`formula`*. +* `--tree`: + Show dependencies as a tree. When given multiple formula arguments output individual trees for every formula. +* `--for-each`: + Switch into the mode used by `deps --all`, but only list dependencies for specified formula one specified formula per line. This is used for debugging the `--installed`/`--all` display mode. + +### `desc` [*`options`*] (*`text`*|`/`*`text`*`/`|*`formula`*) + +Display *`formula`*'s name and one-line description. +Formula descriptions are cached; the cache is created on the +first search, making that search slower than subsequent ones. + +* `-s`, `--search`: + Search both name and description for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression. +* `-n`, `--name`: + Search just the names for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression. +* `-d`, `--description`: + Search just the descriptions for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression. + +### `diy` [*`options`*] + +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`. + +* `--name`: + Explicitly set the provided *`name`* of the package being installed. +* `--version`: + Explicitly set the provided *`version`* of the package being installed. + +### `doctor` [*`options`*] + +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. + +* `--list-checks`: + List all audit methods. +* `-D`, `--audit-debug`: + Enable debugging and profiling of audit methods. + +### `fetch` [*`options`*] *`formula`* + +Download the source packages for the given *`formula`*. +For tarballs, also print SHA-256 checksums. + +* `--HEAD`: + Fetch HEAD version instead of stable version. +* `--devel`: + Fetch development version instead of stable version. +* `--retry`: + Retry if a download fails or re-download if the checksum of a previously cached version no longer matches. +* `--deps`: + Download dependencies for any listed *`formula`*. +* `-s`, `--build-from-source`: + Download the source for rather than a bottle. +* `--build-bottle`: + Download the source (for eventual bottling) rather than a bottle. +* `--force-bottle`: + Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation. + +### `gist-logs` [*`options`*] *`formula`* + +Upload logs for a failed build of *`formula`* to a new Gist. + +*`formula`* is usually the name of the formula to install, but it can be specified +in several different ways. + +If no logs are found, an error message is presented. + +* `--with-hostname`: + Include the hostname in the Gist. +* `-n`, `--new-issue`: + Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist. +* `-p`, `--private`: + The Gist will be marked private and will not appear in listings but will be accessible with the link. + +### `home` [*`formula`*] + +Open *`formula`*'s homepage in a browser. If no formula is provided, +open Homebrew's own homepage in a browser. + +### `info` [*`formula`*] + +Display brief statistics for your Homebrew installation. + +* `--analytics`: + Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set). +* `--days`: + The value for `days` must be `30`, `90` or `365`. The default is `30`. +* `--category`: + The value for `category` must be `install`, `install-on-request`, `build-error` or `os-version`. The default is `install`. +* `--github`: + Open a browser to the GitHub History page for provided *`formula`*. To view formula history locally: `brew log -p` *`formula`* +* `--json`: + Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: +* `--all`: + Get information on all formulae. +* `--installed`: + Get information on all installed formulae. + +### `install` [*`options`*] *`formula`* + +Install *`formula`*. + +*`formula`* is usually the name of the formula to install, but it can be specified +in several different ways. + +* `--env`: + If `std` is passed, use the standard build environment instead of superenv.If `super` is passed, use superenv even if the formula specifies the standard build environment. +* `--ignore-dependencies`: + Skip installing any dependencies of any kind. If they are not already present, the formula will probably fail to install. +* `--only-dependencies`: + Install the dependencies with specified options but do not install the specified formula. +* `--cc`: + Attempt to compile using provided *`compiler`*. *`compiler`* should be the name of the compiler's executable, for instance `gcc-7` for GCC 7. In order to use LLVM's clang, use `llvm_clang`. To specify the Apple-provided clang, use `clang`. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this flag. +* `-s`, `--build-from-source`: + Compile the specified *`formula`* from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available. +* `--force-bottle`: + Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. +* `--include-test`: + Install testing dependencies required to run `brew test`. +* `--devel`: + If *`formula`* defines it, install the development version. +* `--HEAD`: + If *`formula`* defines it, install the HEAD version, aka. master, trunk, unstable. +* `--fetch-HEAD`: + 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 development version has been released. +* `--keep-tmp`: + Don't delete the temporary files created during installation. +* `--build-bottle`: + Prepare the formula for eventual bottling during installation. +* `--display-times`: + Print install times for each formula at the end of the run. +* `-i`, `--interactive`: + 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 package. +* `-g`, `--git`: + Create a Git repository, useful for creating patches to the software. + +### `leaves` + +Show installed formulae that are not dependencies of another installed formula. + +### `ln`, `link` [*`options`*] *`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. + +* `--overwrite`: + Delete files already existing in the prefix while linking. +* `-n`, `--dry-run`: + List all files which would be linked or deleted by `brew link --overwrite`, but will not actually link or delete any files. + +### `list`, `ls` [*`options`*] + +List all installed formulae. + +* `--full-name`: + Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` which produces the actual output. +* `--unbrewed`: + List all files in the Homebrew prefix not installed by Homebrew. +* `--versions`: + Show the version number for installed formulae, or only the specified formulae if *`formula`* are given. +* `--multiple`: + Only show formulae with multiple versions installed. +* `--pinned`: + Show the versions of pinned formulae, or only the specified (pinned) formulae if *`formula`* are given. See also `pin`, `unpin`. +* `-1`: + Force output to be one entry per line. This is the default when output is not to a terminal. +* `-l`: + List in long format. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing. +* `-r`: + Reverse the order of the sort to get the oldest entries first. +* `-t`: + Sort by time modified (most recently modified first). + +### `log` [*`options`*] *`formula`* + +Show the `git log` for the given *`formula`*. + +* `-p`, `--patch`: + Also output patch from commit. +* `--stat`: + Also output diffstat from commit. +* `--oneline`: + Output only one line per commit. +* `-1`, `--max-count`: + Output only one commit. + +### `migrate` [*`options`*] *`formula`* + +Migrate renamed packages to new name, where *`formula`* are old names of +packages. + +### `missing` [*`options`*] [*`formule`*] + +Check the given *`formula`* for missing dependencies. If no *`formula`* are +given, check all installed brews. + +`missing` exits with a non-zero status if any formulae are missing dependencies. + +* `--hide`: + Act as if none of the provided *`hidden`* are installed. *`hidden`* should be comma-separated list of formulae. + +### `options` [*`options`*] *`formula`* + +Display install options specific to *`formula`* + +* `--compact`: + Show all options on a single line separated by spaces. +* `--all`: + Show options for all formulae. +* `--installed`: + Show options for all installed formulae. + +### `outdated` [*`options`*] + +Show formulae that have an updated version available. + +By default, version information is displayed in interactive shells, and +suppressed otherwise. + +* `--json`: + Show output in JSON format for provided *`version`*. Currently the only accepted value of *`version`* is `v1`. +* `--fetch-HEAD`: + 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 development version has been released. - * `config`: - 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. +### `pin` *`formula`* - * `deps` [`--1`] [`-n`] [`--union`] [`--full-name`] [`--installed`] [`--include-build`] [`--include-optional`] [`--skip-recommended`] [`--include-requirements`] *`formula`*: - Show dependencies for *`formula`*. When given multiple formula arguments, - show the intersection of dependencies for every formula. +Pin the specified *`formula`*, preventing them from being upgraded when +issuing the `brew upgrade` *`formula`* command. See also `unpin`. - If `--1` is passed, only show dependencies one level down, instead of - recursing. +### `postinstall` *`formula`* - If `-n` is passed, show dependencies in topological order. +Rerun the post-install steps for *`formula`*. - If `--union` is passed, show the union of dependencies for *`formula`*, - instead of the intersection. +### `readall` [*`options`*] [*`tap`*] - If `--full-name` is passed, list dependencies by their full name. +Import all formulae from specified *`tap`* (defaults to all installed taps). +This can be useful for debugging issues across all formulae when making +significant changes to `formula.rb`, testing the performance of loading +all formulae or to determine if any current formulae have Ruby issues. - If `--installed` is passed, only list those dependencies that are - currently installed. +* `--aliases`: + Verify any alias symlinks in each tap. +* `--syntax`: + Syntax-check all of Homebrew's Ruby files. - By default, `deps` shows required and recommended dependencies for - *`formula`*. To include the `:build` type dependencies, pass `--include-build`. - Similarly, pass `--include-optional` to include `:optional` dependencies or - `--include-test` to include (non-recursive) `:test` dependencies. - To skip `:recommended` type dependencies, pass `--skip-recommended`. - To include requirements in addition to dependencies, pass `--include-requirements`. +### `reinstall` [*`options`*] *`formula`* - * `deps` `--tree` [`--1`] [*`filters`*] [`--annotate`] (*`formula`*|`--installed`): - Show dependencies as a tree. When given multiple formula arguments, output - individual trees for every formula. +Uninstall and then install *`formula`* (with existing and any appended install options). - If `--1` is passed, only one level of children is displayed. +* `-s`, `--build-from-source`: + Compile *`formula`* from source even if a bottle is available. +* `--force-bottle`: + Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. +* `--keep-tmp`: + Don't delete the temporary files created during installation. +* `--display-times`: + Print install times for each formula at the end of the run. - If `--installed` is passed, output a tree for every installed formula. +### `search` [*`options`*] [*`text`*|`/`*`text`*`/`] - The *`filters`* placeholder is any combination of options `--include-build`, - `--include-optional`, `--include-test`, `--skip-recommended`, and - `--include-requirements` as documented above. + Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* + is surrounded with slashes, then it is interpreted as a regular expression. + The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`. - If `--annotate` is passed, the build, optional, and recommended dependencies - are marked as such in the output. + If no *`text`* is passed, display all locally available formulae (including tapped ones). + No online search is performed. - * `deps` [*`filters`*] (`--installed`|`--all`): - 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. +* `--casks`: + Display all locally available casks (including tapped ones). No online search is performed. +* `--desc`: + search formulae with a description matching *`text`* and casks with a name matching *`text`*. +* `--macports`: + Search for *`text`* in the given package manager's list. +* `--fink`: + Search for *`text`* in the given package manager's list. +* `--opensuse`: + Search for *`text`* in the given package manager's list. +* `--fedora`: + Search for *`text`* in the given package manager's list. +* `--debian`: + Search for *`text`* in the given package manager's list. +* `--ubuntu`: + Search for *`text`* in the given package manager's list. - The *`filters`* placeholder is any combination of options `--include-build`, - `--include-optional`, `--include-test`, and `--skip-recommended` as - documented above. +### `sh` [*`options`*] - Additional options specific to *`formula`* may be appended to the command, - and can be listed with `brew options` *`formula`*. +Start a Homebrew build environment shell. 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 an Xcode-only configuration since it adds tools like `make` to your `PATH` +which otherwise build systems would not find. - * `desc` *`formula`*: - Display *`formula`*'s name and one-line description. +* `--env`: + Use the standard `PATH` instead of superenv's, when *`std`* is passed - * `desc` [`--search`|`--name`|`--description`] (*`text`*|`/`*`text`*`/`): - Search both name and description (`--search` or `-s`), just the names - (`--name` or `-n`), or just the descriptions (`--description` or `-d`) for - *`text`*. If *`text`* 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. +### `shellenv` +Prints export statements - run them in a shell and this installation of Homebrew will be included into your `PATH`, `MANPATH` and `INFOPATH`. - * `diy` [`--name=`*`name`*] [`--version=`*`version`*]: - Automatically determine the installation prefix for non-Homebrew software. +`HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to save multiple queries of those variables. - 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`. +Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)` - 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. +### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*] - * `doctor`: - 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. +Check formulae or files for conformance to Homebrew style guidelines. - * `fetch` [`--force`] [`--retry`] [`-v`] [`--devel`|`--HEAD`] [`--deps`] [`--build-from-source`|`--force-bottle`] *`formulae`*: - Download the source packages for the given *`formulae`*. - For tarballs, also print SHA-256 checksums. +Lists of *`file`*, *`tap`* and *`formula`* may not be combined. If none are +provided, `style` will run style checks on the whole Homebrew library, +including core code and all formulae. - If `--HEAD` or `--devel` is passed, fetch that version instead of the - stable version. +* `--fix`: + Fix style violations automatically using RuboCop's auto-correct feature. +* `--display-cop-names`: + Include the RuboCop cop name for each violation in the output. +* `--only-cops`: + Specify a comma-separated *`cops`* list to check for violations of only the listed RuboCop cops. +* `--except-cops`: + Specify a comma-separated *`cops`* list to skip checking for violations of the listed RuboCop cops. - If `-v` is passed, do a verbose VCS checkout, if the URL represents a VCS. - This is useful for seeing if an existing VCS cache has been updated. +### `switch` *`formula`* *`version`* - If `--force` (or `-f`) is passed, remove a previously cached version and re-fetch. +Symlink all of the specific *`version`* of *`formula`*'s install to Homebrew prefix. - If `--retry` is passed, retry if a download fails or re-download if the - checksum of a previously cached version no longer matches. +### `tap` [*`options`*] *`user`*`/`*`repo`* [*`URL`*] - If `--deps` is passed, also download dependencies for any listed *`formulae`*. +Tap a formula repository. - If `--build-from-source` (or `-s`) or `--build-bottle` is passed, download the - source rather than a bottle. +List all installed taps when no arguments are passed. - If `--force-bottle` 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. +With *`URL`* unspecified, taps a formula repository from GitHub using HTTPS. +Since so many taps are hosted on GitHub, this command is a shortcut for +`brew tap` *`user`*`/`*`repo`* `https://github.com/`*`user`*`/homebrew-`*`repo`*. - * `gist-logs` [`--new-issue`|`-n`] [`--private`|`-p`] *`formula`*: - Upload logs for a failed build of *`formula`* to a new Gist. +With *`URL`* specified, 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 +using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC. - *`formula`* is usually the name of the formula to install, but it can be specified - in several different ways. +* `--full`: + Use a full clone when tapping a repository. By default, the repository is cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a full copy, you can retap passing `--full` without first untapping. +* `--force-auto-update`: + Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons). +* `--repair`: + Migrate tapped formulae from symlink-based to directory-based structure. +* `--list-pinned`: + List all pinned taps. +* `-q`, `--quieter`: + Suppress any warnings. - If `--with-hostname` is passed, include the hostname in the Gist. +### `tap-info` [*`options`*] [*`tap`*] - If `--new-issue` is passed, automatically create a new issue in the appropriate - GitHub repository as well as creating the Gist. +Display detailed information about one or more provided *`tap`*. +Display a brief summary of all installed taps if no *`tap`* are passed. - If `--private` is passed, the Gist will be marked private and will not - appear in listings but will be accessible with the link. +* `--installed`: + Display information on all installed taps. +* `--json`: + Print a JSON representation of *`taps`*. Currently the only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: - If no logs are found, an error message is presented. +### `tap-pin` *`tap`* - * `home`: - Open Homebrew's own homepage in a browser. +Pin *`tap`*, prioritising its formulae over core when formula names are supplied +by the user. See also `tap-unpin`. - * `home` *`formula`*: - Open *`formula`*'s homepage in a browser. +### `tap-unpin` *`tap`* - * `info`: - Display brief statistics for your Homebrew installation. +Unpin *`tap`* so its formulae are no longer prioritised. See also `tap-pin`. - * `info` `--analytics` [`--days=`*`days`*] [`--category=`*`category`*]: - Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` - or `HOMEBREW_NO_GITHUB_API` are set) +### `uninstall`, `rm`, `remove` [*`options`*] *`formula`* - The value for `days` must be `30`, `90` or `365`. The default is `30`. +Uninstall *`formula`*. - The value for `category` must be `install`, `install-on-request`, - `build-error` or `os-version`. The default is `install`. +* `--ignore-dependencies`: + Don't fail uninstall, even if *`formula`* is a dependency of any installed formulae. - * `info` *`formula`* [`--analytics`]: - Display information about *`formula`* and analytics data (provided neither - `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set) +### `unlink` [*`options`*] *`formula`* - Pass `--verbose` to see more verbose analytics data. +Remove symlinks for *`formula`* from the Homebrew prefix. This can be useful +for temporarily disabling a formula: +`brew unlink` *`formula`* `&&` *`commands`* `&& brew link` *`formula`* - Pass `--analytics` to see only more verbose analytics data instead of - formula information. +* `-n`, `--dry-run`: + List all files which would be unlinked, but will not actually unlink or delete any files. - * `info` `--github` *`formula`*: - Open a browser to the GitHub History page for *`formula`*. +### `unpack` [*`options`*] *`formula`* - To view formula history locally: `brew log -p` *`formula`* +Unpack the source files for *`formula`* into subdirectories of the current +working directory. - * `info` `--json[=`*`version`*] (`--all`|`--installed`|*`formulae`*): - Print a JSON representation of *`formulae`*. Currently the default and - only accepted value for *`version`* is `v1`. +* `--destdir`: + Create subdirectories in the directory named by *`path`* instead. +* `--patch`: + Patches for *`formula`* will be applied to the unpacked source. +* `-g`, `--git`: + Initialise a Git repository in the unpacked source. This is useful for creating patches for the software. - Pass `--all` to get information on all formulae, or `--installed` to get - information on all installed formulae. +### `unpin` *`formula`* - See the docs for examples of using the JSON output: - +Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*. +See also `pin`. - * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`*`compiler`*] [`--build-from-source`|`--force-bottle`] [`--include-test`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [`--force`] [`--verbose`] [`--display-times`] *`formula`* [*`options`* ...]: - Install *`formula`*. +### `untap` *`tap`* - *`formula`* is usually the name of the formula to install, but it can be specified - in several different ways. +Remove a tapped repository. - If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging - session with access to IRB or a shell inside the temporary build directory. +### `update` [*`options`*] +Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations. - If `--env=std` is passed, use the standard build environment instead of superenv. +* `--merge`: + `git merge` is used to include updates (rather than `git rebase`). - If `--env=super` is passed, use superenv even if the formula specifies the - standard build environment. +* `--force`: + Always do a slower, full update check (even if unnecessary). - If `--ignore-dependencies` is passed, skip installing any dependencies of - any kind. If they are not already present, the formula will probably fail - to install. +### `update-reset` [*`repository`*] +Fetches and resets Homebrew and all tap repositories (or any specified `repository`) using `git`(1) to their latest `origin/master`. Note this will destroy all your uncommitted or committed changes. - If `--only-dependencies` is passed, install the dependencies with specified - options but do not install the specified formula. +### `upgrade` [*`options`*] *`formula`* - If `--cc=`*`compiler`* is passed, attempt to compile using *`compiler`*. - *`compiler`* should be the name of the compiler's executable, for instance - `gcc-7` for GCC 7. In order to use LLVM's clang, use `llvm_clang`. - To specify the Apple-provided clang, use `clang`. - This parameter will only accept compilers that are provided by Homebrew or - bundled with macOS. Please do not file issues if you encounter errors - while using this flag. +Upgrade outdated, unpinned brews (with existing and any appended install options). - If `--build-from-source` (or `-s`) is passed, compile the specified *`formula`* from - source even if a bottle is provided. Dependencies will still be installed - from bottles if they are available. +If *`formula`* are given, upgrade only the specified brews (unless they +are pinned; see `pin`, `unpin`). - If `--force-bottle` is passed, install from a bottle if it exists for the - current or newest version of macOS, even if it would not normally be used - for installation. +* `-s`, `--build-from-source`: + Compile *`formula`* from source even if a bottle is available. +* `--force-bottle`: + Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. +* `--fetch-HEAD`: + 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 development version has been released. +* `--ignore-pinned`: + Set a 0 exit code even if pinned formulae are not upgraded. +* `--keep-tmp`: + Don't delete the temporary files created during installation. +* `--display-times`: + Print install times for each formula at the end of the run. - If `--include-test` is passed, install testing dependencies. These are only - needed by formulae maintainers to run `brew test`. +### `uses` [*`options`*] *`formula`* - If `--devel` is passed, and *`formula`* defines it, install the development version. +Show the formulae that specify *`formula`* as a dependency. When given +multiple formula arguments, show the intersection of formulae that use +*`formula`*. - If `--HEAD` is passed, and *`formula`* defines it, install the HEAD version, - aka. master, trunk, unstable. +By default, `uses` shows all formulae that specify *`formula`* as a required +or recommended dependency. - If `--keep-tmp` is passed, the temporary files created during installation - are not deleted. +By default, `uses` shows usage of *`formula`* by stable builds. - If `--build-bottle` is passed, prepare the formula for eventual bottling - during installation. +* `--recursive`: + Resolve more than one level of dependencies. +* `--installed`: + Only list installed formulae. +* `--include-build`: + Include all formulae that specify *`formula`* as `:build` type dependency. +* `--include-test`: + Include all formulae that specify *`formula`* as `:test` type dependency. +* `--include-optional`: + Include all formulae that specify *`formula`* as `:optional` type dependency. +* `--skip-recommended`: + Skip all formulae that specify *`formula`* as `:recommended` type dependency. +* `--devel`: + Show usage of *`formula`* by development build. +* `--HEAD`: + Show usage of *`formula`* by HEAD build. - If `--force` (or `-f`) is passed, install without checking for previously - installed keg-only or non-migrated versions +### `--cache` [*`options`*] [*`formula`*] - If `--verbose` (or `-v`) is passed, print the verification and postinstall steps. +Display Homebrew's download cache. See also `HOMEBREW_CACHE`. - If `--display-times` is passed, install times for each formula are printed - at the end of the run. +If *`formula`* is provided, display the file or directory used to cache *`formula`*. - Installation options specific to *`formula`* may be appended to the command, - and can be listed with `brew options` *`formula`*. +* `-s`, `--build-from-source`: + Show the cache file used when building from source. +* `--force-bottle`: + Show the cache file used when pouring a bottle. - * `install` `--interactive` [`--git`] *`formula`*: - If `--interactive` (or `-i`) is passed, 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. +### `--cache` [*`formula`*] - If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for - creating patches to the software. +Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if +that directory doesn't exist, `$(brew --repository)/Cellar`. - * `leaves`: - Show installed formulae that are not dependencies of another installed formula. +If *`formula`* is provided, display the location in the cellar where *`formula`* +would be installed, without any sort of versioned directory as the last path. - * `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. +### `--env` [*`options`*] - If `--overwrite` is passed, Homebrew will delete files which already exist in - the prefix while linking. +Show a summary of the Homebrew build environment as a plain list. - If `--dry-run` or `-n` is passed, Homebrew will list all files which would - be linked or which would be deleted by `brew link --overwrite`, but will not - actually link or delete any files. +If the command's output is sent through a pipe and no shell is specified, +the list is formatted for export to `bash`(1) unless `--plain` is passed. - If `--force` (or `-f`) is passed, Homebrew will allow keg-only formulae to be linked. +* `--shell`: + Generate a list of environment variables for the specified shell, or `--shell=auto` to detect the current shell. +* `--plain`: + Plain output even when piped. - * `list`, `ls` [`--full-name`] [`-1`] [`-l`] [`-t`] [`-r`]: - List all installed formulae. If `--full-name` is passed, print formulae - with fully-qualified names. If `--full-name` is not passed, other - options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` which produces the actual output. +### `--prefix` [*`formula`*] - * `list`, `ls` `--unbrewed`: - List all files in the Homebrew prefix not installed by Homebrew. +Display Homebrew's install path. *Default:* `/usr/local` on macOS and +`/home/linuxbrew/.linuxbrew` on Linux. - * `list`, `ls` [`--verbose`] [`--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. +If *`formula`* is provided, display the location in the cellar where *`formula`* +is or would be installed. - If `--versions` is passed, show the version number for installed formulae, - or only the specified formulae if *`formulae`* are given. With `--multiple`, - only show formulae with multiple versions installed. +### `--repository` [*`formula`*] - If `--pinned` is passed, show the versions of pinned formulae, or only the - specified (pinned) formulae if *`formulae`* are given. - See also `pin`, `unpin`. +Display where Homebrew's `.git` directory is located. - * `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. +If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located. - * `migrate` [`--force`] *`formulae`*: - Migrate renamed packages to new name, where *`formulae`* are old names of - packages. +### `--version` - If `--force` (or `-f`) is passed, then treat installed *`formulae`* and passed *`formulae`* - like if they are from same taps and migrate them anyway. - - * `missing` [`--hide=`*`hidden`*] [*`formulae`*]: - Check the given *`formulae`* for missing dependencies. If no *`formulae`* are - given, check all installed brews. - - If `--hide=`*`hidden`* is passed, act as if none of *`hidden`* are installed. - *`hidden`* should be a comma-separated list of formulae. - - `missing` exits with a non-zero status if any formulae are missing dependencies. - - * `options` [`--compact`] (`--all`|`--installed`|*`formulae`*): - Display install options specific to *`formulae`*. - - If `--compact` is passed, show all options on a single line separated by - spaces. - - If `--all` is passed, show options for all formulae. - - If `--installed` is passed, show options for all installed formulae. - - * `outdated` [`--quiet`|`--verbose`|`--json=`*`version`*] [`--fetch-HEAD`]: - Show formulae that have an updated version available. - - By default, version information is displayed in interactive shells, and - suppressed otherwise. - - If `--quiet` is passed, list only the names of outdated brews (takes - precedence over `--verbose`). - - If `--verbose` (or `-v`) is passed, display detailed version information. - - If `--json=`*`version`* is passed, the output will be in JSON format. - Currently the only accepted value for *`version`* is `v1`. - - If `--fetch-HEAD` 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. - - * `pin` *`formulae`*: - Pin the specified *`formulae`*, preventing them from being upgraded when - issuing the `brew upgrade` *`formulae`* command. See also `unpin`. - - * `postinstall` *`formula`*: - Rerun the post-install steps for *`formula`*. - - * `prune` [`--dry-run`]: - Deprecated. Use `brew cleanup` instead. - - * `readall` [`--aliases`] [`--syntax`] [*`taps`*]: - Import all formulae from specified *`taps`* (defaults to all installed taps). - - This can be useful for debugging issues across all formulae when making - significant changes to `formula.rb`, testing the performance of loading - all formulae or to determine if any current formulae have Ruby issues. - - If `--aliases` is passed, also verify any alias symlinks in each tap. - - If `--syntax` is passed, also syntax-check all of Homebrew's Ruby files. - - * `reinstall` [`--debug`] [`--build-from-source`|`--force-bottle`] [`--keep-tmp`] [`--force`] [`--verbose`] [`--display-times`] *`formula`*: - Uninstall and then install *`formula`* (with existing and any appended install options). - - If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging - session with access to IRB or a shell inside the temporary build directory. - - If `--build-from-source` (or `-s`) is passed, compile the specified *`formula`* from - source even if a bottle is provided. Dependencies will still be installed - from bottles if they are available. - - If `--force-bottle` is passed, install from a bottle if it exists for the - current or newest version of macOS, even if it would not normally be used - for installation. - - If `--keep-tmp` is passed, the temporary files created during installation - are not deleted. - - If `--force` (or `-f`) is passed, install without checking for previously - installed keg-only or non-migrated versions - - If `--verbose` (or `-v`) is passed, print the verification and postinstall steps. - - If `--display-times` is passed, install times for each formula are printed - at the end of the run. - - Installation options specific to *`formula`* may be appended to the command, - and can be listed with `brew options` *`formula`*. - - * `search`, `-S`: - Display all locally available formulae (including tapped ones). - No online search is performed. - - * `search` `--casks`: - Display all locally available casks (including tapped ones). - No online search is performed. - - * `search` [`--desc`] (*`text`*|`/`*`text`*`/`): - Perform a substring search of cask tokens and formula names for *`text`*. If *`text`* - is surrounded with slashes, then it is interpreted as a regular expression. - The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`. - - If `--desc` is passed, search formulae with a description matching *`text`* and - casks with a name matching *`text`*. - - * `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) *`text`*: - Search for *`text`* in the given package manager's list. - - * `sh` [`--env=std`]: - Start a Homebrew build environment shell. 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 an Xcode-only configuration since it adds tools like `make` to your `PATH` - which otherwise build systems would not find. - - If `--env=std` is passed, use the standard `PATH` instead of superenv's. - - * `shellenv`: - Prints export statements - run them in a shell and this installation of - Homebrew will be included into your PATH, MANPATH, and INFOPATH. - - HOMEBREW_PREFIX, HOMEBREW_CELLAR and HOMEBREW_REPOSITORY are also exported - to save multiple queries of those variables. - - Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) - with `eval $(brew shellenv)` - - * `style` [`--fix`] [`--display-cop-names`] [`--only-cops=`*`cops`*|`--except-cops=`*`cops`*] [*`files`*|*`taps`*|*`formulae`*]: - Check formulae or files for conformance to Homebrew style guidelines. - - Lists of *`files`*, *`taps`* and *`formulae`* may not be combined. If none are - provided, `style` will run style checks on the whole Homebrew library, - including core code and all formulae. - - If `--fix` is passed, automatically fix style violations using RuboCop's - auto-correct feature. - - If `--display-cop-names` is passed, include the RuboCop cop name for each - violation in the output. - - Passing `--only-cops=`*`cops`* will check for violations of only the listed - RuboCop *`cops`*, while `--except-cops=`*`cops`* will skip checking the listed - *`cops`*. For either option *`cops`* should be a comma-separated list of cop names. - - Exits with a non-zero status if any style violations are found. - - * `switch` *`formula`* *`version`*: - Symlink all of the specific *`version`* of *`formula`*'s install to Homebrew prefix. - - * `tap`: - List all installed taps. - - * `tap` [`--full`] [`--force-auto-update`] *`user`*`/`*`repo`* [*`URL`*]: - Tap a formula repository. - - With *`URL`* unspecified, taps a formula repository from GitHub using HTTPS. - Since so many taps are hosted on GitHub, this command is a shortcut for - `brew tap` *`user`*`/`*`repo`* `https://github.com/`*`user`*`/homebrew-`*`repo`*. - - With *`URL`* specified, 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 - using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC. - - By default, the repository is cloned as a shallow copy (`--depth=1`), but - if `--full` is passed, a full clone will be used. To convert a shallow copy - to a full copy, you can retap passing `--full` without first untapping. - - By default, only taps hosted on GitHub are auto-updated (for performance - reasons). If `--force-auto-update` is passed, this tap will be auto-updated - even if it is not hosted on GitHub. - - `tap` is re-runnable and exits successfully if there's nothing to do. - However, retapping with a different *`URL`* will cause an exception, so first - `untap` if you need to modify the *`URL`*. - - * `tap` `--repair`: - Migrate tapped formulae from symlink-based to directory-based structure. - - * `tap` `--list-pinned`: - List all pinned taps. - - * `tap-info`: - Display a brief summary of all installed taps. - - * `tap-info` (`--installed`|*`taps`*): - Display detailed information about one or more *`taps`*. - - Pass `--installed` to display information on all installed taps. - - * `tap-info` `--json=`*`version`* (`--installed`|*`taps`*): - Print a JSON representation of *`taps`*. Currently the only accepted value - for *`version`* is `v1`. - - Pass `--installed` to get information on installed taps. - - See the docs for examples of using the JSON output: - - - * `tap-pin` *`tap`*: - Pin *`tap`*, prioritizing its formulae over core when formula names are supplied - by the user. See also `tap-unpin`. - - * `tap-unpin` *`tap`*: - Unpin *`tap`* so its formulae are no longer prioritized. See also `tap-pin`. - - * `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] *`formula`*: - Uninstall *`formula`*. - - If `--force` (or `-f`) is passed, and there are multiple versions of *`formula`* - installed, delete all installed versions. - - If `--ignore-dependencies` is passed, uninstalling won't fail, even if - formulae depending on *`formula`* would still be installed. - - * `unlink` [`--dry-run`] *`formula`*: - Remove symlinks for *`formula`* from the Homebrew prefix. This can be useful - for temporarily disabling a formula: - `brew unlink` *`formula`* `&&` *`commands`* `&& brew link` *`formula`* - - 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. - - * `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 - be created in the directory named by *`path`* instead. - - If `--patch` is passed, patches for *`formulae`* will be applied to the - unpacked source. - - If `--git` (or `-g`) is passed, a Git repository will be initialized in the unpacked - source. This is useful for creating patches for the software. - - * `unpin` *`formulae`*: - Unpin *`formulae`*, allowing them to be upgraded by `brew upgrade` *`formulae`*. - See also `pin`. - - * `untap` *`tap`*: - Remove a tapped repository. - - * `update` [`--merge`] [`--force`]: - Fetch the newest version of Homebrew and all formulae from GitHub using - `git`(1) and perform any necessary migrations. - - If `--merge` is specified then `git merge` is used to include updates - (rather than `git rebase`). - - If `--force` (or `-f`) is specified then always do a slower, full update check even - if unnecessary. - - * `update-reset` [*`repositories`*]: - Fetches and resets Homebrew and all tap repositories (or the specified - `repositories`) using `git`(1) to their latest `origin/master`. Note this - will destroy all your uncommitted or committed changes. - - * `upgrade` [`--debug`] [`--build-from-source`|`--force-bottle`] [`--fetch-HEAD`] [`--ignore-pinned`] [`--keep-tmp`] [`--force`] [`--verbose`] [`--display-times`] [*`formula`*] [*`options`* ...]: - Upgrade outdated, unpinned brews (with existing and any appended install options). - - If *`formula`* are given, upgrade only the specified brews (unless they - are pinned; see `pin`, `unpin`). - - If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging - session with access to IRB or a shell inside the temporary build directory. - - If `--build-from-source` (or `-s`) is passed, compile the specified *`formula`* from - source even if a bottle is provided. Dependencies will still be installed - from bottles if they are available. - - If `--force-bottle` is passed, install from a bottle if it exists for the - current or newest version of macOS, even if it would not normally be used - for installation. - - If `--fetch-HEAD` 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. - - If `--ignore-pinned` is passed, set a 0 exit code even if pinned formulae - are not upgraded. - - If `--keep-tmp` is passed, the temporary files created during installation - are not deleted. - - If `--force` (or `-f`) is passed, install without checking for previously - installed keg-only or non-migrated versions - - If `--verbose` (or `-v`) is passed, print the verification and postinstall steps. - - If `--display-times` is passed, install times for each formula are printed - at the end of the run. - - Additional options specific to *`formula`* may be appended to the command, - and can be listed with `brew options` *`formula`*. - - * `uses` [`--installed`] [`--recursive`] [`--include-build`] [`--include-test`] [`--include-optional`] [`--skip-recommended`] [`--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`*. - - Use `--recursive` to resolve more than one level of dependencies. - - If `--installed` is passed, only list installed formulae. - - By default, `uses` shows all formulae that specify *`formulae`* as a required - or recommended dependency. To include the `:build` type dependencies, pass - `--include-build`, to include the `:test` type dependencies, pass - `--include-test` and to include `:optional` dependencies pass - `--include-optional`. To skip `:recommended` type dependencies, pass - `--skip-recommended`. - - By default, `uses` shows usage of *`formulae`* by stable builds. To find - cases where *`formulae`* is used by development or HEAD build, pass - `--devel` or `--HEAD`. - - * `--cache`: - Display Homebrew's download cache. See also `HOMEBREW_CACHE`. - - * `--cache` [`--build-from-source`|`-s`] [`--force-bottle`] *`formula`*: - Display the file or directory used to cache *`formula`*. - - * `--cellar`: - Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if - that directory doesn't exist, `$(brew --repository)/Cellar`. - - * `--cellar` *`formula`*: - Display the location in the cellar where *`formula`* would be installed, - without any sort of versioned directory as the last path. - - * `--env` [`--shell=`(*`shell`*|`auto`)|`--plain`]: - Show a summary of the Homebrew build environment as a plain list. - - Pass `--shell=`*`shell`* to generate a list of environment variables for the - specified shell, or `--shell=auto` to detect the current shell. - - If the command's output is sent through a pipe and no shell is specified, - the list is formatted for export to `bash`(1) unless `--plain` is passed. - - * `--prefix`: - Display Homebrew's install path. *Default:* `/usr/local` on macOS and `/home/linuxbrew/.linuxbrew` on Linux - - * `--prefix` *`formula`*: - Display the location in the cellar where *`formula`* is or would be installed. - - * `--repository`: - Display where Homebrew's `.git` directory is located. - - * `--repository` *`user`*`/`*`repo`*: - Display where tap *`user`*`/`*`repo`*'s directory is located. - - * `--version`: - Print the version number of Homebrew to standard output and exit. +Print the version number of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask +(if tapped) to standard output and exit. ## DEVELOPER COMMANDS -### `audit` [*`options`*] *`formulae`* +### `audit` [*`options`*] *`formula`* -Check *`formulae`* for Homebrew coding style violations. This should be run before +Check *`formula`* for Homebrew coding style violations. This should be run before submitting a new formula. Will exit with a non-zero status if any errors are found, which can be useful for implementing pre-commit hooks. -If no *`formulae`* are provided, all of them are checked. +If no *`formula`* are provided, all of them are checked. * `--strict`: Run additional style checks, including RuboCop style checks. @@ -742,7 +661,7 @@ If no *`formulae`* are provided, all of them are checked. * `--except-cops`: Specify a comma-separated *`cops`* list to skip checking for violations of the listed RuboCop cops. -### `bottle` [*`options`*] *`formulae`* +### `bottle` [*`options`*] *`formula`* Generate a bottle (binary package) from a formula that was installed with `--build-bottle`. @@ -839,12 +758,11 @@ a simple example. For the complete API, see: * `--tap`: Generate the new formula in the provided tap, specified as *`user`*`/`*`repo`*. -### `edit` [*`formulae`*] +### `edit` [*`formula`*] Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the Homebrew repository for editing if no *`formula`* is provided. - ### `extract` [*`options`*] *`formula`* *`tap`* Look through repository history to find the most recent version of *`formula`* and @@ -854,11 +772,10 @@ installed yet, attempt to install/clone the tap before continuing. * `--version`: Extract the provided *`version`* of *`formula`* instead of the most recent. -### `formula` *`formulae`* +### `formula` *`formula`* Display the path where a formula is located. - ### `irb` [*`options`*] Enter the interactive Homebrew Ruby shell. @@ -868,7 +785,7 @@ Enter the interactive Homebrew Ruby shell. * `--pry`: Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set. -### `linkage` [*`options`*] [*`formulae`*] +### `linkage` [*`options`*] [*`formula`*] Check the library links for kegs of installed formulae. Raises an error if run on uninstalled formulae. @@ -889,35 +806,17 @@ Generate Homebrew's manpages. * `--link`: This is now done automatically by `brew update`. -### `mirror` *`formulae`* +### `prof` *`command`* -Reuploads the stable URL for a formula to Bintray to use it as a mirror. +Run Homebrew with the Ruby profiler e.g. `brew prof readall`. - -### `prof` [*`ruby options`*] - -Run Homebrew with the Ruby profiler. - -*Example:* `brew prof readall` - - -### `pull` [*`options`*] *`patch sources`* +### `pull` [*`options`*] *`patch`* Get a patch from a GitHub commit or pull request and apply it to Homebrew. Optionally, publish updated bottles for the formulae changed by the patch. -Each *`patch source`* may be one of: - - ~ The ID number of a PR (pull request) in the homebrew/core GitHub - repository - - ~ The URL of a PR on GitHub, using either the web page or API URL - formats. In this form, the PR may be on Homebrew/brew, - Homebrew/homebrew-core or any tap. - - ~ The URL of a commit on GitHub - - ~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID +Each *`patch`* may be the number of a PR in homebrew/core, the URL of a PR +on GitHub, the URL of a commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL. * `--bottle`: Handle bottles, pulling the bottle-update commit and publishing files on Bintray. @@ -951,11 +850,10 @@ If no *`end_ref`* is provided it defaults to `origin/master`. * `--markdown`: Print as a Markdown list. -### `ruby` [*`ruby options`*] +### `ruby` [`-e`]: -Run a Ruby instance with Homebrew's libraries loaded. - -*Example:* `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb` +Run a Ruby instance with Homebrew's libraries loaded e.g. +`brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb` * `-e`: Execute the provided string argument as a script. @@ -964,8 +862,7 @@ Run a Ruby instance with Homebrew's libraries loaded. Generate the template files for a new tap. - -### `test` [*`options`*] *`formulae`* +### `test` [*`options`*] *`formula`* Run the test method provided by an installed formula. There is no standard output or return code, but generally it should notify the @@ -995,7 +892,7 @@ Run Homebrew's unit and integration tests. * `--only`: Run only *`test_script`*`_spec.rb`. Appending `:`*`line_number`* will start at a specific line. * `--seed`: - Randomize tests with the provided *`value`* instead of a random seed. + Randomise tests with the provided *`value`* instead of a random seed. ### `update-test` [*`options`*] @@ -1011,8 +908,9 @@ If no arguments are passed, use `origin/master` as the start commit. * `--before`: Use the commit at provided *`date`* as the start commit. - * `vendor-gems`: - Install and commit Homebrew's vendored gems. +### `vendor-gems` + +Install and commit Homebrew's vendored gems. ## GLOBAL OPTIONS @@ -1032,80 +930,23 @@ These options are applicable across all sub-commands. ## OFFICIAL EXTERNAL COMMANDS - * `bundle` *`command`*: - Bundler for non-Ruby dependencies from Homebrew. +### `bundle` *`subcommand`*: - `brew bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=`*`path`*|`--global`]: - Install or upgrade all dependencies in a Brewfile. +Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store. See `brew bundle --help`. - `brew bundle dump` [`--force`] [`--describe`] [`--file=`*`path`*|`--global`]: - Write all installed casks/formulae/taps into a Brewfile. +**Homebrew/homebrew-bundle**: - `brew bundle cleanup` [`--force`] [`--zap`] [`--file=`*`path`*|`--global`]: - Uninstall all dependencies not listed in a Brewfile. +### `cask` *`subcommand`*: - `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. +Install macOS applications distributed as binaries. See brew-cask(1). - `brew bundle exec` *`command`*: - Run an external command in an isolated build environment. +**Homebrew/homebrew-cask**: - `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. +### `services` *`subcommand`*: - If `-v` or `--verbose` are passed, print verbose output. +Manage background services with macOS' `launchctl`(1) daemon manager. See `brew services --help`. - If `--no-upgrade` is passed, don't run `brew upgrade` on 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 the Brewfile path to `~/.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**: - - * `cask` [`--version` | `audit` | `cat` | `cleanup` | `create` | `doctor` | `edit` | `fetch` | `home` | `info`]: - Install macOS applications distributed as binaries. - - **Homebrew/homebrew-cask**: - - * `services` *`command`*: - 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 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 *`formula`* 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**: +**Homebrew/homebrew-services**: ## CUSTOM EXTERNAL COMMANDS @@ -1244,7 +1085,7 @@ Note that environment variables must have a value set to be detected. For exampl rather than falling back to building from source. * `HOMEBREW_NO_COLOR`: - If set, Homebrew will not print text with color added. + If set, Homebrew will not print text with colour added. * `HOMEBREW_NO_EMOJI`: If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a @@ -1358,7 +1199,6 @@ See our issues on GitHub: * **Homebrew/homebrew-core**: - [SYNOPSIS]: #SYNOPSIS "SYNOPSIS" [DESCRIPTION]: #DESCRIPTION "DESCRIPTION" [ESSENTIAL COMMANDS]: #ESSENTIAL-COMMANDS "ESSENTIAL COMMANDS" @@ -1374,5 +1214,4 @@ See our issues on GitHub: [AUTHORS]: #AUTHORS "AUTHORS" [BUGS]: #BUGS "BUGS" - [-]: -.html diff --git a/manpages/brew.1 b/manpages/brew.1 index 0998c376f2..789cde567a 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -21,712 +21,755 @@ 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\. . -.TP -\fBinstall\fR \fIformula\fR +.SS "\fBinstall\fR \fIformula\fR:" Install \fIformula\fR\. . -.TP -\fBuninstall\fR \fIformula\fR +.SS "\fBuninstall\fR \fIformula\fR:" Uninstall \fIformula\fR\. . -.TP -\fBupdate\fR -Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\. -. -.TP -\fBlist\fR +.SS "\fBlist\fR:" List all installed formulae\. . -.TP -\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) +.SS "\fBsearch\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 \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is given, all locally available formulae are listed\. . .SH "COMMANDS" . -.TP -\fBanalytics\fR [\fBstate\fR] -Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\. +.SS "\fBanalytics\fR (\fBon\fR|\fBoff\fR) [\fBstate\fR] [\fBregenerate\-uuid\fR]" +If \fBon\fR|\fBoff\fR is passed, turn Homebrew\'s analytics on or off respectively\. . -.TP -\fBanalytics\fR (\fBon\fR|\fBoff\fR) -Turn on/off Homebrew\'s analytics\. +.P +If \fBstate\fR is passed, display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\. . -.TP -\fBanalytics\fR \fBregenerate\-uuid\fR -Regenerate UUID used in Homebrew\'s analytics\. +.P +If \fBregenerate\-uuid\fR is passed, regenerate UUID used in Homebrew\'s analytics\. . -.TP -\fBcat\fR \fIformula\fR +.SS "\fBcat\fR \fIformula\fR" Display the source to \fIformula\fR\. . -.TP -\fBcleanup\fR [\fB\-\-prune=\fR\fIdays\fR] [\fB\-\-dry\-run\fR] [\fB\-s\fR] [\fIformulae\fR|\fIcasks\fR] +.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" 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\. -. -.IP -If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\. -. -.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 +.TP +\fB\-\-prune\fR +Remove all cache files older than specified \fIdays\fR\. . .TP -\fBcommand\fR \fIcmd\fR +\fB\-n\fR, \fB\-\-dry\-run\fR +Show what would be removed, but do not actually remove anything\. +. +.TP +\fB\-s\fR +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 +. +.SS "\fBcommand\fR \fIcmd\fR" Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\. . -.TP -\fBcommands\fR [\fB\-\-quiet\fR [\fB\-\-include\-aliases\fR]] +.SS "\fBcommands\fR [\fIoptions\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\. -. .TP -\fBconfig\fR +\fB\-\-include\-aliases\fR +Include the aliases of internal commands\. +. +.SS "\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 -\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] \fIformula\fR -Show dependencies for \fIformula\fR\. When given multiple formula arguments, show the intersection of dependencies for every formula\. -. -.IP -If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\. -. -.IP -If \fB\-n\fR is passed, show dependencies in topological order\. -. -.IP -If \fB\-\-union\fR is passed, show the union of dependencies for \fIformula\fR, instead of the intersection\. -. -.IP -If \fB\-\-full\-name\fR is passed, list dependencies by their full name\. -. -.IP -If \fB\-\-installed\fR is passed, only list those dependencies that are currently installed\. -. -.IP -By default, \fBdeps\fR shows required and recommended dependencies for \fIformula\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\. -. -.TP -\fBdeps\fR \fB\-\-tree\fR [\fB\-\-1\fR] [\fIfilters\fR] [\fB\-\-annotate\fR] (\fIformula\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\. -. -.IP -If \fB\-\-installed\fR is passed, output a tree for every installed formula\. -. -.IP -The \fIfilters\fR placeholder is any combination of options \fB\-\-include\-build\fR, \fB\-\-include\-optional\fR, \fB\-\-include\-test\fR, \fB\-\-skip\-recommended\fR, and \fB\-\-include\-requirements\fR as documented above\. -. -.IP -If \fB\-\-annotate\fR is passed, the build, optional, and recommended dependencies are marked as such in the output\. -. -.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 -Additional options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\. -. -.TP -\fBdesc\fR \fIformula\fR -Display \fIformula\fR\'s name and one\-line description\. -. -.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\. -. -.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\. -. -.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\. -. -.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\. -. -.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\. -. -.IP -If \fB\-v\fR is passed, do a verbose VCS checkout, if the URL represents a VCS\. This is useful for seeing if an existing VCS cache has been updated\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is passed, remove a previously cached version and re\-fetch\. -. -.IP -If \fB\-\-retry\fR is passed, retry if a download fails or re\-download if the checksum of a previously cached version no longer matches\. -. -.IP -If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\. -. -.IP -If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) or \fB\-\-build\-bottle\fR is passed, download the source rather than a bottle\. -. -.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\. -. -.TP -\fBgist\-logs\fR [\fB\-\-new\-issue\fR|\fB\-n\fR] [\fB\-\-private\fR|\fB\-p\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\. -. -.IP -If \fB\-\-with\-hostname\fR is passed, include the hostname in the Gist\. -. -.IP -If \fB\-\-new\-issue\fR is passed, automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\. -. -.IP -If \fB\-\-private\fR is passed, the Gist will be marked private and will not appear in listings but will be accessible with the link\. -. -.IP -If no logs are found, an error message is presented\. -. -.TP -\fBhome\fR -Open Homebrew\'s own homepage in a browser\. -. -.TP -\fBhome\fR \fIformula\fR -Open \fIformula\fR\'s homepage in a browser\. -. -.TP -\fBinfo\fR -Display brief statistics for your Homebrew installation\. -. -.TP -\fBinfo\fR \fB\-\-analytics\fR [\fB\-\-days=\fR\fIdays\fR] [\fB\-\-category=\fR\fIcategory\fR] -Display Homebrew analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set) -. -.IP -The value for \fBdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\. -. -.IP -The value for \fBcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\. -. -.TP -\fBinfo\fR \fIformula\fR [\fB\-\-analytics\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 verbose analytics data\. -. -.IP -Pass \fB\-\-analytics\fR to see only more verbose analytics data instead of formula information\. +.SS "\fBdeps\fR [\fIoptions\fR] \fIformula\fR" +Show dependencies for \fIformula\fR\. When given multiple formula arguments, show the intersection of dependencies 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\fR \fIformula\fR +\fB\-\-1\fR +Only show dependencies one level down, instead of recursing\. . .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 default and 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\. -. -.IP -See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR +\fB\-n\fR +Show dependencies in topological order\. . .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\. -. -.IP -If \fB\-\-debug\fR (or \fB\-d\fR) is passed and brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. -. -.IP -If \fB\-\-env=std\fR is passed, use the standard build environment instead of superenv\. -. -.IP -If \fB\-\-env=super\fR is passed, use superenv even if the formula specifies the standard build environment\. -. -.IP -If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of any kind\. If they are not already present, the formula will probably fail to install\. -. -.IP -If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\. -. -.IP -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\-7\fR for GCC 7\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this flag\. -. -.IP -If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. -. -.IP -If \fB\-\-force\-bottle\fR is passed, install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. -. -.IP -If \fB\-\-include\-test\fR is passed, install testing dependencies\. These are only needed by formulae maintainers to run \fBbrew test\fR\. -. -.IP -If \fB\-\-devel\fR is passed, and \fIformula\fR defines it, install the development version\. -. -.IP -If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka\. master, trunk, unstable\. -. -.IP -If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installation are not deleted\. -. -.IP -If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling during installation\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is passed, install without checking for previously installed keg\-only or non\-migrated versions -. -.IP -If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the verification and postinstall steps\. -. -.IP -If \fB\-\-display\-times\fR is passed, install times for each formula are printed at the end of the run\. -. -.IP -Installation options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\. +\fB\-\-union\fR +Show the union of dependencies for \fIformula\fR, instead of the intersection\. . .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\. +\fB\-\-full\-name\fR +List dependencies by their full name\. . .TP -\fBleaves\fR -Show installed formulae that are not dependencies of another installed formula\. +\fB\-\-installed\fR +Only list those dependencies that are currently installed\. . .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\. -. -.IP -If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which would be linked or which would be deleted by \fBbrew link \-\-overwrite\fR, but will not actually link or delete any files\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is passed, Homebrew will allow keg\-only formulae to be linked\. +\fB\-\-all\fR +List all the dependencies for all available formulae\. . .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\. +\fB\-\-include\-build\fR +Show \fB:build\fR type dependencies for \fIformula\fR\. . .TP -\fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR -List all files in the Homebrew prefix not installed by Homebrew\. +\fB\-\-include\-optional\fR +Show \fB:optional\fR dependencies for \fIformula\fR\. . .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\. -. -.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\. +\fB\-\-include\-test\fR +Show \fB:test\fR dependencies for \fIformula\fR (non\-recursive)\. . .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\. +\fB\-\-skip\-recommended\fR +Skip \fB:recommended\fR type dependencies for \fIformula\fR\. . .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\. +\fB\-\-include\-requirements\fR +Include requirements in addition to dependencies for \fIformula\fR\. . .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\. -. -.IP -\fBmissing\fR exits with a non\-zero status if any formulae are missing dependencies\. -. -.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\. -. -.IP -If \fB\-\-all\fR is passed, show options for all formulae\. -. -.IP -If \fB\-\-installed\fR is passed, show options for all installed formulae\. +\fB\-\-tree\fR +Show dependencies as a tree\. When given multiple formula arguments output individual trees for every formula\. . .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\. -. -.IP -If \fB\-\-quiet\fR is passed, list only the names of outdated brews (takes precedence over \fB\-\-verbose\fR)\. +\fB\-\-for\-each\fR +Switch into the mode used by \fBdeps \-\-all\fR, but only list dependencies for specified formula one specified formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\. . -.IP -If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, display detailed version information\. -. -.IP -If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. -. -.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\. +.SS "\fBdesc\fR [\fIoptions\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR)" +Display \fIformula\fR\'s name and one\-line description\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\. . .TP -\fBpin\fR \fIformulae\fR -Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformulae\fR command\. See also \fBunpin\fR\. +\fB\-s\fR, \fB\-\-search\fR +Search both name and description for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. . .TP -\fBpostinstall\fR \fIformula\fR -Rerun the post\-install steps for \fIformula\fR\. +\fB\-n\fR, \fB\-\-name\fR +Search just the names for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. . .TP -\fBprune\fR [\fB\-\-dry\-run\fR] -Deprecated\. Use \fBbrew cleanup\fR instead\. -. -.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\. -. -.IP -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\. -. -.TP -\fBreinstall\fR [\fB\-\-debug\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] [\fB\-\-display\-times\fR] \fIformula\fR -Uninstall and then install \fIformula\fR (with existing and any appended install options)\. -. -.IP -If \fB\-\-debug\fR (or \fB\-d\fR) is passed and brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. -. -.IP -If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. -. -.IP -If \fB\-\-force\-bottle\fR is passed, install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. -. -.IP -If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installation are not deleted\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is passed, install without checking for previously installed keg\-only or non\-migrated versions -. -.IP -If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the verification and postinstall steps\. -. -.IP -If \fB\-\-display\-times\fR is passed, install times for each formula are printed at the end of the run\. +\fB\-d\fR, \fB\-\-description\fR +Search just the descriptions for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. . -.IP -Installation options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\. -. -.TP -\fBsearch\fR, \fB\-S\fR -Display all locally available formulae (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\. -. -.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 \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. -. -.IP -If \fB\-\-desc\fR is passed, search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\. -. -.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\. -. -.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\. -. -.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\. -. -.IP -Consider adding evaluating the output in your dotfiles (e\.g\. \fB~/\.profile\fR) with \fBeval $(brew shellenv)\fR -. -.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\. -. -.IP -If \fB\-\-fix\fR is passed, automatically fix style violations using RuboCop\'s auto\-correct feature\. -. -.IP -If \fB\-\-display\-cop\-names\fR is passed, include the RuboCop cop name for each violation in the output\. -. -.IP -Passing \fB\-\-only\-cops=\fR\fIcops\fR will check for violations of only the listed RuboCop \fIcops\fR, while \fB\-\-except\-cops=\fR\fIcops\fR will skip checking the listed \fIcops\fR\. For either option \fIcops\fR should be a comma\-separated list of cop names\. -. -.IP -Exits with a non\-zero status if any style violations are found\. -. -.TP -\fBswitch\fR \fIformula\fR \fIversion\fR -Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\. -. -.TP -\fBtap\fR -List all installed taps\. -. -.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 \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\. -. -.IP -With \fIURL\fR specified, 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 -By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR), but if \fB\-\-full\fR is passed, a full clone will be used\. To convert a shallow copy to a full copy, you can retap passing \fB\-\-full\fR without first untapping\. -. -.IP -By default, only taps hosted on GitHub are auto\-updated (for performance reasons)\. If \fB\-\-force\-auto\-update\fR is passed, this tap will be auto\-updated even if it is not hosted on GitHub\. -. -.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\. -. -.TP -\fBtap\fR \fB\-\-repair\fR -Migrate tapped formulae from symlink\-based to directory\-based structure\. -. -.TP -\fBtap\fR \fB\-\-list\-pinned\fR -List all pinned taps\. -. -.TP -\fBtap\-info\fR -Display a brief summary of all installed taps\. -. -.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\. -. -.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\. -. -.IP -See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\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\. -. -.TP -\fBtap\-unpin\fR \fItap\fR -Unpin \fItap\fR so its formulae are no longer prioritized\. See also \fBtap\-pin\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\. -. -.IP -If \fB\-\-ignore\-dependencies\fR is passed, uninstalling won\'t fail, even if formulae depending on \fIformula\fR would still be installed\. -. -.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\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\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\. -. -.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\. -. -.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\. -. -.TP -\fBunpin\fR \fIformulae\fR -Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformulae\fR\. See also \fBpin\fR\. -. -.TP -\fBuntap\fR \fItap\fR -Remove a tapped repository\. -. -.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)\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is specified then always do a slower, full update check even if unnecessary\. -. -.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\. -. -.TP -\fBupgrade\fR [\fB\-\-debug\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-fetch\-HEAD\fR] [\fB\-\-ignore\-pinned\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] [\fB\-\-display\-times\fR] [\fIformula\fR] [\fIoptions\fR \.\.\.] -Upgrade outdated, unpinned brews (with existing and any appended install options)\. -. -.IP -If \fIformula\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\. -. -.IP -If \fB\-\-debug\fR (or \fB\-d\fR) is passed and brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\. -. -.IP -If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. -. -.IP -If \fB\-\-force\-bottle\fR is passed, install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. -. -.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 -If \fB\-\-ignore\-pinned\fR is passed, set a 0 exit code even if pinned formulae are not upgraded\. -. -.IP -If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installation are not deleted\. -. -.IP -If \fB\-\-force\fR (or \fB\-f\fR) is passed, install without checking for previously installed keg\-only or non\-migrated versions -. -.IP -If \fB\-\-verbose\fR (or \fB\-v\fR) is passed, print the verification and postinstall steps\. -. -.IP -If \fB\-\-display\-times\fR is passed, install times for each formula are printed at the end of the run\. -. -.IP -Additional options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\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\. -. -.IP -If \fB\-\-installed\fR is passed, only list installed formulae\. -. -.IP -By default, \fBuses\fR shows all formulae that specify \fIformulae\fR as a required or recommended dependency\. To include the \fB:build\fR type dependencies, pass \fB\-\-include\-build\fR, to include the \fB:test\fR type dependencies, pass \fB\-\-include\-test\fR and to include \fB:optional\fR dependencies pass \fB\-\-include\-optional\fR\. To skip \fB:recommended\fR type dependencies, pass \fB\-\-skip\-recommended\fR\. -. -.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\. -. -.TP -\fB\-\-cache\fR -Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\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\. -. -.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\. -. -.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\. -. -.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\. -. -.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\. -. -.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 -. -.TP -\fB\-\-prefix\fR \fIformula\fR -Display the location in the cellar where \fIformula\fR is or would be installed\. -. -.TP -\fB\-\-repository\fR -Display where Homebrew\'s \fB\.git\fR directory is located\. +.SS "\fBdiy\fR [\fIoptions\fR]" +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 \fBbrew link\fR\. . .TP -\fB\-\-repository\fR \fIuser\fR\fB/\fR\fIrepo\fR -Display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\. +\fB\-\-name\fR +Explicitly set the provided \fIname\fR of the package being installed\. . .TP \fB\-\-version\fR -Print the version number of Homebrew to standard output and exit\. +Explicitly set the provided \fIversion\fR of the package being installed\. +. +.SS "\fBdoctor\fR [\fIoptions\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 +\fB\-\-list\-checks\fR +List all audit methods\. +. +.TP +\fB\-D\fR, \fB\-\-audit\-debug\fR +Enable debugging and profiling of audit methods\. +. +.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR" +Download the source packages for the given \fIformula\fR\. For tarballs, also print SHA\-256 checksums\. +. +.TP +\fB\-\-HEAD\fR +Fetch HEAD version instead of stable version\. +. +.TP +\fB\-\-devel\fR +Fetch development version instead of stable version\. +. +.TP +\fB\-\-retry\fR +Retry if a download fails or re\-download if the checksum of a previously cached version no longer matches\. +. +.TP +\fB\-\-deps\fR +Download dependencies for any listed \fIformula\fR\. +. +.TP +\fB\-s\fR, \fB\-\-build\-from\-source\fR +Download the source for rather than a bottle\. +. +.TP +\fB\-\-build\-bottle\fR +Download the source (for eventual bottling) rather than a bottle\. +. +.TP +\fB\-\-force\-bottle\fR +Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\. +. +.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR" +Upload logs for a failed build of \fIformula\fR to a new Gist\. +. +.P +\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\. +. +.P +If no logs are found, an error message is presented\. +. +.TP +\fB\-\-with\-hostname\fR +Include the hostname in the Gist\. +. +.TP +\fB\-n\fR, \fB\-\-new\-issue\fR +Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\. +. +.TP +\fB\-p\fR, \fB\-\-private\fR +The Gist will be marked private and will not appear in listings but will be accessible with the link\. +. +.SS "\fBhome\fR [\fIformula\fR]" +Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\. +. +.SS "\fBinfo\fR [\fIformula\fR]" +Display brief statistics for your Homebrew installation\. +. +.TP +\fB\-\-analytics\fR +Display Homebrew analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)\. +. +.TP +\fB\-\-days\fR +The value for \fBdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\. +. +.TP +\fB\-\-category\fR +The value for \fBcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\. +. +.TP +\fB\-\-github\fR +Open a browser to the GitHub History page for provided \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR +. +.TP +\fB\-\-json\fR +Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR +. +.TP +\fB\-\-all\fR +Get information on all formulae\. +. +.TP +\fB\-\-installed\fR +Get information on all installed formulae\. +. +.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR" +Install \fIformula\fR\. +. +.P +\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\. +. +.TP +\fB\-\-env\fR +If \fBstd\fR is passed, use the standard build environment instead of superenv\.If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\. +. +.TP +\fB\-\-ignore\-dependencies\fR +Skip installing any dependencies of any kind\. If they are not already present, the formula will probably fail to install\. +. +.TP +\fB\-\-only\-dependencies\fR +Install the dependencies with specified options but do not install the specified formula\. +. +.TP +\fB\-\-cc\fR +Attempt to compile using provided \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this flag\. +. +.TP +\fB\-s\fR, \fB\-\-build\-from\-source\fR +Compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. +. +.TP +\fB\-\-force\-bottle\fR +Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. +. +.TP +\fB\-\-include\-test\fR +Install testing dependencies required to run \fBbrew test\fR\. +. +.TP +\fB\-\-devel\fR +If \fIformula\fR defines it, install the development version\. +. +.TP +\fB\-\-HEAD\fR +If \fIformula\fR defines it, install the HEAD version, aka\. master, trunk, unstable\. +. +.TP +\fB\-\-fetch\-HEAD\fR +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 development version has been released\. +. +.TP +\fB\-\-keep\-tmp\fR +Don\'t delete the temporary files created during installation\. +. +.TP +\fB\-\-build\-bottle\fR +Prepare the formula for eventual bottling during installation\. +. +.TP +\fB\-\-display\-times\fR +Print install times for each formula at the end of the run\. +. +.TP +\fB\-i\fR, \fB\-\-interactive\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 package\. +. +.TP +\fB\-g\fR, \fB\-\-git\fR +Create a Git repository, useful for creating patches to the software\. +. +.SS "\fBleaves\fR" +Show installed formulae that are not dependencies of another installed formula\. +. +.SS "\fBln\fR, \fBlink\fR [\fIoptions\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 +\fB\-\-overwrite\fR +Delete files already existing in the prefix while linking\. +. +.TP +\fB\-n\fR, \fB\-\-dry\-run\fR +List all files which would be linked or deleted by \fBbrew link \-\-overwrite\fR, but will not actually link or delete any files\. +. +.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR]" +List all installed formulae\. +. +.TP +\fB\-\-full\-name\fR +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 +\fB\-\-unbrewed\fR +List all files in the Homebrew prefix not installed by Homebrew\. +. +.TP +\fB\-\-versions\fR +Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are given\. +. +.TP +\fB\-\-multiple\fR +Only show formulae with multiple versions installed\. +. +.TP +\fB\-\-pinned\fR +Show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are given\. See also \fBpin\fR, \fBunpin\fR\. +. +.TP +\fB\-1\fR +Force output to be one entry per line\. This is the default when output is not to a terminal\. +. +.TP +\fB\-l\fR +List in long format\. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing\. +. +.TP +\fB\-r\fR +Reverse the order of the sort to get the oldest entries first\. +. +.TP +\fB\-t\fR +Sort by time modified (most recently modified first)\. +. +.SS "\fBlog\fR [\fIoptions\fR] \fIformula\fR" +Show the \fBgit log\fR for the given \fIformula\fR\. +. +.TP +\fB\-p\fR, \fB\-\-patch\fR +Also output patch from commit\. +. +.TP +\fB\-\-stat\fR +Also output diffstat from commit\. +. +.TP +\fB\-\-oneline\fR +Output only one line per commit\. +. +.TP +\fB\-1\fR, \fB\-\-max\-count\fR +Output only one commit\. +. +.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR" +Migrate renamed packages to new name, where \fIformula\fR are old names of packages\. +. +.SS "\fBmissing\fR [\fIoptions\fR] [\fIformule\fR]" +Check the given \fIformula\fR for missing dependencies\. If no \fIformula\fR are given, check all installed brews\. +. +.P +\fBmissing\fR exits with a non\-zero status if any formulae are missing dependencies\. +. +.TP +\fB\-\-hide\fR +Act as if none of the provided \fIhidden\fR are installed\. \fIhidden\fR should be comma\-separated list of formulae\. +. +.SS "\fBoptions\fR [\fIoptions\fR] \fIformula\fR" +Display install options specific to \fIformula\fR +. +.TP +\fB\-\-compact\fR +Show all options on a single line separated by spaces\. +. +.TP +\fB\-\-all\fR +Show options for all formulae\. +. +.TP +\fB\-\-installed\fR +Show options for all installed formulae\. +. +.SS "\fBoutdated\fR [\fIoptions\fR]" +Show formulae that have an updated version available\. +. +.P +By default, version information is displayed in interactive shells, and suppressed otherwise\. +. +.TP +\fB\-\-json\fR +Show output in JSON format for provided \fIversion\fR\. Currently the only accepted value of \fIversion\fR is \fBv1\fR\. +. +.TP +\fB\-\-fetch\-HEAD\fR +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 development version has been released\. +. +.SS "\fBpin\fR \fIformula\fR" +Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\. +. +.SS "\fBpostinstall\fR \fIformula\fR" +Rerun the post\-install steps for \fIformula\fR\. +. +.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR]" +Import all formulae from specified \fItap\fR (defaults to all installed taps)\. 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\. +. +.TP +\fB\-\-aliases\fR +Verify any alias symlinks in each tap\. +. +.TP +\fB\-\-syntax\fR +Syntax\-check all of Homebrew\'s Ruby files\. +. +.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR" +Uninstall and then install \fIformula\fR (with existing and any appended install options)\. +. +.TP +\fB\-s\fR, \fB\-\-build\-from\-source\fR +Compile \fIformula\fR from source even if a bottle is available\. +. +.TP +\fB\-\-force\-bottle\fR +Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. +. +.TP +\fB\-\-keep\-tmp\fR +Don\'t delete the temporary files created during installation\. +. +.TP +\fB\-\-display\-times\fR +Print install times for each formula at the end of the run\. +. +.SS "\fBsearch\fR [\fIoptions\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 \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. +. +.P +If no \fItext\fR is passed, display all locally available formulae (including tapped ones)\. No online search is performed\. +. +.TP +\fB\-\-casks\fR +Display all locally available casks (including tapped ones)\. No online search is performed\. +. +.TP +\fB\-\-desc\fR +search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\. +. +.TP +\fB\-\-macports\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.TP +\fB\-\-fink\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.TP +\fB\-\-opensuse\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.TP +\fB\-\-fedora\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.TP +\fB\-\-debian\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.TP +\fB\-\-ubuntu\fR +Search for \fItext\fR in the given package manager\'s list\. +. +.SS "\fBsh\fR [\fIoptions\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 +\fB\-\-env\fR +Use the standard \fBPATH\fR instead of superenv\'s, when \fIstd\fR is passed +. +.SS "\fBshellenv\fR" +Prints export statements \- run them in a shell and this installation of Homebrew will be included into your \fBPATH\fR, \fBMANPATH\fR and \fBINFOPATH\fR\. +. +.P +\fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to save multiple queries of those variables\. +. +.P +Consider adding evaluating the output in your dotfiles (e\.g\. \fB~/\.profile\fR) with \fBeval $(brew shellenv)\fR +. +.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR]" +Check formulae or files for conformance to Homebrew style guidelines\. +. +.P +Lists of \fIfile\fR, \fItap\fR and \fIformula\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\. +. +.TP +\fB\-\-fix\fR +Fix style violations automatically using RuboCop\'s auto\-correct feature\. +. +.TP +\fB\-\-display\-cop\-names\fR +Include the RuboCop cop name for each violation in the output\. +. +.TP +\fB\-\-only\-cops\fR +Specify a comma\-separated \fIcops\fR list to check for violations of only the listed RuboCop cops\. +. +.TP +\fB\-\-except\-cops\fR +Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\. +. +.SS "\fBswitch\fR \fIformula\fR \fIversion\fR" +Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\. +. +.SS "\fBtap\fR [\fIoptions\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]" +Tap a formula repository\. +. +.P +List all installed taps when no arguments are passed\. +. +.P +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 \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\. +. +.P +With \fIURL\fR specified, 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\. +. +.TP +\fB\-\-full\fR +Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap passing \fB\-\-full\fR without first untapping\. +. +.TP +\fB\-\-force\-auto\-update\fR +Auto\-update tap even if it is not hosted on GitHub\. By default, only taps hosted on GitHub are auto\-updated (for performance reasons)\. +. +.TP +\fB\-\-repair\fR +Migrate tapped formulae from symlink\-based to directory\-based structure\. +. +.TP +\fB\-\-list\-pinned\fR +List all pinned taps\. +. +.TP +\fB\-q\fR, \fB\-\-quieter\fR +Suppress any warnings\. +. +.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]" +Display detailed information about one or more provided \fItap\fR\. Display a brief summary of all installed taps if no \fItap\fR are passed\. +. +.TP +\fB\-\-installed\fR +Display information on all installed taps\. +. +.TP +\fB\-\-json\fR +Print a JSON representation of \fItaps\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR +. +.SS "\fBtap\-pin\fR \fItap\fR" +Pin \fItap\fR, prioritising its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\. +. +.SS "\fBtap\-unpin\fR \fItap\fR" +Unpin \fItap\fR so its formulae are no longer prioritised\. See also \fBtap\-pin\fR\. +. +.SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR" +Uninstall \fIformula\fR\. +. +.TP +\fB\-\-ignore\-dependencies\fR +Don\'t fail uninstall, even if \fIformula\fR is a dependency of any installed formulae\. +. +.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR" +Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR +. +.TP +\fB\-n\fR, \fB\-\-dry\-run\fR +List all files which would be unlinked, but will not actually unlink or delete any files\. +. +.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR" +Unpack the source files for \fIformula\fR into subdirectories of the current working directory\. +. +.TP +\fB\-\-destdir\fR +Create subdirectories in the directory named by \fIpath\fR instead\. +. +.TP +\fB\-\-patch\fR +Patches for \fIformula\fR will be applied to the unpacked source\. +. +.TP +\fB\-g\fR, \fB\-\-git\fR +Initialise a Git repository in the unpacked source\. This is useful for creating patches for the software\. +. +.SS "\fBunpin\fR \fIformula\fR" +Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\. +. +.SS "\fBuntap\fR \fItap\fR" +Remove a tapped repository\. +. +.SS "\fBupdate\fR [\fIoptions\fR]" +Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\. +. +.TP +\fB\-\-merge\fR +\fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\. +. +.TP +\fB\-\-force\fR +Always do a slower, full update check (even if unnecessary)\. +. +.SS "\fBupdate\-reset\fR [\fIrepository\fR]" +Fetches and resets Homebrew and all tap repositories (or any specified \fBrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\. +. +.SS "\fBupgrade\fR [\fIoptions\fR] \fIformula\fR" +Upgrade outdated, unpinned brews (with existing and any appended install options)\. +. +.P +If \fIformula\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\. +. +.TP +\fB\-s\fR, \fB\-\-build\-from\-source\fR +Compile \fIformula\fR from source even if a bottle is available\. +. +.TP +\fB\-\-force\-bottle\fR +Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\. +. +.TP +\fB\-\-fetch\-HEAD\fR +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 development version has been released\. +. +.TP +\fB\-\-ignore\-pinned\fR +Set a 0 exit code even if pinned formulae are not upgraded\. +. +.TP +\fB\-\-keep\-tmp\fR +Don\'t delete the temporary files created during installation\. +. +.TP +\fB\-\-display\-times\fR +Print install times for each formula at the end of the run\. +. +.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR" +Show the formulae that specify \fIformula\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. +. +.P +By default, \fBuses\fR shows all formulae that specify \fIformula\fR as a required or recommended dependency\. +. +.P +By default, \fBuses\fR shows usage of \fIformula\fR by stable builds\. +. +.TP +\fB\-\-recursive\fR +Resolve more than one level of dependencies\. +. +.TP +\fB\-\-installed\fR +Only list installed formulae\. +. +.TP +\fB\-\-include\-build\fR +Include all formulae that specify \fIformula\fR as \fB:build\fR type dependency\. +. +.TP +\fB\-\-include\-test\fR +Include all formulae that specify \fIformula\fR as \fB:test\fR type dependency\. +. +.TP +\fB\-\-include\-optional\fR +Include all formulae that specify \fIformula\fR as \fB:optional\fR type dependency\. +. +.TP +\fB\-\-skip\-recommended\fR +Skip all formulae that specify \fIformula\fR as \fB:recommended\fR type dependency\. +. +.TP +\fB\-\-devel\fR +Show usage of \fIformula\fR by development build\. +. +.TP +\fB\-\-HEAD\fR +Show usage of \fIformula\fR by HEAD build\. +. +.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR]" +Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\. +. +.P +If \fIformula\fR is provided, display the file or directory used to cache \fIformula\fR\. +. +.TP +\fB\-s\fR, \fB\-\-build\-from\-source\fR +Show the cache file used when building from source\. +. +.TP +\fB\-\-force\-bottle\fR +Show the cache file used when pouring a bottle\. +. +.SS "\fB\-\-cache\fR [\fIformula\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\. +. +.P +If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\. +. +.SS "\fB\-\-env\fR [\fIoptions\fR]" +Show a summary of the Homebrew build environment as a plain list\. +. +.P +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\. +. +.TP +\fB\-\-shell\fR +Generate a list of environment variables for the specified shell, or \fB\-\-shell=auto\fR to detect the current shell\. +. +.TP +\fB\-\-plain\fR +Plain output even when piped\. +. +.SS "\fB\-\-prefix\fR [\fIformula\fR]" +Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux\. +. +.P +If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR is or would be installed\. +. +.SS "\fB\-\-repository\fR [\fIformula\fR]" +Display where Homebrew\'s \fB\.git\fR directory is located\. +. +.P +If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\. +. +.SS "\fB\-\-version\fR" +Print the version number of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output and exit\. . .SH "DEVELOPER COMMANDS" . -.SS "\fBaudit\fR [\fIoptions\fR] \fIformulae\fR" -Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\. If no \fIformulae\fR are provided, all of them are checked\. +.SS "\fBaudit\fR [\fIoptions\fR] \fIformula\fR" +Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\. If no \fIformula\fR are provided, all of them are checked\. . .TP \fB\-\-strict\fR @@ -772,7 +815,7 @@ Specify a comma\-separated \fIcops\fR list to check for violations of only the l \fB\-\-except\-cops\fR Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\. . -.SS "\fBbottle\fR [\fIoptions\fR] \fIformulae\fR" +.SS "\fBbottle\fR [\fIoptions\fR] \fIformula\fR" Generate a bottle (binary package) from a formula that was installed with \fB\-\-build\-bottle\fR\. If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\. . .TP @@ -914,7 +957,7 @@ Set the version of the new formula to the provided \fIversion\fR\. \fB\-\-tap\fR Generate the new formula in the provided tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\. . -.SS "\fBedit\fR [\fIformulae\fR]" +.SS "\fBedit\fR [\fIformula\fR]" Open a formula in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no \fIformula\fR is provided\. . .SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR" @@ -924,7 +967,7 @@ Look through repository history to find the most recent version of \fIformula\fR \fB\-\-version\fR Extract the provided \fIversion\fR of \fIformula\fR instead of the most recent\. . -.SS "\fBformula\fR \fIformulae\fR" +.SS "\fBformula\fR \fIformula\fR" Display the path where a formula is located\. . .SS "\fBirb\fR [\fIoptions\fR]" @@ -938,7 +981,7 @@ Show several examples\. \fB\-\-pry\fR Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\. . -.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformulae\fR]" +.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR]" Check the library links for kegs of installed formulae\. Raises an error if run on uninstalled formulae\. . .TP @@ -964,32 +1007,14 @@ Return a failing status code if changes are detected in the manpage outputs\. Th \fB\-\-link\fR This is now done automatically by \fBbrew update\fR\. . -.SS "\fBmirror\fR \fIformulae\fR" -Reuploads the stable URL for a formula to Bintray to use it as a mirror\. +.SS "\fBprof\fR \fIcommand\fR" +Run Homebrew with the Ruby profiler e\.g\. \fBbrew prof readall\fR\. . -.SS "\fBprof\fR [\fIruby options\fR]" -Run Homebrew with the Ruby profiler\. -. -.P -\fIExample:\fR \fBbrew prof readall\fR -. -.SS "\fBpull\fR [\fIoptions\fR] \fIpatch sources\fR" +.SS "\fBpull\fR [\fIoptions\fR] \fIpatch\fR" Get a patch from a GitHub commit or pull request and apply it to Homebrew\. Optionally, publish updated bottles for the formulae changed by the patch\. . .P -Each \fIpatch source\fR may be one of: -. -.P -~ The ID number of a PR (pull request) in the homebrew/core GitHub repository -. -.P -~ The URL of a PR on GitHub, using either the web page or API URL formats\. In this form, the PR may be on Homebrew/brew, Homebrew/homebrew\-core or any tap\. -. -.P -~ The URL of a commit on GitHub -. -.P -~ A "https://jenkins\.brew\.sh/job/\.\.\." string specifying a testing job ID +Each \fIpatch\fR may be the number of a PR in homebrew/core, the URL of a PR on GitHub, the URL of a commit on GitHub or a "https://jenkins\.brew\.sh/job/\.\.\." testing job URL\. . .TP \fB\-\-bottle\fR @@ -1042,11 +1067,8 @@ Print the merged pull requests on Homebrew/brew between two Git refs\. If no \fI \fB\-\-markdown\fR Print as a Markdown list\. . -.SS "\fBruby\fR [\fIruby options\fR]" -Run a Ruby instance with Homebrew\'s libraries loaded\. -. -.P -\fIExample:\fR \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR +.SS "\fBruby\fR [\fB\-e\fR]:" +Run a Ruby instance with Homebrew\'s libraries loaded e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR . .TP \fB\-e\fR @@ -1055,7 +1077,7 @@ Execute the provided string argument as a script\. .SS "\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR" Generate the template files for a new tap\. . -.SS "\fBtest\fR [\fIoptions\fR] \fIformulae\fR" +.SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR" Run the test method provided by an installed formula\. There is no standard output or return code, but generally it should notify the user if something is wrong with the installed formula\. . .P @@ -1098,7 +1120,7 @@ Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR w . .TP \fB\-\-seed\fR -Randomize tests with the provided \fIvalue\fR instead of a random seed\. +Randomise tests with the provided \fIvalue\fR instead of a random seed\. . .SS "\fBupdate\-test\fR [\fIoptions\fR]" Run a test of \fBbrew update\fR with a new repository clone\. If no arguments are passed, use \fBorigin/master\fR as the start commit\. @@ -1119,10 +1141,8 @@ Use provided \fIcommit\fR as the start commit\. \fB\-\-before\fR Use the commit at provided \fIdate\fR as the start commit\. . -.TP -\fBvendor\-gems\fR +.SS "\fBvendor\-gems\fR" Install and commit Homebrew\'s vendored gems\. - . .SH "GLOBAL OPTIONS" These options are applicable across all sub\-commands\. @@ -1145,102 +1165,24 @@ Override warnings and enable potentially unsafe operations\. . .SH "OFFICIAL EXTERNAL COMMANDS" . -.TP -\fBbundle\fR \fIcommand\fR -Bundler for non\-Ruby dependencies from Homebrew\. +.SS "\fBbundle\fR \fIsubcommand\fR:" +Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store\. See \fBbrew bundle \-\-help\fR\. . -.IP -\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] - 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 -\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 - 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] - 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 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\. -. -.IP -If \fB\-\-zap\fR is passed, casks will be removed using the \fBzap\fR command instead of \fBuninstall\fR\. -. -.IP -If \fB\-\-file=\fR\fIpath\fR is passed, the Brewfile path is set accordingly\. Use \fB\-\-file=\-\fR to output to console\. -. -.IP -If \fB\-\-global\fR is passed, set the Brewfile path to \fB~/\.Brewfile\fR\. -. -.IP -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\. -. -.IP +.P \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\. +.SS "\fBcask\fR \fIsubcommand\fR:" +Install macOS applications distributed as binaries\. See brew\-cask(1)\. . -.IP +.P \fBHomebrew/homebrew\-cask\fR \fIhttps://github\.com/Homebrew/homebrew\-cask\fR . -.TP -\fBservices\fR \fIcommand\fR -Integrates Homebrew formulae with macOS\' \fBlaunchctl\fR manager\. +.SS "\fBservices\fR \fIsubcommand\fR:" +Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager\. See \fBbrew services \-\-help\fR\. . -.IP -[\fBsudo\fR] \fBbrew services list\fR - List all running services for the current user (or root)\. -. -.IP -[\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 -[\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 -[\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 -[\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 -[\fBsudo\fR] \fBbrew services cleanup\fR - Remove all unused services\. -. -.IP -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 +.P \fBHomebrew/homebrew\-services\fR \fIhttps://github\.com/Homebrew/homebrew\-services\fR . @@ -1372,7 +1314,7 @@ If set, Homebrew will fail on the failure of installation from a bottle rather t . .TP \fBHOMEBREW_NO_COLOR\fR -If set, Homebrew will not print text with color added\. +If set, Homebrew will not print text with colour added\. . .TP \fBHOMEBREW_NO_EMOJI\fR