docs/libcurl/opts/CURLOPT_TLSAUTH_PASSWORD.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_TLSAUTH_PASSWORD 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_TLSAUTH_PASSWORD \- password to use for TLS authentication
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_PASSWORD, char *pwd);
  30 .SH DESCRIPTION
  31 Pass a char * as parameter, which should point to the zero terminated password
  32 to use for the TLS authentication method specified with the
  33 \fICURLOPT_TLSAUTH_TYPE(3)\fP option. Requires that the
  34 \fICURLOPT_TLSAUTH_USERNAME(3)\fP option also be set.
  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 TLS-based protocols
  42 .SH EXAMPLE
  43 TODO
  44 .SH AVAILABILITY
  45 Added in 7.21.4
  46 .SH RETURN VALUE
  47 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  48 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  49 .SH "SEE ALSO"
  50 .BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_USERNAME "(3), "