Alpahabetize commands on man page
This commit is contained in:
Adam Vandenberg
parent
57c61bb9c1
commit
846b6cb91b
@ -39,8 +39,80 @@ For the full command list, see the COMMANDS section.
|
|||||||
|
|
||||||
## COMMANDS
|
## COMMANDS
|
||||||
|
|
||||||
* `-v`, `--version`:
|
* `audit [--strict]` [<formulae>]:
|
||||||
Print the version number of brew to standard error and exit.
|
Check <formulae> for Homebrew coding style violations. This should be
|
||||||
|
run before submitting a new formula.
|
||||||
|
|
||||||
|
If no <formulae> are provided, all of them are checked.
|
||||||
|
|
||||||
|
If `--strict` is passed, perform additional stricter checks that may not need
|
||||||
|
to be fixed before submitting.
|
||||||
|
|
||||||
|
`audit` exits with a non-zero status if any errors are found. This is useful,
|
||||||
|
for instance, for implementing pre-commit hooks.
|
||||||
|
|
||||||
|
* `cat` <formula>:
|
||||||
|
Display the source to <formula>.
|
||||||
|
|
||||||
|
* `cleanup [--force]` [<formula>]:
|
||||||
|
For all installed or specific formulae, remove any older versions from the
|
||||||
|
cellar. By default, does not remove out-of-date keg-only brews, as other
|
||||||
|
software may link directly to specific versions.
|
||||||
|
|
||||||
|
If `--force` is passed, remove out-of-date keg-only brews as well.
|
||||||
|
|
||||||
|
* `create [--no-fetch]` <URL>:
|
||||||
|
Generate 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 `--no-fetch` is passed, Homebrew will not download <URL> to the cache and
|
||||||
|
will thus not add the MD5 to the formula for you.
|
||||||
|
|
||||||
|
* `deps [--1]` <formula>:
|
||||||
|
Show <formula>'s dependencies.
|
||||||
|
|
||||||
|
If `--1` is passed, only show dependencies one level down, instead of
|
||||||
|
recursing.
|
||||||
|
|
||||||
|
* `doctor`:
|
||||||
|
Check your system for potential problems.
|
||||||
|
|
||||||
|
* `edit`:
|
||||||
|
Open all of Homebrew for editing in TextMate.
|
||||||
|
|
||||||
|
* `edit` <formula>:
|
||||||
|
Open <formula> in $EDITOR.
|
||||||
|
|
||||||
|
* `fetch [--force] [-v] [--HEAD] [--deps]` <formulae>:
|
||||||
|
Download the source packages for the given <formulae>.
|
||||||
|
For tarballs, also print MD5 and SHA1 checksums.
|
||||||
|
|
||||||
|
If `--HEAD` is passed, download the HEAD versions of <formulae> instead. `-v`
|
||||||
|
may also be passed to make the VCS checkout verbose, useful for seeing if
|
||||||
|
an existing HEAD cache has been updated.
|
||||||
|
|
||||||
|
If `--force` is passed, remove a previously cached version and re-fetch.
|
||||||
|
|
||||||
|
If `--deps` is passed, also download dependencies for any listed <formulae>.
|
||||||
|
|
||||||
|
* `home`:
|
||||||
|
Open Homebrew's own homepage in a browser.
|
||||||
|
|
||||||
|
* `home` <formula>:
|
||||||
|
Open <formula>'s homepage in a browser.
|
||||||
|
|
||||||
|
* `info` <formula>:
|
||||||
|
Display information about <formula>.
|
||||||
|
|
||||||
|
* `info --github` <formula>:
|
||||||
|
Open a browser to the GitHub History page for formula <formula>.
|
||||||
|
|
||||||
|
To view formula history locally: `brew log -p <formula>`.
|
||||||
|
|
||||||
|
* `info` <URL>:
|
||||||
|
Print the name and version that will be detected for <URL>.
|
||||||
|
|
||||||
* `install [--force] [--debug] [--ignore-dependencies] [--use-llvm] [--use-gcc] [--HEAD]` <formula>:
|
* `install [--force] [--debug] [--ignore-dependencies] [--use-llvm] [--use-gcc] [--HEAD]` <formula>:
|
||||||
Install <formula>.
|
Install <formula>.
|
||||||
@ -80,16 +152,11 @@ For the full command list, see the COMMANDS section.
|
|||||||
If `--git` is passed, Homebrew will create a Git repository, useful for
|
If `--git` is passed, Homebrew will create a Git repository, useful for
|
||||||
creating patches to the software.
|
creating patches to the software.
|
||||||
|
|
||||||
* `search`, `-S` <text>|/<text>/:
|
* `ln`, `link` <formula>:
|
||||||
Perform a substring search of formula names for <text>. If <text> is
|
Symlink all of <formula>'s installed files into the Homebrew prefix. This
|
||||||
surrounded with slashes, then it is interpreted as a regular expression.
|
is done automatically when you install formula. It is useful for DIY
|
||||||
If no search term is given, all available formula are displayed.
|
installation, or in cases where you want to swap out different versions of
|
||||||
|
the same package that you have installed at the same time.
|
||||||
* `search --macports`|`--fink` <text>:
|
|
||||||
Search for <text> on the MacPorts or Fink package search page.
|
|
||||||
|
|
||||||
* `update`:
|
|
||||||
Fetch the newest version of Homebrew from GitHub using `git`(1).
|
|
||||||
|
|
||||||
* `list`:
|
* `list`:
|
||||||
List all installed formulae.
|
List all installed formulae.
|
||||||
@ -97,113 +164,17 @@ For the full command list, see the COMMANDS section.
|
|||||||
* `list` <formula>:
|
* `list` <formula>:
|
||||||
List the installed files for <formula>.
|
List the installed files for <formula>.
|
||||||
|
|
||||||
* `info` <formula>:
|
|
||||||
Display information about <formula>.
|
|
||||||
|
|
||||||
* `info --github` <formula>:
|
|
||||||
Open a browser to the GitHub History page for formula <formula>.
|
|
||||||
|
|
||||||
To view formula history locally: `brew log -p <formula>`.
|
|
||||||
|
|
||||||
* `info` <URL>:
|
|
||||||
Print the name and version that will be detected for <URL>.
|
|
||||||
|
|
||||||
* `home`:
|
|
||||||
Open Homebrew's own homepage in a browser.
|
|
||||||
|
|
||||||
* `home` <formula>:
|
|
||||||
Open <formula>'s homepage in a browser.
|
|
||||||
|
|
||||||
* `rm`, `remove`, `uninstall [--force]` <formula>:
|
|
||||||
Uninstall <formula>.
|
|
||||||
|
|
||||||
If `--force` is passed, and there are multiple versions of <formula>
|
|
||||||
installed, delete all installed versions.
|
|
||||||
|
|
||||||
* `create [--no-fetch]` <URL>:
|
|
||||||
Generate 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 `--no-fetch` is passed, Homebrew will not download <URL> to the cache and
|
|
||||||
will thus not add the MD5 to the formula for you.
|
|
||||||
|
|
||||||
* `edit` <formula>:
|
|
||||||
Open <formula> in $EDITOR.
|
|
||||||
|
|
||||||
* `edit`:
|
|
||||||
Open all of Homebrew for editing in TextMate.
|
|
||||||
|
|
||||||
* `ln`, `link` <formula>:
|
|
||||||
Symlink 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>:
|
|
||||||
Unsymlink <formula> from the Homebrew prefix. This can be useful for
|
|
||||||
temporarily disabling a formula: `brew unlink foo && commands && brew link foo`.
|
|
||||||
|
|
||||||
* `prune`:
|
|
||||||
Remove dead symlinks from the Homebrew prefix. This is generally not
|
|
||||||
needed, but can be useful when doing DIY installations.
|
|
||||||
|
|
||||||
* `outdated`:
|
|
||||||
Show formula that have an updated version available.
|
|
||||||
|
|
||||||
* `deps [--1]` <formula>:
|
|
||||||
Show <formula>'s dependencies.
|
|
||||||
|
|
||||||
If `--1` is passed, only show dependencies one level down, instead of
|
|
||||||
recursing.
|
|
||||||
|
|
||||||
* `uses [--installed]` <formula>:
|
|
||||||
Show the formulas that specify <formula> as a dependency. The list is
|
|
||||||
not recursive; only one level of dependencies is resolved.
|
|
||||||
|
|
||||||
If `--installed` is passed, only lists installed formulae.
|
|
||||||
|
|
||||||
* `doctor`:
|
|
||||||
Check your system for potential problems.
|
|
||||||
|
|
||||||
* `cat` <formula>:
|
|
||||||
Display the source to <formula>.
|
|
||||||
|
|
||||||
* `cleanup [--force]` [<formula>]:
|
|
||||||
For all installed or specific formulae, remove any older versions from the
|
|
||||||
cellar. By default, does not remove out-of-date keg-only brews, as other
|
|
||||||
software may link directly to specific versions.
|
|
||||||
|
|
||||||
If `--force` is passed, remove out-of-date keg-only brews as well.
|
|
||||||
|
|
||||||
* `log [git-log-options]` <formula> ...:
|
* `log [git-log-options]` <formula> ...:
|
||||||
Show the git log for the given formulae. Options that `git-log`(1)
|
Show the git log for the given formulae. Options that `git-log`(1)
|
||||||
recognizes can be passed before the formula list.
|
recognizes can be passed before the formula list.
|
||||||
|
|
||||||
* `fetch [--force] [-v] [--HEAD] [--deps]` <formulae>:
|
* `man`:
|
||||||
Download the source packages for the given <formulae>.
|
Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details.
|
||||||
For tarballs, also print MD5 and SHA1 checksums.
|
|
||||||
|
|
||||||
If `--HEAD` is passed, download the HEAD versions of <formulae> instead. `-v`
|
* `missing` [<formulae>]:
|
||||||
may also be passed to make the VCS checkout verbose, useful for seeing if
|
Check the given <formulae> for missing dependencies.
|
||||||
an existing HEAD cache has been updated.
|
|
||||||
|
|
||||||
If `--force` is passed, remove a previously cached version and re-fetch.
|
If no <formulae> are given, check all installed brews.
|
||||||
|
|
||||||
If `--deps` is passed, also download dependencies for any listed <formulae>.
|
|
||||||
|
|
||||||
* `audit [--strict]` [<formulae>]:
|
|
||||||
Check <formulae> for Homebrew coding style violations. This should be
|
|
||||||
run before submitting a new formula.
|
|
||||||
|
|
||||||
If no <formulae> are provided, all of them are checked.
|
|
||||||
|
|
||||||
If `--strict` is passed, perform additional stricter checks that may not need
|
|
||||||
to be fixed before submitting.
|
|
||||||
|
|
||||||
`audit` exits with a non-zero status if any errors are found. This is useful,
|
|
||||||
for instance, for implementing pre-commit hooks.
|
|
||||||
|
|
||||||
* `options [--compact] [--all]` <formula>:
|
* `options [--compact] [--all]` <formula>:
|
||||||
Display install options specific to <formula>.
|
Display install options specific to <formula>.
|
||||||
@ -213,10 +184,26 @@ For the full command list, see the COMMANDS section.
|
|||||||
|
|
||||||
If `--all` is passed, show options for all formulae.
|
If `--all` is passed, show options for all formulae.
|
||||||
|
|
||||||
* `missing` [<formulae>]:
|
* `outdated`:
|
||||||
Check the given <formulae> for missing dependencies.
|
Show formula that have an updated version available.
|
||||||
|
|
||||||
If no <formulae> are given, check all installed brews.
|
* `prune`:
|
||||||
|
Remove dead symlinks from the Homebrew prefix. This is generally not
|
||||||
|
needed, but can be useful when doing DIY installations.
|
||||||
|
|
||||||
|
* `rm`, `remove`, `uninstall [--force]` <formula>:
|
||||||
|
Uninstall <formula>.
|
||||||
|
|
||||||
|
If `--force` is passed, and there are multiple versions of <formula>
|
||||||
|
installed, delete all installed versions.
|
||||||
|
|
||||||
|
* `search`, `-S` <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.
|
||||||
|
If no search term is given, all available formula are displayed.
|
||||||
|
|
||||||
|
* `search --macports`|`--fink` <text>:
|
||||||
|
Search for <text> on the MacPorts or Fink package search page.
|
||||||
|
|
||||||
* `server`:
|
* `server`:
|
||||||
Start a local web app that lets you browse available formulae, similar
|
Start a local web app that lets you browse available formulae, similar
|
||||||
@ -230,8 +217,31 @@ For the full command list, see the COMMANDS section.
|
|||||||
|
|
||||||
Example: `brew install jruby && brew test jruby`
|
Example: `brew install jruby && brew test jruby`
|
||||||
|
|
||||||
* `man`:
|
* `unlink` <formula>:
|
||||||
Regenerate this man page using [`ronn`][ronn]. See `man brew-man` for details.
|
Unsymlink <formula> from the Homebrew prefix. This can be useful for
|
||||||
|
temporarily disabling a formula: `brew unlink foo && commands && brew link foo`.
|
||||||
|
|
||||||
|
* `update`:
|
||||||
|
Fetch the newest version of Homebrew from GitHub using `git`(1).
|
||||||
|
|
||||||
|
* `uses [--installed]` <formula>:
|
||||||
|
Show the formulas that specify <formula> as a dependency. The list is
|
||||||
|
not recursive; only one level of dependencies is resolved.
|
||||||
|
|
||||||
|
If `--installed` is passed, only lists installed formulae.
|
||||||
|
|
||||||
|
* `--cache`:
|
||||||
|
Display Homebrew's download cache. *Default:* `~/Library/Cache/Homebrew`
|
||||||
|
|
||||||
|
* `--cache` <formula>:
|
||||||
|
Display the file or folder used to cache <formula>.
|
||||||
|
|
||||||
|
* `--cellar`:
|
||||||
|
Display Homebrew's Cellar path. *Default:* `/usr/local/Cellar`
|
||||||
|
|
||||||
|
* `--cellar` <formula>:
|
||||||
|
Display the location in the cellar where <formula> would be installed,
|
||||||
|
without any sort of versioned folder as the last path.
|
||||||
|
|
||||||
* `--config`:
|
* `--config`:
|
||||||
Show Homebrew and system configuration useful for debugging. If you file
|
Show Homebrew and system configuration useful for debugging. If you file
|
||||||
@ -244,23 +254,13 @@ For the full command list, see the COMMANDS section.
|
|||||||
* `--prefix` <formula>:
|
* `--prefix` <formula>:
|
||||||
Display the location in the cellar where <formula> is or would be installed.
|
Display the location in the cellar where <formula> is or would be installed.
|
||||||
|
|
||||||
* `--cellar`:
|
|
||||||
Display Homebrew's Cellar path. *Default:* `/usr/local/Cellar`
|
|
||||||
|
|
||||||
* `--cellar` <formula>:
|
|
||||||
Display the location in the cellar where <formula> would be installed,
|
|
||||||
without any sort of versioned folder as the last path.
|
|
||||||
|
|
||||||
* `--cache`:
|
|
||||||
Display Homebrew's download cache. *Default:* `~/Library/Cache/Homebrew`
|
|
||||||
|
|
||||||
* `--cache` <formula>:
|
|
||||||
Display the file or folder used to cache <formula>.
|
|
||||||
|
|
||||||
* `--repository`:
|
* `--repository`:
|
||||||
Display where Homebrew's `.git` folder is located. For standard installs,
|
Display where Homebrew's `.git` folder is located. For standard installs,
|
||||||
the `prefix` and `repository` are the same folder.
|
the `prefix` and `repository` are the same folder.
|
||||||
|
|
||||||
|
* `-v`, `--version`:
|
||||||
|
Print the version number of brew to standard error and exit.
|
||||||
|
|
||||||
## EXTERNAL COMMANDS
|
## EXTERNAL COMMANDS
|
||||||
|
|
||||||
Homebrew allows external commands to be defined by putting a +x file named
|
Homebrew allows external commands to be defined by putting a +x file named
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn/v0.7.3
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||||
.
|
.
|
||||||
.TH "BREW\-MAN" "1" "May 2011" "Homebrew" "brew"
|
.TH "BREW\-MAN" "1" "January 2011" "Homebrew" "brew"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBbrew\-man\fR \- Generate man pages for Homebrew
|
\fBbrew\-man\fR \- Generate man pages for Homebrew
|
||||||
|
|||||||
@ -47,8 +47,90 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
|
|||||||
.SH "COMMANDS"
|
.SH "COMMANDS"
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fB\-v\fR, \fB\-\-version\fR
|
\fBaudit [\-\-strict]\fR [\fIformulae\fR]
|
||||||
Print the version number of brew to standard error and exit\.
|
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If no \fIformulae\fR are provided, all of them are checked\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-strict\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBcat\fR \fIformula\fR
|
||||||
|
Display the source to \fIformula\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBcleanup [\-\-force]\fR [\fIformula\fR]
|
||||||
|
For all installed or specific formulae, remove any older versions from the cellar\. By default, does not remove out\-of\-date keg\-only brews, as other software may link directly to specific versions\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBcreate [\-\-no\-fetch]\fR \fIURL\fR
|
||||||
|
Generate a formula for the downloadable file at \fIURL\fR 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\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-no\-fetch\fR is passed, Homebrew will not download \fIURL\fR to the cache and will thus not add the MD5 to the formula for you\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBdeps [\-\-1]\fR \fIformula\fR
|
||||||
|
Show \fIformula\fR\'s dependencies\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBdoctor\fR
|
||||||
|
Check your system for potential problems\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBedit\fR
|
||||||
|
Open all of Homebrew for editing in TextMate\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBedit\fR \fIformula\fR
|
||||||
|
Open \fIformula\fR in $EDITOR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBfetch [\-\-force] [\-v] [\-\-HEAD] [\-\-deps]\fR \fIformulae\fR
|
||||||
|
Download the source packages for the given \fIformulae\fR\. For tarballs, also print MD5 and SHA1 checksums\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-HEAD\fR is passed, download the HEAD versions of \fIformulae\fR instead\. \fB\-v\fR may also be passed to make the VCS checkout verbose, useful for seeing if an existing HEAD cache has been updated\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBhome\fR
|
||||||
|
Open Homebrew\'s own homepage in a browser\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBhome\fR \fIformula\fR
|
||||||
|
Open \fIformula\fR\'s homepage in a browser\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBinfo\fR \fIformula\fR
|
||||||
|
Display information about \fIformula\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBinfo \-\-github\fR \fIformula\fR
|
||||||
|
Open a browser to the GitHub History page for formula \fIformula\fR\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
To view formula history locally: \fBbrew log \-p <formula>\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBinfo\fR \fIURL\fR
|
||||||
|
Print the name and version that will be detected for \fIURL\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-llvm] [\-\-use\-gcc] [\-\-HEAD]\fR \fIformula\fR
|
\fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-llvm] [\-\-use\-gcc] [\-\-HEAD]\fR \fIformula\fR
|
||||||
@ -86,16 +168,8 @@ Download and patch \fIformula\fR, then open a shell\. This allows the user to ru
|
|||||||
If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
|
If \fB\-\-git\fR is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBsearch\fR, \fB\-S\fR \fItext\fR|/\fItext\fR/
|
\fBln\fR, \fBlink\fR \fIformula\fR
|
||||||
Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. If no search term is given, all available formula are displayed\.
|
Symlink all of \fIformula\fR\'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\.
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBsearch \-\-macports\fR|\fB\-\-fink\fR \fItext\fR
|
|
||||||
Search for \fItext\fR on the MacPorts or Fink package search page\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBupdate\fR
|
|
||||||
Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBlist\fR
|
\fBlist\fR
|
||||||
@ -106,124 +180,19 @@ List all installed formulae\.
|
|||||||
List the installed files for \fIformula\fR\.
|
List the installed files for \fIformula\fR\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBinfo\fR \fIformula\fR
|
|
||||||
Display information about \fIformula\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBinfo \-\-github\fR \fIformula\fR
|
|
||||||
Open a browser to the GitHub History page for formula \fIformula\fR\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
To view formula history locally: \fBbrew log \-p <formula>\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBinfo\fR \fIURL\fR
|
|
||||||
Print the name and version that will be detected for \fIURL\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBhome\fR
|
|
||||||
Open Homebrew\'s own homepage in a browser\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBhome\fR \fIformula\fR
|
|
||||||
Open \fIformula\fR\'s homepage in a browser\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBrm\fR, \fBremove\fR, \fBuninstall [\-\-force]\fR \fIformula\fR
|
|
||||||
Uninstall \fIformula\fR\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBcreate [\-\-no\-fetch]\fR \fIURL\fR
|
|
||||||
Generate a formula for the downloadable file at \fIURL\fR 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\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-no\-fetch\fR is passed, Homebrew will not download \fIURL\fR to the cache and will thus not add the MD5 to the formula for you\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBedit\fR \fIformula\fR
|
|
||||||
Open \fIformula\fR in $EDITOR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBedit\fR
|
|
||||||
Open all of Homebrew for editing in TextMate\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBln\fR, \fBlink\fR \fIformula\fR
|
|
||||||
Symlink all of \fIformula\fR\'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\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBunlink\fR \fIformula\fR
|
|
||||||
Unsymlink \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBprune\fR
|
|
||||||
Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBoutdated\fR
|
|
||||||
Show formula that have an updated version available\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBdeps [\-\-1]\fR \fIformula\fR
|
|
||||||
Show \fIformula\fR\'s dependencies\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-1\fR is passed, only show dependencies one level down, instead of recursing\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBuses [\-\-installed]\fR \fIformula\fR
|
|
||||||
Show the formulas that specify \fIformula\fR as a dependency\. The list is not recursive; only one level of dependencies is resolved\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-installed\fR is passed, only lists installed formulae\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBdoctor\fR
|
|
||||||
Check your system for potential problems\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBcat\fR \fIformula\fR
|
|
||||||
Display the source to \fIformula\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBcleanup [\-\-force]\fR [\fIformula\fR]
|
|
||||||
For all installed or specific formulae, remove any older versions from the cellar\. By default, does not remove out\-of\-date keg\-only brews, as other software may link directly to specific versions\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBlog [git\-log\-options]\fR \fIformula\fR \.\.\.
|
\fBlog [git\-log\-options]\fR \fIformula\fR \.\.\.
|
||||||
Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
|
Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBfetch [\-\-force] [\-v] [\-\-HEAD] [\-\-deps]\fR \fIformulae\fR
|
\fBman\fR
|
||||||
Download the source packages for the given \fIformulae\fR\. For tarballs, also print MD5 and SHA1 checksums\.
|
Regenerate this man page using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\. See \fBman brew\-man\fR for details\.
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-HEAD\fR is passed, download the HEAD versions of \fIformulae\fR instead\. \fB\-v\fR may also be passed to make the VCS checkout verbose, useful for seeing if an existing HEAD cache has been updated\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBaudit [\-\-strict]\fR [\fIformulae\fR]
|
\fBmissing\fR [\fIformulae\fR]
|
||||||
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
|
Check the given \fIformulae\fR for missing dependencies\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
If no \fIformulae\fR are provided, all of them are checked\.
|
If no \fIformulae\fR are given, check all installed brews\.
|
||||||
.
|
|
||||||
.IP
|
|
||||||
If \fB\-\-strict\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\.
|
|
||||||
.
|
|
||||||
.IP
|
|
||||||
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
|
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBoptions [\-\-compact] [\-\-all]\fR \fIformula\fR
|
\fBoptions [\-\-compact] [\-\-all]\fR \fIformula\fR
|
||||||
@ -236,11 +205,27 @@ If \fB\-\-compact\fR is passed, show all options on a single line separated by s
|
|||||||
If \fB\-\-all\fR is passed, show options for all formulae\.
|
If \fB\-\-all\fR is passed, show options for all formulae\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBmissing\fR [\fIformulae\fR]
|
\fBoutdated\fR
|
||||||
Check the given \fIformulae\fR for missing dependencies\.
|
Show formula that have an updated version available\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBprune\fR
|
||||||
|
Remove dead symlinks from the Homebrew prefix\. This is generally not needed, but can be useful when doing DIY installations\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBrm\fR, \fBremove\fR, \fBuninstall [\-\-force]\fR \fIformula\fR
|
||||||
|
Uninstall \fIformula\fR\.
|
||||||
.
|
.
|
||||||
.IP
|
.IP
|
||||||
If no \fIformulae\fR are given, check all installed brews\.
|
If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR installed, delete all installed versions\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBsearch\fR, \fB\-S\fR \fItext\fR|/\fItext\fR/
|
||||||
|
Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. If no search term is given, all available formula are displayed\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBsearch \-\-macports\fR|\fB\-\-fink\fR \fItext\fR
|
||||||
|
Search for \fItext\fR on the MacPorts or Fink package search page\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBserver\fR
|
\fBserver\fR
|
||||||
@ -254,8 +239,35 @@ A few formulae provide a test method\. \fBbrew test <formula>\fR runs this test
|
|||||||
Example: \fBbrew install jruby && brew test jruby\fR
|
Example: \fBbrew install jruby && brew test jruby\fR
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBman\fR
|
\fBunlink\fR \fIformula\fR
|
||||||
Regenerate this man page using \fBronn\fR \fIhttp://rtomayko\.github\.com/ronn/\fR\. See \fBman brew\-man\fR for details\.
|
Unsymlink \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBupdate\fR
|
||||||
|
Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fBuses [\-\-installed]\fR \fIformula\fR
|
||||||
|
Show the formulas that specify \fIformula\fR as a dependency\. The list is not recursive; only one level of dependencies is resolved\.
|
||||||
|
.
|
||||||
|
.IP
|
||||||
|
If \fB\-\-installed\fR is passed, only lists installed formulae\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fB\-\-cache\fR
|
||||||
|
Display Homebrew\'s download cache\. \fIDefault:\fR \fB~/Library/Cache/Homebrew\fR
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fB\-\-cache\fR \fIformula\fR
|
||||||
|
Display the file or folder used to cache \fIformula\fR\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fB\-\-cellar\fR
|
||||||
|
Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB/usr/local/Cellar\fR
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
\fB\-\-cellar\fR \fIformula\fR
|
||||||
|
Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned folder as the last path\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fB\-\-config\fR
|
\fB\-\-config\fR
|
||||||
@ -270,25 +282,13 @@ Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR
|
|||||||
Display the location in the cellar where \fIformula\fR is or would be installed\.
|
Display the location in the cellar where \fIformula\fR is or would be installed\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fB\-\-cellar\fR
|
|
||||||
Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB/usr/local/Cellar\fR
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fB\-\-cellar\fR \fIformula\fR
|
|
||||||
Display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned folder as the last path\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fB\-\-cache\fR
|
|
||||||
Display Homebrew\'s download cache\. \fIDefault:\fR \fB~/Library/Cache/Homebrew\fR
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fB\-\-cache\fR \fIformula\fR
|
|
||||||
Display the file or folder used to cache \fIformula\fR\.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fB\-\-repository\fR
|
\fB\-\-repository\fR
|
||||||
Display where Homebrew\'s \fB\.git\fR folder is located\. For standard installs, the \fBprefix\fR and \fBrepository\fR are the same folder\.
|
Display where Homebrew\'s \fB\.git\fR folder is located\. For standard installs, the \fBprefix\fR and \fBrepository\fR are the same folder\.
|
||||||
.
|
.
|
||||||
|
.TP
|
||||||
|
\fB\-v\fR, \fB\-\-version\fR
|
||||||
|
Print the version number of brew to standard error and exit\.
|
||||||
|
.
|
||||||
.SH "EXTERNAL COMMANDS"
|
.SH "EXTERNAL COMMANDS"
|
||||||
Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR on the PATH\. This will cause Homebrew to recognize \fBbrew cmdname\fR\.
|
Homebrew allows external commands to be defined by putting a +x file named \fBbrew\-<cmdname>\fR or \fBbrew\-<cmdname>\.rb\fR on the PATH\. This will cause Homebrew to recognize \fBbrew cmdname\fR\.
|
||||||
.
|
.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user