chiark / gitweb /
Import buf from Catacomb; split out the dstr bits, and throw away the mp and
[mLib] / man / crc32.3
index 3d2dead447580f3547df7209a4b91cdb601c698f..6eca843c785c78cafde1b86d00a25dc2e7a44a58 100644 (file)
@@ -7,7 +7,7 @@
 .  ds ss ^
 .  ds se
 .\}
-.TH crc32 3 "8 May 1999" "mLib"
+.TH crc32 3 "8 May 1999" "Straylight/Edgeware" "mLib utilities library"
 .SH NAME
 crc32 \- calculate 32-bit CRC
 .\" @crc32
@@ -15,7 +15,7 @@ crc32 \- calculate 32-bit CRC
 .nf
 .B "#include <mLib/crc32.h>"
 
-.BI "int crc32(unsigned long " crc ", const void *" buf ", size_t " sz );
+.BI "uint32 crc32(uint32 " crc ", const void *" buf ", size_t " sz );
 .BI CRC32( result ", " crc ", " buf ", " sz )
 .fi
 .SH DESCRIPTION
@@ -49,11 +49,11 @@ a given block in a way which doesn't change its (unknown) CRC.
 .PP
 The exact behaviour of the CRC is beyond the scope of this manual;
 suffice to say that the result is, in some suitable representation, the
-remainder after division in the finite field GF(2\*(ss32\*(se) of the
-block by a carefully chosen polynomial of order 32.
+remainder after division by a degree-32 polynomial in GF(2)[x].
 .SH "RETURN VALUE"
 The return value is the 32-bit CRC of the input block.
 .SH "SEE ALSO"
+.BR unihash (3),
 .BR mLib (3).
 .SH AUTHOR
-Mark Wooding, <mdw@nsict.org>
+Mark Wooding, <mdw@distorted.org.uk>