Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FOLLOWLOCATION.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_FOLLOWLOCATION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FOLLOWLOCATION \- follow HTTP 3xx redirects
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, long enable);
30 .SH DESCRIPTION
31 A long parameter set to 1 tells the library to follow any Location: header
32 that the server sends as part of a HTTP header in a 3xx response. The
33 Location: header can specify a relative or an absolute URL to follow.
34
35 libcurl will issue another request for the new URL and follow new Location:
36 headers all the way until no more such headers are returned.
37 \fICURLOPT_MAXREDIRS(3)\fP can be used to limit the number of redirects
38 libcurl will follow.
39
40 libcurl limits what protocols it automatically follows to. The accepted
41 protocols are set with \fICURLOPT_REDIR_PROTOCOLS(3)\fP. By default libcurl
42 will allow all protocols on redirect except those disabled for security
43 reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB and SMBS
44 are also disabled.
45
46 When following a Location:, the 3xx response code that redirected it also
47 dictates which request method it will use in the subsequent request: For 301,
48 302 and 303 responses libcurl will switch method to GET unless
49 \fICURLOPT_POSTREDIR(3)\fP instructs libcurl otherwise. All other 3xx codes
50 will make libcurl send the same method again.
51
52 For users who think the existing location following is too naive, too simple
53 or just lacks features, it is very easy to instead implement your own redirect
54 follow logic with the use of \fIcurl_easy_getinfo(3)\fP's
55 \fICURLINFO_REDIRECT_URL(3)\fP option instead of using
56 \fICURLOPT_FOLLOWLOCATION(3)\fP.
57 .SH DEFAULT
58 0, disabled
59 .SH PROTOCOLS
60 HTTP(S)
61 .SH EXAMPLE
62 .nf
63 CURL *curl = curl_easy_init();
64 if(curl) {
65   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
66
67   /* example.com is redirected, so we tell libcurl to follow redirection */
68   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
69
70   curl_easy_perform(curl);
71 }
72 .fi
73 .SH AVAILABILITY
74 Along with HTTP
75 .SH RETURN VALUE
76 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
77 .SH "SEE ALSO"
78 .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_PROTOCOLS "(3), "
79 .BR CURLOPT_POSTREDIR "(3), "
80 .BR CURLINFO_REDIRECT_URL "(3), ", CURLINFO_REDIRECT_COUNT "(3), "