Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_NOPROXY.3, revision 1.1
1.1 ! misho 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 "August 24, 2018" "libcurl 7.70.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: If there's an environment variable called \fBno_proxy\fP (or \fBNO_PROXY\fP),
! 57: it will be used if the \fICURLOPT_NOPROXY(3)\fP option is not set. It works
! 58: exactly the same way.
! 59: .SH DEFAULT
! 60: NULL
! 61: .SH PROTOCOLS
! 62: Most
! 63: .SH EXAMPLE
! 64: .nf
! 65: CURL *curl = curl_easy_init();
! 66: if(curl) {
! 67: /* accept various URLs */
! 68: curl_easy_setopt(curl, CURLOPT_URL, input);
! 69: /* use this proxy */
! 70: curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy:80");
! 71: /* ... but make sure this host name is not proxied */
! 72: curl_easy_setopt(curl, CURLOPT_NOPROXY, "www.example.com");
! 73: curl_easy_perform(curl);
! 74: }
! 75: .fi
! 76: .SH AVAILABILITY
! 77: Added in 7.19.4
! 78: .SH RETURN VALUE
! 79: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
! 80: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 81: .SH "SEE ALSO"
! 82: .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYAUTH "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>