]> Sergey Matveev's repositories - meta4ra.git/blobdiff - README
Prepare for release
[meta4ra.git] / README
diff --git a/README b/README
index 45c90babf7035dcb614a1c70e34fec4d8dee3efd..8f711941566c64516967734958774c0d4067464e 100644 (file)
--- a/README
+++ b/README
@@ -1,46 +1,18 @@
 meta4ra -- Metalink4 utilities
 
-meta4-create utility is used to create Metalink4
+meta4ra-create utility is used to create Metalink4
 (https://datatracker.ietf.org/doc/html/rfc5854)
 .meta4-file for single specified file.
 
--fn NAME    -- the only required option specifying file's name.
--desc "..." -- set file's description.
--mtime FILE -- let published date be equal to FILE's mtime.
--sig FILE   -- path to armored OpenPGP's signature file.
--torrent URL -- set BitTorrent's URL.
--hashes -- comma-separated list of colon-separated pairs of hash'es
-           name and the external command used to compute it. Command
-           shall take the data from stdin and print the digest in
-           hexadecimal form with the following newline to stdout.
+meta4ra-check utility is used to check .meta4 file, extract signatures
+and verify corresponding files integrity.
 
-Following hashes are predefined by default:
+meta4ra-hash utility can be used to hash the data with a single hash
+algorithm. It could be useful if you want to use the best found
+algorithm on current system, whatever it is.
 
-* sha-256:sha256 -- standardized name; standard command in many OSes
-                    May be fast on hardware accelerated CPUs.
-* sha-512:sha512 -- standardized name; standard command in many OSes
-                    Faster on 64-bit CPUs than software sha-256.
-* skein-256:skein256 -- non-standardized name; out-of-box command in FreeBSD
-                        Faster than software sha-*/shake*.
-* skein-512:skein512 -- non-standardized name; out-of-box command in FreeBSD
-                        Faster on 64-bit CPUs than skein-256.
-* shake128:goshake128 -- standardized name; non-standard command
-                         Faster than software sha-*. Much faster on hardware.
-* shake256:goshake256 -- standardized name; non-standard command
-                         Same speed as sha-512 on 64-bit CPUs.
-                         Much faster on hardware.
-* streebog-256:streebog256sum -- non-standardized name; command is in contrib/
-* streebog-512:streebog512sum -- non-standardized name; command is in contrib/
-* blake3-256:b3sum -- non-standardized name; additional package in most OSes
-                      Fastest parallelizeable software hash
+meta4ra is copylefted free software: see the file COPYING for copying
+conditions. It should work on all POSIX-compatible systems.
 
-SHA2 and SHA3 (SHAKE*) are USA's NIST standards. Streebog is Russian
-Federation's government standard. Skein is SHA3-finalist. BLAKE3 is
-reduced round Merklee-tree-based BLAKE2 descendant. BLAKE2 is reduced
-round BLAKE, that also was one of SHA3-finalists.
-
-meta4-check utility is used to check files against provided Metalink4.
-
--extract-sig -- store the OpenPGP signature (if exists) in .asc file nearby.
--hashes      -- same as in meta4-create. Hashes are sorted by preferences
-                priority. First matching one will be used to check integrity.
+You can select desired fields by ordinary XML-related utulities:
+    xml sel -t -m "/_:metalink/_:file/_:url" -v . -nl data.meta4