Getopt::Long::More::Util - Utilities for Getopt::Long::More
This document describes version 0.001 of Getopt::Long::More::Util (from Perl distribution Getopt-Long-More-Util), released on 2016-12-03.
Detect whether a file is a Getopt::Long::More-based CLI script.
The criteria are:
the file must exist and readable;
(optional, if include_noexec is false) file must have its executable mode bit set;
content must start with a shebang #!;
either: must be perl script (shebang line contains 'perl') and must contain something like use Getopt::Long::More;
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
filename => str
Path to file to be checked.
include_noexec => bool (default: 1)
Include scripts that do not have +x mode bit set.
string => buf
Content to be checked.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/Getopt-Long-More-Util.
Source repository is at https://github.com/perlancar/perl-Getopt-Long-More-Util.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Getopt-Long-More-Util
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.
This software is copyright (c) 2016 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Getopt::Long::More::Util, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.