Add clang options to man page.

This commit is contained in:
Adam Vandenberg 2011-06-16 20:50:40 -07:00
parent be63ae9b14
commit e8ebd6756e
2 changed files with 21 additions and 11 deletions

View File

@ -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-llvm] [--use-gcc] [--HEAD]` <formula>: * `install [--force] [--debug] [--ignore-dependencies] [--use-clang] [--use-gcc] [--use-llvm] [--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
@ -133,12 +133,14 @@ For the full command list, see the COMMANDS section.
any kind. If they are not already present, the formula will probably fail any kind. If they are not already present, the formula will probably fail
to install. to install.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC. If `--use-clang` is passed, attempt to compile using clang.
*NOTE*: Not all formulae will build with LLVM.
If `--use-gcc` is passed, attempt to compile using GCC. This is useful for If `--use-gcc` is passed, attempt to compile using GCC. This is useful for
systems whose default compiler is LLVM-GCC. systems whose default compiler is LLVM-GCC.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC.
*NOTE*: Not all formulae will build with LLVM.
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.
@ -324,13 +326,14 @@ Some sample commands ship with Homebrew and are enabled by default.
This issue typically occurs when using FileVault or custom SSD This issue typically occurs when using FileVault or custom SSD
configurations. configurations.
* HOMEBREW\_USE\_CLANG:
If set, instructs Homebrew to compile using clang.
* HOMEBREW\_USE\_GCC: * HOMEBREW\_USE\_GCC:
If set, instructs Homebrew to use gcc, even if the system default If set, instructs Homebrew to compile using gcc.
is currently set to LLVM.
* HOMEBREW\_USE\_LLVM: * HOMEBREW\_USE\_LLVM:
If set, instructs Homebrew to use the LLVM front-ends to the GCC If set, instructs Homebrew to compile using LLVM.
compilers.
*NOTE*: Not all formulae build correctly with LLVM. *NOTE*: Not all formulae build correctly with LLVM.

View File

@ -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\-llvm] [\-\-use\-gcc] [\-\-HEAD]\fR \fIformula\fR \fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-clang] [\-\-use\-gcc] [\-\-use\-llvm] [\-\-HEAD]\fR \fIformula\fR
Install \fIformula\fR\. Install \fIformula\fR\.
. .
.IP .IP
@ -152,12 +152,15 @@ If \fB\-\-debug\fR is passed and brewing fails, open a shell inside the temporar
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\. 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 .IP
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\-clang\fR is passed, attempt to compile using clang\.
. .
.IP .IP
If \fB\-\-use\-gcc\fR is passed, attempt to compile using GCC\. This is useful for systems whose default compiler is LLVM\-GCC\. If \fB\-\-use\-gcc\fR is passed, attempt to compile using GCC\. This is useful for systems whose default compiler is LLVM\-GCC\.
. .
.IP .IP
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
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
@ -355,12 +358,16 @@ If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary folder fo
This issue typically occurs when using FileVault or custom SSD configurations\. This issue typically occurs when using FileVault or custom SSD configurations\.
. .
.TP .TP
HOMEBREW_USE_CLANG
If set, instructs Homebrew to compile using clang\.
.
.TP
HOMEBREW_USE_GCC HOMEBREW_USE_GCC
If set, instructs Homebrew to use gcc, even if the system default is currently set to LLVM\. If set, instructs Homebrew to compile using gcc\.
. .
.TP .TP
HOMEBREW_USE_LLVM HOMEBREW_USE_LLVM
If set, instructs Homebrew to use the LLVM front\-ends to the GCC compilers\. If set, instructs Homebrew to compile using LLVM\.
. .
.IP .IP
\fINOTE\fR: Not all formulae build correctly with LLVM\. \fINOTE\fR: Not all formulae build correctly with LLVM\.