91 lines
3.6 KiB
Groff
91 lines
3.6 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 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.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.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_FOLLOWLOCATION 3 "17 Jun 2014" libcurl libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_FOLLOWLOCATION \- follow HTTP 3xx redirects
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, long enable);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
A long parameter set to 1 tells the library to follow any Location: header
|
||
|
|
redirects that a HTTP server sends in a 30x response. The Location: header can
|
||
|
|
specify a relative or an absolute URL to follow.
|
||
|
|
|
||
|
|
libcurl issues another request for the new URL and follows subsequent new
|
||
|
|
Location: redirects all the way until no more such headers are returned or the
|
||
|
|
maximum limit is reached. \fICURLOPT_MAXREDIRS(3)\fP is used to limit the
|
||
|
|
number of redirects libcurl follows.
|
||
|
|
|
||
|
|
libcurl restricts what protocols it automatically follow redirects to. The
|
||
|
|
accepted target protocols are set with \fICURLOPT_REDIR_PROTOCOLS(3)\fP. By
|
||
|
|
default libcurl allows HTTP, HTTPS, FTP and FTPS on redirects.
|
||
|
|
|
||
|
|
When following a redirect, the specific 30x response code also dictates which
|
||
|
|
request method libcurl uses in the subsequent request: For 301, 302 and 303
|
||
|
|
responses libcurl switches method from POST to GET unless
|
||
|
|
\fICURLOPT_POSTREDIR(3)\fP instructs libcurl otherwise. All other redirect
|
||
|
|
response codes make libcurl use the same method again.
|
||
|
|
|
||
|
|
For users who think the existing location following is too naive, too simple
|
||
|
|
or just lacks features, it is 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 NOTE
|
||
|
|
Since libcurl changes method or not based on the specific HTTP response code,
|
||
|
|
setting \fICURLOPT_CUSTOMREQUEST(3)\fP while following redirects may change
|
||
|
|
what libcurl would otherwise do and if not that carefully may even make it
|
||
|
|
misbehave since \fICURLOPT_CUSTOMREQUEST(3)\fP overrides the method libcurl
|
||
|
|
would otherwise select internally.
|
||
|
|
.SH DEFAULT
|
||
|
|
0, disabled
|
||
|
|
.SH PROTOCOLS
|
||
|
|
HTTP(S)
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://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 CURLINFO_REDIRECT_COUNT (3),
|
||
|
|
.BR CURLINFO_REDIRECT_URL (3),
|
||
|
|
.BR CURLOPT_POSTREDIR (3),
|
||
|
|
.BR CURLOPT_PROTOCOLS (3),
|
||
|
|
.BR CURLOPT_REDIR_PROTOCOLS (3)
|