Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_COMPRESSION.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
! 9: .\" *
! 10: .\" * This software is licensed as described in the file COPYING, which
! 11: .\" * you should have received as part of this distribution. The terms
! 12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
! 13: .\" *
! 14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
! 15: .\" * copies of the Software, and permit persons to whom the Software is
! 16: .\" * furnished to do so, under the terms of the COPYING file.
! 17: .\" *
! 18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
! 19: .\" * KIND, either express or implied.
! 20: .\" *
! 21: .\" **************************************************************************
! 22: .\"
! 23: .TH CURLOPT_SSH_COMPRESSION 3 "August 10, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_SSH_COMPRESSION \- enables compression / decompression of SSH traffic
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);
! 31: .SH DESCRIPTION
! 32: Pass a long as parameter set to 1L to enable or 0L to disable.
! 33:
! 34: Enables built-in SSH compression. This is a request, not an order; the server
! 35: may or may not do it.
! 36: .SH DEFAULT
! 37: 0, disabled
! 38: .SH PROTOCOLS
! 39: All SSH based protocols: SCP, SFTP
! 40: .SH EXAMPLE
! 41: .nf
! 42: CURL *curl = curl_easy_init();
! 43: if(curl) {
! 44: curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com");
! 45:
! 46: /* enable built-in compression */
! 47: curl_easy_setopt(curl, CURLOPT_SSH_COMPRESSION, 1L);
! 48:
! 49: /* Perform the request */
! 50: curl_easy_perform(curl);
! 51: }
! 52: .fi
! 53: .SH AVAILABILITY
! 54: Added in 7.56.0
! 55: .SH RETURN VALUE
! 56: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
! 57: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 58: .SH "SEE ALSO"
! 59: .BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_TRANSFER_ENCODING "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>