directories

NAME
SYNOPSIS
DESCRIPTION
METHODS
SEE ALSO
AUTHOR
COPYRIGHT AND LICENSE

NAME

SYNOPSIS

  use File::Set;

  $FS = File::Set->new();

  # Add directories (and implicitly all files and sub-dirs) to file set
  $FS->add('/etc');
  $FS->add('/usr/lib', '/usr/include');
  # Add files in directory (not recursive);
  $FS->add({ recurse => 0 }, '/usr/local/bin');

  # Exclude particular files/directories
  $FS->exclude('/usr/include/linux', '/etc/shadow');

  # Add/exclude from file (see below for file format)
  $FS->add_from_file('/tmp/config');

  # List files, calling callback for each dir/file
  $FS->list(\&callback);

  # Save a list of checksums for all files/directories
  $FS->save_checksum_db('/tmp/checksumdb');

  # Compare a list against a previously saved checksum db
  #  and call callback for added/deleted/changed files
  $FS->compare_checksum_db('/tmp/checksumdb', \&callback)

DESCRIPTION

This module is designed to build and manipulate a set of files from a list of input directories and files. You can specify whether directories should be recursed or not, or specific sub-directories ignored.

METHODS

new(): Create a new fileset object. Any parameters are passed straight to the add() method
prefix($path): Sets a path 'prefix' that's prepended to all paths before they are used.
add([ $Opts ], $path1, $Path2, ...): Add the given paths to the file set.; $Opts is an option hash-reference of options.
exclude([ $Opts ], $path1, $Path2, ...): Exclude the given paths from the file set.; Like calling add() with the exclude option set to true
add_from_file($file): Open the given file and add the paths to the fileset; The file can have:
get_path_list(): Return an array of all paths added/excluded; Each item as an array-ref of 2 items. The first item is the path and the second item is the hash-ref of options
canon_path($path1, $Path2, ...): Cleanup the given paths to a consistent form
list($Context, $Callback, $ErrorHandler): The main method call. Iterates through all dirs, sub-dirs and files added through add() but not excluded through exclude(); For each file/directory calls code-ref $Callback passing $Context as the first parameter. Additional parameters are:
save_checksum_db($DbFile): Uses the list() method to iterate through added paths, and outputs a checksum of information about all dirs/files to $DbFile.; For all files this includes mode, gid, uid, size. For files this also includes the md5 checksum.; Can be used for the c<compare_checksum_db()> call below
compare_checksum_db($DbFile, $Context, $Callback): Uses the list() method to iterate through added paths, and compares to the contents of the $DbFile file. If any files or directories have changed, calls the $Callback code-ref with $Context as the first parameter. Additional parameters are:
create_gnu_tar($TarFile): Create a tar file containing the added paths; Correctly creates .tar.gz and .tar.bz2 files

AUTHOR

Rob Mueller <mailto:cpan@robm.fastmail.fm>

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.