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