mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/Manpage.md

1309 lines
51 KiB
Markdown
Raw Normal View History

man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
brew(1) -- The missing package manager for macOS
===============================================
## SYNOPSIS
`brew` `--version`<br>
Document all short flags.
2017-04-02 10:14:21 +01:00
`brew` `command` [`--verbose`|`-v`] [`options`] [`formula`] ...
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
## DESCRIPTION
Homebrew is the easiest and most flexible way to install the UNIX tools Apple
didn't include with macOS.
## ESSENTIAL COMMANDS
Fix another internal link
2017-05-07 00:45:02 +01:00
For the full command list, see the [COMMANDS](#commands) section.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
With `--verbose` or `-v`, many commands print extra debugging information. Note that these flags should only appear after a command.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `install` `formula`:
Install `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `uninstall` `formula`:
Uninstall `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `update`:
Fetch the newest version of Homebrew from GitHub using `git`(1).
* `list`:
List all installed formulae.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `search` (`text`|`/``text``/`):
Perform a substring search of formula names for `text`. If `text` is
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
surrounded with slashes, then it is interpreted as a regular expression.
Document all short flags.
2017-04-02 10:14:21 +01:00
The search for `text` is extended online to some popular taps.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If no search term is given, all locally available formulae are listed.
## COMMANDS
* `analytics` [`state`]:
Display anonymous user behaviour analytics state.
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
Read more at <https://docs.brew.sh/Analytics>.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `analytics` (`on`|`off`):
Turn on/off Homebrew's analytics.
* `analytics` `regenerate-uuid`:
Regenerate UUID used in Homebrew's analytics.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `cat` `formula`:
Display the source to `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `cleanup` [`--prune=``days`] [`--dry-run`] [`-s`] [`formulae`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
For all installed or specific formulae, remove any older versions from the
cellar. In addition, old downloads from the Homebrew download-cache are deleted.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--prune=``days` is specified, remove all cache files older than `days`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--dry-run` or `-n` is passed, show what would be removed, but do not
actually remove anything.
If `-s` is passed, scrub the cache, removing downloads for even the latest
versions of formulae. Note downloads for any installed formulae will still not be
deleted. If you want to delete those too: `rm -rf $(brew --cache)`
Document all short flags.
2017-04-02 10:14:21 +01:00
* `command` `cmd`:
Display the path to the file which is used when invoking `brew` `cmd`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `commands` [`--quiet` [`--include-aliases`]]:
Show a list of built-in and external commands.
If `--quiet` is passed, list only the names of commands without the header.
With `--include-aliases`, the aliases of internal commands will be included.
* `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.
brew deps: add --include-requirements
2017-08-03 00:41:51 -04:00
* `deps` [`--1`] [`-n`] [`--union`] [`--full-name`] [`--installed`] [`--include-build`] [`--include-optional`] [`--skip-recommended`] [`--include-requirements`] `formulae`:
Document all short flags.
2017-04-02 10:14:21 +01:00
Show dependencies for `formulae`. When given multiple formula arguments,
show the intersection of dependencies for `formulae`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--1` is passed, only show dependencies one level down, instead of
recursing.
If `-n` is passed, show dependencies in topological order.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--union` is passed, show the union of dependencies for `formulae`,
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
instead of the intersection.
If `--full-name` is passed, list dependencies by their full name.
If `--installed` is passed, only list those dependencies that are
currently installed.
By default, `deps` shows required and recommended dependencies for
Document all short flags.
2017-04-02 10:14:21 +01:00
`formulae`. To include the `:build` type dependencies, pass `--include-build`.
Allow :test dependencies. These specify that they are needed by the test block. This can be combined with `:build` to ensure that this formula isn't uninstalled by `brew test-bot` when running `test do` blocks on our CI.
2018-03-05 10:36:39 +00:00
Similarly, pass `--include-optional` to include `:optional` dependencies or
deps: don't display recursive test dependencies. You only care about the test dependencies for the specific formula you are testing right now.
2018-03-14 15:41:18 +00:00
`--include-test` to include (non-recursive) `:test` dependencies.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
To skip `:recommended` type dependencies, pass `--skip-recommended`.
brew deps: add --include-requirements
2017-08-03 00:41:51 -04:00
To include requirements in addition to dependencies, pass `--include-requirements`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
brew deps: add --include-requirements
2017-08-03 00:41:51 -04:00
* `deps` `--tree` [`--1`] [`filters`] [`--annotate`] (`formulae`|`--installed`):
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Show dependencies as a tree. When given multiple formula arguments, output
individual trees for every formula.
brew deps: add --include-requirements
2017-08-03 00:41:51 -04:00
If `--1` is passed, only one level of children is displayed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--installed` is passed, output a tree for every installed formula.
Document all short flags.
2017-04-02 10:14:21 +01:00
The `filters` placeholder is any combination of options `--include-build`,
Allow :test dependencies. These specify that they are needed by the test block. This can be combined with `:build` to ensure that this formula isn't uninstalled by `brew test-bot` when running `test do` blocks on our CI.
2018-03-05 10:36:39 +00:00
`--include-optional`, `--include-test`, `--skip-recommended`, and
`--include-requirements` as documented above.
brew deps: add --include-requirements
2017-08-03 00:41:51 -04:00
If `--annotate` is passed, the build, optional, and recommended dependencies
are marked as such in the output.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `deps` [`filters`] (`--installed`|`--all`):
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
The `filters` placeholder is any combination of options `--include-build`,
Allow :test dependencies. These specify that they are needed by the test block. This can be combined with `:build` to ensure that this formula isn't uninstalled by `brew test-bot` when running `test do` blocks on our CI.
2018-03-05 10:36:39 +00:00
`--include-optional`, `--include-test`, and `--skip-recommended` as
documented above.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `desc` `formula`:
Display `formula`'s name and one-line description.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `diy` [`--name=``name`] [`--version=``version`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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`.
Document all short flags.
2017-04-02 10:14:21 +01:00
The options `--name=``name` and `--version=``version` each take an argument
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
and allow you to explicitly set the name and version of the package you are
installing.
* `doctor`:
Check your system for potential problems. Doctor exits with a non-zero status
doctor: tell people not to file issues. This stuff doesn't matter.
2017-12-11 15:27:18 +00:00
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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `fetch` [`--force`] [`--retry`] [`-v`] [`--devel`|`--HEAD`] [`--deps`] [`--build-from-source`|`--force-bottle`] `formulae`:
Download the source packages for the given `formulae`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
For tarballs, also print SHA-256 checksums.
If `--HEAD` or `--devel` is passed, fetch that version instead of the
stable version.
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force` (or `-f`) is passed, remove a previously cached version and re-fetch.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--retry` is passed, retry if a download fails or re-download if the
checksum of a previously cached version no longer matches.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--deps` is passed, also download dependencies for any listed `formulae`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--build-from-source` (or `-s`) is passed, download the source rather than a
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
bottle.
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `gist-logs` [`--new-issue`|`-n`] `formula`:
Upload logs for a failed build of `formula` to a new Gist.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
`formula` is usually the name of the formula to install, but it can be specified
Fix the link code
2017-05-07 00:35:36 +01:00
in several different ways. See [SPECIFYING FORMULAE](#specifying-formulae).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
If `--with-hostname` is passed, include the hostname in the Gist.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--new-issue` is passed, automatically create a new issue in the appropriate
GitHub repository as well as creating the Gist.
If no logs are found, an error message is presented.
* `home`:
Open Homebrew's own homepage in a browser.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `home` `formula`:
Open `formula`'s homepage in a browser.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `info`:
Display brief statistics for your Homebrew installation.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `info` `formula`:
Display information about `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `info` `--github` `formula`:
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
Open a browser to the GitHub History page for `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: fix double backticks appearing in HTML manpage
2018-02-01 17:17:09 -05:00
To view formula history locally: `brew log -p `formula
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `info` `--json=``version` (`--all`|`--installed`|`formulae`):
Print a JSON representation of `formulae`. Currently the only accepted value
for `version` is `v1`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Pass `--all` to get information on all formulae, or `--installed` to get
information on all installed formulae.
See the docs for examples of using the JSON output:
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
<https://docs.brew.sh/Querying-Brew>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
install: add --include-test option. Allow at `install` (or `install --only-dependencies`) time to specify that test dependencies should be installed. This will allow simplifying code in `brew test-bot`. This could also be made an environment variable if desired by maintainers.
2018-03-15 13:37:34 +00:00
* `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`] `formula` [`options` ...]:
Document all short flags.
2017-04-02 10:14:21 +01:00
Install `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
`formula` is usually the name of the formula to install, but it can be specified
Fix the link code
2017-05-07 00:35:36 +01:00
in several different ways. See [SPECIFYING FORMULAE](#specifying-formulae).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
session with access to IRB or a shell inside the temporary build directory.
If `--env=std` is passed, use the standard build environment instead of superenv.
If `--env=super` is passed, use superenv even if the formula specifies the
standard build environment.
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.
If `--only-dependencies` is passed, install the dependencies with specified
options but do not install the specified formula.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--cc=``compiler` is passed, attempt to compile using `compiler`.
`compiler` should be the name of the compiler's executable, for instance
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
`gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC
4.9.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
source even if a bottle is provided. Dependencies will still be installed
from bottles if they are available.
If `HOMEBREW_BUILD_FROM_SOURCE` is set, regardless of whether `--build-from-source` was
Document all short flags.
2017-04-02 10:14:21 +01:00
passed, then both `formula` and the dependencies installed as part of this process
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
are built from source even if bottles 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.
install: add --include-test option. Allow at `install` (or `install --only-dependencies`) time to specify that test dependencies should be installed. This will allow simplifying code in `brew test-bot`. This could also be made an environment variable if desired by maintainers.
2018-03-15 13:37:34 +00:00
If `--include-test` is passed, install testing dependencies. These are only
needed by formulae maintainers to run `brew test`.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--devel` is passed, and `formula` defines it, install the development version.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--HEAD` is passed, and `formula` defines it, install the HEAD version,
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
aka master, trunk, unstable.
If `--keep-tmp` is passed, the temporary files created during installation
are not deleted.
If `--build-bottle` is passed, prepare the formula for eventual bottling
during installation.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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.
Correct syntax error in Manpage.md
2017-07-11 23:53:49 +02:00
Installation options specific to `formula` may be appended to the command,
Run brew man
2017-07-13 11:15:22 +02:00
and can be listed with `brew options` `formula`.
Add a suitable explanatory line
2017-07-11 23:43:28 +02:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
creating patches to the software.
* `leaves`:
Show installed formulae that are not dependencies of another installed formula.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `ln`, `link` [`--overwrite`] [`--dry-run`] [`--force`] `formula`:
Symlink all of `formula`'s installed files into the Homebrew prefix. This
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
is done automatically when you install formulae but can be useful for DIY
installations.
If `--overwrite` is passed, Homebrew will delete files which already exist in
the prefix while linking.
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force` (or `-f`) is passed, Homebrew will allow keg-only formulae to be linked.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `list`, `ls` [`--full-name`]:
List all installed formulae. If `--full-name` is passed, print formulae
with fully-qualified names. If `--full-name` is not passed, any other
options (e.g. `-t`) are passed to `ls` which produces the actual output.
* `list`, `ls` `--unbrewed`:
List all files in the Homebrew prefix not installed by Homebrew.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `list`, `ls` [`--verbose`] [`--versions` [`--multiple`]] [`--pinned`] [`formulae`]:
Document all short flags.
2017-04-02 10:14:21 +01:00
List the installed files for `formulae`. Combined with `--verbose`, recursively
list the contents of all subdirectories in each `formula`'s keg.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--versions` is passed, show the version number for installed formulae,
Document all short flags.
2017-04-02 10:14:21 +01:00
or only the specified formulae if `formulae` are given. With `--multiple`,
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
only show formulae with multiple versions installed.
If `--pinned` is passed, show the versions of pinned formulae, or only the
Document all short flags.
2017-04-02 10:14:21 +01:00
specified (pinned) formulae if `formulae` are given.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
See also `pin`, `unpin`.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `log` [`git-log-options`] `formula` ...:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Show the git log for the given formulae. Options that `git-log`(1)
recognizes can be passed before the formula list.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `migrate` [`--force`] `formulae`:
Migrate renamed packages to new name, where `formulae` are old names of
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
packages.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force` (or `-f`) is passed, then treat installed `formulae` and passed `formulae`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
like if they are from same taps and migrate them anyway.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `missing` [`--hide=``hidden`] [`formulae`]:
Check the given `formulae` for missing dependencies. If no `formulae` are
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
given, check all installed brews.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--hide=``hidden` is passed, act as if none of `hidden` are installed.
`hidden` should be a comma-separated list of formulae.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `options` [`--compact`] (`--all`|`--installed`|`formulae`):
Display install options specific to `formulae`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `outdated` [`--quiet`|`--verbose`|`--json=``version`] [`--fetch-HEAD`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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`).
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--verbose` (or `-v`) is passed, display detailed version information.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
If `--json=``version` is passed, the output will be in JSON format.
Currently the only accepted value for `version` is `v1`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `pin` `formulae`:
Pin the specified `formulae`, preventing them from being upgraded when
Make pinning more robust Don’t autoremove pins on uninstall or upgrade and note this in the manpage.
2018-02-05 09:31:17 +00:00
issuing the `brew upgrade `formulae command. See also `unpin`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `postinstall` `formula`:
Rerun the post-install steps for `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `prune` [`--dry-run`]:
Remove dead symlinks from the Homebrew prefix. This is generally not
Disable/delete/add more deprecations Move various `odeprecated` to `odisabled` and delete uses of `odisabled`.
2018-03-25 10:11:24 +01:00
needed, but can be useful when doing DIY installations.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--dry-run` or `-n` is passed, show what would be removed, but do not
actually remove anything.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `readall` [`--aliases`] [`--syntax`] [`taps`]:
Import all formulae from specified `taps` (defaults to all installed taps).
Unhide readall and update-reset from manpage. These are both tools that end-users can find useful on occasion so it doesn't make sense to hide them.
2017-10-26 16:14:14 +01:00
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.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `reinstall` `formula`:
reinstall/upgrade: document use of options. To avoid user confusion e.g. #3606.
2017-12-30 21:23:33 +00:00
Uninstall and then install `formula` (with existing install options).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `search`, `-S`:
Display all locally available formulae for brewing (including tapped ones).
No online search is performed if called without arguments.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `search` [`--desc`] (`text`|`/``text``/`):
Perform a substring search of formula names for `text`. If `text` is
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
surrounded with slashes, then it is interpreted as a regular expression.
Document all short flags.
2017-04-02 10:14:21 +01:00
The search for `text` is extended online to some popular taps.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--desc` is passed, browse available packages matching `text` including a
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
description for each.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `search` (`--debian`|`--fedora`|`--fink`|`--macports`|`--opensuse`|`--ubuntu`) `text`:
Search for `text` in the given package manager's list.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `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.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `style` [`--fix`] [`--display-cop-names`] [`--only-cops=``cops`|`--except-cops=``cops`] [`files`|`taps`|`formulae`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Check formulae or files for conformance to Homebrew style guidelines.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
If `--fix` is passed, automatically fix style violations using RuboCop's
auto-correct feature.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
If `--display-cop-names` is passed, include the RuboCop cop name for each
violation in the output.
Add `--only-cops`,`--except-cops` options for brew style and simplify cop names
2017-05-03 11:33:00 +05:30
style: add optional rubocop-rspec support. It's really noisy and too pedantic for us to use now but I got it working locally and used `--fix` to generate #3981 so let's add it as an option for now.
2018-03-25 13:34:57 +01:00
If `--rspec` is passed, install and use the RuboCop RSpec gem.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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.
Add `--only-cops`,`--except-cops` options for brew style and simplify cop names
2017-05-03 11:33:00 +05:30
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Exits with a non-zero status if any style violations are found.
cmd/switch: improve usability. - Ensure that we output the available versions where relevant - Use `<formula>` to be consistent with other commands’ help - General code cleanup
2018-03-30 15:01:41 +01:00
* `switch` `formula` `version`:
Symlink all of the specific `version` of `formula`'s install to Homebrew prefix.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `tap`:
List all installed taps.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap` [`--full`] `user``/``repo` [`URL`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Tap a formula repository.
Document all short flags.
2017-04-02 10:14:21 +01:00
With `URL` unspecified, taps a formula repository from GitHub using HTTPS.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Since so many taps are hosted on GitHub, this command is a shortcut for
docs: fix double backticks appearing in HTML manpage
2018-02-01 17:17:09 -05:00
`tap `user`/`repo` https://github.com/`user`/homebrew-`repo.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
With `URL` specified, taps a formula repository from anywhere, using
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
`tap` is re-runnable and exits successfully if there's nothing to do.
Document all short flags.
2017-04-02 10:14:21 +01:00
However, retapping with a different `URL` will cause an exception, so first
`untap` if you need to modify the `URL`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap-info` (`--installed`|`taps`):
Display detailed information about one or more `taps`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Pass `--installed` to display information on all installed taps.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap-info` `--json=``version` (`--installed`|`taps`):
Print a JSON representation of `taps`. Currently the only accepted value
for `version` is `v1`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Pass `--installed` to get information on installed taps.
See the docs for examples of using the JSON output:
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
<https://docs.brew.sh/Querying-Brew>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap-pin` `tap`:
Pin `tap`, prioritizing its formulae over core when formula names are supplied
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
by the user. See also `tap-unpin`.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap-unpin` `tap`:
Unpin `tap` so its formulae are no longer prioritized. See also `tap-pin`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] `formula`:
Uninstall `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force` (or `-f`) is passed, and there are multiple versions of `formula`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
installed, delete all installed versions.
If `--ignore-dependencies` is passed, uninstalling won't fail, even if
Document all short flags.
2017-04-02 10:14:21 +01:00
formulae depending on `formula` would still be installed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `unlink` [`--dry-run`] `formula`:
Remove symlinks for `formula` from the Homebrew prefix. This can be useful
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
for temporarily disabling a formula:
docs: fix double backticks appearing in HTML manpage
2018-02-01 17:17:09 -05:00
`brew unlink `formula` && `commands` && brew link `formula
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--patch` is passed, patches for `formulae` will be applied to the
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
unpacked source.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--git` (or `-g`) is passed, a Git repository will be initialized in the unpacked
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
source. This is useful for creating patches for the software.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `unpin` `formulae`:
docs: fix double backticks appearing in HTML manpage
2018-02-01 17:17:09 -05:00
Unpin `formulae`, allowing them to be upgraded by `brew upgrade `formulae.
Note cases when pinned formulae get upgraded. Fixes #3021.
2017-08-11 17:23:11 +01:00
See also `pin`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `untap` `tap`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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`).
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force` (or `-f`) is specified then always do a slower, full update check even
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
if unnecessary.
Unhide readall and update-reset from manpage. These are both tools that end-users can find useful on occasion so it doesn't make sense to hide them.
2017-10-26 16:14:14 +01:00
* `update-reset`:
Fetches and resets Homebrew and all tap repositories using `git`(1) to
their latest `origin/master`. Note this will destroy all your uncommitted
or committed changes.
upgrade: make pinned error have correct exit code. Also, display before saying "no packages to upgrade". Fixes #3936.
2018-03-16 20:31:20 +00:00
* `upgrade` [`install-options`] [`--cleanup`] [`--fetch-HEAD`] [`--ignore-pinned`] [`formulae`]:
reinstall/upgrade: document use of options. To avoid user confusion e.g. #3606.
2017-12-30 21:23:33 +00:00
Upgrade outdated, unpinned brews (with existing install options).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Options for the `install` command are also valid here.
upgrade: add HOMEBREW_UPGRADE_CLEANUP variable. Allow users to specify they want `brew upgrade --cleanup` to always be run when they run `brew upgrade`.
2018-03-12 11:05:06 +00:00
If `--cleanup` is specified or `HOMEBREW_UPGRADE_CLEANUP` is set then remove
previously installed `formula` version(s).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
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.
upgrade: make pinned error have correct exit code. Also, display before saying "no packages to upgrade". Fixes #3936.
2018-03-16 20:31:20 +00:00
If `--ignore-pinned` is passed, set a 0 exit code even if pinned formulae
are not upgraded.
upgrade: fix the man page wrongly saying that it will upgrade pins. This is incorrect as in order to upgrade a pinned package it must first be unpinned.
2018-03-10 11:54:10 +00:00
If `formulae` are given, upgrade only the specified brews (unless they
are pinned; see `pin`, `unpin`).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
uses: add --include-test support.
2018-03-16 09:29:31 +00:00
* `uses` [`--installed`] [`--recursive`] [`--include-build`] [`--include-test`] [`--include-optional`] [`--skip-recommended`] [`--devel`|`--HEAD`] `formulae`:
Document all short flags.
2017-04-02 10:14:21 +01:00
Show the formulae that specify `formulae` as a dependency. When given
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
multiple formula arguments, show the intersection of formulae that use
Document all short flags.
2017-04-02 10:14:21 +01:00
`formulae`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Use `--recursive` to resolve more than one level of dependencies.
If `--installed` is passed, only list installed formulae.
Document all short flags.
2017-04-02 10:14:21 +01:00
By default, `uses` shows all formulae that specify `formulae` as a required
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
or recommended dependency. To include the `:build` type dependencies, pass
uses: add --include-test support.
2018-03-16 09:29:31 +00:00
`--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`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
uses: add --include-test support.
2018-03-16 09:29:31 +00:00
By default, `uses` shows usage of `formulae` by stable builds. To find
Document all short flags.
2017-04-02 10:14:21 +01:00
cases where `formulae` is used by development or HEAD build, pass
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
`--devel` or `--HEAD`.
* `--cache`:
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `--cache` `formula`:
Display the file or directory used to cache `formula`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `--cellar`:
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `--cellar` `formula`:
Display the location in the cellar where `formula` would be installed,
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
without any sort of versioned directory as the last path.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `--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.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `--prefix`:
Display Homebrew's install path. *Default:* `/usr/local`
Document all short flags.
2017-04-02 10:14:21 +01:00
* `--prefix` `formula`:
Display the location in the cellar where `formula` is or would be installed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `--repository`:
Fix outdated `--repository` man documentation
2017-06-15 17:39:57 -07:00
Display where Homebrew's `.git` directory is located.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `--repository` `user``/``repo`:
Display where tap `user``/``repo`'s directory is located.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `--version`:
Print the version number of Homebrew to standard output and exit.
## DEVELOPER COMMANDS
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `audit` [`--strict`] [`--fix`] [`--online`] [`--new-formula`] [`--display-cop-names`] [`--display-filename`] [`--only=``method`|`--except=``method`] [`--only-cops=``cops`|`--except-cops=``cops`] [`formulae`]:
Document all short flags.
2017-04-02 10:14:21 +01:00
Check `formulae` for Homebrew coding style violations. This should be
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
run before submitting a new formula.
Document all short flags.
2017-04-02 10:14:21 +01:00
If no `formulae` are provided, all of them are checked.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--strict` is passed, additional checks are run, including RuboCop
style checks.
If `--fix` is passed, style violations will be
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
automatically fixed using RuboCop's auto-correct feature.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--online` is passed, additional slower checks that require a network
connection are run.
If `--new-formula` is passed, various additional checks are run that check
if a new formula is eligible for Homebrew. This should be used when creating
new formulae and implies `--strict` and `--online`.
If `--display-cop-names` is passed, the RuboCop cop name for each violation
is included in the output.
If `--display-filename` is passed, every line of output is prefixed with the
name of the file or formula being audited, to make the output easy to grep.
docs: fix double backticks appearing in HTML manpage
2018-02-01 17:17:09 -05:00
Passing `--only=``method` will run only the methods named `audit_`method,
while `--except=``method` will skip the methods named `audit_`method.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
For either option `method` should be a comma-separated list.
audit: allow skipping audit methods. Add `--only` and `--except` methods which can be used to selectively enable or disable audit groups.
2017-04-18 08:17:24 +01:00
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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.
Add `--only-cops`,`--except-cops` options for brew audit Also refactor audit cops into two "departments" - FormulaAudit - FormulaAuditStrict
2017-04-23 04:09:13 +05:30
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
`audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--root-url=``URL`] [`--force-core-tap`] `formulae`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Generate a bottle (binary package) from a formula installed with
`--build-bottle`.
If the formula specifies a rebuild version, it will be incremented in the
generated DSL. Passing `--keep-old` will attempt to keep it at its
original value, while `--no-rebuild` will remove it.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--verbose` (or `-v`) is passed, print the bottling commands and any warnings
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
encountered.
If `--skip-relocation` is passed, do not check if the bottle can be marked
as relocatable.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--root-url` is passed, use the specified `URL` as the root of the
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
bottle's URL instead of Homebrew's default.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--force-core-tap` is passed, build a bottle even if `formula` is not
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
in homebrew/core or any installed taps.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] `formulae`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Generate a bottle from a formula and print the new DSL merged into the
existing formula.
If `--write` is passed, write the changes to the formula file. A new
commit will then be generated unless `--no-commit` is passed.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `bump-formula-pr` [`--devel`] [`--dry-run` [`--write`]] [`--audit`|`--strict`] [`--mirror=``URL`] [`--version=``version`] [`--message=``message`] (`--url=``URL` `--sha256=``sha-256`|`--tag=``tag` `--revision=``revision`) `formula`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Creates a pull request to update the formula with a new URL or a new tag.
Document all short flags.
2017-04-02 10:14:21 +01:00
If a `URL` is specified, the `sha-256` checksum of the new download must
also be specified. A best effort to determine the `sha-256` and `formula`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
name will be made if either or both values are not supplied by the user.
Document all short flags.
2017-04-02 10:14:21 +01:00
If a `tag` is specified, the git commit `revision` corresponding to that
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
tag must also be specified.
If `--devel` is passed, bump the development rather than stable version.
The development spec must already exist.
If `--dry-run` is passed, print what would be done rather than doing it.
If `--write` is passed along with `--dry-run`, perform a not-so-dry run
making the expected file modifications but not taking any git actions.
If `--audit` is passed, run `brew audit` before opening the PR.
If `--strict` is passed, run `brew audit --strict` before opening the PR.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--mirror=``URL` is passed, use the value as a mirror URL.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--version=``version` is passed, use the value to override the value
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
parsed from the URL or tag. Note that `--version=0` can be used to delete
an existing `version` override from a formula if it has become redundant.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--message=``message` is passed, append `message` to the default PR
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
message.
bump-formula-pr: add --no-browse option. If `--no-browse` is passed, don't pass the `--browse` argument to `hub` which opens the pull request URL in a browser. Instead, output it to the command line.
2017-10-30 09:14:53 +00:00
If `--no-browse` is passed, don't pass the `--browse` argument to `hub`
which opens the pull request URL in a browser. Instead, output it to the
command line.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
If `--quiet` is passed, don't output replacement messages or warn about
duplicate pull requests.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Note that this command cannot be used to transition a formula from a
URL-and-sha256 style specification into a tag-and-revision style
specification, nor vice versa. It must use whichever style specification
the preexisting formula already uses.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `create` `URL` [`--autotools`|`--cmake`|`--meson`] [`--no-fetch`] [`--set-name` `name`] [`--set-version` `version`] [`--tap` `user``/``repo`]:
Generate a formula for the downloadable file at `URL` and open it in the editor.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The `wget`
formula serves as a simple example. For the complete API have a look at
<http://www.rubydoc.info/github/Homebrew/brew/master/Formula>.
If `--autotools` is passed, create a basic template for an Autotools-style build.
If `--cmake` is passed, create a basic template for a CMake-style build.
If `--meson` is passed, create a basic template for a Meson-style build.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--no-fetch` is passed, Homebrew will not download `URL` to the cache and
create: use GitHub metadata where available. GitHub provides a description and homepage field so let `brew create` use them where possible. Also, detect GitHub repositories based on `releases` as well as `archive`s.
2017-04-18 08:22:37 +01:00
will thus not add the SHA256 to the formula for you. It will also not check
the GitHub API for GitHub projects (to fill out the description and homepage).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
The options `--set-name` and `--set-version` each take an argument and allow
you to explicitly set the name and version of the package you are creating.
The option `--tap` takes a tap as its argument and generates the formula in
the specified tap.
* `edit`:
Open all of Homebrew for editing.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `edit` `formula`:
Open `formula` in the editor.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `formula` `formula`:
Display the path where `formula` is located.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
irb: add pry support. Make `brew irb` optionally support `pry`. While doing so, also make it a `dev-cmd`.
2018-02-28 11:36:23 +00:00
* `irb` [`--examples`] [`--pry`]:
Enter the interactive Homebrew Ruby shell.
If `--examples` is passed, several examples will be shown.
If `--pry` is passed or HOMEBREW_PRY is set, pry will be
used instead of irb.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
* `linkage` [`--test`] [`--reverse`] `formula`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Checks the library links of an installed formula.
Only works on installed formulae. An error is raised if it is run on
uninstalled formulae.
If `--test` is passed, only display missing libraries and exit with a
non-zero exit code if any missing libraries were found.
If `--reverse` is passed, print the dylib followed by the binaries
which link to it for each library the keg references.
* `man` [`--fail-if-changed`]:
Generate Homebrew's manpages.
If `--fail-if-changed` is passed, the command will return a failing
status code if changes are detected in the manpage outputs.
This can be used for CI to be notified when the manpages are out of date.
Additionally, the date used in new manpages will match those in the existing
manpages (to allow comparison without factoring in the date).
Add prof and ruby commands. These are imported from Homebrew/homebrew-dev-tools and are both used by maintainers so may be useful for contributors too.
2018-02-27 12:07:30 +00:00
* `prof` [`ruby options`]:
Run Homebrew with the Ruby profiler.
For example:
Regenerate Manpage.md and brew.1
2017-10-09 22:13:26 -07:00
* `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] [`--warn-on-publish-failure`] [`--bintray-org=``bintray-org`] [`--test-bot-user=``test-bot-user`] `patch-source` [`patch-source`]:
pull: optionally warn (not die) on bottle publish failure. This is useful when you're pulling PRs where individual bottles can't be uploaded/built but you still want to pull the PR as a whole anyway.
2017-02-20 12:47:08 +00:00
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
Optionally, installs the formulae changed by the patch.
Document all short flags.
2017-04-02 10:14:21 +01:00
Each `patch-source` may be one of:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
~ 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
Update jenkins.brew.sh links. These previously, incorrectly pointed to bot.brew.sh. Fixes #2703.
2017-05-30 19:14:40 +01:00
~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--bottle` is passed, handle bottles, pulling the bottle-update
commit and publishing files on Bintray.
If `--bump` is passed, for one-formula PRs, automatically reword
commit message to our preferred format.
If `--clean` is passed, do not rewrite or otherwise modify the
commits found in the pulled PR.
If `--ignore-whitespace` is passed, silently ignore whitespace
discrepancies when applying diffs.
If `--resolve` is passed, when a patch fails to apply, leave in
progress and allow user to resolve, instead of aborting.
If `--branch-okay` is passed, do not warn if pulling to a branch
besides master (useful for testing).
If `--no-pbcopy` is passed, do not copy anything to the system
clipboard.
If `--no-publish` is passed, do not publish bottles to Bintray.
pull: optionally warn (not die) on bottle publish failure. This is useful when you're pulling PRs where individual bottles can't be uploaded/built but you still want to pull the PR as a whole anyway.
2017-02-20 12:47:08 +00:00
If `--warn-on-publish-failure` was passed, do not exit if there's a
failure publishing bottles on Bintray.
Regenerate Manpage.md and brew.1
2017-10-09 22:13:26 -07:00
If `--bintray-org=``bintray-org` is passed, publish at the given Bintray
organisation.
If `--test-bot-user=``test-bot-user` is passed, pull the bottle block
commit from the specified user on GitHub.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `release-notes` [`--markdown`] [`previous_tag`] [`end_ref`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Output the merged pull requests on Homebrew/brew between two Git refs.
Document all short flags.
2017-04-02 10:14:21 +01:00
If no `previous_tag` is provided it defaults to the newest tag.
If no `end_ref` is provided it defaults to `origin/master`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--markdown` is passed, output as a Markdown list.
Add prof and ruby commands. These are imported from Homebrew/homebrew-dev-tools and are both used by maintainers so may be useful for contributors too.
2018-02-27 12:07:30 +00:00
* `ruby` [`ruby options`]:
Run a Ruby instance with Homebrew's libraries loaded.
For example:
Document all short flags.
2017-04-02 10:14:21 +01:00
* `tap-new` `user``/``repo`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Generate the template files for a new tap.
Document all short flags.
2017-04-02 10:14:21 +01:00
* `test` [`--devel`|`--HEAD`] [`--debug`] [`--keep-tmp`] `formula`:
Most formulae provide a test method. `brew test` `formula` runs this
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
test method. There is no standard output or return code, but it should
generally indicate to the user if something is wrong with the installed
formula.
To test the development or head version of a formula, use `--devel` or
`--HEAD`.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--debug` (or `-d`) is passed and the test fails, an interactive debugger will be
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
launched with access to IRB or a shell inside the temporary test directory.
If `--keep-tmp` is passed, the temporary files created for the test are
not deleted.
Example: `brew install jruby && brew test jruby`
tests: Use Parser to parse args
2018-03-25 13:18:23 +05:30
* `tests` [`--verbose`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=``test_script`[`:``line_number`]] [`--seed=``seed`] [`--online`] [`--official-cmd-taps`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Run Homebrew's unit and integration tests. If provided,
Document all short flags.
2017-04-02 10:14:21 +01:00
`--only=``test_script` runs only `test_script`_spec.rb, and `--seed`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
randomizes tests with the provided value instead of a random seed.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--verbose` (or `-v`) is passed, print the command that runs the tests.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
If `--coverage` is passed, also generate code coverage reports.
If `--generic` is passed, only run OS-agnostic tests.
If `--no-compat` is passed, do not load the compatibility layer when
running tests.
tests: cleanup tests. Remove pending tests that are never run on CI (i.e. require `--online`), remove fixtures for those tests and just make `--official-cmd-taps` run by `--online` instead.
2017-06-07 16:25:07 +01:00
If `--online` is passed, include tests that use the GitHub API and tests
that use any of the taps for official external commands.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
* `update-test` [`--commit=``commit`] [`--before=``date`] [`--to-tag`] [`--keep-tmp`]:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Runs a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as the start commit.
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--commit=``commit` is passed, use `commit` as the start commit.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Document all short flags.
2017-04-02 10:14:21 +01:00
If `--before=``date` is passed, use the commit at `date` as the
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
start commit.
If `--to-tag` is passed, set `HOMEBREW_UPDATE_TO_TAG` to test updating
between tags.
If `--keep-tmp` is passed, retain the temporary directory containing
the new repository clone.
## OFFICIAL EXTERNAL COMMANDS
Improve external command documentation Extract `brew bundle` and `brew services` docs from their help. Add a little for `brew cask` until we can think about e.g. merging the manpages.
2018-03-15 16:25:14 +00:00
* `bundle` `command`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Improve external command documentation Extract `brew bundle` and `brew services` docs from their help. Add a little for `brew cask` until we can think about e.g. merging the manpages.
2018-03-15 16:25:14 +00:00
Bundler for non-Ruby dependencies from Homebrew.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Improve external command documentation Extract `brew bundle` and `brew services` docs from their help. Add a little for `brew cask` until we can think about e.g. merging the manpages.
2018-03-15 16:25:14 +00:00
`bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]:
Install or upgrade all dependencies in a Brewfile.
`brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`]
Write all installed casks/formulae/taps into a Brewfile.
`brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`]
Uninstall all dependencies not listed in a Brewfile.
`brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`]
Check if all dependencies are installed in a Brewfile.
`brew bundle exec` `command`
Run an external command in an isolated build environment.
`brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`]
List all dependencies present in a Brewfile, optionally limiting by types.
By default, only brew dependencies are output.
If `-v` or `--verbose` are passed, print verbose output.
If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies.
Note they may still be upgraded by `brew install` if needed.
If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile.
If `--file=`path is passed, the Brewfile path is set accordingly
Use `--file=-` to output to console.
If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`.
If `--describe` is passed, output a description comment above each line.
This comment will not be output if the dependency does not have a description.
If `-h` or `--help` are passed, print this help message and exit.
Homebrew/homebrew-bundle <https://github.com/Homebrew/homebrew-bundle>
* `cask` [`--version` | `audit` | `cat` | `cleanup` | `create` | `doctor` | `edit` | `fetch` | `home` | `info`]:
Install macOS applications distributed as binaries.
Caskroom/homebrew-cask <https://github.com/caskroom/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 starting 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 immediately and register it to launch at login (or `boot`).
[`sudo`] `brew services` `cleanup`
Remove all unused services.
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Otherwise, operate on `~/Library/LaunchAgents (started at login)`.
Homebrew/homebrew-services <https://github.com/Homebrew/homebrew-services>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
## CUSTOM EXTERNAL COMMANDS
Homebrew, like `git`(1), supports external commands. These are executable
Document all short flags.
2017-04-02 10:14:21 +01:00
scripts that reside somewhere in the `PATH`, named `brew-``cmdname` or
`brew-``cmdname``.rb`, which can be invoked like `brew` `cmdname`. This allows you
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
to create your own commands without modifying Homebrew's internals.
Instructions for creating your own commands can be found in the docs:
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
<https://docs.brew.sh/External-Commands>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
## SPECIFYING FORMULAE
Document all short flags.
2017-04-02 10:14:21 +01:00
Many Homebrew commands accept one or more `formula` arguments. These arguments
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
can take several different forms:
* The name of a formula:
e.g. `git`, `node`, `wget`.
* The fully-qualified name of a tapped formula:
Sometimes a formula from a tapped repository may conflict with one in
`homebrew/core`.
You can still access these formulae by using a special syntax, e.g.
`homebrew/dupes/vim` or `homebrew/versions/node4`.
* An arbitrary URL:
Homebrew can install formulae via URL, e.g.
`https://raw.github.com/Homebrew/homebrew-core/master/Formula/git.rb`.
The formula file will be cached for later use.
## ENVIRONMENT
Note environment variables need to have values. Address the confusion in #4015.
2018-04-07 10:10:24 +01:00
Note that environment variables must have a value set to be detected. For example, `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`.
More environment filtering tweaks - only document HOMEBREW_* variables in the manpage (although still read from all the original environment variables). - resort manpage environment variables in alphabetical order - check the original path for trailing slashes
2017-05-13 11:42:01 +01:00
* `HOMEBREW_ARTIFACT_DOMAIN`:
If set, instructs Homebrew to use the given URL as a download mirror for bottles and binaries.
* `HOMEBREW_AUTO_UPDATE_SECS`:
If set, Homebrew will only check for autoupdates once per this seconds interval.
*Default:* `60`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
More environment filtering tweaks - only document HOMEBREW_* variables in the manpage (although still read from all the original environment variables). - resort manpage environment variables in alphabetical order - check the original path for trailing slashes
2017-05-13 11:42:01 +01:00
* `HOMEBREW_AWS_ACCESS_KEY_ID`, `HOMEBREW_AWS_SECRET_ACCESS_KEY`:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
When using the `S3` download strategy, Homebrew will look in
these variables for access credentials (see
<https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment>
to retrieve these access credentials from AWS). If they are not set,
the `S3` download strategy will download with a public
(unsigned) URL.
* `HOMEBREW_BOTTLE_DOMAIN`:
If set, instructs Homebrew to use the given URL as a download mirror for bottles.
* `HOMEBREW_BROWSER`:
If set, uses this setting as the browser when opening project homepages,
instead of the OS default browser.
* `HOMEBREW_BUILD_FROM_SOURCE`:
If set, instructs Homebrew to compile from source even when a formula
provides a bottle. This environment variable is intended for use by
Homebrew developers. Please do not file issues if you encounter errors when
using this environment variable.
* `HOMEBREW_CACHE`:
If set, instructs Homebrew to use the given directory as the download cache.
*Default:* `~/Library/Caches/Homebrew`.
Add/use HOMEBREW_CURLRC variable.
2018-04-08 15:51:58 -07:00
* `HOMEBREW_CURLRC`:
If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables
the use of `curlrc`).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_CURL_VERBOSE`:
If set, Homebrew will pass `--verbose` when invoking `curl`(1).
* `HOMEBREW_DEBUG`:
If set, any commands that can emit debugging information will do so.
* `HOMEBREW_DEBUG_INSTALL`:
When `brew install -d` or `brew install -i` drops into a shell,
`HOMEBREW_DEBUG_INSTALL` will be set to the name of the formula being
brewed.
* `HOMEBREW_DEBUG_PREFIX`:
When `brew install -d` or `brew install -i` drops into a shell,
`HOMEBREW_DEBUG_PREFIX` will be set to the target prefix in the Cellar
of the formula being brewed.
* `HOMEBREW_DEVELOPER`:
If set, Homebrew will tweak behaviour to be more relevant for Homebrew
developers (active or budding) e.g. turning warnings into errors.
* `HOMEBREW_EDITOR`:
If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory.
*Note:* `brew edit` will open all of Homebrew as discontinuous files and
directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case.
Document HOMEBREW_FORCE_BREWED_CURL Should have been in #3482.
2017-12-06 12:56:15 +00:00
* `HOMEBREW_FORCE_BREWED_CURL`:
If set, Homebrew will use a Homebrew-installed `curl` rather than the
system version.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_FORCE_VENDOR_RUBY`:
brew.1: clarify Homebrew's Ruby isn't 2.0 now. Make this generic; it doesn't matter what version this is and this will future proof it.
2017-12-08 16:49:33 +00:00
If set, Homebrew will always use its vendored, relocatable Ruby version
even if the system version of Ruby is new enough.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
More environment filtering tweaks - only document HOMEBREW_* variables in the manpage (although still read from all the original environment variables). - resort manpage environment variables in alphabetical order - check the original path for trailing slashes
2017-05-13 11:42:01 +01:00
* `HOMEBREW_GIT`:
When using Git, Homebrew will use `GIT` if set,
a Homebrew-built Git if installed, or the system-provided binary.
Set this to force Homebrew to use a particular git binary.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_GITHUB_API_TOKEN`:
A personal access token for the GitHub API, which you can create at
<https://github.com/settings/tokens>. If set, GitHub will allow you a
greater number of API requests. See
<https://developer.github.com/v3/#rate-limiting> for more information.
Homebrew uses the GitHub API for features such as `brew search`.
*Note:* Homebrew doesn't require permissions for any of the scopes.
irb: add pry support. Make `brew irb` optionally support `pry`. While doing so, also make it a `dev-cmd`.
2018-02-28 11:36:23 +00:00
* `HOMEBREW_INSTALL_BADGE`:
Text printed before the installation summary of each successful build.
Defaults to the beer emoji.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files.
* `HOMEBREW_MAKE_JOBS`:
If set, instructs Homebrew to use the value of `HOMEBREW_MAKE_JOBS` as
the number of parallel jobs to run when building with `make`(1).
*Default:* the number of available CPU cores.
* `HOMEBREW_NO_ANALYTICS`:
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_NO_AUTO_UPDATE`:
If set, Homebrew will not auto-update before running `brew install`,
`brew upgrade` or `brew tap`.
Tty: if HOMEBREW_NO_COLOR env var is present, disable color bin/brew will recognize NO_COLOR variable and copy it to HOMEBREW_NO_COLOR
2018-02-12 11:06:55 -06:00
* `HOMEBREW_NO_COLOR`:
If set, Homebrew will not print text with color added.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_NO_EMOJI`:
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
successful build.
*Note:* Homebrew will only try to print emoji on Lion or newer.
* `HOMEBREW_NO_INSECURE_REDIRECT`:
If set, Homebrew will not permit redirects from secure HTTPS
to insecure HTTP.
While ensuring your downloads are fully secure, this is likely
to cause from-source SourceForge, some GNU & GNOME based
formulae to fail to download.
* `HOMEBREW_NO_GITHUB_API`:
If set, Homebrew will not use the GitHub API for e.g searches or
fetching relevant issues on a failed install.
irb: add pry support. Make `brew irb` optionally support `pry`. While doing so, also make it a `dev-cmd`.
2018-02-28 11:36:23 +00:00
* `HOMEBREW_PRY`:
If set, Homebrew will use `pry` for the `brew irb` command.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_SVN`:
When exporting from Subversion, Homebrew will use `HOMEBREW_SVN` if set,
a Homebrew-built Subversion if installed, or the system-provided binary.
Set this to force Homebrew to use a particular `svn` binary.
* `HOMEBREW_TEMP`:
If set, instructs Homebrew to use `HOMEBREW_TEMP` as the temporary directory
for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as macOS has trouble moving
symlinks across volumes when the target does not yet exist.
This issue typically occurs when using FileVault or custom SSD
configurations.
upgrade: add HOMEBREW_UPGRADE_CLEANUP variable. Allow users to specify they want `brew upgrade --cleanup` to always be run when they run `brew upgrade`.
2018-03-12 11:05:06 +00:00
* `HOMEBREW_UPGRADE_CLEANUP`:
If set, `brew upgrade` always assumes `--cleanup` has been passed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
* `HOMEBREW_VERBOSE`:
If set, Homebrew always assumes `--verbose` when running commands.
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
* `http_proxy`:
Sets the HTTP proxy to be used by `curl`, `git` and `svn` when downloading
through Homebrew.
* `https_proxy`:
Sets the HTTPS proxy to be used by `curl`, `git` and `svn` when downloading
through Homebrew.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08:00
* `all_proxy`:
Sets the SOCKS5 proxy to be used by `curl`, `git` and `svn` when downloading
through Homebrew.
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
* `ftp_proxy`:
Sets the FTP proxy to be used by `curl`, `git` and `svn` when downloading
through Homebrew.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Added info about no_proxy to docs
2017-12-19 10:59:04 +02:00
* `no_proxy`:
Sets the comma-separated list of hostnames and domain names that should be excluded from proxying
by `curl`, `git` and `svn` when downloading through Homebrew.
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
## USING HOMEBREW BEHIND A PROXY
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08:00
Use the `http_proxy`, `https_proxy`, `all_proxy`, `no_proxy` and/or `ftp_proxy` documented above.
Added info about no_proxy to docs
2017-12-19 10:59:04 +02:00
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08:00
For example for an unauthenticated HTTP or SOCKS5 proxy:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
export http_proxy=http://`host`:`port`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08:00
export all_proxy=socks5://`host`:`port`
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
And for an authenticated HTTP proxy:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Unify proxy documentation. Specify under the list of environment variables how to set each of those that we passthrough and use.
2017-11-30 14:05:06 +00:00
export http_proxy=http://`user`:`password`@`host`:`port`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
## SEE ALSO
Use https for all docs.brew.sh links. May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
Homebrew Documentation: <https://docs.brew.sh>
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
`brew-cask`(1), `git`(1), `git-log`(1)
## AUTHORS
Homebrew's lead maintainer is Mike McQuaid.
Documentation improvements - Document ilovezfs as the official lead maintainer of Homebrew/homebrew-core. This is a role he's been doing unofficially (and brilliantly) for a while and explicit documentation of power structures makes it easier for non-Homebrew-maintainers to understand. - Document the contents of some of Homebrew's subdirectories for people clicking around in the GitHub UI looking to contribute. - Remove update bug mention from README. Enough time has passed that we can remove this disappointment.
2017-07-15 12:57:34 +01:00
Homebrew/homebrew-core's lead maintainer is ilovezfs.
Update other Homebrew maintainers.
2018-01-18 15:45:51 +00:00
Homebrew/brew's other current maintainers are ilovezfs, Alyssa Ross, JCount, Misty De Meo, Gautham Goli, Markus Reiter and William Woodruff.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
Update other Homebrew maintainers.
2018-01-18 15:45:51 +00:00
Homebrew/homebrew-core's other current maintainers are FX Coudert, JCount, Misty De Meo and Tom Schoonjans.
Former maintainers with significant contributions include Tim Smith, Baptiste Fontaine, Xu Cheng, Martin Afanasjew, Dominyk Tiller, Brett Koonce, Charlie Sharpsteen, Jack Nagel, Adam Vandenberg, Andrew Janke, Alex Dunn, neutric, Tomasz Pajor, Uladzislau Shablinski and Homebrew's creator: Max Howell.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
## BUGS
See our issues on GitHub:
* Homebrew/brew <https://github.com/Homebrew/brew/issues>
* Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues>
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
[ESSENTIAL COMMANDS]: #ESSENTIAL-COMMANDS "ESSENTIAL COMMANDS"
[COMMANDS]: #COMMANDS "COMMANDS"
[DEVELOPER COMMANDS]: #DEVELOPER-COMMANDS "DEVELOPER COMMANDS"
[OFFICIAL EXTERNAL COMMANDS]: #OFFICIAL-EXTERNAL-COMMANDS "OFFICIAL EXTERNAL COMMANDS"
[CUSTOM EXTERNAL COMMANDS]: #CUSTOM-EXTERNAL-COMMANDS "CUSTOM EXTERNAL COMMANDS"
[SPECIFYING FORMULAE]: #SPECIFYING-FORMULAE "SPECIFYING FORMULAE"
[ENVIRONMENT]: #ENVIRONMENT "ENVIRONMENT"
[USING HOMEBREW BEHIND A PROXY]: #USING-HOMEBREW-BEHIND-A-PROXY "USING HOMEBREW BEHIND A PROXY"
[SEE ALSO]: #SEE-ALSO "SEE ALSO"
[AUTHORS]: #AUTHORS "AUTHORS"
[BUGS]: #BUGS "BUGS"
[-]: -.html
Reference in New Issue Copy Permalink