comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_SSH_COMPRESSION.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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 "05 Aug 2017" "libcurl 7.56.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSH_COMPRESSION \- enables compression / decompression of SSH traffic
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);
30 .SH DESCRIPTION
31 Pass a long as parameter set to 1L to enable or 0L to disable.
32
33 Enables built-in SSH compression. This is a request, not an order; the server
34 may or may not do it.
35 .SH DEFAULT
36 0, disabled
37 .SH PROTOCOLS
38 All SSH based protocols: SCP, SFTP
39 .SH EXAMPLE
40 .nf
41 CURL *curl = curl_easy_init();
42 if(curl) {
43 curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com");
44
45 /* enable built-in compression */
46 curl_easy_setopt(curl, CURLOPT_SSH_COMPRESSION, 1L);
47
48 /* Perform the request */
49 curl_easy_perform(curl);
50 }
51 .fi
52 .SH AVAILABILITY
53 Added in 7.56.0
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
56 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
57 .SH "SEE ALSO"
58 .BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_TRANSFER_ENCODING "(3), "