mirror of
https://codeberg.org/kiss-community/repo
synced 2025-01-05 01:10:07 -07:00
72 lines
2.2 KiB
Groff
72 lines
2.2 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_DEFAULT_PROTOCOL.md
|
|
.TH CURLOPT_DEFAULT_PROTOCOL 3 "2024-11-09" libcurl
|
|
.SH NAME
|
|
CURLOPT_DEFAULT_PROTOCOL \- default protocol to use if the URL is missing a
|
|
scheme name
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEFAULT_PROTOCOL,
|
|
char *protocol);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This option tells libcurl to use \fIprotocol\fP if the URL is missing a scheme
|
|
name.
|
|
|
|
Use one of these protocol (scheme) names:
|
|
|
|
dict, file, ftp, ftps, gopher, http, https, imap, imaps, ldap, ldaps, pop3,
|
|
pop3s, rtsp, scp, sftp, smb, smbs, smtp, smtps, telnet, tftp
|
|
|
|
An unknown or unsupported protocol causes error \fICURLE_UNSUPPORTED_PROTOCOL\fP
|
|
when libcurl parses a URL without a scheme. Parsing happens when
|
|
\fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP is called. The protocol set
|
|
supported by libcurl vary depending on how it was built. Use
|
|
\fIcurl_version_info(3)\fP if you need a list of protocol names supported by the
|
|
build of libcurl that you are using.
|
|
|
|
This option does not change the default proxy protocol (http).
|
|
|
|
Without this option libcurl would make a guess based on the host, see
|
|
\fICURLOPT_URL(3)\fP for details.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
previous ones. Set it to NULL to disable its use again.
|
|
.SH DEFAULT
|
|
NULL (make a guess based on the host)
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
/* set a URL without a scheme */
|
|
curl_easy_setopt(curl, CURLOPT_URL, "example.com");
|
|
|
|
/* set the default protocol (scheme) for schemeless URLs */
|
|
curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.45.0
|
|
.SH RETURN VALUE
|
|
CURLE_OK if the option is supported.
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
CURLE_UNKNOWN_OPTION if the option is not supported.
|
|
.SH SEE ALSO
|
|
.BR CURLINFO_PROTOCOL (3),
|
|
.BR CURLINFO_SCHEME (3),
|
|
.BR CURLOPT_URL (3)
|