dc317f03b96a9ed32c7cae341f14a9c454d64fc2
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_PROXY_CAPATH.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, 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_PROXY_CAPATH 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROXY_CAPATH \- specify directory holding proxy CA certificates
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath);
30 .SH DESCRIPTION
31 Pass a char * to a zero terminated string naming a directory holding multiple
32 CA certificates to verify the HTTPS proxy with. If libcurl is built against
33 OpenSSL, the certificate directory must be prepared using the openssl c_rehash
34 utility. This makes sense only when \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled
35 (which it is by default).
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 Everything used over an HTTPS proxy
43 .SH EXAMPLE
44 TODO
45 .SH AVAILABILITY
46 Added in 7.52.0
47
48 This option is supported by the OpenSSL, GnuTLS and PolarSSL backends. The NSS
49 backend provides the option only for backward compatibility.
50 .SH RETURN VALUE
51 CURLE_OK if supported; or an error such as:
52
53 CURLE_NOT_BUILT_IN - Not supported by the SSL backend
54
55 CURLE_UNKNOWN_OPTION
56
57 CURLE_OUT_OF_MEMORY
58 .SH "SEE ALSO"
59 .BR CURLOPT_CAINFO "(3), "
60 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "