Blame README.md

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