NAME

Karma::File - manipulation of karma file bases


FUNCTIONS

describe()

eg. Karma::File->describe( File => 'foo', In => 'bar/', As => $arrayref );

This function will alter the description of File to match the array of lines referenced by $arrayref.

set_stats()

eg. Karma::File->set_stats( File => 'foo', In => 'bar', To => { foobar => 1 } );

A call to set_stats will replace the statistics information for File with To.

move_raw()

eg. Karma::File->move_raw( File => 'foo', To => 'bar' );

Move an individual file (desc and stat will be out of sync) This function is just like the unix tool mv.

place()

eg. Karma::File->place( File => 'foo', In => 'bar' );

This routine is used to install new entries into the karma file bases. It will automatically extract and install a description for the file, as well as build its initial statistics.

get_description()

eg. Karma::File->get_description( 'foo' );

If the given file happens to be an archive of a supported type, its common description will be returned as a reference to an array of lines.

Current supported archive types include:

Any type of tarball
PC Style zip files.

This function looks in the archive for files commonly known to some type of description or information about the archive.

Theses files include:

file_id.diz
.lsm
readme(.txt)
changes
changelog
news

Obviously, not all of these files are entirely useful. Therefore they are preferred in the order listed in this document.