mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
bb50368ef8
To please manpage-syntax.pl used by test 1173 Closes #11957
80 lines
2.7 KiB
Groff
80 lines
2.7 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_PROXY_CAPATH 3 "16 Nov 2016" libcurl libcurl
|
|
.SH NAME
|
|
CURLOPT_PROXY_CAPATH \- directory holding HTTPS proxy CA certificates
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a char * to a null-terminated string naming a directory holding multiple
|
|
CA certificates to verify the HTTPS proxy with. If libcurl is built against
|
|
OpenSSL, the certificate directory must be prepared using the OpenSSL
|
|
\fBc_rehash\fP utility. This makes sense only when
|
|
\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is enabled (which it is by default).
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
The default value for this can be figured out with \fICURLINFO_CAPATH(3)\fP.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
Everything used over an HTTPS proxy
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
/* using an HTTPS proxy */
|
|
curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
|
|
curl_easy_setopt(curl, CURLOPT_PROXY_CAPATH, "/etc/cert-dir");
|
|
ret = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.52.0
|
|
|
|
This option is supported by the OpenSSL, GnuTLS, and mbedTLS (since 7.56.0)
|
|
backends.
|
|
.SH RETURN VALUE
|
|
CURLE_OK if supported; or an error such as:
|
|
|
|
CURLE_NOT_BUILT_IN - Not supported by the SSL backend
|
|
|
|
CURLE_UNKNOWN_OPTION
|
|
|
|
CURLE_OUT_OF_MEMORY
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_CAINFO (3),
|
|
.BR CURLOPT_DEBUGFUNCTION (3),
|
|
.BR CURLOPT_PROXY_CAINFO (3),
|
|
.BR CURLOPT_PROXY_SSL_VERIFYHOST (3),
|
|
.BR CURLOPT_STDERR (3)
|