NAME

File::Util - Easy, versatile, portable file handling

IMPORTANT!

This is a developer's release, and is not intended for use in the public sector. This code is made available for developers who wish to aid in the furthering of the code, though it _is_ stable.

This is not a registered module in the CPAN module list. It is not part of the CPAN yet.

SYNOPSIS

Nothing here at present.

DESCRIPTION

File::Util provides a comprehensive toolbox of utilities to automate all kinds of common tasks on file / directories. Its purpose is to do so in the most portable manner possible so that users of this module won't have to worry about whether their programs will work on other OSes and machines.

INSTALLATION

To install this module type the following at the command prompt:

perl Makefile.PL
make
make test
make install

On windows machines use nmake rather than make; those running cygwin don't have to worry about this. If you don't know what cygwin is, use nmake and check out <URL: http://cygwin.com/ > after you're done installing this module if you want to find out.

File::Util ISA

Exporter

Class::OOorNO

METHODS

Item's marked with an asterisk (*) are AUTOLOAD-ed methods. (see the AutoLoader documentation.) Item's marked with the dagger symbol (†) are constant subroutines which take no argments and always return the same value.

bitmask( [file name] ) *

Documentation is under way.

can_flock * †

Documentation is under way.

can_read( [file name] )

Documentation is under way.

can_write( [file name] )

Documentation is under way.

created( [file name] ) *

Documentation is under way.

ebcdic * †

Documentation is under way.

escape_filename( [string] ) *

Documentation is under way.

existent( [file name] ) *

Documentation is under way.

file_type( [file name] ) *

Documentation is under way.

flock_rules( [KEYWORDs] ) *

Documentation is under way.

isbin( [file name] ) *

Documentation is under way.

last_access( [file name] ) *

Documentation is under way.

last_mod( [file name] ) *

Documentation is under way.

line_count( [file name] )

Documentation is under way.

list_dir( [directory name] , [--opts] )

Documentation is under way.

load_dir( [directory name] , [--opts] ) *

Documentation is under way.

load_file( [file name] , [--opts] )

Documentation is under way.

make_dir( [new directory name] , [--opts] ) *

Documentation is under way.

max_dives( [integer] ) *

Documentation is under way.

needs_binmode * †

Documentation is under way.

new( [--opts] )

Documentation is under way.

open_handle( [file name] , [--opts] ) *

Documentation is under way.

os * †

Documentation is under way.

readlimit( [integer] ) *

Documentation is under way.

size( [file name] ) *

Documentation is under way.

strip_path( [string] )

Documentation is under way.

trunc( [file name] ) *

Documentation is under way.

use_flock( [true / false value] ) *

Documentation is under way.

write_file('file' => [file name] , 'content' => [data] , [--opts])

Documentation is under way.

valid_filename( [string] )

Documentation is under way.

VERSION †

Documentation is under way.

CONSTANTS

NL

Documentation is under way.

SL

Documentation is under way.

EXPORT

None by default.

EXPORT_OK

bitmask()

can_flock()

can_read()

can_write()

ebcdic()

escape_filename()

existent()

file_type()

isbin()

NL

needs_binmode()

os()

size()

SL

strip_path()

valid_filename()

Symbols in @Class::OOorNO::EXPORT_OK are made available for import...

EXPORT_TAGS

:all (exports all of @File::Util::EXPORT_OK)

PREREQUISITES

Perl 5.006 or better

Class::OOorNO v0.00_2 or better

Exception::Handler v1.00_0 or better

EXAMPLES

None at present.

BUGS

This documentation isn't done yet, as you can see. This is being rectified as quickly as possible. Please excercise caution if you choose to use this code before it can be further documented for you. Please excuse the inconvenience.

AUTHOR

Tommy Butler <cpan@atrixnet.com>

AUTHOR

Tommy Butler <cpan@atrixnet.com>

COPYRIGHT

Copyright(c) 2001-2003, Tommy Butler. All rights reserved.

LICENSE

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

SEE ALSO

Class::OOorNO

Exception::Handler

File::Slurp

Exporter

AutoLoader

cpanm File::Util

perl -MCPAN -e shell
install File::Util