Document fetch --HEAD

This commit is contained in:
Adam Vandenberg 2010-10-13 06:48:38 -07:00
parent 64027ae9d5
commit 739f96843a
2 changed files with 19 additions and 9 deletions

View File

@ -167,6 +167,14 @@ didn't include with OS X.
Shows the git log for the given formulae. Options that `git log`
recognizes can be passed before the formula list.
* `fetch [-v] [--HEAD]` <formula>:
Downloads the tarball or checks out from VCS for the given <formula>. For
tarballs, also prints MD5 and SHA1 checksums.
If `--HEAD` is passed, download the HEAD version of <formula> instead. `-v`
may also be passed to make the VCS checkout verbose, useful for seeing if
an existing HEAD cache has been updated.
## EXTERNAL COMMANDS
Homebrew allows external commands to be defined by putting a +x file named
@ -179,10 +187,6 @@ Some external commands are shipped with Homebrew, and enabled by default.
Checks all formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
* `fetch` <formula>:
Downloads the tarball or checks out from VCS for the given <formula>. For
tarballs, also prints MD5 and SHA1 checksums.
* `options` <formula>:
Displays install options specific to <formula>.

View File

@ -60,7 +60,10 @@ If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end t
If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of any kind\. If they are not already present, the formula will probably fail to install\.
.
.IP
If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka master, trunk, unstable, dev\. To install a newer version of HEAD, either \fBbrew rm <foo> && brew install \-\-HEAD <foo>\fR or \fBbrew \-\-force \-\-HEAD <foo>\fR\.
If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka master, trunk, unstable, dev\.
.
.IP
To install a newer version of HEAD use \fBbrew rm <foo> && brew install \-\-HEAD <foo>\fR or \fBbrew \-\-force \-\-HEAD <foo>\fR\.
.
.TP
\fBinstall \-\-interactive [\-\-git]\fR \fIformula\fR
@ -174,6 +177,13 @@ Using Git, fetches the newest version of Homebrew from the GitHub repository\.
\fBlog [git\-options]\fR \fIformula\fR \.\.\.
Shows the git log for the given formulae\. Options that \fBgit log\fR recognizes can be passed before the formula list\.
.
.TP
\fBfetch [\-v] [\-\-HEAD]\fR \fIformula\fR
Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
.
.IP
If \fB\-\-HEAD\fR is passed, download the HEAD version of \fIformula\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\.
.
.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\.
.
@ -185,10 +195,6 @@ Some external commands are shipped with Homebrew, and enabled by default\.
Checks all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
.
.TP
\fBfetch\fR \fIformula\fR
Downloads the tarball or checks out from VCS for the given \fIformula\fR\. For tarballs, also prints MD5 and SHA1 checksums\.
.
.TP
\fBoptions\fR \fIformula\fR
Displays install options specific to \fIformula\fR\.
.