1Digest::CRC version 0.21
2========================
3
4NAME
5    Digest::CRC - Generic CRC functions
6
7DESCRIPTION
8    The Digest::CRC module calculates CRC sums of all sorts.  It contains
9    wrapper functions with the correct parameters for CRC-CCITT, CRC-16 and
10    CRC-32.
11
12SYNOPSIS
13    # Functional style
14
15    use Digest::CRC qw(crc32 crc16 crcccitt crc);
16    $crc = crc32("123456789");
17    $crc = crc16("123456789");
18    $crc = crcccitt("123456789");
19
20    $crc = crc($input,$width,$init,$xorout,$poly,$refin,$refout);
21
22    # OO style
23    use Digest::CRC;
24
25    $ctx = Digest::CRC->new(type=>"crc16");
26    $ctx = Digest::CRC->new(width=>16, init=>0x0000, xorout=>0x0000,
27                            poly=>0x8005, refin=>1, refout=>1);
28    $ctx->add($data);
29    $ctx->addfile(*FILE);
30
31    $digest = $ctx->digest;
32    $digest = $ctx->hexdigest;
33    $digest = $ctx->b64digest;
34
35INSTALLATION
36
37To install this module type the following:
38
39   perl Makefile.PL
40   make
41   make test
42   make install
43
44COPYRIGHT AND LICENCE
45   CRC algorithm code taken from "A PAINLESS GUIDE TO CRC ERROR DETECTION
46   ALGORITHMS".
47
48   The author of this package disclaims all copyrights and releases it
49   into the public domain.
50