comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_PROTOCOLS.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 - 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 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_PROTOCOLS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROTOCOLS \- set allowed protocols
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask);
30 .SH DESCRIPTION
31 Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
32 limits what protocols libcurl may use in the transfer. This allows you to have
33 a libcurl built to support a wide range of protocols but still limit specific
34 transfers to only be allowed to use a subset of them. By default libcurl will
35 accept all protocols it supports (\fICURLPROTO_ALL\fP). See also
36 \fICURLOPT_REDIR_PROTOCOLS(3)\fP.
37
38 These are the available protocol defines:
39 .nf
40 CURLPROTO_DICT
41 CURLPROTO_FILE
42 CURLPROTO_FTP
43 CURLPROTO_FTPS
44 CURLPROTO_GOPHER
45 CURLPROTO_HTTP
46 CURLPROTO_HTTPS
47 CURLPROTO_IMAP
48 CURLPROTO_IMAPS
49 CURLPROTO_LDAP
50 CURLPROTO_LDAPS
51 CURLPROTO_POP3
52 CURLPROTO_POP3S
53 CURLPROTO_RTMP
54 CURLPROTO_RTMPE
55 CURLPROTO_RTMPS
56 CURLPROTO_RTMPT
57 CURLPROTO_RTMPTE
58 CURLPROTO_RTMPTS
59 CURLPROTO_RTSP
60 CURLPROTO_SCP
61 CURLPROTO_SFTP
62 CURLPROTO_SMB
63 CURLPROTO_SMBS
64 CURLPROTO_SMTP
65 CURLPROTO_SMTPS
66 CURLPROTO_TELNET
67 CURLPROTO_TFTP
68 .fi
69 .SH DEFAULT
70 All protocols built-in
71 .SH PROTOCOLS
72 All
73 .SH EXAMPLE
74 .nf
75 curl = curl_easy_init();
76 if(curl) {
77 /* pass in the URL from an external source */
78 curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
79
80 /* only allow HTTP, TFTP and SFTP */
81 curl_easy_setopt(curl, CURLOPT_PROTOCOLS,
82 CURLPROTO_HTTP | CURLPROTO_TFTP | CURLPROTO_SFTP);
83
84 /* Perform the request */
85 curl_easy_perform(curl);
86 }
87 .fi
88 .SH AVAILABILITY
89 Added in 7.19.4
90 .SH RETURN VALUE
91 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
92 .SH "SEE ALSO"
93 .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_URL "(3), "