aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Manpage.md
diff options
context:
space:
mode:
authorMike McQuaid2017-11-30 14:05:06 +0000
committerMike McQuaid2017-11-30 14:05:06 +0000
commit022303f96c6226001308b994ad68b460f5df579b (patch)
tree818f329e4cfcfe55af54be2147ac9c75d0f9e029 /docs/Manpage.md
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 'docs/Manpage.md')
-rw-r--r--docs/Manpage.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/Manpage.md b/docs/Manpage.md
index d94cec30a..fc0bb0465 100644
--- a/docs/Manpage.md
+++ b/docs/Manpage.md
@@ -1077,20 +1077,26 @@ can take several different forms:
* `HOMEBREW_VERBOSE`:
If set, Homebrew always assumes `--verbose` when running commands.
-## USING HOMEBREW BEHIND A PROXY
+ * `http_proxy`:
+ Sets the HTTP proxy to be used by `curl`, `git` and `svn` when downloading
+ through Homebrew.
+
+ * `https_proxy`:
+ Sets the HTTPS proxy to be used by `curl`, `git` and `svn` when downloading
+ through Homebrew.
-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.
+ * `ftp_proxy`:
+ Sets the FTP proxy to be used by `curl`, `git` and `svn` when downloading
+ through Homebrew.
-For the majority of cases setting `http_proxy` is enough. You can set this in
-your shell profile, or you can use it before a brew command:
+## USING HOMEBREW BEHIND A PROXY
+Use the `http_proxy`, `https_proxy` and/or `ftp_proxy` documented above. For example for an unauthenticated HTTP proxy:
- http_proxy=http://`host`:`port` brew install foo
+ export http_proxy=http://`host`:`port`
-If your proxy requires authentication:
+And for an authenticated HTTP proxy:
- http_proxy=http://`user`:`password`@`host`:`port` brew install foo
+ export http_proxy=http://`user`:`password`@`host`:`port`
## SEE ALSO