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

1354 lines
55 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
docs: update descriptions of git- and curl-related vars Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable.
2018-10-25 09:24:00 -04: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
## SYNOPSIS
`brew` `--version`<br>
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: update man page text
2018-12-03 21:23:06 -05:00
With `--verbose` or `-v`, many commands print extra debugging information. Note that
these flags should only appear after a 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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `search` (*`text`*|`/`*`text`*`/`):
docs: update man page text
2018-12-03 21:23:06 -05:00
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
is surrounded with slashes, then it is interpreted as a regular expression.
The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`.
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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `cleanup` [`--prune=`*`days`*] [`--dry-run`] [`-s`] [*`formulae`*|*`casks`*]:
Deprecate `brew cask cleanup`.
2018-08-09 15:00:19 +02:00
Remove stale lock files and outdated downloads for formulae and casks,
and remove old versions of installed formulae. If arguments are specified,
only do this for the specified formulae and casks.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
Deprecate `brew cask cleanup`.
2018-08-09 15:00:19 +02:00
If `-s` is passed, scrub the cache, including downloads for even the latest
versions. Note downloads for any installed formula or cask will still not
add quotes to brew --cache in help for cleanup command
2018-09-17 01:18:31 +03:00
be deleted. If you want to delete those too: `rm -rf "$(brew --cache)"`
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `deps` [`--1`] [`-n`] [`--union`] [`--full-name`] [`--installed`] [`--include-build`] [`--include-optional`] [`--skip-recommended`] [`--include-requirements`] *`formulae`*:
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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `desc` [`--search`|`--name`|`--description`] (*`text`*|`/`*`text`*`/`):
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
Search both name and description (`--search` or `-s`), just the names
(`--name` or `-n`), or just the descriptions (`--description` or `-d`) for
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
*`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
* `gist-logs` [`--new-issue`|`-n`] [`--private`|`-p`] *`formula`*:
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
If `--private` is passed, the Gist will be marked private and will not
appear in listings but will be accessible with the link.
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 logs are found, an error message is presented.
* `home`:
Open Homebrew's own homepage in a browser.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
info: make verbose analytics use tabular output. This copies (and slightly improves) the current `brew formula-analytics` output so `brew formula-analytics` can be adjusted to just output JSON.
2018-10-20 12:06:24 +01:00
* `info` `--analytics` [`--days=`*`days`*] [`--category=`*`category`*]:
Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS`
or `HOMEBREW_NO_GITHUB_API` are set)
The value for `days` must be `30`, `90` or `365`. The default is `30`.
The value for `category` must be `install`, `install-on-request`,
`build-error` or `os-version`. The default is `install`.
* `info` *`formula`* [`--analytics`]:
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
Display information about *`formula`* and analytics data (provided neither
cmd/info: display analytics data. When users don't have `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` set let's display some analytics data in `brew info`. This should be useful for both maintainers and for users of Homebrew. Note this by default combines all installs across options for a single number; for formulae with lots of options it's a bit overwhelming to print the installs per-option. However, for `HOMEBREW_DEVELOPER`s print the full output. Sample non-developer output: ```console $ brew info wget wget: stable 1.19.5 (bottled), HEAD Internet file retriever https://www.gnu.org/software/wget/ /usr/local/Cellar/wget/1.19.5 (49 files, 3.7MB) * Built from source on 2018-09-03 at 20:46:32 From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/wget.rb ==> Dependencies Build: pkg-config ✔ Required: libidn2 ✔, openssl ✔ Optional: pcre ✔, libmetalink ✘, gpgme ✘ ==> Options --with-debug Build with debug support --with-gpgme Build with gpgme support --with-libmetalink Build with libmetalink support --with-pcre Build with pcre support --HEAD Install HEAD version ==> Analytics install: 84638 (30d), 353800 (90d), 1372775 (365d) install_on_request: 77926 (30d), 291305 (90d), 1044898 (365d) build_error: 11 (30d) ``` Sample developer output: ```console $ brew info wget wget: stable 1.19.5 (bottled), HEAD Internet file retriever https://www.gnu.org/software/wget/ /usr/local/Cellar/wget/1.19.5 (49 files, 3.7MB) * Built from source on 2018-09-03 at 20:46:32 From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/wget.rb ==> Dependencies Build: pkg-config ✔ Required: libidn2 ✔, openssl ✔ Optional: pcre ✔, libmetalink ✘, gpgme ✘ ==> Options --with-debug Build with debug support --with-gpgme Build with gpgme support --with-libmetalink Build with libmetalink support --with-pcre Build with pcre support --HEAD Install HEAD version ==> Analytics ==> install (30d) wget: 84516 wget --with-debug: 51 wget --with-libressl: 16 wget --with-pcre: 14 wget --with-pcre --with-libmetalink --with-gpgme: 12 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 8 wget --HEAD: 3 wget --HEAD --with-debug --with-libmetalink --with-gpgme: 3 wget --with-gpgme: 3 wget --with-libmetalink: 3 wget --with-pcre --with-libmetalink: 3 wget --with-debug --with-pcre: 2 wget --with-libmetalink --with-gpgme: 2 wget --with-pcre --with-gpgme: 2 ==> install (90d) wget: 353131 wget --with-debug: 188 wget --with-pcre: 138 wget --with-pcre --with-libmetalink --with-gpgme: 118 wget --with-libressl: 81 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 47 wget --with-pcre --with-libmetalink: 31 wget --HEAD: 13 wget --with-pcre --with-gpgme: 12 wget --with-gpgme: 11 wget --with-debug --with-pcre: 10 wget --with-libmetalink: 8 wget --HEAD --with-pcre --with-libmetalink --with-gpgme: 4 wget --with-debug --with-pcre --with-libmetalink: 4 wget --with-libmetalink --with-gpgme: 4 ==> install (365d) wget: 1369530 wget --with-pcre: 810 wget --with-debug: 649 wget --with-pcre --with-libmetalink --with-gpgme: 554 wget --with-libressl: 479 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 235 wget --with-pcre --with-libmetalink: 184 wget --with-gpgme: 67 wget --with-pcre --with-gpgme: 67 wget --with-debug --with-pcre: 65 wget --HEAD: 54 wget --with-libmetalink: 30 wget --with-libmetalink --with-gpgme: 27 wget --with-debug --with-pcre --with-libmetalink: 24 ==> install_on_request (30d) wget: 77827 wget --with-debug: 48 wget --with-pcre: 12 wget --with-pcre --with-libmetalink --with-gpgme: 11 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 8 wget --HEAD: 3 wget --HEAD --with-debug --with-libmetalink --with-gpgme: 3 wget --with-gpgme: 3 wget --with-libmetalink: 3 wget --with-debug --with-pcre: 2 wget --with-libmetalink --with-gpgme: 2 wget --with-pcre --with-gpgme: 2 wget --with-pcre --with-libmetalink: 2 ==> install_on_request (90d) wget: 290818 wget --with-debug: 157 wget --with-pcre --with-libmetalink --with-gpgme: 101 wget --with-pcre: 100 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 42 wget --with-pcre --with-libmetalink: 30 wget --HEAD: 13 wget --with-pcre --with-gpgme: 11 wget --with-gpgme: 10 wget --with-debug --with-pcre: 8 wget --with-libmetalink: 7 wget --HEAD --with-pcre --with-libmetalink --with-gpgme: 4 wget --with-debug --with-pcre --with-libmetalink: 4 ==> install_on_request (365d) wget: 1042845 wget --with-pcre: 504 wget --with-debug: 458 wget --with-pcre --with-libmetalink --with-gpgme: 432 wget --with-debug --with-pcre --with-libmetalink --with-gpgme: 201 wget --with-pcre --with-libmetalink: 158 wget --with-gpgme: 61 wget --HEAD: 54 wget --with-pcre --with-gpgme: 49 wget --with-debug --with-pcre: 47 wget --with-debug --with-pcre --with-libmetalink: 24 wget --with-libressl: 23 wget --with-libmetalink: 22 wget --with-libmetalink --with-gpgme: 20 ==> build_error (30d) wget: 9 wget --HEAD: 1 wget --with-debug: 1 ```
2018-09-06 14:18:30 +01:00
`HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set)
info: tweak analytics behaviour. - Make `--verbose` and `--analytics` behave differently. - Allow `--analytics` to return results for formulae that don't exist (but are in the top 10,000 installed formulae).
2018-10-21 13:07:08 +01:00
Pass `--verbose` to see more verbose analytics data.
Pass `--analytics` to see only more verbose analytics data instead of
formula 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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `info` `--github` *`formula`*:
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
info: make --json a valid argument. This is already accepted so let's handle this in the logic instead.
2019-01-04 13:26:16 +00:00
* `info` `--json[=`*`version`*] (`--all`|`--installed`|*`formulae`*):
Print a JSON representation of *`formulae`*. Currently the default and
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`] [`--display-times`] *`formula`* [*`options`* ...]:
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If `--cc=`*`compiler`* is passed, attempt to compile using *`compiler`*.
*`compiler`* should be the name of the compiler's executable, for instance
Update man pages to reflect prior change Generate new man pages so that the docs and manpages match up
2018-07-05 21:45:53 -04:00
`gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a
Homebrew-provided GCC 4.9. In order to use LLVM's clang, use
`llvm_clang`. To specify the Apple-provided clang, use `clang`. This
Update documentation and generate manpage * update references in `--cc` flag, using modern gcc examples * note that issues should not be filed if `--cc` flag is used * remove reference to `HOMEBREW_CC` as it should not be exposed to users * generate manpages using `brew man` with these changes
2018-07-05 17:25:19 -04:00
parameter will only accept compilers that are provided by Homebrew or
Fix typo * change `MacOS` -> `macOS` * regenerate manpages
2018-07-06 23:06:41 -04:00
bundled with macOS. Please do not file issues if you encounter errors
Update documentation and generate manpage * update references in `--cc` flag, using modern gcc examples * note that issues should not be filed if `--cc` flag is used * remove reference to `HOMEBREW_CC` as it should not be exposed to users * generate manpages using `brew man` with these changes
2018-07-05 17:25:19 -04:00
while using this flag.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
Add --display-times option to `install`, `reinstall`, and `upgrade`
2018-06-20 00:54:14 -04:00
If `--display-times` is passed, install times for each formula are printed
at the end of the run.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
Installation options specific to *`formula`* may be appended to the command,
and can be listed with `brew options` *`formula`*.
Add a suitable explanatory line
2017-07-11 23:43:28 +02:00
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `install` `--interactive` [`--git`] *`formula`*:
If `--interactive` (or `-i`) is passed, download and patch *`formula`*, then
Document all short flags.
2017-04-02 10:14:21 +01:00
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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
cmd/list: add common `ls` options. We need to manually specify these now so let's add a few that we'd either previously documented or we've caught being used in the wild and adjust the documentation accordingly.
2018-05-29 18:45:46 +01:00
* `list`, `ls` [`--full-name`] [`-1`] [`-l`] [`-t`] [`-r`]:
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 all installed formulae. If `--full-name` is passed, print formulae
cmd/list: add common `ls` options. We need to manually specify these now so let's add a few that we'd either previously documented or we've caught being used in the wild and adjust the documentation accordingly.
2018-05-29 18:45:46 +01:00
with fully-qualified names. If `--full-name` is not passed, other
options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` which produces the actual output.
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` `--unbrewed`:
List all files in the Homebrew prefix not installed by Homebrew.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `list`, `ls` [`--verbose`] [`--versions` [`--multiple`]] [`--pinned`] [*`formulae`*]:
List the installed files for *`formulae`*. Combined with `--verbose`, recursively
list the contents of all subdirectories in each *`formula`*'s keg.
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,
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
missing: exit nonzero if missing deps are found
2018-04-12 22:35:51 -07:00
`missing` exits with a non-zero status if any formulae are missing dependencies.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `pin` *`formulae`*:
Pin the specified *`formulae`*, preventing them from being upgraded when
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`]:
cleanup: run and replace `brew prune`. It's always seemed a bit pointless to me that we have both of these commands. Given we're doing more and more to recommend (and eventually, safely, automatically run (see #4760) `brew cleanup` let's roll their functionality into a single command.
2019-01-02 13:21:34 +00:00
Deprecated. Use `brew cleanup` 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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `reinstall` [`--display-times`] *`formula`*:
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
Add --display-times option to `install`, `reinstall`, and `upgrade`
2018-06-20 00:54:14 -04:00
If `--display-times` is passed, install times for each formula are printed
at the end of the run.
Update docs and manpage for HOMEBREW_INSTALL_CLEANUP
2018-10-30 10:19:45 -04:00
If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
of upgraded *`formulae`* as well as the HOMEBREW_CACHE for that 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
* `search`, `-S`:
Readd functionality to list all casks.
2018-06-23 01:31:16 +02:00
Display all locally available formulae (including tapped ones).
No online search is performed.
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
* `search` `--casks`:
Readd functionality to list all casks.
2018-06-23 01:31:16 +02:00
Display all locally available casks (including tapped ones).
No online search is performed.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `search` [`--desc`] (*`text`*|`/`*`text`*`/`):
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
Readd functionality to list all casks.
2018-06-23 01:31:16 +02:00
is surrounded with slashes, then it is interpreted as a regular expression.
docs: update man page text
2018-12-03 21:23:06 -05:00
The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If `--desc` is passed, search formulae with a description matching *`text`* and
casks with a name matching *`text`*.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `shellenv`:
Prints export statements - run them in a shell and this installation of
Homebrew will be included into your PATH, MANPATH, and INFOPATH.
HOMEBREW_PREFIX, HOMEBREW_CELLAR and HOMEBREW_REPOSITORY are also exported
to save multiple queries of those variables.
Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`)
with `eval $(brew shellenv)`
* `style` [`--fix`] [`--display-cop-names`] [`--only-cops=`*`cops`*|`--except-cops=`*`cops`*] [*`files`*|*`taps`*|*`formulae`*]:
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
Lists of *`files`*, *`taps`* and *`formulae`* may not be combined. If none are
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `switch` *`formula`* *`version`*:
Symlink all of the specific *`version`* of *`formula`*'s install to Homebrew prefix.
man: Generate dev cmd manpages
2018-09-28 21:39:52 +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
* `tap`:
List all installed taps.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `tap` [`--full`] [`--force-auto-update`] *`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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew 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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
Support enabling auto-updates for non-GitHub taps
2018-04-12 16:14:02 -07:00
By default, only taps hosted on GitHub are auto-updated (for performance
reasons). If `--force-auto-update` is passed, this tap will be auto-updated
even if it is not hosted on GitHub.
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` is re-runnable and exits successfully if there's nothing to do.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `tap-info`:
Display a brief summary of all installed taps.
* `tap-info` (`--installed`|*`taps`*):
Display detailed information about one or more *`taps`*.
Pass `--installed` to display information on all installed taps.
* `tap-info` `--json=`*`version`* (`--installed`|*`taps`*):
Print a JSON representation of *`taps`*. Currently the only accepted value
for *`version`* is `v1`.
Pass `--installed` to get information on installed taps.
See the docs for examples of using the JSON output:
<https://docs.brew.sh/Querying-Brew>
* `tap-pin` *`tap`*:
Pin *`tap`*, prioritizing its formulae over core when formula names are supplied
by the user. See also `tap-unpin`.
* `tap-unpin` *`tap`*:
Unpin *`tap`* so its formulae are no longer prioritized. See also `tap-pin`.
* `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] *`formula`*:
Uninstall *`formula`*.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `unpin` *`formulae`*:
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `update` [`--merge`] [`--force`]:
Fetch the newest version of Homebrew and all formulae from GitHub using
`git`(1) and perform any necessary migrations.
If `--merge` is specified then `git merge` is used to include updates
(rather than `git rebase`).
If `--force` (or `-f`) is specified then always do a slower, full update check even
if unnecessary.
* `update-reset` [*`repositories`*]:
Fetches and resets Homebrew and all tap repositories (or the specified
`repositories`) using `git`(1) to their latest `origin/master`. Note this
will destroy all your uncommitted or committed changes.
Cleanup periodically if HOMEBREW_INSTALL_CLEANUP is set. This will become the default in a later version of Homebrew but has an opt-out through HOMEBREW_NO_INSTALL_CLEANUP. Also, always cleanup files older than 120 days and set the general default value for "old" logs, casks etc. to 30 days.
2019-01-03 16:23:44 +00:00
* `upgrade` [*`install-options`*] [`--fetch-HEAD`] [`--ignore-pinned`] [`--display-times`] [*`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.
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.
Add --display-times option to `install`, `reinstall`, and `upgrade`
2018-06-20 00:54:14 -04:00
If `--display-times` is passed, install times for each formula are printed
at the end of the run.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If *`formulae`* are given, upgrade only the specified brews (unless they
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
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `uses` [`--installed`] [`--recursive`] [`--include-build`] [`--include-test`] [`--include-optional`] [`--skip-recommended`] [`--devel`|`--HEAD`] *`formulae`*:
Show the formulae that specify *`formulae`* as a dependency. When given
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
By default, `uses` shows usage of *`formulae`* by stable builds. To find
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`.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `--cache`:
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
man: Update manpages
2018-10-03 19:52:26 +05:30
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `--cache` [`--build-from-source`|`-s`] [`--force-bottle`] *`formula`*:
Display the file or directory used to cache *`formula`*.
man: Update manpages
2018-10-03 19:52:26 +05:30
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `--cellar`:
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.
man: Update manpages
2018-10-03 19:52:26 +05:30
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `--cellar` *`formula`*:
Display the location in the cellar where *`formula`* would be installed,
without any sort of versioned directory as the last path.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `--env` [`--shell=`(*`shell`*|`auto`)|`--plain`]:
Show a summary of the Homebrew build environment as a plain 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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
Pass `--shell=`*`shell`* to generate a list of environment variables for the
specified shell, or `--shell=auto` to detect the current shell.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If the command's output is sent through a pipe and no shell is specified,
the list is formatted for export to `bash`(1) unless `--plain` is passed.
* `--prefix`:
Display Homebrew's install path. *Default:* `/usr/local` on macOS and `/home/linuxbrew/.linuxbrew` on Linux
* `--prefix` *`formula`*:
Display the location in the cellar where *`formula`* is or would be installed.
* `--repository`:
Display where Homebrew's `.git` directory is located.
* `--repository` *`user`*`/`*`repo`*:
Display where tap *`user`*`/`*`repo`*'s directory is located.
* `--version`:
Print the version number of Homebrew to standard output and exit.
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
## DEVELOPER COMMANDS
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `audit` [*`options`*] *`formulae`*
`brew man` output
2018-07-30 18:26:09 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Check *`formulae`* for Homebrew coding style violations. This should be run before
submitting a new formula. Will exit with a non-zero status if any errors are
found, which can be useful for implementing pre-commit hooks.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If no *`formulae`* are provided, all of them are checked.
`brew man` output
2018-07-30 18:26:09 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--strict`:
Run additional style checks, including RuboCop style checks.
* `--online`:
Run additional slower style checks that require a network connection.
* `--new-formula`:
Run various additional style checks to determine if a new formula is eligible for Homebrew. This should be used when creating new formula and implies `--strict` and `--online`.
* `--fix`:
Fix style violations automatically using RuboCop's auto-correct feature.
* `--display-cop-names`:
Include the RuboCop cop name for each violation in the output.
* `--display-filename`:
Prefix every line of output with name of the file or formula being audited, to make output easy to grep.
* `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods.
* `--only`:
Specify a comma-separated *`method`* list to only run the methods named `audit_`*`method`*.
* `--except`:
Specify a comma-separated *`method`* list to skip running the methods named `audit_`*`method`*.
* `--only-cops`:
Specify a comma-separated *`cops`* list to check for violations of only the listed RuboCop cops.
* `--except-cops`:
Specify a comma-separated *`cops`* list to skip checking for violations of the listed RuboCop cops.
### `bottle` [*`options`*] *`formulae`*
Generate a bottle (binary package) from a formula that was installed with
man: Format h3 tags in ronn output
2018-10-02 18:46:48 +05:30
`--build-bottle`.
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
If the formula specifies a rebuild version, it will be incremented in the
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
generated DSL. Passing `--keep-old` will attempt to keep it at its original
value, while `--no-rebuild` will remove it.
* `--skip-relocation`:
Do not check if the bottle can be marked as relocatable.
* `--or-later`:
Append `_or_later` to the bottle tag.
* `--force-core-tap`:
Build a bottle even if *`formula`* is not in homebrew/core or any installed taps.
* `--no-rebuild`:
If the formula specifies a rebuild version, remove it from the generated DSL.
* `--keep-old`:
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL.
* `--json`:
Write bottle information to a JSON file, which can be used as the argument for `--merge`.
* `--merge`:
Generate an updated bottle block for a formula and optionally merge it into the formula file. Instead of a formula name, requires a JSON file generated with `brew bottle --json` *`formula`*.
* `--write`:
Write the changes to the formula file. A new commit will be generated unless `--no-commit` is passed.
* `--no-commit`:
When passed with `--write`, a new commit will not generated after writing changes to the formula file.
* `--root-url`:
Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default.
### `bump-formula-pr` [*`options`*] [*`formula`*]
Create a pull request to update a formula with a new URL or a new tag.
If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also
be specified. A best effort to determine the *`SHA-256`* and *`formula`* name will
be made if either or both values are not supplied by the user.
If a *`tag`* is specified, the Git commit *`revision`* corresponding to that tag
must also be specified.
*Note:* this command cannot be used to transition a formula from a
URL-and-SHA-256 style specification into a tag-and-revision style specification,
nor vice versa. It must use whichever style specification the preexisting
formula already uses.
* `--devel`:
Bump the development rather than stable version. The development spec must already exist.
* `-n`, `--dry-run`:
Print what would be done rather than doing it.
* `--write`:
When passed along with `--dry-run`, perform a not-so-dry run by making the expected file modifications but not taking any Git actions.
bump-formula-pr: run audit by default
2018-10-28 01:13:50 +10:00
* `--no-audit`:
Don't run `brew audit` before opening the PR.
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--strict`:
Run `brew audit --strict` before opening the PR.
* `--no-browse`:
Print the pull request URL instead of opening in a browser.
* `--mirror`:
Use the provided *`URL`* as a mirror URL.
* `--version`:
Use the provided *`version`* to override the value 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.
* `--message`:
Append the provided *`message`* to the default PR message.
* `--url`:
Specify the *`URL`* for the new download. If a *`URL`* is specified, the *`SHA-256`* checksum of the new download should also be specified.
* `--sha256`:
Specify the *`SHA-256`* checksum of the new download.
* `--tag`:
Specify the new git commit *`tag`* for the formula.
* `--revision`:
Specify the new git commit *`revision`* corresponding to a specified *`tag`*.
### `create` [*`options`*] *`URL`*
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
Generate a formula for the downloadable file at *`URL`* and open it in the editor.
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04: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, see:
<http://www.rubydoc.info/github/Homebrew/brew/master/Formula>
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--autotools`:
Create a basic template for an Autotools-style build.
* `--cmake`:
Create a basic template for a CMake-style build.
* `--meson`:
Create a basic template for a Meson-style build.
* `--no-fetch`:
Homebrew will not download *`URL`* to the cache and will thus not add the SHA-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage).
* `--HEAD`:
Indicate that *`URL`* points to the package's repository rather than a file.
* `--set-name`:
Set the name of the new formula to the provided *`name`*.
* `--set-version`:
Set the version of the new formula to the provided *`version`*.
* `--tap`:
Generate the new formula in the provided tap, specified as *`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `edit` [*`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no *`formula`* is provided.
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
man: Update manpages
2018-10-03 19:52:26 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `extract` [*`options`*] *`formula`* *`tap`*
man: Update manpages
2018-10-03 19:52:26 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Look through repository history to find the most recent version of *`formula`* and
create a copy in *`tap`*`/Formula/`*`formula`*`@`*`version`*`.rb`. If the tap is not
installed yet, attempt to install/clone the tap before continuing.
man: Update manpages
2018-10-03 19:52:26 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--version`:
Extract the provided *`version`* of *`formula`* instead of the most recent.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `formula` *`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Display the path where a 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
Add manpages/docs for extract command
2018-07-29 20:53:14 -04:00
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `irb` [*`options`*]
Add manpages/docs for extract command
2018-07-29 20:53:14 -04:00
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Enter the interactive Homebrew Ruby shell.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--examples`:
Show several examples.
* `--pry`:
Use Pry instead of IRB. Implied if `HOMEBREW_PRY` is set.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `linkage` [*`options`*] [*`formulae`*]
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Check the library links for kegs of installed formulae.
Raises an error if run on uninstalled 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--test`:
Display only missing libraries and exit with a non-zero status if any missing libraries are found.
* `--reverse`:
For every library that a keg references, print its dylib path followed by the binaries that link to it.
* `--cached`:
Print the cached linkage values stored in `HOMEBREW_CACHE`, set by a previous `brew linkage` run.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `man` [*`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
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
Generate Homebrew's manpages.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--fail-if-changed`:
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).
* `--link`:
This is now done automatically by `brew update`.
linkage: test all kegs if none are specified
2018-08-03 11:15:58 -07:00
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `mirror` *`formulae`*
style: Fix style errors
2018-10-02 19:54:22 +05:30
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `prof` [*`ruby options`*]
Run Homebrew with the Ruby profiler.
*Example:* `brew prof readall`
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `pull` [*`options`*] *`patch sources`*
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish updated bottles for the formulae changed by the patch.
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Each *`patch source`* may be one of:
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
~ The ID number of a PR (pull request) in the homebrew/core GitHub
repository
~ The URL of a PR on GitHub, using either the web page or API URL
formats. In this form, the PR may be on Homebrew/brew,
Homebrew/homebrew-core or any tap.
~ The URL of a commit on GitHub
~ A "https://jenkins.brew.sh/job/..." string specifying a testing job ID
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--bottle`:
Handle bottles, pulling the bottle-update commit and publishing files on Bintray.
* `--bump`:
For one-formula PRs, automatically reword commit message to our preferred format.
* `--clean`:
Do not rewrite or otherwise modify the commits found in the pulled PR.
* `--ignore-whitespace`:
Silently ignore whitespace discrepancies when applying diffs.
* `--resolve`:
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting.
* `--branch-okay`:
Do not warn if pulling to a branch besides master (useful for testing).
* `--no-pbcopy`:
Do not copy anything to the system clipboard.
* `--no-publish`:
Do not publish bottles to Bintray.
* `--warn-on-publish-failure`:
Do not exit if there's a failure publishing bottles on Bintray.
* `--bintray-org`:
Publish bottles at the provided Bintray *`organisation`*.
* `--test-bot-user`:
Pull the bottle block commit from the provided *`user`* on GitHub.
### `release-notes` [*`options`*] [*`previous_tag`*] [*`end_ref`*]
Print the merged pull requests on Homebrew/brew between two Git refs.
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If no *`previous_tag`* is provided it defaults to the latest 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--markdown`:
Print as a Markdown 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `ruby` [*`ruby options`*]
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Run a Ruby instance with Homebrew's libraries loaded.
style: Fix style errors
2018-10-02 19:54:22 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
*Example:* `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `-e`:
Execute the provided string argument as a script.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `tap-new` *`user`*`/`*`repo`*
Generate the template files for a new 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `test` [*`options`*] *`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Run the test method provided by an installed formula.
There is no standard output or return code, but generally it should notify the
user if something is wrong with the installed formula.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
*Example:* `brew install jruby && brew test jruby`
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--devel`:
Test the development version of a formula.
* `--HEAD`:
Test the head version of a formula.
* `--keep-tmp`:
Keep the temporary files created for the test.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `tests` [*`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Run Homebrew's unit and integration 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--coverage`:
Generate code coverage reports.
* `--generic`:
Run only OS-agnostic tests.
* `--no-compat`:
Do not load the compatibility layer when running tests.
* `--online`:
Include tests that use the GitHub API and tests that use any of the taps for official external commands.
* `--only`:
Run only *`test_script`*`_spec.rb`. Appending `:`*`line_number`* will start at a specific line.
* `--seed`:
Randomize tests with the provided *`value`* instead of a random seed.
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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
### `update-test` [*`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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
Run a test of `brew update` with a new repository clone.
man: Format h3 tags in ronn output
2018-10-02 18:46:48 +05:30
If no arguments are passed, use `origin/master` 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `--to-tag`:
Set `HOMEBREW_UPDATE_TO_TAG` to test updating between tags.
* `--keep-tmp`:
Retain the temporary directory containing the new repository clone.
* `--commit`:
Use provided *`commit`* as the start commit.
* `--before`:
Use the commit at provided *`date`* as the start commit.
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
Add `brew vendor-gems` command. This simplifies the process of vendoring gems given `Gemfile` or `Gemfile.lock` changes.
2018-12-21 20:09:08 +00:00
* `vendor-gems`:
Install and commit Homebrew's vendored gems.
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
## GLOBAL OPTIONS
These options are applicable across all sub-commands.
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `-q`, `--quiet`:
Suppress any warnings.
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `-v`, `--verbose`:
Make some output more verbose.
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `-d`, `--debug`:
Display any debugging 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
dev-cmd/: remove colons from command specs. These aren't needed when converting Parser-based help text to man page or Markdown formats. Includes regenerated docs.
2018-10-15 15:06:33 -04:00
* `-f`, `--force`:
Override warnings and enable potentially unsafe operations.
man: Seperate global options into a section
2018-10-02 14:44:38 +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
## OFFICIAL EXTERNAL COMMANDS
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `bundle` *`command`*:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=`*`path`*|`--global`]:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Install or upgrade all dependencies in a Brewfile.
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle dump` [`--force`] [`--describe`] [`--file=`*`path`*|`--global`]:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Write all installed casks/formulae/taps into a Brewfile.
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle cleanup` [`--force`] [`--zap`] [`--file=`*`path`*|`--global`]:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Uninstall all dependencies not listed in a Brewfile.
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle check` [`--no-upgrade`] [`--file=`*`path`*|`--global`] [`--verbose`]:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Check if all dependencies are installed in a Brewfile. Missing dependencies are listed in verbose mode.
`check` will exit on the first category missing a dependency unless in verbose mode.
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle exec` *`command`*:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Run an external command in an isolated build environment.
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
`brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=`*`path`*|`--global`]:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
List all dependencies present in a Brewfile, optionally limiting by types.
By default, only brew dependencies are output.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `-v` or `--verbose` are passed, print verbose output.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `--no-upgrade` is passed, don't run `brew upgrade` on outdated dependencies.
Note they may still be upgraded by `brew install` if needed.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `--zap` is passed, casks will be removed using the `zap` command instead of `uninstall`.
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
If `--file=`*`path`* is passed, the Brewfile path is set accordingly.
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Use `--file=-` to output to console.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `--global` is passed, set the Brewfile path to `~/.Brewfile`.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
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.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `-h` or `--help` are passed, print this help message and exit.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
**Homebrew/homebrew-bundle**: <https://github.com/Homebrew/homebrew-bundle>
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
* `cask` [`--version` | `audit` | `cat` | `cleanup` | `create` | `doctor` | `edit` | `fetch` | `home` | `info`]:
Install macOS applications distributed as binaries.
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
**Homebrew/homebrew-cask**: <https://github.com/Homebrew/homebrew-cask>
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
* `services` *`command`*:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Integrates Homebrew formulae with macOS' `launchctl` manager.
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services list`:
List all running services for the current user (or root).
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services run` (*`formula`*|`--all`):
Run the service *`formula`* without registering to launch at login (or boot).
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services start` (*`formula`*|`--all`):
Start the service *`formula`* immediately and register it to launch at login (or boot).
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services stop` (*`formula`*|`--all`):
Stop the service *`formula`* immediately and unregister it from launching at login (or boot).
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services restart` (*`formula`*|`--all`):
Stop (if necessary) and start the service *`formula`* immediately and register it to launch at login (or boot).
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
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
[`sudo`] `brew services cleanup`:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
Remove all unused services.
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot).
Update manpage Pull in changes from https://github.com/Homebrew/homebrew-services/pull/174 and some missing changes from https://github.com/Homebrew/brew/pull/5089.
2018-10-23 15:52:18 +01:00
Otherwise, operate on `~/Library/LaunchAgents` (started at login).
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
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
**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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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`.
docs: bottle is a valid formula specifier, too
2018-11-09 04:05:38 +03:00
* An arbitrary file or 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
Homebrew can install formulae via URL, e.g.
docs: update man page text
2018-12-03 21:23:06 -05:00
`https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`,
docs: bottle is a valid formula specifier, too
2018-11-09 04:05:38 +03:00
or from a local path. It could point to either a formula file or a bottle.
In the case of a URL, the downloaded file will be cached for later use.
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
## ENVIRONMENT
docs: update descriptions of git- and curl-related vars Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable.
2018-10-25 09:24:00 -04:00
docs: update man page text
2018-12-03 21:23:06 -05: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`.
Note environment variables need to have values. Address the confusion in #4015.
2018-04-07 10:10:24 +01: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_ARTIFACT_DOMAIN`:
docs: update man page text
2018-12-03 21:23:06 -05:00
If set, instructs Homebrew to prefix all download URLs, including those for bottles,
with this variable. For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080`
will cause a formula with the URL `https://example.com/foo.tar.gz` to instead
download from `http://localhost:8080/example.com/foo.tar.gz`.
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_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>
Change docs to use symbols instead of class names.
2018-08-03 11:55:37 +02:00
to retrieve these access credentials from AWS). If they are not set,
docs: update man page text
2018-12-03 21:23:06 -05:00
the `S3` download strategy will download with a public (unsigned) 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
* `HOMEBREW_BOTTLE_DOMAIN`:
Update manpages about artifact/bottle variables
2018-08-14 00:56:26 -04:00
By default, Homebrew uses `https://homebrew.bintray.com/` as its download
docs: update man page text
2018-12-03 21:23:06 -05:00
mirror for bottles. If set, instructs Homebrew to instead use the specified
Update manpages about artifact/bottle variables
2018-08-14 00:56:26 -04:00
URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will
cause all bottles to download from the prefix `http://localhost:8080/`.
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_BROWSER`:
docs: update man page text
2018-12-03 21:23:06 -05:00
If set, Homebrew uses this setting as the browser when opening project
homepages, instead of the OS default 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
* `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`:
docs: update man page text
2018-12-03 21:23:06 -05:00
If set, instructs Homebrew to use the specified directory as the download cache.
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
*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_DEVELOPER`:
If set, Homebrew will tweak behaviour to be more relevant for Homebrew
docs: update man page text
2018-12-03 21:23:06 -05:00
developers (active or budding), e.g. turning warnings into errors.
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_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`:
docs: update descriptions of git- and curl-related vars Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable.
2018-10-25 09:24:00 -04:00
If set, Homebrew will always use a Homebrew-installed `curl` rather than the
system version. Automatically set if the system version of `curl` is too old.
Document HOMEBREW_FORCE_BREWED_CURL Should have been in #3482.
2017-12-06 12:56:15 +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
* `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
Implement HOMEBREW_FORCE_BREWED_GIT Because of this messing with the user's path: https://github.com/Homebrew/brew/blob/ efc02899c851c62c9ce0d15dea9a231575d7d774/bin/brew#L68 brew uses /usr/bin/git over brewed git, even when the former is problematically old. There may also be other reasons a user prefers to use brewed git. There was already a HOMEBREW_FORCE_BREWED_CURL option and a HOMEBREW_SYSTEM_CURL_TOO_OLD check to set it. This mostly copies those to implement HOMEBREW_FORCE_BREWED_GIT & HOMEBREW_SYSTEM_GIT_TOO_OLD. See also: https://github.com/Linuxbrew/brew/issues/736
2018-06-25 23:36:12 -07:00
* `HOMEBREW_FORCE_BREWED_GIT`:
docs: update descriptions of git- and curl-related vars Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable.
2018-10-25 09:24:00 -04:00
If set, Homebrew will always use a Homebrew-installed `git` rather than the
system version. Automatically set if the system version of `git` is too old.
Implement HOMEBREW_FORCE_BREWED_GIT Because of this messing with the user's path: https://github.com/Homebrew/brew/blob/ efc02899c851c62c9ce0d15dea9a231575d7d774/bin/brew#L68 brew uses /usr/bin/git over brewed git, even when the former is problematically old. There may also be other reasons a user prefers to use brewed git. There was already a HOMEBREW_FORCE_BREWED_CURL option and a HOMEBREW_SYSTEM_CURL_TOO_OLD check to set it. This mostly copies those to implement HOMEBREW_FORCE_BREWED_GIT & HOMEBREW_SYSTEM_GIT_TOO_OLD. See also: https://github.com/Linuxbrew/brew/issues/736
2018-06-25 23:36:12 -07: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
* `HOMEBREW_GITHUB_API_TOKEN`:
docs: update man page text
2018-12-03 21:23:06 -05:00
A personal access token for the GitHub API, used by Homebrew for features
such as `brew search`. You can create one at <https://github.com/settings/tokens>.
If set, GitHub will allow you a greater number of API requests. For more
information, see: <https://developer.github.com/v3/#rate-limiting>
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:* 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.
docs: update man page text
2018-12-03 21:23:06 -05:00
*Default:* the beer emoji.
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
Cleanup periodically if HOMEBREW_INSTALL_CLEANUP is set. This will become the default in a later version of Homebrew but has an opt-out through HOMEBREW_NO_INSTALL_CLEANUP. Also, always cleanup files older than 120 days and set the general default value for "old" logs, casks etc. to 30 days.
2019-01-03 16:23:44 +00:00
* `HOMEBREW_INSTALL_CLEANUP`:
If set, `brew install`, `brew upgrade` and `brew reinstall` will remove
previously installed version(s) of the installed/upgraded formulae.
If `brew cleanup` has not been run in 30 days then it will be run at this
time.
This will become the default in a later version of Homebrew. To opt-out see
`HOMEBREW_NO_INSTALL_CLEANUP`.
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`:
docs: update man page text
2018-12-03 21:23:06 -05:00
If set, Homebrew will use the specified directory to store log files.
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_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.
docs: update man page text
2018-12-03 21:23:06 -05:00
*Note:* Homebrew will only try to print emoji on OS X Lion or newer.
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_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`:
docs: update man page text
2018-12-03 21:23:06 -05:00
If set, Homebrew will not use the GitHub API, e.g. for searches or
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
fetching relevant issues on a failed install.
Cleanup periodically if HOMEBREW_INSTALL_CLEANUP is set. This will become the default in a later version of Homebrew but has an opt-out through HOMEBREW_NO_INSTALL_CLEANUP. Also, always cleanup files older than 120 days and set the general default value for "old" logs, casks etc. to 30 days.
2019-01-03 16:23:44 +00:00
* `HOMEBREW_NO_INSTALL_CLEANUP`:
If set, `brew install`, `brew upgrade` and `brew reinstall` will never
automatically remove the previously installed version(s) of the
installed/upgraded formulae.
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`:
docs: update man page text
2018-12-03 21:23:06 -05:00
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
docs: update man page text
2018-12-03 21:23:06 -05:00
Homebrew prefix are on different volumes, as macOS has trouble moving
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
symlinks across volumes when the target does not yet exist.
docs: update man page text
2018-12-03 21:23:06 -05:00
This issue typically occurs when using FileVault or custom SSD configurations.
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
manpage: add HOMEBREW_UPDATE_TO_TAG docs.
2018-11-25 20:16:27 +00:00
* `HOMEBREW_UPDATE_TO_TAG`:
If set, instructs Homebrew to always use the latest stable tag (even if
developer commands have been run).
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`:
docs: update man page text
2018-12-03 21:23:06 -05:00
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.
Added info about no_proxy to docs
2017-12-19 10:59:04 +02: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
## USING HOMEBREW BEHIND A PROXY
Added info about no_proxy to docs
2017-12-19 10:59:04 +02:00
docs: update man page text
2018-12-03 21:23:06 -05:00
Set the `http_proxy`, `https_proxy`, `all_proxy`, `ftp_proxy` and/or `no_proxy`
environment variables documented above.
For example, to use an unauthenticated HTTP or SOCKS5 proxy:
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: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04:00
export all_proxy=socks5://$HOST:$PORT
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08: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
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
docs: distinguish <code> and <var> in HTML output Replace <var> tags with markup for italicized monospaced text in Markdown. This requires the source to not combine bracketed and backticked text.
2018-10-06 00:31:10 -04: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.
README: remove JCount.
2018-12-16 11:40:42 +00:00
Homebrew's project leadership committee is Mike McQuaid, Misty De Meo and Markus Reiter.
Add the SFC PLC to the README and manpage. Let's document these so people know who the leadership team behind the project is.
2018-08-02 13:26:02 +01:00
README: add igas, claui surname.
2018-12-22 13:20:58 +00:00
Homebrew/brew's other current maintainers are Claudia Pellegrino, Michka Popoff, Shaun Jackman, Chongyu Zhu, Vitor Galvao, Misty De Meo, Gautham Goli, Markus Reiter, Steven Peters, Jonathan Chang 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
Add new maintainers Also add some who were missing (sorry folks) and our Linux maintainers.
2018-08-07 10:51:16 +01:00
Homebrew/brew's Linux support (and Linuxbrew) maintainers are Michka Popoff and Shaun Jackman.
Update other Homebrew maintainers.
2018-01-18 15:45:51 +00:00
README: add igas, claui surname.
2018-12-22 13:20:58 +00:00
Homebrew/homebrew-core's other current maintainers are Claudia Pellegrino, Igor Kapkov, Michka Popoff, Shaun Jackman, Chongyu Zhu, Izaak Beekman, Sean Molenaar, Jan Viljanen, Jason Tedor, Viktor Szakats, FX Coudert, Thierry Moisan, Steven Peters, Misty De Meo and Tom Schoonjans.
Add new maintainers Also add some who were missing (sorry folks) and our Linux maintainers.
2018-08-07 10:51:16 +01:00
README: remove JCount.
2018-12-16 11:40:42 +00:00
Former maintainers with significant contributions include JCount, commitay, Dominyk Tiller, Tim Smith, Baptiste Fontaine, Xu Cheng, Martin Afanasjew, Brett Koonce, Charlie Sharpsteen, Jack Nagel, Adam Vandenberg, Andrew Janke, Alex Dunn, neutric, Tomasz Pajor, Uladzislau Shablinski, Alyssa Ross, ilovezfs 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:
docs: fix Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
* **Homebrew/brew**:
<https://github.com/Homebrew/brew/issues>
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 Official External Commands section Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-02 21:56:00 -04:00
* **Homebrew/homebrew-core**:
<https://github.com/Homebrew/homebrew-core/issues>
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
[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
[ESSENTIAL COMMANDS]: #ESSENTIAL-COMMANDS "ESSENTIAL COMMANDS"
[COMMANDS]: #COMMANDS "COMMANDS"
[DEVELOPER COMMANDS]: #DEVELOPER-COMMANDS "DEVELOPER COMMANDS"
man: Seperate global options into a section
2018-10-02 14:44:38 +05:30
[GLOBAL OPTIONS]: #GLOBAL-OPTIONS "GLOBAL 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
[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