comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_PROXYAUTH.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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_PROXYAUTH 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROXYAUTH \- set HTTP proxy authentication methods to try
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYAUTH, long bitmask);
30 .SH DESCRIPTION
31 Pass a long as parameter, which is set to a bitmask, to tell libcurl which
32 HTTP authentication method(s) you want it to use for your proxy
33 authentication. If more than one bit is set, libcurl will first query the
34 site to see what authentication methods it supports and then pick the best one
35 you allow it to use. For some methods, this will induce an extra network
36 round-trip. Set the actual name and password with the
37 \fICURLOPT_PROXYUSERPWD(3)\fP option.
38
39 The bitmask can be constructed by or'ing together the bits fully listed and
40 described in the \fICURLOPT_HTTPAUTH(3)\fP man page.
41 .SH DEFAULT
42 CURLAUTH_BASIC
43 .SH PROTOCOLS
44 HTTP
45 .SH EXAMPLE
46 .nf
47 CURL *curl = curl_easy_init();
48 if(curl) {
49 CURLcode ret;
50 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
51 /* use this proxy */
52 curl_easy_setopt(curl, CURLOPT_PROXY, "http://local.example.com:1080");
53 /* allow whatever auth the proxy speaks */
54 curl_easy_setopt(curl, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
55 /* set the proxy credentials */
56 curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, "james:007");
57 ret = curl_easy_perform(curl);
58 curl_easy_cleanup(curl);
59 }
60 .fi
61 .SH AVAILABILITY
62 Added in 7.10.7
63 .SH RETURN VALUE
64 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
65 CURLE_NOT_BUILT_IN if the bitmask specified no supported authentication
66 methods.
67 .SH "SEE ALSO"
68 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
69 .BR CURLOPT_PROXYUSERPWD "(3), " CURLOPT_PROXYPORT "(3), "