c33d79171b172929dc781619e8c432115bdab4cb
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_DNS_INTERFACE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_DNS_INTERFACE \- set interface to speak DNS over
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_INTERFACE, char *ifname);
30 .SH DESCRIPTION
31 Pass a char * as parameter. Set the name of the network interface that the DNS
32 resolver should bind to. This must be an interface name (not an address). Set
33 this option to NULL to use the default setting (don't bind to a specific
34 interface).
35 .SH DEFAULT
36 NULL
37 .SH PROTOCOLS
38 .SH EXAMPLE
39 TODO
40 .SH AVAILABILITY
41 Added in 7.33.0. This option also requires that libcurl was built with a
42 resolver backend that supports this operation. The c-ares backend is the only
43 such one.
44 .SH RETURN VALUE
45 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
46 or CURLE_NOT_BUILT_IN if support was disabled at compile-time.
47 .SH "SEE ALSO"
48 .BR CURLOPT_DNS_SERVERS "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "