diff options
author | ng0 <ng0@infotropique.org> | 2017-08-22 18:16:20 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-08-22 18:16:20 +0000 |
commit | 25a03ee9c6133cfe1ce809a8ab1528ae7328fe35 (patch) | |
tree | 5ee3f3450604faedd1d4a9e53a3982c6ffcfe5fc /docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 | |
parent | 535a1e532345d3760d496b5b21052f23e8965f4c (diff) | |
download | gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.gz gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.bz2 gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.zip |
gnurl: Rename man3 files to avoid collisions.
This is necessary so that gnURL and cURL can co-exist on
the same system. However renaming most of the files is not logical.
Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3')
-rw-r--r-- | docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 | 80 |
1 files changed, 0 insertions, 80 deletions
diff --git a/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 b/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 deleted file mode 100644 index 8a04e894c..000000000 --- a/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 +++ /dev/null @@ -1,80 +0,0 @@ -.\" ************************************************************************** -.\" * _ _ ____ _ -.\" * Project ___| | | | _ \| | -.\" * / __| | | | |_) | | -.\" * | (__| |_| | _ <| |___ -.\" * \___|\___/|_| \_\_____| -.\" * -.\" * Copyright (C) 1998 - 2015, 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 https://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_FOLLOWLOCATION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" -.SH NAME -CURLOPT_FOLLOWLOCATION \- follow HTTP 3xx redirects -.SH SYNOPSIS -#include <gnurl/curl.h> - -CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, long enable); -.SH DESCRIPTION -A long parameter set to 1 tells the library to follow any Location: header -that the server sends as part of a HTTP header in a 3xx response. The -Location: header can specify a relative or an absolute URL to follow. - -libcurl will issue another request for the new URL and follow new Location: -headers all the way until no more such headers are returned. -\fICURLOPT_MAXREDIRS(3)\fP can be used to limit the number of redirects -libcurl will follow. - -libcurl limits what protocols it automatically follows to. The accepted -protocols are set with \fICURLOPT_REDIR_PROTOCOLS(3)\fP. By default libcurl -will allow all protocols on redirect except those disabled for security -reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB and SMBS -are also disabled. - -When following a Location:, the 3xx response code that redirected it also -dictates which request method it will use in the subsequent request: For 301, -302 and 303 responses libcurl will switch method to GET unless -\fICURLOPT_POSTREDIR(3)\fP instructs libcurl otherwise. All other 3xx codes -will make libcurl send the same method again. - -For users who think the existing location following is too naive, too simple -or just lacks features, it is very easy to instead implement your own redirect -follow logic with the use of \fIcurl_easy_getinfo(3)\fP's -\fICURLINFO_REDIRECT_URL(3)\fP option instead of using -\fICURLOPT_FOLLOWLOCATION(3)\fP. -.SH DEFAULT -0, disabled -.SH PROTOCOLS -HTTP(S) -.SH EXAMPLE -.nf -CURL *curl = curl_easy_init(); -if(curl) { - curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); - - /* example.com is redirected, so we tell libcurl to follow redirection */ - curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); - - curl_easy_perform(curl); -} -.fi -.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_REDIR_PROTOCOLS "(3), " CURLOPT_PROTOCOLS "(3), " -.BR CURLOPT_POSTREDIR "(3), " -.BR CURLINFO_REDIRECT_URL "(3), ", CURLINFO_REDIRECT_COUNT "(3), " |