NAME
pmgrep - Print lines from installed Perl module sources matching a pattern
VERSION
This document describes version 0.738 of pmgrep (from Perl distribution App-PMUtils), released on 2021-12-03.
SYNOPSIS
Usage:
% pmgrep [--all] [--color=str] [--count|-c] [--dash-prefix-inverts|--no-dash-prefix-inverts|--nodash-prefix-inverts] [--debug|--log-level=level|--quiet|--trace|--verbose] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--invert-match|-v|--no-invert-match|--noinvert-match] [--line-number|-n] [(--module=perl::modnames)+] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--pm|--no-pm|--nopm] [--pmc|--no-pmc|--nopmc] [--pod|--no-pod|--nopod] [--quiet-arg] [--recursive|-r] [(--regexp=str)+] [--modules-json=json] [--regexps-json=json|(-e=str)+] [-q|--silent] -- [pattern] [module] ...
DESCRIPTION
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.
Examples:
# Find pre-increment in all Perl module files
% pmgrep '\+\+\$'
# Find some pattern in all Data::Sah::Coerce::* modules (note ** wildcard for recursing)
% pmgrep 'return ' Data::Sah::Coerce::**OPTIONS
* marks required options.
Main options
- --module=s@
-
If not specified, all installed Perl modules will be searched.
Can also be specified as the 2nd command-line argument and onwards.
Can be specified multiple times.
- --modules-json=s
-
See
--module.Can also be specified as the 2nd command-line argument and onwards.
- --no-pm
- --pattern=s
-
Can also be specified as the 1st command-line argument.
- --pmc
-
Whether to include .pmc files.
- --pod
-
Whether to include .pod files.
- --recursive, -r
- --regexp=s@
-
Can be specified multiple times.
- --regexps-json=s
-
See
--regexp. - -e=s@
-
Alias for --regexp.
See
--regexp.Can be specified multiple times.
General output control options
- --color=s
-
Default value:
"auto"Valid values:
["never","always","auto"] - --count, -c
-
Supress normal output, return a count of matching lines.
- --quiet-arg, --silent, -q
Logging options
- --debug
-
Shortcut for --log-level=debug.
- --log-level=s
-
Set log level.
- --quiet
-
Shortcut for --log-level=error.
- --trace
-
Shortcut for --log-level=trace.
- --verbose
-
Shortcut for --log-level=info.
Matching control options
- --all
-
Require all patterns to match, instead of just one.
- --dash-prefix-inverts
-
When given pattern that starts with dash "-FOO", make it to mean "^(?!.*FOO)".
This is a convenient way to search for lines that do not match a pattern. Instead of using `-v` to invert the meaning of all patterns, this option allows you to invert individual pattern using the dash prefix, which is also used by Google search and a few other search engines.
- --ignore-case, -i
- --invert-match, -v
-
Invert the sense of matching.
Output line prefix control options
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By 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] - --page-result
-
Filter output through a pager.
- --view-result
-
View output using a viewer.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C pmgrep pmgrepin 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.
tcsh
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).
other shells
For fish and zsh, install shcompgen as described above.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-PMUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-PMUtils.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -lIf you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014 by perlancar <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.
BUGS
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.