| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 2018, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.TH libcurl-env 3 "20 January 2018" "libcurl 7.58.0" "libcurl environment variables" |
| 23 |
.SH NAME |
| 24 |
libcurl-env \- environment variables libcurl understands |
| 25 |
.SH DESCRIPTION |
| 26 |
libcurl reads and understands a set of environment variables that if set will |
| 27 |
control and change behaviors. This is the full list of variables to set and |
| 28 |
description of what they do. Also note that curl, the command line tool, |
| 29 |
supports a set of additional environment variables independently of this. |
| 30 |
.IP "[scheme]_proxy" |
| 31 |
When libcurl is given a URL to use in a transfer, it first extracts the |
| 32 |
"scheme" part from the URL and checks if there is a given proxy set for that |
| 33 |
in its corresponding environment variable. A URL like "http://example.com" |
| 34 |
will hence use the "http_proxy" variable, while a URL like "ftp://example.com" |
| 35 |
will use the "ftp_proxy" variable. |
| 36 |
|
| 37 |
These proxy variables are also checked for in their uppercase versions, except |
| 38 |
the "http_proxy" one which is only used lowercase. Note also that some systems |
| 39 |
actually have a case insensitive handling of environment variables and then of |
| 40 |
course "HTTP_PROXY" will still work... |
| 41 |
.IP ALL_PROXY |
| 42 |
This is a setting to set proxy for all URLs, independently of what scheme is |
| 43 |
being used. Note that the scheme specific variables will override this one if |
| 44 |
set. |
| 45 |
.IP CURL_SSL_BACKEND |
| 46 |
When libcurl is built to support multiple SSL backends, it will select a |
| 47 |
specific backend at first use. If no selection is done by the program using |
| 48 |
libcurl, this variable's selection will be used. It should be set to the full |
| 49 |
SSL backend name to use (case insensitive). |
| 50 |
.IP HOME |
| 51 |
When the netrc feature is used (\fICURLOPT_NETRC(3)\fP), this variable is |
| 52 |
checked as the primary way to find the "current" home directory in which |
| 53 |
the .netrc file is likely to exist. |
| 54 |
.IP LOGNAME |
| 55 |
User name to use when invoking the ntlm-wb tool, if NTLMUSER wasn't set. |
| 56 |
.IP NO_PROXY |
| 57 |
This has the same functionality as the \fICURLOPT_NOPROXY(3)\fP option: it |
| 58 |
gives libcurl a comma-separated list of host name patterns for which libcurl |
| 59 |
should not use a proxy. |
| 60 |
.IP NTLMUSER |
| 61 |
User name to use when invoking the ntlm-wb tool. |
| 62 |
.IP SSLKEYLOGFILE |
| 63 |
When set and libcurl runs with a SSL backend that supports this feature, |
| 64 |
libcurl will save SSL secrets into the given file name. Using those SSL |
| 65 |
secrets, other tools (such as Wireshark) can decrypt the SSL communication and |
| 66 |
analyze/view the traffic. |
| 67 |
.IP SSL_DIR |
| 68 |
When libcurl runs with the NSS backends for TLS features, this variable is |
| 69 |
used to find the directory for NSS PKI database instead of the built-in. |
| 70 |
.IP USER |
| 71 |
User name to use when invoking the ntlm-wb tool, if NTLMUSER and LOGNAME |
| 72 |
weren't set. |
| 73 |
.SH "Debug Variables" |
| 74 |
There's a set of variables only recognized and used if libcurl was built |
| 75 |
"debug enabled", which should never be true for a library used in production. |
| 76 |
.IP "CURL_GETHOSTNAME" |
| 77 |
Debug-only variable. |
| 78 |
.IP "CURL_FORCETIME" |
| 79 |
Debug-only variable. |
| 80 |
.IP "CURL_ENTROPY" |
| 81 |
Debug-only variable. Used to set a fixed faked value to use instead of a |
| 82 |
proper random number so that functions in libcurl that are otherwise getting |
| 83 |
random outputs can be tested for what they generate. |
| 84 |
.IP "CURL_TRACE" |
| 85 |
Debug-only variable. Used for debugging the lib/ldap implementation. |
| 86 |
.IP "CURL_NTLM_WB_FILE" |
| 87 |
Debug-only variable. Used to set to a debug-version of the ntlm-wb executable. |
| 88 |
.IP "CURL_OPENLDAP_TRACE" |
| 89 |
Debug-only variable. Used for debugging the lib/openldap.c implementation. |