chiark / gitweb /
Update manual style.
[mLib] / man / crc32.3
index 911cf5f294c8a5bdcf3caac91a3ced2dfef6ce31..c9e34ba611aa31f30becacfe23ec38122e778f85 100644 (file)
@@ -1,12 +1,21 @@
 .\" -*-nroff-*-
-.TH crc32 3mLib "8 May 1999" "mLib"
+.ie t \{\
+.  ds ss \s8\u
+.  ds se \d\s0
+.\}
+.el \{\
+.  ds ss ^
+.  ds se
+.\}
+.TH crc32 3 "8 May 1999" "Straylight/Edgeware" "mLib utilities library"
 .SH NAME
 crc32 \- calculate 32-bit CRC
+.\" @crc32
 .SH SYNOPSIS
 .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
@@ -40,9 +49,10 @@ 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^32) 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 mLib (3).
 .SH AUTHOR
 Mark Wooding, <mdw@nsict.org>