Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_CAPATH.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2019, 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 "May 15, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PROXY_CAPATH \- specify directory holding proxy CA certificates
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath);
                     31: .SH DESCRIPTION
                     32: Pass a char * to a zero terminated string naming a directory holding multiple
                     33: CA certificates to verify the HTTPS proxy with. If libcurl is built against
                     34: OpenSSL, the certificate directory must be prepared using the openssl c_rehash
                     35: utility. This makes sense only when \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is
                     36: enabled (which it is by default).
                     37: 
                     38: The application does not have to keep the string around after setting this
                     39: option.
                     40: .SH DEFAULT
                     41: NULL
                     42: .SH PROTOCOLS
                     43: Everything used over an HTTPS proxy
                     44: .SH EXAMPLE
                     45: .nf
                     46: CURL *curl = curl_easy_init();
                     47: if(curl) {
                     48:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
                     49:   /* using an HTTPS proxy */
                     50:   curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
                     51:   curl_easy_setopt(curl, CURLOPT_PROXY_CAPATH, "/etc/cert-dir");
                     52:   ret = curl_easy_perform(curl);
                     53:   curl_easy_cleanup(curl);
                     54: }
                     55: .fi
                     56: .SH AVAILABILITY
                     57: Added in 7.52.0
                     58: 
                     59: This option is supported by the OpenSSL, GnuTLS, and mbedTLS (since 7.56.0)
                     60: backends. The NSS backend provides the option only for backward compatibility.
                     61: .SH RETURN VALUE
                     62: CURLE_OK if supported; or an error such as:
                     63: 
                     64: CURLE_NOT_BUILT_IN - Not supported by the SSL backend
                     65: 
                     66: CURLE_UNKNOWN_OPTION
                     67: 
                     68: CURLE_OUT_OF_MEMORY
                     69: .SH "SEE ALSO"
                     70: .BR CURLOPT_PROXY_CAINFO "(3), "
                     71: .Br CURLOPT_CAINFO "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
                     72: .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>