summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts
diff options
context:
space:
mode:
authorDaniel Silverstone <daniel.silverstone@codethink.co.uk>2023-04-26 09:44:57 +0100
committerDaniel Stenberg <daniel@haxx.se>2023-05-15 13:20:47 +0200
commite915b6904c02294dc5ccd9b7c95d46af2839dd1c (patch)
treea4abacc77e8c530b19971e7db3ac74bc96b24f21 /docs/libcurl/opts
parentf157610d30e981b2f5553c0f212adfdc75881ab5 (diff)
downloadcurl-e915b6904c02294dc5ccd9b7c95d46af2839dd1c.tar.gz
ssh: Add support for libssh2 read timeout
Hook the new (1.11.0 or newer) libssh2 support for setting a read timeout into the SERVER_RESPONSE_TIMEOUT option. With this done, clients can use the standard curl response timeout setting to also control the time that libssh2 will wait for packets from a slow server. This is necessary to enable use of very slow SFTP servers. Signed-off-by: Daniel Silverstone <daniel.silverstone@codethink.co.uk> Closes #10965
Diffstat (limited to 'docs/libcurl/opts')
-rw-r--r--docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.35
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.3 b/docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.3
index 69d892e65..46d6fdaa7 100644
--- a/docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.3
+++ b/docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.3
@@ -45,7 +45,7 @@ This option was formerly known as \fBCURLOPT_FTP_RESPONSE_TIMEOUT\fP.
.SH DEFAULT
None
.SH PROTOCOLS
-FTP, IMAP, POP3 and SMTP
+FTP, IMAP, POP3, SMTP, and SSH
.SH EXAMPLE
.nf
CURL *curl = curl_easy_init();
@@ -60,6 +60,9 @@ if(curl) {
.fi
.SH AVAILABILITY
Added in 7.10.8. Used under this name since 7.20.0
+
+Support for SSH is predicated on a new enough (1.11.0) version of libssh2
+being available when compiling libcurl.
.SH RETURN VALUE
Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns
CURLE_BAD_FUNCTION_ARGUMENT if set to a negative value or a value that when