CURLOPT_SSH_COMPRESSION - Man Page
enable SSH compression
Synopsis
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);
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.
Default
0, disabled
Protocols
This functionality affects scp and sftp
Example
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); } }
Availability
Added in curl 7.56.0
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.
See Also
Referenced By
curl_easy_setopt(3), libcurl-symbols(3).
2024-09-24 libcurl