3c783479a89ba495b13299dea3330bb67a56ef65
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_DNS_LOCAL_IP6.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_LOCAL_IP6 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_DNS_LOCAL_IP6 \- IPv6 address to bind DNS resolves to
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_LOCAL_IP6, char *address);
30 .SH DESCRIPTION
31 Set the local IPv6 \fIaddress\fP that the resolver should bind to. The
32 argument should be of type char * and contain a single IPv6 address as a
33 string.  Set this option to NULL to use the default setting (don't bind to a
34 specific IP address).
35
36 The application does not have to keep the string around after setting this
37 option.
38 .SH DEFAULT
39 NULL
40 .SH PROTOCOLS
41 All
42 .SH EXAMPLE
43 TODO
44 .SH AVAILABILITY
45 This option requires that libcurl was built with a resolver backend that
46 supports this operation. The c-ares backend is the only such one.
47
48 Added in 7.33.0
49 .SH RETURN VALUE
50 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
51 CURLE_NOT_BUILT_IN if support was disabled at compile-time, or
52 CURLE_BAD_FUNCTION_ARGUMENT when given a bad address.
53 .SH "SEE ALSO"
54 .BR CURLOPT_DNS_INTERFACE "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "