docs/libcurl/opts/CURLOPT_PROXYUSERNAME.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_PROXYUSERNAME 3 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXYUSERNAME \- user name to use for proxy authentication
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
  32                           char *username);
  33 .SH DESCRIPTION
  34 Pass a char * as parameter, which should be pointing to the zero terminated
  35 user name to use for the transfer.
  36
  37 \fICURLOPT_PROXYUSERNAME(3)\fP sets the user name to be used in protocol
  38 authentication with the proxy.
  39
  40 To specify the proxy password use the \fICURLOPT_PROXYPASSWORD(3)\fP.
  41
  42 The application does not have to keep the string around after setting this
  43 option.
  44 .SH DEFAULT
  45 blank
  46 .SH PROTOCOLS
  47 Most
  48 .SH EXAMPLE
  49 .nf
  50 CURL *curl = curl_easy_init();
  51 if(curl) {
  52   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  53   curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
  54   curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
  55   curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "qwerty");
  56   ret = curl_easy_perform(curl);
  57   curl_easy_cleanup(curl);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 Added in 7.19.1
  62 .SH RETURN VALUE
  63 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  64 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  65 .SH "SEE ALSO"
  66 .BR CURLOPT_PROXYPASSWORD "(3), " CURLOPT_USERNAME "(3), "
  67 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"