2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_SSH_COMPRESSION.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH CURLOPT_SSH_COMPRESSION 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_SSH_COMPRESSION \- enable SSH compression
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a long as parameter set to 1L to enable or 0L to disable.
|
|
|
|
|
|
|
|
|
|
Enables built\-in SSH compression. This is a request, not an order; the server
|
|
|
|
|
may or may not do it.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
0, disabled
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects scp and sftp
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com");
|
|
|
|
|
|
|
|
|
|
/* enable built-in compression */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_SSH_COMPRESSION, 1L);
|
|
|
|
|
|
|
|
|
|
/* Perform the request */
|
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.56.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_ACCEPT_ENCODING (3),
|
|
|
|
|
.BR CURLOPT_TRANSFER_ENCODING (3)
|
