CURLOPT_DNS_SERVERS.3 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_DNS_SERVERS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_DNS_SERVERS \- DNS servers to use
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_SERVERS, char *servers);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a char * that is the list of DNS servers to be used instead of the system
  33. default. The format of the dns servers option is:
  34. host[:port][,host[:port]]...
  35. For example:
  36. 192.168.1.100,192.168.1.101,3.4.5.6
  37. The application does not have to keep the string around after setting this
  38. option.
  39. .SH DEFAULT
  40. NULL - use system default
  41. .SH PROTOCOLS
  42. All
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  48. curl_easy_setopt(curl, CURLOPT_DNS_SERVERS, "192.168.1.100:53,192.168.1.101");
  49. ret = curl_easy_perform(curl);
  50. curl_easy_cleanup(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. This option requires that libcurl was built with a resolver backend that
  55. supports this operation. The c-ares backend is the only such one.
  56. Added in 7.24.0
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
  59. CURLE_NOT_BUILT_IN if support was disabled at compile-time,
  60. CURLE_BAD_FUNCTION_ARGUMENT when given an invalid server list, or
  61. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_DNS_LOCAL_IP4 "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), "