mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
161 lines
4.8 KiB
Markdown
161 lines
4.8 KiB
Markdown
|
The missing package manager for OS X
|
||
|
|
====================================
|
||
|
|
|
||
|
|
## SYNOPSIS
|
||
|
|
|
||
|
|
`brew` [--verbose|-v] command [options] [formula] ...
|
||
|
|
`brew` [--version|-v]
|
||
|
|
|
||
|
|
## DESCRIPTION
|
||
|
|
|
||
|
|
Homebrew is the easiest and most flexible way to install the UNIX tools Apple
|
||
|
|
didn't include with OS X.
|
||
|
|
|
||
|
|
## OPTIONS
|
||
|
|
* `-v`, `--verbose` command [options] [formula] ...:
|
||
|
|
Prints extra, comand-specific debugging information.
|
||
|
|
Note that `brew -v` by itself is the same as `brew --version`.
|
||
|
|
|
||
|
|
## COMMANDS
|
||
|
|
|
||
|
|
* `-v`, `--version`:
|
||
|
|
Prints the version number of brew to standard error and exits.
|
||
|
|
|
||
|
|
* `--prefix` [<formula>]:
|
||
|
|
Displays the install path for Homebrew.
|
||
|
|
If <formula> is given, display location in the cellar where that package
|
||
|
|
is or would be installed.
|
||
|
|
|
||
|
|
* `--cache` [<formula>]:
|
||
|
|
Displays the path Homebrew uses to cache downloads.
|
||
|
|
If <formula> is given, display the file or folder used to cache that specific package.
|
||
|
|
|
||
|
|
* `--config`:
|
||
|
|
Shows 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.
|
||
|
|
|
||
|
|
* `-S`, `search` <text>|/<text>/:
|
||
|
|
Performs a substring search of formula names for <text>. If <text> is
|
||
|
|
surrounded with slashes, then it is interpreted as a regular expression.
|
||
|
|
If no search term is given, all available formula are displayed.
|
||
|
|
|
||
|
|
* `install [--debug]` <formula>:
|
||
|
|
Installs <formula>.
|
||
|
|
|
||
|
|
If `--debug` is passed and brewing fails, opens a shell inside the
|
||
|
|
temporary folder used for compiling.
|
||
|
|
|
||
|
|
* `install --interactive [--git]` <formula>:
|
||
|
|
Downloads and patches <formula>, and then opens a shell. This allows the
|
||
|
|
user to run `./configure --help` and otherwise determine how to turn the
|
||
|
|
software package into a Homebrew formula.
|
||
|
|
|
||
|
|
If `--git` is passed, Homebrew will create a Git repository, useful for
|
||
|
|
creating patches to the software.
|
||
|
|
|
||
|
|
* `list`:
|
||
|
|
Lists all installed formulae.
|
||
|
|
|
||
|
|
* `list` <formula>:
|
||
|
|
Lists the installed files for <formula>.
|
||
|
|
|
||
|
|
* `info` <formula>:
|
||
|
|
Gives all available information for <formula>.
|
||
|
|
|
||
|
|
* `info --github` <formula>:
|
||
|
|
Opens a browser to the GitHub History page for formula <formula>.
|
||
|
|
|
||
|
|
* `info --all`:
|
||
|
|
Summarises all installed packages; this is inteded to be used by
|
||
|
|
higher-level tools.
|
||
|
|
|
||
|
|
* `home`:
|
||
|
|
Opens a browser to Homebrew's own homepage.
|
||
|
|
|
||
|
|
* `home` <formula>:
|
||
|
|
Opens a browser to <formula>'s homepage.
|
||
|
|
|
||
|
|
* `rm`, `remove` <formula>:
|
||
|
|
Uninstalls <formula>.
|
||
|
|
|
||
|
|
* `create [--cache]` <URL>:
|
||
|
|
Generates a formula for the downloadable file at <URL> and opens it in
|
||
|
|
$EDITOR. Homebrew will attempt to automatically derive the formula name
|
||
|
|
and version, if it fails, you'll have to make your own template. I suggest
|
||
|
|
copying wget's.
|
||
|
|
|
||
|
|
If `--cache` is passed, Homebrew will download the <URL> to the cache and
|
||
|
|
add the MD5 to the formula for you.
|
||
|
|
|
||
|
|
* `create --macports`|`--fink` <formula>:
|
||
|
|
Opens a browser to the MacPorts or Fink package search page, so you can
|
||
|
|
see how they do <formula>.
|
||
|
|
|
||
|
|
* `edit` <formula>:
|
||
|
|
Opens the formula in $EDITOR.
|
||
|
|
|
||
|
|
* `edit`:
|
||
|
|
Opens all of Homebrew for editing in TextMate.
|
||
|
|
|
||
|
|
* `link` <formula>:
|
||
|
|
Symlinks all of <formula>'s installed files into the Homebrew prefix. This
|
||
|
|
is done automatically when you install formula. It is useful for DIY
|
||
|
|
installation, or in cases where you want to swap out different versions of
|
||
|
|
the same package that you have installed at the same time.
|
||
|
|
|
||
|
|
* `unlink` <formula>:
|
||
|
|
Unsymlinks <formula> from the Homebrew prefix.
|
||
|
|
|
||
|
|
* `prune`:
|
||
|
|
Removes dead symlinks from the Homebrew prefix. This is generally not
|
||
|
|
needed. However, it can be useful if you are doing DIY installations.
|
||
|
|
|
||
|
|
* `outdated`:
|
||
|
|
Shows formula that have an updated version available.
|
||
|
|
|
||
|
|
* `deps` <formula>:
|
||
|
|
Shows <formula>'s dependencies.
|
||
|
|
|
||
|
|
* `uses` <formula>:
|
||
|
|
Shows the formulas that specify <formula> as a dependency. The list is not
|
||
|
|
recursive; only one level of dependencies is resolved.
|
||
|
|
|
||
|
|
* `doctor`:
|
||
|
|
Audits your system for potential problems.
|
||
|
|
|
||
|
|
* `cat` <formula>:
|
||
|
|
Displays the source to <formula>.
|
||
|
|
|
||
|
|
* `cleanup` [<formula>]:
|
||
|
|
For all installed or specific formulae, remove any older versions from the
|
||
|
|
cellar.
|
||
|
|
|
||
|
|
* `update`:
|
||
|
|
Using Git, fetches the newest version of Homebrew from the GitHub repository.
|
||
|
|
|
||
|
|
## ENVIRONMENT
|
||
|
|
|
||
|
|
* HOMEBREW\_DEBUG:
|
||
|
|
If set, instructs Homebrew to always assume `--debug` when running commands.
|
||
|
|
|
||
|
|
* HOMEBREW\_USE\_LLVM:
|
||
|
|
If set, instructs Homebrew to use the LLVM front-ends to the GCC compilers.
|
||
|
|
*NOTE*: Not all formulae will build correctly under LLVM.
|
||
|
|
|
||
|
|
* HOMEBREW\_VERBOSE:
|
||
|
|
If set, instructs Homebrew to always assume `--verbose` when running
|
||
|
|
commands.
|
||
|
|
|
||
|
|
## SEE ALSO
|
||
|
|
|
||
|
|
Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/
|
||
|
|
|
||
|
|
## AUTHORS
|
||
|
|
|
||
|
|
Max Howell, a splendid chap.
|
||
|
|
|
||
|
|
## BUGS
|
||
|
|
|
||
|
|
See Issues on GitHub: http://github.com/mxcl/homebrew/issues
|