NAME
Filename::Executable - Check whether filename indicates being an
executable program/script
VERSION
This document describes version 0.002 of Filename::Executable (from Perl
distribution Filename-Executable), released on 2023-12-16.
SYNOPSIS
use Filename::Executable qw(check_executable_filename);
my $res = check_executable_filename(filename => "foo.sh");
if ($res) {
printf "File is an executable (type: %s, ext: %s)\n",
$res->{exec_type},
$res->{exec_ext};
} else {
print "File is not an executable\n";
}
DESCRIPTION
FUNCTIONS
check_executable_filename
Usage:
check_executable_filename(%args) -> bool|hash
Check whether filename indicates being an executable program/script.
Examples:
* Example #1:
check_executable_filename(filename => "foo.pm"); # -> 0
* Example #2:
check_executable_filename(filename => "foo.appimage");
Result:
{ exec_ext => ".appimage", exec_name => "foo", exec_type => "appimage" }
* Case-insensitive by default:
check_executable_filename(filename => "foo.Appimage");
Result:
{ exec_ext => ".Appimage", exec_name => "foo", exec_type => "appimage" }
* Case-sensitive:
check_executable_filename(filename => "foo.Appimage", ignore_case => 0); # -> 0
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
* filename* => *str*
(No description)
* ignore_case => *bool* (default: 1)
Whether to match case-insensitively.
Return value: (bool|hash)
Return false if no archive suffixes detected. Otherwise return a hash of
information, which contains these keys: "exec_type", "exec_ext",
"exec_name".
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/Filename-Executable>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-Filename-Executable>.
SEE ALSO
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 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-Executable>
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.