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