uninstall formulaUninstall formula.
updateFetch the newest version of Homebrew from GitHub using git(1).
listList all installed formulae.
search text|/text/Perform a substring search of formula names for text. If text is +
search (text|/text/)Perform a substring search of 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 some popular taps. If no search term is given, all locally available formulae are listed.
If --dry-run or -n is passed, show what would be removed, but do not
actually remove anything.
If -s is passed, scrubs the cache, removing downloads for even the latest
+
If -s is passed, scrub the cache, removing downloads for even the latest
versions of formulae. Note downloads for any installed formulae will still not be
deleted. If you want to delete those too: rm -rf $(brew --cache)
command cmdDisplay the path to the file which is used when invoking brew cmd.
The filters placeholder is any combination of options --include-build,
--include-optional, and --skip-recommended as documented above.
desc formulaDisplay formula's name and one-line description.
desc [-s|-n|-d] patternSearch both name and description (-s), just the names (-n), or just the
-descriptions (-d) for <pattern>. <pattern> is by default interpreted
-as a literal string; if flanked by slashes, it is instead interpreted as a
-regular expression. Formula descriptions are cached; the cache is created on
+
desc [-s|-n|-d] (text|/text/)Search both name and description (-s), just the names (-n), or just the
+descriptions (-d) for text. If text is flanked by slashes, it is interpreted
+as a regular expression. Formula descriptions are cached; the cache is created on
the first search, making that search slower than subsequent ones.
diy [--name=name] [--version=version]Automatically determine the installation prefix for non-Homebrew software.
@@ -144,14 +143,14 @@ GitHub repository as well as creating the Gist.info formulaDisplay information about formula.
info --github formulaOpen a browser to the GitHub History page for formula formula.
-To view formula history locally: brew log -p <formula>.
To view formula history locally: brew log -p <formula>
info --json=version (--all|--installed|formulae)Print a JSON representation of formulae. Currently the only accepted value
for version is v1.
Pass --all to get information on all formulae, or --installed to get
information on all installed formulae.
See the docs for examples of using the JSON: +
See the docs for examples of using the JSON output: http://docs.brew.sh/Querying-Brew.html
install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source] [--devel|--HEAD] [--keep-tmp] formulaInstall formula.
@@ -265,7 +264,7 @@ spaces.If --all is passed, show options for all formulae.
If --installed is passed, show options for all installed formulae.
outdated [--quiet|--verbose|--json=v1] [--fetch-HEAD]Show formulae that have an updated version available.
+outdated [--quiet|--verbose|--json=version] [--fetch-HEAD]Show formulae that have an updated version available.
By default, version information is displayed in interactive shells, and suppressed otherwise.
@@ -295,7 +294,7 @@ actually remove anything.reinstall formulaUninstall and then install formula.
search, -SDisplay all locally available formulae for brewing (including tapped ones). No online search is performed if called without arguments.
search [--desc] text|/text/Perform a substring search of formula names for text. If text is +
search [--desc] (text|/text/)Perform a substring search of 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 some popular taps.
@@ -353,7 +352,7 @@ for version isv1.
Pass --installed to get information on installed taps.
See the docs for examples of using the JSON: +
See the docs for examples of using the JSON output: http://docs.brew.sh/Querying-Brew.html
tap-pin tapPin tap, prioritizing its formulae over core when formula names are supplied
by the user. See also tap-unpin.
unlink [--dry-run] formulaRemove symlinks for formula from the Homebrew prefix. This can be useful
for temporarily disabling a formula:
-brew unlink foo && commands && brew link foo.
brew unlink <formula> && <commands> && brew link <formula>
If --dry-run or -n is passed, Homebrew will list all files which would
be unlinked, but will not actually unlink or delete any files.
unpack [--git|--patch] [--destdir=path] formulaeUnpack the source files for formulae into subdirectories of the current
working directory. If --destdir=path is given, the subdirectories will
-be created in the directory named by <path> instead.
If --patch is passed, patches for formulae will be applied to the
unpacked source.
:build type dependencies,
--include-build. Similarly, pass --include-optional to include :optional
dependencies. To skip :recommended type dependencies, pass --skip-recommended.
-By default, uses shows usages of formula by stable builds. To find
-cases where formula is used by development or HEAD build, pass
+
By default, uses shows usages of formulae by stable builds. To find
+cases where formulae is used by development or HEAD build, pass
--devel or --HEAD.
--cacheDisplay Homebrew's download cache. See also HOMEBREW_CACHE.
--cache formulaDisplay the file or directory used to cache formula.
audit exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.
bottle [--verbose] [--no-rebuild] [--keep-old] [--skip-relocation] [--root-url=<root_url>] [--force-core-tap]:bottle --merge [--no-commit] [--keep-old] [--write]:Generate a bottle (binary package) from a formula installed with +
bottle [--verbose] [--no-rebuild] [--keep-old] [--skip-relocation] [--root-url=URL] [--force-core-tap]:bottle --merge [--no-commit] [--keep-old] [--write]Generate a bottle (binary package) from a formula installed with
--build-bottle.
bump-formula-pr [--devel] [--dry-run] [--audit|--strict] [--message=message] --url=url --sha256=sha-256 formula:bump-formula-pr [--devel] [--dry-run] [--audit|--strict] [--message=message] --tag=tag --revision=revision formulaCreates a pull request to update the formula with a new url or a new tag.
+bump-formula-pr [--devel] [--dry-run [--write]] [--audit|--strict] [--mirror=URL] [--version=version] [--message=message] (--url=URL --sha256=sha-256|--tag=tag --revision=revision) formulaCreates a pull request to update the formula with a new URL or a new tag.
-If a url is specified, the sha-256 checksum of the new download must +
If a URL is specified, the sha-256 checksum of the new download must also be specified. A best effort to determine the sha-256 and formula name will be made if either or both values are not supplied by the user.
@@ -506,25 +502,24 @@ making the expected file modifications but not taking any git actions.If --strict is passed, run brew audit --strict before opening the PR.
If --mirror=url is passed, use the value as a mirror url.
If --mirror=URL is passed, use the value as a mirror URL.
If --version=version is passed, use the value to override the value
-parsed from the url or tag. Note that --version=0 can be used to delete
+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.
If --message=message is passed, append message to the default PR
message.
Note that this command cannot be used to transition a formula from a -url-and-sha256 style specification into a tag-and-revision style +URL-and-sha256 style specification into a tag-and-revision style specification, nor vice versa. It must use whichever style specification the preexisting formula already uses.
create URL [--autotools|--cmake|--meson] [--no-fetch] [--set-name name] [--set-version version] [--tap user/repo]Generate a formula for the downloadable file at URL and open it in the editor.
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The wget
-formula serves as a simple example. For the complete API have a look at
http://www.rubydoc.info/github/Homebrew/brew/master/Formula
+formula serves as a simple example. For the complete API have a look at +http://www.rubydoc.info/github/Homebrew/brew/master/Formula.If --autotools is passed, create a basic template for an Autotools-style build.
If --cmake is passed, create a basic template for a CMake-style build.
@@ -540,8 +535,8 @@ you to explicitly set the name and version of the package you are creating.
editOpen all of Homebrew for editing.
edit formulaOpen formula in the editor.
formula formulaDisplay the path where formula is
linkage [--test] [--reverse] formula-nameChecks the library links of an installed formula.
+formula formulaDisplay the path where formula is located.
linkage [--test] [--reverse] formulaChecks the library links of an installed formula.
Only works on installed formulae. An error is raised if it is run on uninstalled formulae.
@@ -558,44 +553,47 @@ 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).pull [--bottle] [--bump] [--clean] [--ignore-whitespace] [--resolve] [--branch-okay] [--no-pbcopy] [--no-publish] patch-source [patch-source]Gets a patch from a GitHub commit or pull request and applies it to Homebrew. +Optionally, installs the formulae changed by the patch.
- pull [--bottle] [--bump] [--clean] [--ignore-whitespace] [--resolve] [--branch-okay] [--no-pbcopy] [--no-publish] patch-source [patch-source]
Each patch-source may be one of:
-Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
-Optionally, installs the formulae changed by the patch.
+ ~ The ID number of a PR (pull request) in the homebrew/core GitHub
+ repository
-Each <patch-source> may be one of:
- * The ID number of a PR (Pull Request) in the homebrew/core GitHub
- repository
- * The URL of a PR on GitHub, using either the web page or API URL
+ ~ The URL of a PR on GitHub, using either the web page or API URL
formats. In this form, the PR may be on Homebrew/brew,
- Homebrew/homebrew-core or any tap.
- * The URL of a commit on GitHub
- * A "http://bot.brew.sh/job/..." string specifying a testing job ID
-
If --bottle was passed, handle bottles, pulling the bottle-update
- commit and publishing files on Bintray.
- If --bump was passed, for one-formula PRs, automatically reword
- commit message to our preferred format.
- If --clean was passed, do not rewrite or otherwise modify the
- commits found in the pulled PR.
- If --ignore-whitespace was passed, silently ignore whitespace
- discrepancies when applying diffs.
- If --resolve was passed, when a patch fails to apply, leave in
- progress and allow user to
- resolve, instead of aborting.
- If --branch-okay was passed, do not warn if pulling to a branch
- besides master (useful for testing).
- If --no-pbcopy was passed, do not copy anything to the system
- If --no-publish was passed, do not publish bottles to Bintray.
~ The URL of a commit on GitHub
-release-notes [previous_tag] [end_ref]Output the merged pull requests on Homebrew/brew between two Git refs.
-If no previous_tag is provided it defaults to the newest tag.
-If no end_ref is provided it defaults to origin/master.
~ A "http://bot.brew.sh/job/..." string specifying a testing job ID
+ +If --bottle is passed, handle bottles, pulling the bottle-update
+commit and publishing files on Bintray.
If --bump is passed, for one-formula PRs, automatically reword
+commit message to our preferred format.
If --clean is passed, do not rewrite or otherwise modify the
+commits found in the pulled PR.
If --ignore-whitespace is passed, silently ignore whitespace
+discrepancies when applying diffs.
If --resolve is passed, when a patch fails to apply, leave in
+progress and allow user to resolve, instead of aborting.
If --branch-okay is passed, do not warn if pulling to a branch
+besides master (useful for testing).
If --no-pbcopy is passed, do not copy anything to the system
+clipboard.
If --no-publish is passed, do not publish bottles to Bintray.
release-notes [--markdown] [previous_tag] [end_ref]Output the merged pull requests on Homebrew/brew between two Git refs.
+If no previous_tag is provided it defaults to the newest tag.
+If no end_ref is provided it defaults to origin/master.
If --markdown is passed, output as a Markdown list.
tap-new user/repoGenerate the template files for a new tap.
Example: brew install jruby && brew test jruby
tests [-v] [--coverage] [--generic] [--no-compat] [--only=<test_script:test_method>] [--seed seed] [--trace] [--online] [--official-cmd-taps]Run Homebrew's unit and integration tests.
update-test [--commit=<commit>] [--before=<date>] [--keep-tmp]Runs a test of brew update with a new repository clone.
tests [-v] [--coverage] [--generic] [--no-compat] [--only=test_script:test_method] [--seed seed] [--trace] [--online] [--official-cmd-taps]Run Homebrew's unit and integration tests.
update-test [--commit=commit] [--before=date] [--keep-tmp]Runs a test of brew update with a new repository clone.
If no arguments are passed, use origin/master as the start commit.
If --commit=<commit> is passed, use <commit> as the start commit.
If --commit=commit is passed, use commit as the start commit.
If --before=<date> is passed, use the commit at <date> as the
+
If --before=date is passed, use the commit at date as the
start commit.
If --to-tag is passed, set HOMEBREW_UPDATE_TO_TAG to test updating
+
If --to-tag is passed, set HOMEBREW_UPDATE_TO_TAG to test updating
between tags.
If --keep-tmp is passed, retain the temporary directory containing
@@ -742,7 +740,7 @@ successful build.
While ensuring your downloads are fully secure, this is likely -to cause from-source Sourceforge, some GNU & GNOME based +to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download.
HOMEBREW_NO_GITHUB_APIIf set, Homebrew will not use the GitHub API for e.g searches or fetching relevant issues on a failed install.
Homebrew's lead maintainer is Mike McQuaid.
-Homebrew's current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, [Alex Dunn](https://github.
+Homebrew's current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, Alex Dunn, FX Coudert, ilovezfs, Josh Hagins, JCount, Misty De Meo, Tomasz Pajor, Markus Reiter, Tim Smith, Tom Schoonjans, Uladzislau Shablinski and William Woodruff.
Former maintainers with significant contributions include Xu Cheng, Martin Afanasjew, Dominyk Tiller, Brett Koonce, Jack Nagel, Adam Vandenberg and Homebrew's creator: Max Howell.
-- cgit v1.2.3