App::lcpan::Cmd::mentions - List mentions
This document describes version 1.062 of App::lcpan::Cmd::mentions (from Perl distribution App-lcpan), released on 2020-08-13.
handle_cmd(%args) -> [status, msg, payload, meta]
This subcommand lists mentions (references to modules/scripts in POD files inside releases).
Only mentions to modules/scripts in another release are indexed (i.e. mentions to modules/scripts in the same dist/release are not indexed). Only mentions to known scripts are indexed, but mentions to unknown modules are also indexed.
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.
mentioned_modules => array[str]
Filter by module name(s) being mentioned.
mentioned_scripts => array[str]
Filter by script name(s) 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.
type => str (default: "any")
Filter by type of things being mentioned.
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) 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)
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) 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.