Sortix cross-nightly manual

This manual documents Sortix cross-nightly. You can instead view this document in the latest official manual.

CURLOPT_SSH_COMPRESSION(3)

Library Functions Manual

CURLOPT_SSH_COMPRESSION(3)

NAME

CURLOPT_SSH_COMPRESSION - enable SSH compression

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);

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.

0, disabled

This functionality affects scp and sftp

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);
}
}

Added in curl 7.56.0

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.