App::pmgrep - Print lines from installed Perl module sources matching a pattern
This document describes version 0.732 of App::pmgrep (from Perl distribution App-PMUtils), released on 2020-05-02.
Usage:
pmgrep(%args) -> [status, msg, payload, meta]
Print lines from installed Perl module sources matching a pattern.
This is a like the Unix command grep but instead of specifying filenames, you specify module names or prefixes. The utility will search module source files from Perl's @INC.
@INC
This function is not exported.
Arguments ('*' denotes required arguments):
all => true
Require all patterns to match, instead of just one.
color => str
count => true
Supress normal output, return a count of matching lines.
ignore_case => bool
invert_match => bool
Invert the sense of matching.
line_number => true
modules => array[perl::modname_or_prefix]
If not specified, all installed Perl modules will be searched.
pattern => re
pm => bool (default: 1)
Whether to include .pm files.
pmc => bool
Whether to include .pmc files.
pod => bool
Whether to include .pod files.
quiet => true
recursive => true
regexps => array[re]
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-PMUtils.
Source repository is at https://github.com/perlancar/perl-App-PMUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PMUtils
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, 2014 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::PMUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PMUtils
CPAN shell
perl -MCPAN -e shell install App::PMUtils
For more information on module installation, please visit the detailed CPAN module installation guide.