]> Sergey Matveev's repositories - meta4ra.git/blobdiff - README
*-hashes-detect, *-hash, *-check -stdin/-all-hashes, optional builtins
[meta4ra.git] / README
diff --git a/README b/README
index 1969527a7ae63bfc13997e008a323e3b6b58c4d0..15bc1a458c7aeac6cb449408802352c3c4a334a8 100644 (file)
--- a/README
+++ b/README
@@ -1,39 +1,15 @@
 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.
-Look for its -help for invocation information.
 
--hashes are 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:
-
-* 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
-
-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.
+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.
 
 meta4ra is copylefted free software: see the file COPYING for copying
 conditions. It should work on all POSIX-compatible systems.