CURLOPT_NOPROXY.3 3.3 KB

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