Filesys::DiskUsage version 0.04 =============================== =head1 NAME Filesys::DiskUsage - Estimate file space usage (similar to `du`) =head1 SYNOPSIS use Filesys::DiskUsage qw/du/; # basic $total = du(qw/file1 file2 directory1/); or # no recursion $total = du( { recursive => 0 } , <*> ); or # max-depth is 1 $total = du( { 'max-depth' => 1 } , <*> ); or # get an array @sizes = du( @files ); or # get a hash %sizes = du( { 'make-hash' => 1 }, @files_and_directories ); =head1 FUNCTIONS =head2 du Estimate file space usage. Get the size of files: $total = du(qw/file1 file2/); Get the size of directories: $total = du(qw/file1 directory1/); =head3 OPTIONS =over 6 =item dereference Follow symbolic links. Default is 0. Overrides C<symlink-size>. Get the size of a directory, recursively, following symbolic links: $total = du( { dereference => 1 } , $dir ); =item exclude => PATTERN Exclude files that match PATTERN. Get the size of every file except for dot files: $total = du( { exclude => qr/^\./ } , @files ); =item human-readable Return sizes in human readable format (e.g., 1K 234M 2G) $total = du ( { 'human-readable' => 1 } , @files ); =item Human-readable Return sizes in human readable format, but use powers of 1000 instead of 1024. $total = du ( { 'Human-readable' => 1 } , @files ); =item make-hash Return the results in a hash. %sizes = du( { 'make-hash' => 1 } , @files ); =item max-depth Sets the max-depth for recursion. A negative number means there is no max-depth. Default is -1. Get the size of every file in the directory and immediate subdirectories: $total = du( { 'max-depth' => 1 } , <*> ); =item recursive Sets whether directories are to be explored or not. Set to 0 if you don't want recursion. Default is 1. Overrides C<max-depth>. Get the size of every file in the directory, but not directories: $total = du( { recursive => 0 } , <*> ); =item sector-size => NUMBER All file sizes are rounded up to a multiple of this number. Any file that is not an exact multiple of this size will be treated as the next multiple of this number as they would in a sector-based file system. Common values will be 512 or 1024. Default is 1 (no sectors). $total = du( { sector-size => 1024 }, <*> ); =item symlink-size => NUMBER Symlinks are assumed to be this size. Without this option, symlinks are ignored unless dereferenced. Setting this option to 0 will result in the files showing up in the hash, if C<make-hash> is set, with a size of 0. Setting this option to any other number will treat the size of the symlink as this number. This option is ignored if the C<dereference> option is set. $total = du( { symlink-size => 1024, sector-size => 1024 }, <*> ); =item truncate-readable => NUMBER Human readable formats decimal places are truncated by the value of this option. A negative number means the result won't be truncated at all. Default if 2. Get the size of a file in human readable format with three decimal places: $size = du( { 'human-readable' => 1 , 'truncate-readable' => 3 } , $file); =back =head1 AUTHOR Jose Castro, C<< <cog@cpan.org> >> =head1 BUGS Please report any bugs or feature requests to C<bug-disk-usage@rt.cpan.org>, or through the web interface at L<http://rt.cpan.org>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 COPYRIGHT & LICENSE Copyright 2004 Jose Castro, All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.