Imported Upstream version 7.53.1
[platform/upstream/curl.git] / docs / cmdline-opts / metalink.d
1 Long: metalink
2 Help: Process given URLs as metalink XML file
3 Added: 7.27.0
4 Requires: metalink
5 ---
6 This option can tell curl to parse and process a given URI as Metalink file
7 (both version 3 and 4 (RFC 5854) are supported) and make use of the mirrors
8 listed within for failover if there are errors (such as the file or server not
9 being available). It will also verify the hash of the file after the download
10 completes. The Metalink file itself is downloaded and processed in memory and
11 not stored in the local file system.
12
13 Example to use a remote Metalink file:
14
15  curl --metalink http://www.example.com/example.metalink
16
17 To use a Metalink file in the local file system, use FILE protocol (file://):
18
19  curl --metalink file://example.metalink
20
21 Please note that if FILE protocol is disabled, there is no way to use a local
22 Metalink file at the time of this writing. Also note that if --metalink and
23 --include are used together, --include will be ignored. This is because
24 including headers in the response will break Metalink parser and if the
25 headers are included in the file described in Metalink file, hash check will
26 fail.
27