Return to CURLOPT_FOLLOWLOCATION.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2020, 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 "January 28, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_FOLLOWLOCATION \- follow HTTP 3xx redirects
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, long enable);
                     31: .SH DESCRIPTION
                     32: A long parameter set to 1 tells the library to follow any Location: header
                     33: that the server sends as part of an HTTP header in a 3xx response. The
                     34: Location: header can specify a relative or an absolute URL to follow.
                     35: 
                     36: libcurl will issue another request for the new URL and follow new Location:
                     37: headers all the way until no more such headers are returned.
                     38: \fICURLOPT_MAXREDIRS(3)\fP can be used to limit the number of redirects
                     39: libcurl will follow.
                     40: 
                     41: libcurl limits what protocols it automatically follows to. The accepted
                     42: protocols are set with \fICURLOPT_REDIR_PROTOCOLS(3)\fP. By default libcurl
                     43: will allow HTTP, HTTPS, FTP and FTPS on redirect (7.65.2). Older versions of
                     44: libcurl allowed all protocols on redirect except those disabled for security
                     45: reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB and SMBS
                     46: are also disabled.
                     47: 
                     48: When following a Location:, the 3xx response code that redirected it also
                     49: dictates which request method it will use in the subsequent request: For 301,
                     50: 302 and 303 responses libcurl will switch method from POST to GET unless
                     51: \fICURLOPT_POSTREDIR(3)\fP instructs libcurl otherwise. All other 3xx codes
                     52: will make libcurl send the same method again.
                     53: 
                     54: For users who think the existing location following is too naive, too simple
                     55: or just lacks features, it is very easy to instead implement your own redirect
                     56: follow logic with the use of \fIcurl_easy_getinfo(3)\fP's
                     57: \fICURLINFO_REDIRECT_URL(3)\fP option instead of using
                     58: \fICURLOPT_FOLLOWLOCATION(3)\fP.
                     59: .SH DEFAULT
                     60: 0, disabled
                     61: .SH PROTOCOLS
                     62: HTTP(S)
                     63: .SH EXAMPLE
                     64: .nf
                     65: CURL *curl = curl_easy_init();
                     66: if(curl) {
                     67:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     68: 
                     69:   /* example.com is redirected, so we tell libcurl to follow redirection */
                     70:   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
                     71: 
                     72:   curl_easy_perform(curl);
                     73: }
                     74: .fi
                     75: .SH AVAILABILITY
                     76: Along with HTTP
                     77: .SH RETURN VALUE
                     78: Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
                     79: .SH "SEE ALSO"
                     80: .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_PROTOCOLS "(3), "
                     81: .BR CURLOPT_POSTREDIR "(3), "
                     82: .BR CURLINFO_REDIRECT_URL "(3), " CURLINFO_REDIRECT_COUNT "(3), "