aboutsummaryrefslogtreecommitdiffstats
path: root/manpages
diff options
context:
space:
mode:
authorMike McQuaid2017-11-30 14:05:06 +0000
committerMike McQuaid2017-11-30 14:05:06 +0000
commit022303f96c6226001308b994ad68b460f5df579b (patch)
tree818f329e4cfcfe55af54be2147ac9c75d0f9e029 /manpages
parent3f7e63a24c7a449eeed3d5dcee1f209b924d58cb (diff)
downloadbrew-022303f96c6226001308b994ad68b460f5df579b.tar.bz2
Unify proxy documentation.
Specify under the list of environment variables how to set each of those that we passthrough and use.
Diffstat (limited to 'manpages')
-rw-r--r--manpages/brew.123
1 files changed, 16 insertions, 7 deletions
diff --git a/manpages/brew.1 b/manpages/brew.1
index 449d20a3e..f15e11940 100644
--- a/manpages/brew.1
+++ b/manpages/brew.1
@@ -1104,30 +1104,39 @@ This issue typically occurs when using FileVault or custom SSD configurations\.
\fBHOMEBREW_VERBOSE\fR
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\. \fBcurl\fR, \fBgit\fR, \fBsvn\fR)\. Many of these tools can download via a proxy\. It\'s common for these tools to read proxy parameters from environment variables\.
+.TP
+\fBhttp_proxy\fR
+Sets the HTTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
-.P
-For the majority of cases setting \fBhttp_proxy\fR is enough\. You can set this in your shell profile, or you can use it before a brew command:
+.TP
+\fBhttps_proxy\fR
+Sets the HTTPS proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
+.
+.TP
+\fBftp_proxy\fR
+Sets the FTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
+.
+.SH "USING HOMEBREW BEHIND A PROXY"
+Use the \fBhttp_proxy\fR, \fBhttps_proxy\fR and/or \fBftp_proxy\fR documented above\. For example for an unauthenticated HTTP proxy:
.
.IP "" 4
.
.nf
-http_proxy=http://<host>:<port> brew install foo
+export http_proxy=http://<host>:<port>
.
.fi
.
.IP "" 0
.
.P
-If your proxy requires authentication:
+And for an authenticated HTTP proxy:
.
.IP "" 4
.
.nf
-http_proxy=http://<user>:<password>@<host>:<port> brew install foo
+export http_proxy=http://<user>:<password>@<host>:<port>
.
.fi
.