docs/libcurl/opts/CURLOPT_DNS_INTERFACE.3

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