Format::FileSize
================

$Id: README,v 1.3 2003/08/27 19:16:23 mrodrigu Exp $

The README is used to introduce the module and provide instructions on
how to install the module, any machine dependencies it may have (for
example C compilers and installed libraries) and any other information
that should be provided before the module is installed.

A README file is required for CPAN modules since CPAN extracts the
README file from a module distribution so that people browsing the
archive can use it get an idea of the modules uses. It is usually a
good idea to provide version information here so that people can
decide whether fixes for the module are worth downloading.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install


DEPENDENCIES

This module requires these other modules and libraries:

  List::Util
  Scalar::Util (1.10, that's more recent than the one in 5.8.0)
  Memoize
  Carp


DOCUMENTATION

To view the documentation for this module type the following:

   perldoc Format::FileSize
or
  man Format::FileSize

SUMMARY


Format::FileSize is a Perl extension for formating file sizes

Format::FileSize exports one function: formatted_size, which 
takes a size and returns a nicely formated number.

  use Format::FileSize;
  my $size= formatted_size( -s $ARG[0]);
  print "$ARG[0] $size\n";

COPYRIGHT AND LICENCE

Copyright (C) 2003 Michel Rodriguez

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