blob: fe56ae94adae6eeeff8c400c468695d8ff26d6ee [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.\"
Elliott Hughes1ef06ba2018-05-30 15:43:58 -070023.TH CURLOPT_PROXYPASSWORD 3 "May 30, 2017" "libcurl 7.60.0" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_PROXYPASSWORD \- password to use with proxy authentication
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPASSWORD, char *pwd);
31.SH DESCRIPTION
32Pass a char * as parameter, which should be pointing to the zero terminated
33password to use for authentication with the proxy.
34
35The \fICURLOPT_PROXYPASSWORD(3)\fP option should be used in conjunction with
36the \fICURLOPT_PROXYUSERNAME(3)\fP option.
Elliott Hughes82be86d2017-09-20 17:00:17 -070037
38The application does not have to keep the string around after setting this
39option.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070040.SH DEFAULT
41blank
42.SH PROTOCOLS
43Most
44.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070045.nf
46CURL *curl = curl_easy_init();
47if(curl) {
48 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
49 curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
50 curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
51 curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "qwerty");
52 ret = curl_easy_perform(curl);
53 curl_easy_cleanup(curl);
54}
55.fi
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070056.SH AVAILABILITY
57Added in 7.19.1
58.SH RETURN VALUE
59Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
60CURLE_OUT_OF_MEMORY if there was insufficient heap space.
61.SH "SEE ALSO"
62.BR CURLOPT_PASSWORD "(3), " CURLOPT_PROXYUSERNAME "(3), "
63.BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"