Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_DNS_SERVERS.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 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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_DNS_SERVERS \- set preferred DNS servers
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_SERVERS, char *servers);
30 .SH DESCRIPTION
31 Pass a char * that is the list of DNS servers to be used instead of the system
32 default.  The format of the dns servers option is:
33
34 host[:port][,host[:port]]...
35
36 For example:
37
38 192.168.1.100,192.168.1.101,3.4.5.6
39 .SH DEFAULT
40 NULL - use system default
41 .SH PROTOCOLS
42 All
43 .SH EXAMPLE
44 TODO
45 .SH AVAILABILITY
46 This option requires that libcurl was built with a resolver backend that
47 supports this operation. The c-ares backend is the only such one.
48
49 Added in 7.24.0
50 .SH RETURN VALUE
51 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
52 CURLE_NOT_BUILT_IN if support was disabled at compile-time,
53 CURLE_BAD_FUNCTION_ARGUMENT when given an invalid server list, or
54 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
55 .SH "SEE ALSO"
56 .BR CURLOPT_DNS_LOCAL_IP4 "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), "