diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2014-06-18 13:18:58 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2014-06-18 13:18:58 +0200 |
| commit | c3954ffb25ee45198ac98f2027ea55cf48ee825e (patch) | |
| tree | 3b1cbe51f8a4dfbf57a521edf18ebf8de57a8ba9 /docs/libcurl/opts/CURLOPT_MAXREDIRS.3 | |
| parent | 38bf85fd61df0d7bcab1e1f6bbf6051f7f486bd9 (diff) | |
opts: more man pages
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_MAXREDIRS.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_MAXREDIRS.3 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_MAXREDIRS.3 b/docs/libcurl/opts/CURLOPT_MAXREDIRS.3 new file mode 100644 index 000000000..52d256767 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_MAXREDIRS.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_MAXREDIRS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_MAXREDIRS \- maximum number of redirects allowed +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount); +.SH DESCRIPTION +Pass a long. The set number will be the redirection limit \fIamount\fP. If +that many redirections have been followed, the next redirect will cause an +error (\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the +\fICURLOPT_FOLLOWLOCATION(3)\fP is used at the same time. + +Setting the limit to 0 will make libcurl refuse any redirect. + +Set it to -1 for an infinite number of redirects. +.SH DEFAULT +-1, unlimited +.SH PROTOCOLS +HTTP +.SH EXAMPLE +TODO +.SH AVAILABILITY +Along with HTTP +.SH RETURN VALUE +Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_FOLLOWLOCATION "(3), " |