docs/libcurl/opts/CURLOPT_NOPROXY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 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 .\"
  23 .TH CURLOPT_NOPROXY 3 "March 03, 2018" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_NOPROXY \- disable proxy use for specific hosts
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROXY, char *noproxy);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string. The string consists of a comma
  33 separated list of host names that do not require a proxy to get reached, even
  34 if one is specified.  The only wildcard available is a single * character,
  35 which matches all hosts, and effectively disables the proxy. Each name in this
  36 list is matched as either a domain which contains the hostname, or the
  37 hostname itself. For example, example.com would match example.com,
  38 example.com:80, and www.example.com, but not www.notanexample.com or
  39 example.com.othertld.
  40
  41 If the name in the noproxy list has a leading period, it is a domain match
  42 against the provided host name. This way ".example.com" will switch off proxy
  43 use for both "www.example.com" as well as for "foo.example.com".
  44
  45 Setting the noproxy string to "" (an empty string) will explicitly enable the
  46 proxy for all host names, even if there is an environment variable set for it.
  47
  48 Enter IPv6 numerical addresses in the list of host names without enclosing
  49 brackets:
  50
  51  "example.com,::1,localhost"
  52
  53 The application does not have to keep the string around after setting this
  54 option.
  55 .SH "Environment variables"
  56 See \fICURLOPT_PROXY(3)\fP
  57 .SH DEFAULT
  58 NULL
  59 .SH PROTOCOLS
  60 Most
  61 .SH EXAMPLE
  62 .nf
  63 CURL *curl = curl_easy_init();
  64 if(curl) {
  65   /* accept various URLs */
  66   curl_easy_setopt(curl, CURLOPT_URL, input);
  67   /* use this proxy */
  68   curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy:80");
  69   /* ... but make sure this host name is not proxied */
  70   curl_easy_setopt(curl, CURLOPT_NOPROXY, "www.example.com");
  71   curl_easy_perform(curl);
  72 }
  73 .fi
  74 .SH AVAILABILITY
  75 Added in 7.19.4
  76 .SH RETURN VALUE
  77 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  78 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  79 .SH "SEE ALSO"
  80 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYAUTH "(3), "