Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.

Commit

Permalink
Add versions command to the man page
Browse files Browse the repository at this point in the history
Additionally, document the '--build-from-source' option for the
`install` command.
  • Loading branch information
jacknagel committed Aug 25, 2011
1 parent 2695821 commit 826fe4d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
9 changes: 8 additions & 1 deletion Library/Contributions/manpages/brew.1.md
Expand Up @@ -116,7 +116,7 @@ For the full command list, see the COMMANDS section.
* `info` <URL>: * `info` <URL>:
Print the name and version that will be detected for <URL>. Print the name and version that will be detected for <URL>.


* `install [--force] [--debug] [--ignore-dependencies] [--use-clang] [--use-gcc] [--use-llvm] [--HEAD]` <formula>: * `install [--force] [--debug] [--ignore-dependencies] [--use-clang] [--use-gcc] [--use-llvm] [--build-from-source] [--HEAD]` <formula>:
Install <formula>. Install <formula>.


<formula> is usually the name of the formula to install, but may also be <formula> is usually the name of the formula to install, but may also be
Expand All @@ -141,6 +141,9 @@ For the full command list, see the COMMANDS section.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC. If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC.
*NOTE*: Not all formulae will build with LLVM. *NOTE*: Not all formulae will build with LLVM.


If `--build-from-source` is passed, compile from source even if a bottle
is provided for <formula>.

If `--HEAD` is passed, and <formula> defines it, install the HEAD version, If `--HEAD` is passed, and <formula> defines it, install the HEAD version,
aka master, trunk, unstable, dev. aka master, trunk, unstable, dev.


Expand Down Expand Up @@ -233,6 +236,10 @@ For the full command list, see the COMMANDS section.


If `--installed` is passed, only lists installed formulae. If `--installed` is passed, only lists installed formulae.


* `versions` <formulae>:
List previous versions of <formulae>, along with a command to checkout
each version.

* `which` [<formulae>]: * `which` [<formulae>]:
List versions of installed brews. List versions of installed brews.


Expand Down
11 changes: 9 additions & 2 deletions share/man/man1/brew.1
@@ -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" "1" "July 2011" "Homebrew" "brew" .TH "BREW" "1" "August 2011" "Homebrew" "brew"
. .
.SH "NAME" .SH "NAME"
\fBbrew\fR \- The missing package manager for OS X \fBbrew\fR \- The missing package manager for OS X
Expand Down Expand Up @@ -136,7 +136,7 @@ To view formula history locally: \fBbrew log \-p <formula>\fR\.
Print the name and version that will be detected for \fIURL\fR\. Print the name and version that will be detected for \fIURL\fR\.
. .
.TP .TP
\fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-clang] [\-\-use\-gcc] [\-\-use\-llvm] [\-\-HEAD]\fR \fIformula\fR \fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-clang] [\-\-use\-gcc] [\-\-use\-llvm] [\-\-build\-from\-source] [\-\-HEAD]\fR \fIformula\fR
Install \fIformula\fR\. Install \fIformula\fR\.
. .
.IP .IP
Expand All @@ -161,6 +161,9 @@ If \fB\-\-use\-gcc\fR is passed, attempt to compile using GCC\. This is useful f
If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end to GCC\. \fINOTE\fR: Not all formulae will build with LLVM\. If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end to GCC\. \fINOTE\fR: Not all formulae will build with LLVM\.
. .
.IP .IP
If \fB\-\-build\-from\-source\fR is passed, compile from source even if a bottle is provided for \fIformula\fR\.
.
.IP
If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka master, trunk, unstable, dev\. If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka master, trunk, unstable, dev\.
. .
.IP .IP
Expand Down Expand Up @@ -260,6 +263,10 @@ Show the formulas that specify \fIformula\fR as a dependency\. The list is not r
If \fB\-\-installed\fR is passed, only lists installed formulae\. If \fB\-\-installed\fR is passed, only lists installed formulae\.
. .
.TP .TP
\fBversions\fR \fIformulae\fR
List previous versions of \fIformulae\fR, along with a command to checkout each version\.
.
.TP
\fBwhich\fR [\fIformulae\fR] \fBwhich\fR [\fIformulae\fR]
List versions of installed brews\. List versions of installed brews\.
. .
Expand Down

0 comments on commit 826fe4d

Please sign in to comment.