NAME
App::lcpan::Cmd::metacpan_script - Open script POD on MetaCPAN
VERSION
This document describes version 0.008 of App::lcpan::Cmd::metacpan_script (from Perl distribution App-lcpan-CmdBundle-metacpan), released on 2022-03-27.
DESCRIPTION
This module handles the lcpan subcommand metacpan-script
.
FUNCTIONS
handle_cmd
Usage:
handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]
Open script POD on MetaCPAN.
This will open Chttps://metacpan.org/pod/SCRIPTNAME. SCRIPTNAME
will be first checked for existence in local index database.
This function is not exported.
Arguments ('*' denotes required arguments):
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
Defaults to
~/cpan
.index_name => filename (default: "index.db")
Filename of index.
If
index_name
is a filename without any path, e.g.index.db
then index will be located in the top-level ofcpan
. Ifindex_name
contains a path, e.g../index.db
or/home/ujang/lcpan.db
then the index will be located solely using theindex_name
.scripts* => array[filename::unix]
use_bootstrap => bool (default: 1)
Whether to use bootstrap database from App-lcpan-Bootstrap.
If you are indexing your private CPAN-like repository, you want to turn this off.
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-lcpan-CmdBundle-metacpan.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-lcpan-CmdBundle-metacpan.
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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2019, 2018, 2017 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=App-lcpan-CmdBundle-metacpan
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.