summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPádraig Brady <P@draigBrady.com>2023-04-30 22:10:25 +0100
committerPádraig Brady <P@draigBrady.com>2023-04-30 22:10:25 +0100
commit6d683a1d020894d549986bd7b9e78b77b35650a2 (patch)
tree90064f4f7579a2e09aeda4657d86dd65cb437385
parent2cae0419c9343cfbdf392b46f3d4c5ea6c428bb9 (diff)
downloadcoreutils-6d683a1d020894d549986bd7b9e78b77b35650a2.tar.gz
doc: provide more info on the default 32-bit cksum digest
* doc/coreutils.texi (cksum invocation): Say that the default digest format is 32-bit and based on the Ethernet standard CRC.
-rw-r--r--doc/coreutils.texi10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 2188922c6..260592db2 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -3984,11 +3984,13 @@ next section) is preferable in new applications.
@pindex cksum
@cindex cyclic redundancy check
@cindex CRC checksum
+@cindex 32-bit checksum
+@cindex checksum, 32-bit
@cindex digest
-@command{cksum} by default computes a cyclic redundancy check (CRC) checksum
-for each given @var{file}, or standard input if none are given or for a
-@var{file} of @samp{-}.
+@command{cksum} by default computes a 32-bit cyclic redundancy check (CRC)
+checksum for each given @var{file}, or standard input if none are given or for
+a @var{file} of @samp{-}.
cksum also supports the @option{-a/--algorithm} option to select the
digest algorithm to use. @command{cksum} is the preferred interface
@@ -4008,6 +4010,8 @@ distribution).
@command{cksum} by default prints the POSIX standard CRC checksum
for each file along with the number of bytes in the file,
and the file name unless no arguments were given.
+The 32-bit CRC used is based on the polynomial used
+for CRC error checking in the ISO/IEC 8802-3:1996 standard (Ethernet).
The same usage and options as the @command{b2sum}
command are supported. @xref{b2sum invocation}.