NAME

App::lcpan::Cmd::mentions_by_mod - List POD mentions by module(s)

VERSION

This document describes version 1.018 of App::lcpan::Cmd::mentions_by_mod (from Perl distribution App-lcpan), released on 2017-06-17.

FUNCTIONS

handle_cmd

Usage:

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

List POD mentions by module(s).

This subcommand is a shortcut for:

 % lcpan mentions --mentioner-module MOD

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.

• mentioned_authors => array[str]

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

• mentioned_modules => array[str]

  Filter by module name(s) being mentioned.

• mentioned_scripts => array[str]

  Filter by script name(s) being mentioned.

• modules* => array[perl::modname]

• type => str (default: "any")

  Filter by type of things being mentioned.

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)

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