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