SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from Fedora 28 perl-CPAN-Checksums-2.12-5.fc28.noarch.rpm

CPAN::Checksums

Section: User Contributed Perl Documentation (3)
Updated: 2016-06-14
Index 

NAME

CPAN::Checksums - Write a "CHECKSUMS" file for a directory as on CPAN 

SYNOPSIS

  use CPAN::Checksums qw(updatedir);  my $success = updatedir($directory);
 

INCOMPATIBILITY ALERT

Since version 1.0 the generation of the attribute "shortname" isturned off by default. It was too slow and was not used as far as Iknow, and above all, it could fail on large directories. The shortnamefeature can still be turned on by setting the global variable$TRY_SHORTNAME to a true value. 

DESCRIPTION

$success = updatedir($dir)
"updatedir()" takes a directory name as argument and writes a typical"CHECKSUMS" file in that directory as used on CPAN unless a previouslywritten "CHECKSUMS" file is there that is still valid. Returns 2 if anew "CHECKSUMS" file has been written, 1 if a valid "CHECKSUMS" file isalready there, otherwise dies.

Note: since version 2.0 updatedir on empty directories behaves justthe same. In older versions it silently did nothing.

 

Global Variables in package CPAN::Checksums

$IGNORE_MATCH
If the global variable $IGNORE_MATCH is set, then all files matchingthis expression will be completely ignored and will not be included inthe CPAN "CHECKSUMS" files. Per default this variable is set to

    qr{(?i-xsm:readme$)}
$CAUTION
Setting the global variable $CAUTION causes updatedir() to reportchanges of files in the attributes "size", "mtime", "md5", or"md5-ungz" to STDERR.
$TRY_SHORTNAME
By setting the global variable $TRY_SHORTNAME to a true value, you cantell updatedir() to include an attribute "shortname" in the resultinghash that is 8.3-compatible. Please note, that updatedir() in thiscase may be slow and may even fail on large directories, because itwill always only try 1000 iterations to find a name that is not yettaken and then give up.
$SIGNING_KEY
Setting the global variable $SIGNING_KEY makes the generated "CHECKSUMS"file to be clear-signed by the command specified in $SIGNING_PROGRAM(defaults to "gpg --clearsign --default-key "), passing the signingkey as an extra argument. The resulting "CHECKSUMS" file should look like:

    0&&<<''; # this PGP-signed message is also valid perl    -----BEGIN PGP SIGNED MESSAGE-----    Hash: SHA1    # CHECKSUMS file written on ... by CPAN::Checksums (v...)    $cksum = {        ...    };    __END__    -----BEGIN PGP SIGNATURE-----    ...    -----END PGP SIGNATURE-----

note that the actual data remains intact, but two extra lines areadded to make it legal for both OpenPGP and perl syntax.

$MIN_MTIME_CHECKSUMS
If the global variable $MIN_MTIME_CHECKSUMS is set, then updatedirwill renew signatures on checksum files that have an older mtime thanthe given value.
 

PREREQUISITES

DirHandle, IO::File, Digest::MD5, Digest::SHA, Compress::Bzip2,Compress::Zlib, File::Spec, Data::Dumper, Data::Compare, File::Temp 

BUGS

If updatedir is interrupted, it may leave a temporary file lyingaround. These files have the File::Temp template "CHECKSUMS.XXXX" andshould be harvested by a cronjob. 

AUTHOR

Andreas Koenig, andreas.koenigAATTanima.de; GnuPG support by Autrijus Tang 

COPYRIGHT & LICENSE

Copyright (c) 2002-2008 Andreas Koenig, Audrey Tang, Steve Peters.

This program is free software; you can redistribute it and/ormodify it under the same terms as Perl itself. 

SEE ALSO

perl(1).


 

Index

NAME
SYNOPSIS
INCOMPATIBILITY ALERT
DESCRIPTION
Global Variables in package CPAN::Checksums
PREREQUISITES
BUGS
AUTHOR
COPYRIGHT & LICENSE
SEE ALSO

This document was created byman2html,using the manual pages.