diff options
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.3')
-rw-r--r-- | docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.3 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.3 b/docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.3 new file mode 100644 index 00000000..18dbc2fe --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.3 @@ -0,0 +1,50 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_FTP_RESPONSE_TIMEOUT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_FTP_RESPONSE_TIMEOUT \- time allowed to wait for FTP response +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_RESPONSE_TIMEOUT, long timeout); +.SH DESCRIPTION +Pass a long. Causes libcurl to set a \fItimeout\fP period (in seconds) on the +amount of time that the server is allowed to take in order to send a response +message for a command before the session is considered dead. While libcurl is +waiting for a response, this value overrides \fICURLOPT_TIMEOUT(3)\fP. It is +recommended that if used in conjunction with \fICURLOPT_TIMEOUT(3)\fP, you set +\fICURLOPT_FTP_RESPONSE_TIMEOUT(3)\fP to a value smaller than +\fICURLOPT_TIMEOUT(3)\fP. +.SH DEFAULT +None +.SH PROTOCOLS +FTP +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.10.8 +.SH RETURN VALUE +Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_TIMEOUT "(3), " CURLOPT_CONNECTTIMEOUT "(3), " +.BR CURLOPT_LOW_SPEED_LIMIT "(3), " |