pmgrep - Print lines from installed Perl module sources matching a pattern
This document describes version 0.721 of pmgrep (from Perl distribution App-PMUtils), released on 2019-02-24.
Usage:
% pmgrep [options] [pattern] [module] ...
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
* marks required options.
*
If not specified, all installed Perl modules will be searched.
Can be specified multiple times.
See --module.
--module
Whether to include .pmc files.
Whether to include .pod files.
See --regexp.
--regexp
Alias for -e.
Valid values:
["never","always","auto"]
Supress normal output, return a count of matching lines.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Require all patterns to match, instead of just one.
Invert the sense of matching.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C pmgrep pmgrep
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete pmgrep 'p/*/`pmgrep`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
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) 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.