2014-06-19 11:59:00 -04:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
2017-05-30 17:35:30 -04:00
|
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-19 11:59:00 -04:00
|
|
|
.\" *
|
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2016-02-02 18:19:02 -05:00
|
|
|
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
|
2014-06-19 11:59:00 -04:00
|
|
|
.\" *
|
|
|
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
|
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
|
.\" * KIND, either express or implied.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\"
|
|
|
|
|
.TH CURLOPT_PROXYUSERNAME 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
|
|
|
.SH NAME
|
2014-11-02 05:33:51 -05:00
|
|
|
CURLOPT_PROXYUSERNAME \- user name to use for proxy authentication
|
2014-06-19 11:59:00 -04:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
|
|
|
|
|
char *username);
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a char * as parameter, which should be pointing to the zero terminated
|
|
|
|
|
user name to use for the transfer.
|
|
|
|
|
|
2016-05-02 03:09:36 -04:00
|
|
|
\fICURLOPT_PROXYUSERNAME(3)\fP sets the user name to be used in protocol
|
2014-06-19 11:59:00 -04:00
|
|
|
authentication with the proxy.
|
|
|
|
|
|
|
|
|
|
To specify the proxy password use the \fICURLOPT_PROXYPASSWORD(3)\fP.
|
2016-12-21 08:48:35 -05:00
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
2014-06-19 11:59:00 -04:00
|
|
|
.SH DEFAULT
|
|
|
|
|
blank
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
Most
|
|
|
|
|
.SH EXAMPLE
|
2017-05-30 17:35:30 -04:00
|
|
|
.nf
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "qwerty");
|
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2014-06-19 11:59:00 -04:00
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.19.1
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR CURLOPT_PROXYPASSWORD "(3), " CURLOPT_USERNAME "(3), "
|
|
|
|
|
.BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"
|
