docs/libcurl/opts/CURLOPT_CAPATH.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 http://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_CAPATH 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_CAPATH \- specify directory holding CA certificates
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_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 peer with. If libcurl is built against OpenSSL,
  33 the certificate directory must be prepared using the openssl c_rehash utility.
  34 This makes sense only when used in combination with the
  35 \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
  36
  37 The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due
  38 to some limitation in openssl.
  39 .SH DEFAULT
  40 NULL
  41 .SH PROTOCOLS
  42 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 This option is OpenSSL-specific and does nothing if libcurl is built to use
  47 GnuTLS. NSS-powered libcurl provides the option only for backward
  48 compatibility.
  49 .SH RETURN VALUE
  50 Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not, or
  51 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  52 .SH "SEE ALSO"
  53 .BR CURLOPT_CAINFO "(3), "
  54 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "