Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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 an 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 HTTP, HTTPS, FTP and FTPS on redirect (7.65.2). Older versions of
43 libcurl allowed all protocols on redirect except those disabled for security
44 reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB and SMBS
45 are also disabled.
46
47 When following a Location:, the 3xx response code that redirected it also
48 dictates which request method it will use in the subsequent request: For 301,
49 302 and 303 responses libcurl will switch method to GET unless
50 \fICURLOPT_POSTREDIR(3)\fP instructs libcurl otherwise. All other 3xx codes
51 will make libcurl send the same method again.
52
53 For users who think the existing location following is too naive, too simple
54 or just lacks features, it is very easy to instead implement your own redirect
55 follow logic with the use of \fIcurl_easy_getinfo(3)\fP's
56 \fICURLINFO_REDIRECT_URL(3)\fP option instead of using
57 \fICURLOPT_FOLLOWLOCATION(3)\fP.
58 .SH DEFAULT
59 0, disabled
60 .SH PROTOCOLS
61 HTTP(S)
62 .SH EXAMPLE
63 .nf
64 CURL *curl = curl_easy_init();
65 if(curl) {
66 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
67
68 /* example.com is redirected, so we tell libcurl to follow redirection */
69 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
70
71 curl_easy_perform(curl);
72 }
73 .fi
74 .SH AVAILABILITY
75 Along with HTTP
76 .SH RETURN VALUE
77 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
78 .SH "SEE ALSO"
79 .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_PROTOCOLS "(3), "
80 .BR CURLOPT_POSTREDIR "(3), "
81 .BR CURLINFO_REDIRECT_URL "(3), " CURLINFO_REDIRECT_COUNT "(3), "