App::lcpan::Cmd::mentions_for_mod - List POD mentions for module(s)
This document describes version 1.068 of App::lcpan::Cmd::mentions_for_mod (from Perl distribution App-lcpan), released on 2021-06-05.
handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]
List POD mentions for module(s).
This subcommand is a shortcut for:
% lcpan mentions --type known-module --mentioned-module <module1> [module2] ...
This searches PODs that mention either
module2, and so on. To search for PODs that mention all of the modules, see the
This function is not exported.
Arguments ('*' denotes required arguments):
added_or_updated_since => date
Include only records that are added/updated since a certain date.
added_or_updated_since_last_index_update => true
Include only records that are added/updated since the last index update.
added_or_updated_since_last_n_index_updates => posint
Include only records that are added/updated since the last N index updates.
added_since => date
Include only records that are added since a certain date.
added_since_last_index_update => true
Include only records that are added since the last index update.
added_since_last_n_index_updates => posint
Include only records that are added since the last N index updates.
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
index_name => filename (default: "index.db")
Filename of index.
index_nameis a filename without any path, e.g.
index.dbthen index will be located in the top-level of
index_namecontains a path, e.g.
/home/ujang/lcpan.dbthen the index will be located solely using the
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.
modules* => array[perl::modname]
updated_since => date
Include only records that are updated since certain date.
updated_since_last_index_update => true
Include only records that are updated since the last index update.
updated_since_last_n_index_updates => posint
Include only records that are updated since the last N index updates.
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)
Please visit the project's homepage at https://metacpan.org/release/App-lcpan.
Source repository is at https://github.com/perlancar/perl-App-lcpan.
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.
This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015 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.