docs/libcurl/libcurl-env.3

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