mirror of
https://github.com/curl/curl.git
synced 2024-12-27 06:59:43 +08:00
5b060a4108
... instead of using future tense. + numerous cleanups and improvements + stick to "reuse" not "re-use" + fewer contractions Closes #11713
87 lines
3.3 KiB
Groff
87 lines
3.3 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_NOPROXY 3 "19 Jun 2014" libcurl libcurl
|
|
.SH NAME
|
|
CURLOPT_NOPROXY \- disable proxy use for specific hosts
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROXY, char *noproxy);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a null-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, "ample.com" would match ample.com, ample.com:80,
|
|
and www.ample.com, but not www.example.com or ample.com.org.
|
|
|
|
Setting the \fInoproxy\fP string to "" (an empty string) explicitly enables
|
|
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"
|
|
|
|
Since 7.86.0, IP addresses specified to this option can be provided using CIDR
|
|
notation: an appended slash and number specifies the number of "network bits"
|
|
out of the address to use in the comparison. For example "192.168.0.0/16"
|
|
would match all addresses starting with "192.168".
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH "Environment variables"
|
|
If there is an environment variable called \fBno_proxy\fP (or \fBNO_PROXY\fP),
|
|
it is used if the \fICURLOPT_NOPROXY(3)\fP option is not set. It works exactly
|
|
the same way.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
Most
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.19.4
|
|
.SH 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.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYAUTH "(3), "
|