admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

manpage updates

Browse Source 
* Update title for ronn 0.7.3
* document --use-llvm
* document --ignore-dependencies
This commit is contained in:
Adam Vandenberg 2010-06-15 11:53:46 -07:00
parent 551e4efbd6
commit 0aed492572
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Library/Contributions/manpages/brew.1.md
View File

@ -1,5 +1,5 @@
The missing package manager for OS X brew(1) -- The missing package manager for OS X
==================================== ===============================================
## SYNOPSIS ## SYNOPSIS
@ -40,12 +40,19 @@ didn't include with OS X.
surrounded with slashes, then it is interpreted as a regular expression. surrounded with slashes, then it is interpreted as a regular expression.
If no search term is given, all available formula are displayed. If no search term is given, all available formula are displayed.
* `install [--debug]` <formula>: * `install [--debug] [--use-llvm] [--ignore-dependencies]` <formula>:
Installs <formula>. Installs <formula>.
If `--debug` is passed and brewing fails, opens a shell inside the If `--debug` is passed and brewing fails, opens a shell inside the
temporary folder used for compiling. temporary folder used for compiling.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC.
*NOTE*: Not all formulae are compatible with LLVM, especially C++-based ones.
If `--ignore-dependencies` is passed, skip installing any dependencies of
any kind. If they are not already present, the formula will probably fail to
install.
* `install --interactive [--git]` <formula>: * `install --interactive [--git]` <formula>:
Downloads and patches <formula>, and then opens a shell. This allows the Downloads and patches <formula>, and then opens a shell. This allows the
user to run `./configure --help` and otherwise determine how to turn the user to run `./configure --help` and otherwise determine how to turn the

12
share/man/man1/brew.1
View File

@ -1,5 +1,5 @@
.\" generated with Ronn/v0.6.6 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/ .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "BREW" "1" "June 2010" "Homebrew" "brew" .TH "BREW" "1" "June 2010" "Homebrew" "brew"
. .
@ -44,12 +44,18 @@ Shows Homebrew and system configuration useful for debugging\. If you file a bug
Performs 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\. Performs 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 .TP
\fBinstall [\-\-debug]\fR \fIformula\fR \fBinstall [\-\-debug] [\-\-use\-llvm] [\-\-ignore\-dependencies]\fR \fIformula\fR
Installs \fIformula\fR\. Installs \fIformula\fR\.
. .
.IP .IP
If \fB\-\-debug\fR is passed and brewing fails, opens a shell inside the temporary folder used for compiling\. If \fB\-\-debug\fR is passed and brewing fails, opens a shell inside the temporary folder used for compiling\.
. .
.IP
If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end to GCC\. \fINOTE\fR: Not all formulae are compatible with LLVM, especially C++\-based ones\.
.
.IP
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\.
.
.TP .TP
\fBinstall \-\-interactive [\-\-git]\fR \fIformula\fR \fBinstall \-\-interactive [\-\-git]\fR \fIformula\fR
Downloads and patches \fIformula\fR, and then opens a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\. Downloads and patches \fIformula\fR, and then opens a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\.