CURLOPT_DNS_INTERFACE.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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_DNS_INTERFACE 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_DNS_INTERFACE \- interface to speak DNS over
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_INTERFACE, char *ifname);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a char * as parameter. Set the name of the network interface that the DNS
  35. resolver should bind to. This must be an interface name (not an address). Set
  36. this option to NULL to use the default setting (do not bind to a specific
  37. interface).
  38. The application does not have to keep the string around after setting this
  39. option.
  40. .SH DEFAULT
  41. NULL
  42. .SH PROTOCOLS
  43. All protocols except file:// - protocols that resolve host names.
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  49. curl_easy_setopt(curl, CURLOPT_DNS_INTERFACE, "eth0");
  50. ret = curl_easy_perform(curl);
  51. curl_easy_cleanup(curl);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Added in 7.33.0. This option also requires that libcurl was built with a
  56. resolver backend that supports this operation. The c-ares backend is the only
  57. such one.
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
  60. or CURLE_NOT_BUILT_IN if support was disabled at compile-time.
  61. .SH "SEE ALSO"
  62. .BR CURLOPT_DNS_SERVERS "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "