Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_NOPROXY (3)

Name

CURLOPT_NOPROXY - disable proxy use for specific hosts

Synopsis

#include <curl/curl.h>

CURLcode    curl_easy_setopt(CURL    *handle,   CURLOPT_NOPROXY,   char
*noproxy);

Description

CURLOPT_NOPROXY(3)         curl_easy_setopt options         CURLOPT_NOPROXY(3)



NAME
       CURLOPT_NOPROXY - disable proxy use for specific hosts

SYNOPSIS
       #include <curl/curl.h>

       CURLcode    curl_easy_setopt(CURL    *handle,   CURLOPT_NOPROXY,   char
       *noproxy);

DESCRIPTION
       Pass a pointer to a zero terminated string. The string  consists  of  a
       comma  separated  list of host names that do not require a proxy to get
       reached, even if one is specified.  The only wildcard  available  is  a
       single  *  character, which matches all hosts, and effectively disables
       the proxy. Each name in this list is matched as either a  domain  which
       contains the hostname, or the hostname itself. For example, example.com
       would match example.com, example.com:80, and www.example.com,  but  not
       www.notanexample.com or example.com.othertld.

       If  the  name  in the noproxy list has a leading period, it is a domain
       match against the provided host  name.  This  way  ".example.com"  will
       switch  off  proxy  use  for  both  "www.example.com"  as  well  as for
       "foo.example.com".

       Setting the noproxy string to ""  (an  empty  string)  will  explicitly
       enable  the  proxy  for all host names, even if there is an environment
       variable set for it.

       Enter IPv6 numerical addresses  in  the  list  of  host  names  without
       enclosing brackets:

        "example.com,::1,localhost"

       The  application  does not have to keep the string around after setting
       this option.

Environment variables
       If there's an environment variable called no_proxy  (or  NO_PROXY),  it
       will  be  used  if  the  CURLOPT_NOPROXY(3) option is not set. It works
       exactly the same way.

DEFAULT
       NULL

PROTOCOLS
       Most

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         /* accept various URLs */
         curl_easy_setopt(curl, CURLOPT_URL, input);
         /* use this proxy */
         curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy:80");
         /* ... but make sure this host name is not proxied */
         curl_easy_setopt(curl, CURLOPT_NOPROXY, "www.example.com");
         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.19.4

RETURN VALUE
       Returns CURLE_OK if the option is  supported,  CURLE_UNKNOWN_OPTION  if
       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_PROXY(3), CURLOPT_PROXYAUTH(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014               CURLOPT_NOPROXY(3)