|
Packit Service |
a275fa |
=head1 NAME
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
String::CRC32 - Perl interface for cyclic redundancy check generation
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
=head1 SYNOPSIS
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
use String::CRC32;
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
$crc = crc32("some string");
|
|
Packit Service |
a275fa |
$crc = crc32("some string", initvalue);
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
$somestring = "some string";
|
|
Packit Service |
a275fa |
$crc = crc32($somestring);
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
open(SOMEFILE, "location/of/some.file");
|
|
Packit Service |
a275fa |
binmode SOMEFILE;
|
|
Packit Service |
a275fa |
$crc = crc32(*SOMEFILE);
|
|
Packit Service |
a275fa |
close(SOMEFILE);
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
=head1 DESCRIPTION
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
The B<CRC32> module calculates CRC sums of 32 bit lengths.
|
|
Packit Service |
a275fa |
It generates the same CRC values as ZMODEM, PKZIP, PICCHECK and
|
|
Packit Service |
a275fa |
many others.
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
Despite its name, this module is able to compute
|
|
Packit Service |
a275fa |
the checksum of files as well as strings.
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
=head1 EXAMPLES
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
$crc = crc32("some string");
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
results in the same as
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
$crc = crc32(" string", crc32("some"));
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
This is useful for subsequent CRC checking of substrings.
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
You may even check files:
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
open(SOMEFILE, "location/of/some.file");
|
|
Packit Service |
a275fa |
binmode SOMEFILE;
|
|
Packit Service |
a275fa |
$crc = crc32(*SOMEFILE);
|
|
Packit Service |
a275fa |
close(SOMEFILE);
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
A init value may also have been supplied in the above example.
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
=head1 AUTHOR
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
Soenke J. Peters <peters__perl@opcenter.de>
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
Current maintainer: LEEJO
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
Address bug reports and comments to: L<https://github.com/leejo/string-crc32/issues>
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
=head1 LICENSE
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
CRC algorithm code taken from CRC-32 by Craig Bruce.
|
|
Packit Service |
a275fa |
The module stuff is inspired by a similar perl module called
|
|
Packit Service |
a275fa |
String::CRC by David Sharnoff & Matthew Dillon.
|
|
Packit Service |
a275fa |
Horst Fickenscher told me that it could be useful to supply an init
|
|
Packit Service |
a275fa |
value to the crc checking function and so I included this possibility.
|
|
Packit Service |
a275fa |
|
|
Packit Service |
a275fa |
The author of this package disclaims all copyrights and
|
|
Packit Service |
a275fa |
releases it into the public domain.
|