NAME

EBook::Ishmael - Convert ebook documents to plain text

SYNOPSIS

use EBook::Ishmael;

my $ishmael = EBook::Ishmael->init();
$ishmael->run();

DESCRIPTION

EBook::Ishmael is the workhorse module for ishmael. If you're looking for user documentation, you should consult its manual instead of this (this is developer documentation).

METHODS

$i = EBook::Ishmael->init()

Reads @ARGV and returns a blessed EBook::Ishmael object. Consult the manual for ishmael for a list of options that are available.

$i->text()

Dumps ebook file to text, default run mode.

$i->meta()

Dumps ebook metadata, --metadata mode.

$i->meta_json()

Dumps ebook metadata in JSON form, --meta-json mode.

$i->id()

Identify the format of the given ebook, --identify mode.

$i->html()

Dump the HTML-ified contents of a given ebook, --html mode.

$i->run()

Runs ishmael based on the parameters processed during init().

AUTHOR

Written by Samuel Young, <samyoung12788@gmail.com>.

This project's source can be found on its Codeberg Page. Comments and pull requests are welcome!

COPYRIGHT

Copyright (C) 2025 Samuel Young

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SEE ALSO

ishmael