Imported Upstream version 7.53.1
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_NOPROXY.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 "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 The application does not have to keep the string around after setting this
41 option.
42 .SH DEFAULT
43 NULL
44 .SH PROTOCOLS
45 Most
46 .SH EXAMPLE
47 TODO
48 .SH AVAILABILITY
49 Added in 7.19.4
50 .SH RETURN VALUE
51 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
52 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
53 .SH "SEE ALSO"
54 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYAUTH "(3), "