]> Sergey Matveev's repositories - meta4ra.git/blob - README
Ability to skip Published/Generator fields inclusion
[meta4ra.git] / README
1 meta4ra -- Metalink4 utilities
2
3 meta4-create utility is used to create Metalink4
4 (https://datatracker.ietf.org/doc/html/rfc5854)
5 .meta4-file for single specified file.
6
7 -fn NAME      -- the only required option specifying file's name.
8 -desc "..."   -- set file's description.
9 -mtime FILE   -- let published date be equal to FILE's mtime.
10 -sig-pgp .asc -- path to armored OpenPGP's signature file.
11 -sig-ssh .sig -- path to armored OpenSSH's signature file.
12 -torrent URL  -- set BitTorrent's URL.
13 -hashes -- comma-separated list of colon-separated pairs of hash'es
14            name and the external command used to compute it. Command
15            shall take the data from stdin and print the digest in
16            hexadecimal form with the following newline to stdout.
17
18 Following hashes are predefined by default:
19
20 * sha-256:sha256 -- standardized name; standard command in many OSes
21                     May be fast on hardware accelerated CPUs.
22 * sha-512:sha512 -- standardized name; standard command in many OSes
23                     Faster on 64-bit CPUs than software sha-256.
24 * skein-256:skein256 -- non-standardized name; out-of-box command in FreeBSD
25                         Faster than software sha-*/shake*.
26 * skein-512:skein512 -- non-standardized name; out-of-box command in FreeBSD
27                         Faster on 64-bit CPUs than skein-256.
28 * shake128:goshake128 -- standardized name; non-standard command
29                          Faster than software sha-*. Much faster on hardware.
30 * shake256:goshake256 -- standardized name; non-standard command
31                          Same speed as sha-512 on 64-bit CPUs.
32                          Much faster on hardware.
33 * streebog-256:streebog256sum -- non-standardized name; command is in contrib/
34 * streebog-512:streebog512sum -- non-standardized name; command is in contrib/
35 * blake3-256:b3sum -- non-standardized name; additional package in most OSes
36                       Fastest parallelizeable software hash
37
38 SHA2 and SHA3 (SHAKE*) are USA's NIST standards. Streebog is Russian
39 Federation's government standard. Skein is SHA3-finalist. BLAKE3 is
40 reduced round Merklee-tree-based BLAKE2 descendant. BLAKE2 is reduced
41 round BLAKE, that also was one of SHA3-finalists.
42
43 meta4-check utility is used to check files against provided Metalink4.
44
45 -extract-sig -- store the OpenPGP signature (if exists) in .asc file nearby.
46 -hashes      -- same as in meta4-create. Hashes are sorted by preferences
47                 priority. First matching one will be used to check integrity.