- COPYRIGHT AND LICENSE
pmlist - List Perl modules (and PODs, and module prefixes)
This document describes version 0.734 of pmlist (from Perl distribution App-PMUtils), released on 2020-06-12.
% pmlist Text::
% pmlist Module::P* % pmlist Module/P** % pmlist **::Tiny
This is basically a CLI interface to PERLANCAR::Module::List, with tab completion.
* marks required options.
- --detail, -l
Return detailed records instead of just module names.
- --recurse, -R
- --with-path, -x
Instead of module names, return module paths instead.
Only list core modules.
Only search in core directories.
Do not include "." in search dir.
By default, Perl usually adds `.` (the current directory) in the search dir. This option removes it.
List .pod files.
Alias for --no-core.
List prefixes (dirs).
Only list XS modules.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Filter output through a pager.
View output using a viewer.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C pmlist pmlist
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 pmlist 'p/*/`pmlist`/'
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.
This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015, 2014 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.