mirror of
https://codeberg.org/kiss-community/repo
synced 2024-11-19 21:20:07 -07:00
84 lines
2.0 KiB
Groff
84 lines
2.0 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_PROTOCOLS.md
|
|
.TH CURLOPT_PROTOCOLS 3 libcurl
|
|
.SH NAME
|
|
CURLOPT_PROTOCOLS \- allowed protocols
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This option is deprecated. We strongly recommend using
|
|
\fICURLOPT_PROTOCOLS_STR(3)\fP instead because this option cannot control all
|
|
available protocols!
|
|
|
|
Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
|
|
limits what protocols libcurl may use in the transfer. This allows you to have
|
|
a libcurl built to support a wide range of protocols but still limit specific
|
|
transfers to only be allowed to use a subset of them. By default libcurl
|
|
accepts all protocols it supports (\fICURLPROTO_ALL\fP). See also
|
|
\fICURLOPT_REDIR_PROTOCOLS(3)\fP.
|
|
|
|
These are the available protocol defines:
|
|
.nf
|
|
CURLPROTO_DICT
|
|
CURLPROTO_FILE
|
|
CURLPROTO_FTP
|
|
CURLPROTO_FTPS
|
|
CURLPROTO_GOPHER
|
|
CURLPROTO_HTTP
|
|
CURLPROTO_HTTPS
|
|
CURLPROTO_IMAP
|
|
CURLPROTO_IMAPS
|
|
CURLPROTO_LDAP
|
|
CURLPROTO_LDAPS
|
|
CURLPROTO_POP3
|
|
CURLPROTO_POP3S
|
|
CURLPROTO_RTMP
|
|
CURLPROTO_RTMPE
|
|
CURLPROTO_RTMPS
|
|
CURLPROTO_RTMPT
|
|
CURLPROTO_RTMPTE
|
|
CURLPROTO_RTMPTS
|
|
CURLPROTO_RTSP
|
|
CURLPROTO_SCP
|
|
CURLPROTO_SFTP
|
|
CURLPROTO_SMB
|
|
CURLPROTO_SMBS
|
|
CURLPROTO_SMTP
|
|
CURLPROTO_SMTPS
|
|
CURLPROTO_TELNET
|
|
CURLPROTO_TFTP
|
|
.fi
|
|
.SH DEFAULT
|
|
All protocols built\-in.
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(int argc, char **argv)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
/* pass in the URL from an external source */
|
|
curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
|
|
|
|
/* only allow HTTP, TFTP and SFTP */
|
|
curl_easy_setopt(curl, CURLOPT_PROTOCOLS,
|
|
CURLPROTO_HTTP | CURLPROTO_TFTP | CURLPROTO_SFTP);
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.19.4. Deprecated since 7.85.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_DEFAULT_PROTOCOL (3),
|
|
.BR CURLOPT_REDIR_PROTOCOLS (3),
|
|
.BR CURLOPT_URL (3)
|