Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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
       curl_easy_setopt(3) returns a CURLcode indicating success or error.

       CURLE_OK	(0) means everything was OK, non-zero means an error occurred,
       see libcurl-errors(3).

SEE ALSO
       CURLOPT_ACCEPT_ENCODING(3), CURLOPT_TRANSFER_ENCODING(3)

libcurl				  2025-06-03	    CURLOPT_SSH_COMPRESSION(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=CURLOPT_SSH_COMPRESSION&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help