App::lcpan::Cmd::subs - List subroutines
This document describes version 1.062 of App::lcpan::Cmd::subs (from Perl distribution App-lcpan), released on 2020-08-13.
Usage:
handle_cmd(%args) -> [status, msg, payload, meta]
List subroutines.
This subcommand lists subroutines/methods/static methods.
This function is not exported.
Arguments ('*' denotes required arguments):
authors => array[str]
Filter by author(s) of module.
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
Defaults to ~/cpan.
~/cpan
detail => bool
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.
index_name
index.db
cpan
./index.db
/home/ujang/lcpan.db
or => bool
When there are more than one query, perform OR instead of AND logic.
packages => array[str]
Filter by package name(s).
query => array[str]
Search query.
query_type => str (default: "any")
sort => array[str] (default: ["sub"])
Sort the result.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 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.
To install App::lcpan, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::lcpan
CPAN shell
perl -MCPAN -e shell install App::lcpan
For more information on module installation, please visit the detailed CPAN module installation guide.