From 896f53d78bfdec504ffb11a6a5206179cb62caa1 Mon Sep 17 00:00:00 2001 From: Adam Vandenberg Date: Sun, 6 Jan 2013 17:32:23 -0800 Subject: [PATCH] Document HOMEBREW_BROWSER and BROWSER --- Library/Contributions/manpages/brew.1.md | 28 +++++++++++++---------- share/man/man1/brew.1 | 29 ++++++++++++++---------- 2 files changed, 33 insertions(+), 24 deletions(-) diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 7cb10ac59c..a7642dab69 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -371,21 +371,29 @@ can take several different forms: ## ENVIRONMENT + * BROWSER: + If set, and `HOMEBREW_BROWSER` is not, use `BROWSER` as the web browser + when opening project homepages. + + * EDITOR: + If set, and `HOMEBREW_EDITOR` is not, use `EDITOR` as the text editor. + * GIT: When using Git, Homebrew will use `GIT` if set, a Homebrew-built Git if installed, or the system-provided binary. Set this to force Homebrew to use a particular git binary. - * EDITOR: - If set, and `HOMEBREW_EDITOR` is not, use `EDITOR` as the text editor. + * HOMEBREW_BROWSER: + If set, uses this setting as the browser when opening project homepages, + instead of the OS default browser. * HOMEBREW\_BUILD\_FROM\_SOURCE: If set, instructs Homebrew to compile from source even when a formula provides a bottle. * HOMEBREW\_CACHE: - If set, instructs Homebrew to use the give directory as the download cache. + If set, instructs Homebrew to use the given directory as the download cache. Otherwise, `~/Library/Caches/Homebrew` is used. This can be used to keep downloads out of your home directory, if you have @@ -395,8 +403,7 @@ can take several different forms: If set, Homebrew will pass `--verbose` when invoking `curl`(1). * HOMEBREW\_DEBUG: - If set, instructs Homebrew to always assume `--debug` when running - commands. + If set, Homebrew always assumes `--debug` when running commands. * HOMEBREW\_DEBUG\_INSTALL: When `brew install -d` or `brew install -i` drops into a shell, @@ -449,19 +456,16 @@ can take several different forms: configurations. * HOMEBREW\_USE\_CLANG: - If set, instructs Homebrew to compile using clang. + If set, forces Homebrew to compile using clang. * HOMEBREW\_USE\_GCC: - If set, instructs Homebrew to compile using gcc. + If set, forces Homebrew to compile using gcc. * HOMEBREW\_USE\_LLVM: - If set, instructs Homebrew to compile using LLVM. - - *NOTE*: Not all formulae build correctly with LLVM. + If set, forces Homebrew to compile using LLVM. * HOMEBREW\_VERBOSE: - If set, instructs Homebrew to always assume `--verbose` when running - commands. + If set, Homebrew always assumes `--verbose` when running commands. ## USING HOMEBREW BEHIND A PROXY diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index a01979d0d2..490fa46f3b 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BREW" "1" "December 2012" "Homebrew" "brew" +.TH "BREW" "1" "January 2013" "Homebrew" "brew" . .SH "NAME" \fBbrew\fR \- The missing package manager for OS X @@ -412,6 +412,14 @@ Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/mxcl/h .SH "ENVIRONMENT" . .TP +BROWSER +If set, and \fBHOMEBREW_BROWSER\fR is not, use \fBBROWSER\fR as the web browser when opening project homepages\. +. +.TP +EDITOR +If set, and \fBHOMEBREW_EDITOR\fR is not, use \fBEDITOR\fR as the text editor\. +. +.TP GIT When using Git, Homebrew will use \fBGIT\fR if set, a Homebrew\-built Git if installed, or the system\-provided binary\. . @@ -419,8 +427,8 @@ When using Git, Homebrew will use \fBGIT\fR if set, a Homebrew\-built Git if ins Set this to force Homebrew to use a particular git binary\. . .TP -EDITOR -If set, and \fBHOMEBREW_EDITOR\fR is not, use \fBEDITOR\fR as the text editor\. +HOMEBREW_BROWSER +If set, uses this setting as the browser when opening project homepages, instead of the OS default browser\. . .TP HOMEBREW_BUILD_FROM_SOURCE @@ -428,7 +436,7 @@ If set, instructs Homebrew to compile from source even when a formula provides a . .TP HOMEBREW_CACHE -If set, instructs Homebrew to use the give directory as the download cache\. Otherwise, \fB~/Library/Caches/Homebrew\fR is used\. +If set, instructs Homebrew to use the given directory as the download cache\. Otherwise, \fB~/Library/Caches/Homebrew\fR is used\. . .IP This can be used to keep downloads out of your home directory, if you have it mounted on an SSD or are using FileVault for instance\. @@ -439,7 +447,7 @@ If set, Homebrew will pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\. . .TP HOMEBREW_DEBUG -If set, instructs Homebrew to always assume \fB\-\-debug\fR when running commands\. +If set, Homebrew always assumes \fB\-\-debug\fR when running commands\. . .TP HOMEBREW_DEBUG_INSTALL @@ -490,22 +498,19 @@ This issue typically occurs when using FileVault or custom SSD configurations\. . .TP HOMEBREW_USE_CLANG -If set, instructs Homebrew to compile using clang\. +If set, forces Homebrew to compile using clang\. . .TP HOMEBREW_USE_GCC -If set, instructs Homebrew to compile using gcc\. +If set, forces Homebrew to compile using gcc\. . .TP HOMEBREW_USE_LLVM -If set, instructs Homebrew to compile using LLVM\. -. -.IP -\fINOTE\fR: Not all formulae build correctly with LLVM\. +If set, forces Homebrew to compile using LLVM\. . .TP HOMEBREW_VERBOSE -If set, instructs Homebrew to always assume \fB\-\-verbose\fR when running commands\. +If set, Homebrew always assumes \fB\-\-verbose\fR when running commands\. . .SH "USING HOMEBREW BEHIND A PROXY" Homebrew uses several commands for downloading files (e\.g\. curl, git, svn)\. Many of these tools can download via a proxy\. It\'s common for these tools to read proxy parameters from environment variables\.