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

1234 lines
48 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `install` *`formula`*:
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Install *`formula`*.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
List all installed formulae.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `search` (*`text`*|`/`*`text`*`/`):
Perform a substring search of cask tokens and formula names for *`text`*. If *`text`*
is surrounded with slashes, then it is interpreted as a regular expression.
The search for *`text`* is extended online to `homebrew/core` and `homebrew/cask`.
If no search term is given, all locally available formulae are listed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
## 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `analytics` (`on`|`off`) [`state`] [`regenerate-uuid`]
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If `on`|`off` is passed, turn Homebrew's analytics on or off respectively.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If `state` is passed, display anonymous user behaviour analytics state.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If `regenerate-uuid` is passed, regenerate UUID used in Homebrew's 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `cat` *`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
Commit typo manpage updates.
2019-02-01 13:57:50 +00:00
Display the source 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `cleanup` [*`options`*] [*`formula`*|*`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
manpages: commit updates.
2019-01-30 21:35:32 +00: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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--prune`:
Remove all cache files older than specified *`days`*.
* `-n`, `--dry-run`:
Show what would be removed, but do not actually remove anything.
* `-s`:
Scrub the cache, including downloads for even the latest versions. Note downloads for any installed formula or cask will still not be deleted. If you want to delete those too: `rm -rf "$(brew --cache)"`
cleanup: add --prune-prefix option. From https://discourse.brew.sh/t/error-calling-brew-prune-is-disabled/4142/4 and https://github.com/github/homebrew-bootstrap/pull/72 it seems this is worth having as a dedicated flag.
2019-02-13 09:39:21 +00:00
* `--prune-prefix`:
Only prune the symlinks and directories from the prefix and remove no other files.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `command` *`cmd`*
Display the path to the file which is used when invoking `brew` *`cmd`*.
### `commands` [*`options`*]
Show a list of built-in and external commands.
* `--include-aliases`:
Include the aliases of internal commands.
### `config`
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.
### `deps` [*`options`*] *`formula`*
Show dependencies for *`formula`*. When given multiple formula arguments,
show the intersection of dependencies for *`formula`*.
* `--1`:
Only show dependencies one level down, instead of recursing.
* `-n`:
Show dependencies in topological order.
* `--union`:
Show the union of dependencies for *`formula`*, instead of the intersection.
* `--full-name`:
List dependencies by their full name.
* `--installed`:
Only list those dependencies that are currently installed.
* `--all`:
List all the dependencies for all available formulae.
* `--include-build`:
Show `:build` type dependencies for *`formula`*.
* `--include-optional`:
Show `:optional` dependencies for *`formula`*.
* `--include-test`:
Show `:test` dependencies for *`formula`* (non-recursive).
* `--skip-recommended`:
Skip `:recommended` type dependencies for *`formula`*.
* `--include-requirements`:
Include requirements in addition to dependencies for *`formula`*.
* `--tree`:
Show dependencies as a tree. When given multiple formula arguments output individual trees for every formula.
* `--for-each`:
Switch into the mode used by `deps --all`, but only list dependencies for specified formula one specified formula per line. This is used for debugging the `--installed`/`--all` display mode.
### `desc` [*`options`*] (*`text`*|`/`*`text`*`/`|*`formula`*)
Display *`formula`*'s name and one-line description.
Formula descriptions are cached; the cache is created on the
first search, making that search slower than subsequent ones.
* `-s`, `--search`:
Search both name and description for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
* `-n`, `--name`:
Search just the names for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
* `-d`, `--description`:
Search just the descriptions for provided *`text`*. If *`text`* is flanked by slashes, it is interpreted as a regular expression.
### `diy` [*`options`*]
Automatically determine the installation prefix for non-Homebrew software.
Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with `brew link`.
* `--name`:
Explicitly set the provided *`name`* of the package being installed.
* `--version`:
Explicitly set the provided *`version`* of the package being installed.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `doctor` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Check your system for potential problems. Doctor exits with a non-zero status
if any potential problems are found. Please note that these warnings are just
used to help the Homebrew maintainers with debugging if you file an issue. If
everything you use Homebrew for is working fine: please don't worry or file
an issue; just ignore this.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--list-checks`:
List all audit methods.
* `-D`, `--audit-debug`:
Enable debugging and profiling of audit methods.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `fetch` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Download the source packages for the given *`formula`*.
For tarballs, also print SHA-256 checksums.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--HEAD`:
Fetch HEAD version instead of stable version.
* `--devel`:
Fetch development version instead of stable version.
* `--retry`:
Retry if a download fails or re-download if the checksum of a previously cached version no longer matches.
* `--deps`:
Download dependencies for any listed *`formula`*.
* `-s`, `--build-from-source`:
Download the source for rather than a bottle.
* `--build-bottle`:
Download the source (for eventual bottling) rather than a bottle.
* `--force-bottle`:
Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation.
### `gist-logs` [*`options`*] *`formula`*
Upload logs for a failed build of *`formula`* to a new Gist.
*`formula`* is usually the name of the formula to install, but it can be specified
in several different ways.
If no logs are found, an error message is presented.
* `--with-hostname`:
Include the hostname in the Gist.
* `-n`, `--new-issue`:
Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist.
* `-p`, `--private`:
The Gist will be marked private and will not appear in listings but will be accessible with the link.
### `home` [*`formula`*]
Open *`formula`*'s homepage in a browser. If no formula is provided,
open Homebrew's own homepage in a browser.
### `info` [*`formula`*]
Display brief statistics for your Homebrew installation.
* `--analytics`:
Display Homebrew analytics data (provided neither `HOMEBREW_NO_ANALYTICS` or `HOMEBREW_NO_GITHUB_API` are set).
* `--days`:
The value for `days` must be `30`, `90` or `365`. The default is `30`.
* `--category`:
The value for `category` must be `install`, `install-on-request`, `build-error` or `os-version`. The default is `install`.
* `--github`:
Open a browser to the GitHub History page for provided *`formula`*. To view formula history locally: `brew log -p` *`formula`*
* `--json`:
Print a JSON representation of *`formula`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
* `--all`:
Get information on all formulae.
* `--installed`:
Get information on all installed formulae.
### `install` [*`options`*] *`formula`*
Install *`formula`*.
*`formula`* is usually the name of the formula to install, but it can be specified
in several different ways.
Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual
2019-02-03 09:34:00 +01:00
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the installed formulae or, every 30 days, for all formulae.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--env`:
If `std` is passed, use the standard build environment instead of superenv.If `super` is passed, use superenv even if the formula specifies the standard build environment.
* `--ignore-dependencies`:
Skip installing any dependencies of any kind. If they are not already present, the formula will probably fail to install.
* `--only-dependencies`:
Install the dependencies with specified options but do not install the specified formula.
* `--cc`:
Attempt to compile using provided *`compiler`*. *`compiler`* should be the name of the compiler's executable, for instance `gcc-7` for GCC 7. In order to use LLVM's clang, use `llvm_clang`. To specify the Apple-provided clang, use `clang`. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this flag.
* `-s`, `--build-from-source`:
Compile the specified *`formula`* from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--include-test`:
Install testing dependencies required to run `brew test`.
* `--devel`:
If *`formula`* defines it, install the development version.
* `--HEAD`:
If *`formula`* defines it, install the HEAD version, aka. master, trunk, unstable.
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
* `--build-bottle`:
Prepare the formula for eventual bottling during installation.
cmd/install: add --bottle-arch. This argument was missing when the command-line parser code was added. Fixes #5741.
2019-02-15 20:13:05 +00:00
* `--bottle-arch`:
Optimise bottles for the given architecture rather than the oldest architecture supported by the version of macOS the bottles are built on.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--display-times`:
Print install times for each formula at the end of the run.
* `-i`, `--interactive`:
Download and patch *`formula`*, then open a shell. This allows the user to run `./configure --help` and otherwise determine how to turn the software package into a Homebrew package.
* `-g`, `--git`:
Create a Git repository, useful for creating patches to the software.
missing: exit nonzero if missing deps are found
2018-04-12 22:35:51 -07:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `leaves`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Show installed formulae that are not dependencies of another 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `ln`, `link` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Symlink all of *`formula`*'s installed files into the Homebrew prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--overwrite`:
Delete files already existing in the prefix while linking.
* `-n`, `--dry-run`:
List all files which would be linked or deleted by `brew link --overwrite`, but will not actually link or delete any files.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `list`, `ls` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
List all installed 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--full-name`:
Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-t` and `-r`) are passed to `ls` which produces the actual output.
* `--unbrewed`:
List all files in the Homebrew prefix not installed by Homebrew.
* `--versions`:
Show the version number for installed formulae, or only the specified formulae if *`formula`* are given.
* `--multiple`:
Only show formulae with multiple versions installed.
* `--pinned`:
Show the versions of pinned formulae, or only the specified (pinned) formulae if *`formula`* are given. See also `pin`, `unpin`.
* `-1`:
Force output to be one entry per line. This is the default when output is not to a terminal.
* `-l`:
List in long format. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing.
* `-r`:
Reverse the order of the sort to get the oldest entries first.
* `-t`:
Sort by time modified (most recently modified first).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Show the `git log` for the given *`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `-p`, `--patch`:
Also output patch from commit.
* `--stat`:
Also output diffstat from commit.
* `--oneline`:
Output only one line per commit.
* `-1`, `--max-count`:
Output only one commit.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `migrate` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Migrate renamed packages to new name, where *`formula`* are old names of
packages.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `missing` [*`options`*] [*`formule`*]
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Check the given *`formula`* for missing dependencies. If no *`formula`* are
given, check all installed brews.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
`missing` exits with a non-zero status if any formulae are missing dependencies.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--hide`:
Act as if none of the provided *`hidden`* are installed. *`hidden`* should be comma-separated list of formulae.
docs: add more missing option descriptions and improve wording or formatting where necessary.
2018-02-01 16:06:17 -05:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `options` [*`options`*] *`formula`*
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display install options specific to *`formula`*
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--compact`:
Show all options on a single line separated by spaces.
* `--all`:
Show options for all formulae.
* `--installed`:
Show options for all installed formulae.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `outdated` [*`options`*]
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Show formulae that have an updated version available.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
By default, version information is displayed in interactive shells, and
suppressed otherwise.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--json`:
outdated & tap-info: set default value for --json Matching what's already been done for `brew info`.
2019-03-04 11:59:49 -05:00
Print output in JSON format. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `pin` *`formula`*
Add --display-times option to `install`, `reinstall`, and `upgrade`
2018-06-20 00:54:14 -04:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Pin the specified *`formula`*, preventing them from being upgraded when
issuing the `brew upgrade` *`formula`* command. See also `unpin`.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `postinstall` *`formula`*
Readd functionality to list all casks.
2018-06-23 01:31:16 +02:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `readall` [*`options`*] [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Import all formulae from specified *`tap`* (defaults to all installed taps).
This can be useful for debugging issues across all formulae when making
significant changes to `formula.rb`, testing the performance of loading
all formulae or to determine if any current formulae have Ruby issues.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--aliases`:
Verify any alias symlinks in each tap.
* `--syntax`:
Syntax-check all of Homebrew's Ruby 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `reinstall` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Uninstall and then install *`formula`* (with existing and any appended 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
Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual
2019-02-03 09:34:00 +01:00
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the reinstalled formulae or, every 30 days, for all formulae.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
* `--display-times`:
Print install times for each formula at the end of the run.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `search` [*`options`*] [*`text`*|`/`*`text`*`/`]
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
manpages: commit updates.
2019-01-30 21:35:32 +00: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`.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If no *`text`* is passed, display all locally available formulae (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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--casks`:
Display all locally available casks (including tapped ones). No online search is performed.
* `--desc`:
search formulae with a description matching *`text`* and casks with a name matching *`text`*.
* `--macports`:
Search for *`text`* in the given package manager's list.
* `--fink`:
Search for *`text`* in the given package manager's list.
* `--opensuse`:
Search for *`text`* in the given package manager's list.
* `--fedora`:
Search for *`text`* in the given package manager's list.
* `--debian`:
Search for *`text`* in the given package manager's list.
* `--ubuntu`:
Search for *`text`* in the given package manager's list.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `sh` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
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.
Add `--only-cops`,`--except-cops` options for brew style and simplify cop names
2017-05-03 11:33:00 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--env`:
Use the standard `PATH` instead of superenv's, when *`std`* is passed
Add `--only-cops`,`--except-cops` options for brew style and simplify cop names
2017-05-03 11:33:00 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `shellenv`
Prints export statements - run them in a shell and this installation of Homebrew will be included into your `PATH`, `MANPATH` and `INFOPATH`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
`HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to save multiple queries of those variables.
man: Generate dev cmd manpages
2018-09-28 21:39:52 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)`
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `style` [*`options`*] [*`file`*|*`tap`*|*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Check formulae or files for conformance to Homebrew style guidelines.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Lists of *`file`*, *`tap`* and *`formula`* may not be combined. If none are
provided, `style` will run style checks on the whole Homebrew library,
including core code and all formulae.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--fix`:
Fix style violations automatically using RuboCop's auto-correct feature.
* `--display-cop-names`:
Include the RuboCop cop name for each violation in the output.
* `--only-cops`:
Specify a comma-separated *`cops`* list to check for violations of only the listed RuboCop cops.
* `--except-cops`:
Specify a comma-separated *`cops`* list to skip checking for violations of the listed RuboCop cops.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `switch` *`formula`* *`version`*
Support enabling auto-updates for non-GitHub taps
2018-04-12 16:14:02 -07:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Symlink all of the specific *`version`* of *`formula`*'s install to Homebrew prefix.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `tap` [*`options`*] *`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Tap a formula repository.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
List all installed taps when no arguments are passed.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
With *`URL`* unspecified, taps a formula repository from GitHub using HTTPS.
Since so many taps are hosted on GitHub, this command is a shortcut for
`brew tap` *`user`*`/`*`repo`* `https://github.com/`*`user`*`/homebrew-`*`repo`*.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
With *`URL`* specified, taps a formula repository from anywhere, using
any transport protocol that `git` handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--full`:
Use a full clone when tapping a repository. By default, the repository is cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a full copy, you can retap passing `--full` without first untapping.
* `--force-auto-update`:
Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons).
* `--repair`:
Migrate tapped formulae from symlink-based to directory-based structure.
* `--list-pinned`:
List all pinned taps.
* `-q`, `--quieter`:
Suppress any warnings.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `tap-info` [*`options`*] [*`tap`*]
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display detailed information about one or more provided *`tap`*.
Display a brief summary of all installed taps if no *`tap`* are passed.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--installed`:
Display information on all installed taps.
* `--json`:
outdated & tap-info: set default value for --json Matching what's already been done for `brew info`.
2019-03-04 11:59:49 -05:00
Print a JSON representation of *`taps`*. Currently the default and only accepted value for *`version`* is `v1`. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew>
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `tap-pin` *`tap`*
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Pin *`tap`*, prioritising its formulae over core when formula names are supplied
by the user. See also `tap-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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `tap-unpin` *`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Unpin *`tap`* so its formulae are no longer prioritised. See also `tap-pin`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `uninstall`, `rm`, `remove` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--ignore-dependencies`:
Don't fail uninstall, even if *`formula`* is a dependency of any installed 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `unlink` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Remove symlinks for *`formula`* from the Homebrew prefix. This can be useful
for temporarily disabling a formula:
`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `-n`, `--dry-run`:
List all files which would be unlinked, but will not actually unlink or delete any 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `unpack` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Unpack the source files for *`formula`* into subdirectories of the current
working directory.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--destdir`:
Create subdirectories in the directory named by *`path`* instead.
* `--patch`:
Patches for *`formula`* will be applied to the unpacked source.
* `-g`, `--git`:
Initialise a Git repository in the unpacked source. This is useful for creating patches for the software.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `unpin` *`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Unpin *`formula`*, allowing them to be upgraded by `brew upgrade` *`formula`*.
See also `pin`.
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
manpages: commit updates.
2019-01-30 21:35:32 +00: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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Remove a tapped repository.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `update` [*`options`*]
Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--merge`:
`git merge` is used to include updates (rather than `git rebase`).
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--force`:
Always do a slower, full update check (even if unnecessary).
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `update-reset` [*`repository`*]
Fetches and resets Homebrew and all tap repositories (or any specified `repository`) using `git`(1) to their latest `origin/master`. Note this will destroy all your uncommitted or committed changes.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `upgrade` [*`options`*] *`formula`*
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Upgrade outdated, unpinned brews (with existing and any appended install options).
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If *`formula`* are given, upgrade only the specified brews (unless they
are pinned; see `pin`, `unpin`).
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual
2019-02-03 09:34:00 +01:00
Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the upgraded formulae or, every 30 days, for all formulae.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation.
* `--fetch-HEAD`:
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repository's HEAD will be checked for updates when a new stable or development version has been released.
* `--ignore-pinned`:
Set a 0 exit code even if pinned formulae are not upgraded.
* `--keep-tmp`:
Don't delete the temporary files created during installation.
* `--display-times`:
Print install times for each formula at the end of the run.
### `uses` [*`options`*] *`formula`*
Show the formulae that specify *`formula`* as a dependency. When given
multiple formula arguments, show the intersection of formulae that use
*`formula`*.
By default, `uses` shows all formulae that specify *`formula`* as a required
or recommended dependency.
By default, `uses` shows usage of *`formula`* by stable builds.
* `--recursive`:
Resolve more than one level of dependencies.
* `--installed`:
Only list installed formulae.
* `--include-build`:
Include all formulae that specify *`formula`* as `:build` type dependency.
* `--include-test`:
Include all formulae that specify *`formula`* as `:test` type dependency.
* `--include-optional`:
Include all formulae that specify *`formula`* as `:optional` type dependency.
* `--skip-recommended`:
Skip all formulae that specify *`formula`* as `:recommended` type dependency.
* `--devel`:
Show usage of *`formula`* by development build.
* `--HEAD`:
Show usage of *`formula`* by HEAD build.
Make install/reinstall/upgrade options more consistent.
2019-01-29 19:25:13 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `--cache` [*`options`*] [*`formula`*]
Add --display-times option to `install`, `reinstall`, and `upgrade`
2018-06-20 00:54:14 -04:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display Homebrew's download cache. See also `HOMEBREW_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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If *`formula`* is provided, display the file or directory used to cache *`formula`*.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `-s`, `--build-from-source`:
Show the cache file used when building from source.
* `--force-bottle`:
Show the cache file used when pouring a bottle.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `--cache` [*`formula`*]
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display Homebrew's Cellar path. *Default:* `$(brew --prefix)/Cellar`, or if
that directory doesn't exist, `$(brew --repository)/Cellar`.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If *`formula`* is provided, display the location in the cellar where *`formula`*
would be installed, without any sort of versioned directory as the last path.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `--env` [*`options`*]
man: Update manpages
2018-10-03 19:52:26 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Show a summary of the Homebrew build environment as a plain list.
man: Update manpages
2018-10-03 19:52:26 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00: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.
man: Update manpages
2018-10-03 19:52:26 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
* `--shell`:
Generate a list of environment variables for the specified shell, or `--shell=auto` to detect the current shell.
* `--plain`:
Plain output even when piped.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `--prefix` [*`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display Homebrew's install path. *Default:* `/usr/local` on macOS and
`/home/linuxbrew/.linuxbrew` on Linux.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If *`formula`* is provided, display the location in the cellar where *`formula`*
is or would be installed.
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
cmd/repository: Fix man pages and help
2019-02-06 17:53:15 +00:00
### `--repository` [*`user`*`/`*`repo`*]
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Display where Homebrew's `.git` directory is located.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located.
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `--version`
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Print the version number of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `audit` [*`options`*] *`formula`*
`brew man` output
2018-07-30 18:26:09 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Check *`formula`* for Homebrew coding style violations. This should be run before
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
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.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If no *`formula`* 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.
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `bottle` [*`options`*] *`formula`*
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
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `edit` [*`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
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
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `formula` *`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
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
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `linkage` [*`options`*] [*`formula`*]
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `prof` *`command`*
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Run Homebrew with the Ruby profiler e.g. `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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `pull` [*`options`*] *`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
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Each *`patch`* may be the number of a PR in homebrew/core, the URL of a PR
on GitHub, the URL of a commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL.
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
* `--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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `ruby` [`-e`]:
style: Fix style errors
2018-10-02 19:54:22 +05:30
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Run a Ruby instance with Homebrew's libraries loaded e.g.
`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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `test` [*`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
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`:
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Randomise 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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `vendor-gems`
Install and commit Homebrew's vendored gems.
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
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `bundle` *`subcommand`*:
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store. See `brew bundle --help`.
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
manpages: commit updates.
2019-01-30 21:35:32 +00: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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `cask` *`subcommand`*:
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Install macOS applications distributed as binaries. See brew-cask(1).
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
manpages: commit updates.
2019-01-30 21:35:32 +00: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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
### `services` *`subcommand`*:
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
manpages: commit updates.
2019-01-30 21:35:32 +00:00
Manage background services with macOS' `launchctl`(1) daemon manager. See `brew services --help`.
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
manpages: commit updates.
2019-01-30 21:35:32 +00: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_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
man: mention HOMEBREW_DISPLAY in man page
2019-02-12 12:39:59 -08:00
* `HOMEBREW_DISPLAY`:
If set, Homebrew will use this X11 display when opening a page in a browser,
for example with `brew home`. Primarily useful on Linux.
*Default:* the value of the user's `DISPLAY` environment variable.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown 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
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown 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`.
Add HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK variable If set, Homebrew will fail if on the failure of installation from a bottle rather than falling back to building from source.
2019-01-12 12:08:18 +00:00
* `HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK`:
Fiks HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK description This change fixes a syntax error introduced in b278165da
2019-01-14 16:29:42 -06:00
If set, Homebrew will fail on the failure of installation from a bottle
Add HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK variable If set, Homebrew will fail if on the failure of installation from a bottle rather than falling back to building from source.
2019-01-12 12:08:18 +00:00
rather than falling back to building from source.
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`:
manpages: commit updates.
2019-01-30 21:35:32 +00:00
If set, Homebrew will not print text with colour added.
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
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown 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
Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual
2019-02-03 09:34:00 +01:00
automatically cleanup the installed/upgraded/reinstalled formulae or all
formulae every 30 days.
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
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
Add/link Homebrew Governance document.
2019-02-15 10:54:30 +00:00
Homebrew's Project Leader is Mike McQuaid.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown 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/link Homebrew Governance document.
2019-02-15 10:54:30 +00:00
Homebrew's Project Leadership Committee is Misty De Meo, Shaun Jackman, Jonathan Chang, Mike McQuaid 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
Add/link Homebrew Governance document.
2019-02-15 10:54:30 +00:00
Homebrew's Technical Steering Committee is Michka Popoff, FX Coudert, Markus Reiter, Misty De Meo and Mike McQuaid.
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown 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 EricFromCanada. Welcome to the team!
2019-02-04 18:12:18 +01:00
Homebrew's other current maintainers are Claudia Pellegrino, Chongyu Zhu, Vitor Galvao, Gautham Goli, Steven Peters, William Woodruff, Igor Kapkov, Izaak Beekman, Sean Molenaar, Jan Viljanen, Jason Tedor, Eric Knibbe, Viktor Szakats, Thierry Moisan, Steven Peters 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