Zed Pobre > EBook-Tools-v0.4.9 > EBook::Tools::MSReader

Download:
EBook-Tools-v0.4.9.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  2
View/Report Bugs
Module Version: v0.4.8   Source  

NAME ^

EBook::Tools::MSReader - Helper code for working with Microsoft Reader (.lit) e-books.

SYNOPSIS ^

 use EBook::Tools::MSReader qw(find_convertlit find_convertlit_keys
                               system_convertlit);
 $EBook::Tools::MSReader::convertlit_cmd = '/opt/convertlit/clit';
 $EBook::Tools::MSReader::convertlit_keys = '/opt/convertlit/keys.txt';

 my $convertlit = find_convertlit();
 my $keyfile = find_convertlit_keys();
 system_convertlit(infile => 'myfile.lit',
                   dir => 'myfile-unpacked');

PROCEDURES ^

All procedures are exportable, but none are exported by default.

find_convertlit()

Attempts to locate the convertlit executable by making a test execution on predicted locations (including just checking PATH) and looking in the EBook::Tools user configuration directory (see "userconfigdir()" in EBook::Tools.

Returns the system command used for a successful invocation, or undef if nothing worked.

This will use package variable $convertlit_cmd as its first guess, and set that variable to the return value as well.

find_convertlit_keys($filename)

Attempts to locate the convertlit keys.txt file by checking predicted filenames, both in the current working directory and in the EBook::Tools user configuration directory (see "userconfigdir()" in EBook::Tools.

If $filename is provided, the file basename-keys.txt will also be checked in both locations.

Returns the name of the first file found, or undef if nothing was found.

This will use package variable $convertlit_keys as its first guess, and set that variable to the return value as well.

system_convertlit(%args)

Runs convertlit to extract or downconvert a MS Reader .lit file. The procedures find_convertlit() and find_convertlit_keys() are both called to locate necessary helper files.

Returns the return value from convertlit, or undef if convertlit or the input file could not be found, or neither output file nor directory is specified.

Arguments

BUGS AND LIMITATIONS ^

AUTHOR ^

Zed Pobre <zed@debian.org>

LICENSE AND COPYRIGHT ^

Copyright 2008 Zed Pobre

Licensed to the public under the terms of the GNU GPL, version 2.

ConvertLIT (not included) is copyright 2002, 2003 Dan A. Jackson, and licensed under the terms of the GNU GPL, version 2 or later.

syntax highlighting: