docs/libcurl/opts/CURLOPT_PROXYUSERPWD.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_PROXYUSERPWD 3 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXYUSERPWD \- user name and password to use for proxy authentication
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);
  31 .SH DESCRIPTION
  32 Pass a char * as parameter, which should be [user name]:[password] to use for
  33 the connection to the HTTP proxy. Both the name and the password will be URL
  34 decoded before use, so to include for example a colon in the user name you
  35 should encode it as %3A. (This is different to how \fICURLOPT_USERPWD(3)\fP is
  36 used - beware.)
  37
  38 Use \fICURLOPT_PROXYAUTH(3)\fP to specify the authentication method.
  39
  40 The application does not have to keep the string around after setting this
  41 option.
  42 .SH DEFAULT
  43 This is NULL by default.
  44 .SH PROTOCOLS
  45 Used with all protocols that can use a proxy
  46 .SH EXAMPLE
  47 .nf
  48 CURL *curl = curl_easy_init();
  49 if(curl) {
  50   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  51   curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
  52   curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, "clark%20kent:superman");
  53   ret = curl_easy_perform(curl);
  54   curl_easy_cleanup(curl);
  55 }
  56 .fi
  57 .SH AVAILABILITY
  58 Always
  59 .SH RETURN VALUE
  60 Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
  61 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "