++ed by:
DMOL MELO BEROV

3 PAUSE users
4 non-PAUSE users.

perlancar

NAME

App::lcpan::Cmd::mentions_for_script - List POD mentions for script(s)

VERSION

This document describes version 1.032 of App::lcpan::Cmd::mentions_for_script (from Perl distribution App-lcpan), released on 2019-01-09.

FUNCTIONS

handle_cmd

Usage:

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

List POD mentions for script(s).

This subcommand is a shortcut for:

 % lcpan mentions --type script --mentioned-script SCRIPT

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.

  • mentioned_authors => array[str]

    Filter by author(s) of module/script being mentioned.

  • mentioner_authors => array[str]

    Filter by author(s) of POD that does the mentioning.

  • mentioner_authors_arent => array[str]

  • mentioner_modules => array[str]

    Filter by module(s) that do the mentioning.

  • mentioner_scripts => array[str]

    Filter by script(s) that do the mentioning.

  • scripts* => array[str]

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

SOURCE

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

BUGS

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

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) 2019, 2018, 2017, 2016, 2015 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.