Sortix
Sortix Download Manual Development Source Code News Blog More
current nightly

Sortix volatile manual

This manual documents Sortix volatile, a development build that has not been officially released. 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

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

CURLOPT_ACCEPT_ENCODING(3), CURLOPT_TRANSFER_ENCODING(3)
2025-05-13 libcurl
Copyright 2011-2025 Jonas 'Sortie' Termansen and contributors.
Sortix's source code is free software under the ISC license.
#sortix on irc.sortix.org
@sortix_org