docs/libcurl/opts/CURLOPT_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_PASSWORD 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PASSWORD \- password to use in authentication
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PASSWORD, char *pwd);
  30 .SH DESCRIPTION
  31 Pass a char * as parameter, which should be pointing to the zero terminated
  32 password to use for the transfer.
  33
  34 The \fICURLOPT_PASSWORD(3)\fP option should be used in conjunction with the
  35 \fICURLOPT_USERNAME(3)\fP option.
  36
  37 The application does not have to keep the string around after setting this
  38 option.
  39 .SH DEFAULT
  40 blank
  41 .SH PROTOCOLS
  42 Most
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.19.1
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  49 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  50 .SH "SEE ALSO"
  51 .BR CURLOPT_USERPWD "(3), " CURLOPT_USERNAME "(3), "
  52 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"
  53