docs/libcurl/opts/CURLOPT_PROXYUSERNAME.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 http://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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXYUSERNAME \- user name to use for proxy authentication
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
  31                           char *username);
  32 .SH DESCRIPTION
  33 Pass a char * as parameter, which should be pointing to the zero terminated
  34 user name to use for the transfer.
  35
  36 \fBCURLOPT_PROXYUSERNAME(3)\fP sets the user name to be used in protocol
  37 authentication with the proxy.
  38
  39 To specify the proxy password use the \fICURLOPT_PROXYPASSWORD(3)\fP.
  40 .SH DEFAULT
  41 blank
  42 .SH PROTOCOLS
  43 Most
  44 .SH EXAMPLE
  45 TODO
  46 .SH AVAILABILITY
  47 Added in 7.19.1
  48 .SH RETURN VALUE
  49 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  50 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  51 .SH "SEE ALSO"
  52 .BR CURLOPT_PROXYPASSWORD "(3), " CURLOPT_USERNAME "(3), "
  53 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"