blob: e0e367a899d125cb83e7f765c3ae6b9126543c43 [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_PROXY_SERVICE_NAME 3 "May 31, 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
Alex Deymo8f1a2142016-06-28 14:49:26 -070026CURLOPT_PROXY_SERVICE_NAME \- proxy authentication service name
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070027.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME, char *name);
31.SH DESCRIPTION
32Pass a char * as parameter to a string holding the \fIname\fP of the
Alex Deymo8f1a2142016-06-28 14:49:26 -070033service. The default service name is "HTTP" for HTTP based proxies and "rcmd"
34for SOCKS5. This option allows you to change it.
Elliott Hughes82be86d2017-09-20 17:00:17 -070035
36The application does not have to keep the string around after setting this
37option.
Alex Deymo8f1a2142016-06-28 14:49:26 -070038.SH DEFAULT
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070039See above
40.SH PROTOCOLS
Alex Deymo8f1a2142016-06-28 14:49:26 -070041All network protocols
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070042.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070043.nf
44CURL *curl = curl_easy_init();
45if(curl) {
46 CURLcode ret;
47 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
48 curl_easy_setopt(curl, CURLOPT_PROXY_SERVICE_NAME, "custom");
49 ret = curl_easy_perform(curl);
50}
51.fi
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070052.SH AVAILABILITY
Alex Deymo8f1a2142016-06-28 14:49:26 -070053Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070054.SH RETURN VALUE
55Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
56CURLE_OUT_OF_MEMORY if there was insufficient heap space.
57.SH "SEE ALSO"
58.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "