docs/libcurl/opts/CURLOPT_PROXYUSERPWD.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_PROXYUSERPWD 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXYUSERPWD \- user name and password to use for proxy authentication
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);
  30 .SH DESCRIPTION
  31 Pass a char * as parameter, which should be [user name]:[password] to use for
  32 the connection to the HTTP proxy. Both the name and the password will be URL
  33 decoded before use, so to include for example a colon in the user name you
  34 should encode it as %3A. (This is different to how \fICURLOPT_USERPWD(3)\fP is
  35 used - beware.)
  36
  37 Use \fICURLOPT_PROXYAUTH(3)\fP to specify the authentication method.
  38
  39 The application does not have to keep the string around after setting this
  40 option.
  41 .SH DEFAULT
  42 This is NULL by default.
  43 .SH PROTOCOLS
  44 Used with all protocols that can use a proxy
  45 .SH EXAMPLE
  46 TODO
  47 .SH AVAILABILITY
  48 Always
  49 .SH RETURN VALUE
  50 Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
  51 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  52 .SH "SEE ALSO"
  53 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "