/ 
Filename-Ebook-0.002
River stage one • 3 direct dependents • 3 total dependents
/ Filename::Ebook

NAME

Filename::Ebook - Check whether filename indicates being an e-book

VERSION

This document describes version 0.002 of Filename::Ebook (from Perl distribution Filename-Ebook), released on 2023-12-15.

SYNOPSIS

use Filename::Ebook qw(check_ebook_filename);
my $res = check_ebook_filename(filename => "how not to die.pdf");
if ($res) {
    print "Filename indicates an ebook\n",
} else {
    print "Filename does not indicate an ebook\n";
}

DESCRIPTION

FUNCTIONS

check_ebook_filename

Usage:

check_ebook_filename(%args) -> any

Check whether filename indicates being an e-book.

Examples:

  • Example #1:

    check_ebook_filename(filename => "foo.bar"); # -> 0

  • Example #2:

    check_ebook_filename(filename => "baz.epub"); # -> {}

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • filename* => str

    (No description)

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Filename-Ebook.

SOURCE

Source repository is at https://github.com/perlancar/perl-Filename-Ebook.

SEE ALSO

Other Filename::*, e.g. Filename::Image or Filename::Video

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2020 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Filename-Ebook

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.