CURLOPT_DNS_SERVERS.3 2.5 KB

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