/ 
App-lcpan-CmdBundle-weaver-0.031
River stage one • 1 direct dependent • 1 total dependent
/ App::lcpan::Cmd::weaver_role

NAME

App::lcpan::Cmd::weaver_role - Show a single Pod::Weaver role

VERSION

This document describes version 0.031 of App::lcpan::Cmd::weaver_role (from Perl distribution App-lcpan-CmdBundle-weaver), released on 2020-01-19.

DESCRIPTION

This module handles the lcpan subcommand weaver-role.

FUNCTIONS

handle_cmd

Usage:

handle_cmd(%args) -> [status, msg, payload, meta]

Show a single Pod::Weaver role.

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 of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.

  • 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.

  • weaver_role* => perl::modname

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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-lcpan-CmdBundle-weaver.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-lcpan-CmdBundle-weaver.

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2017, 2016 by 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.