pmless - Show Perl module source code with `less`
This document describes version 0.48 of pmless (from Perl distribution App-PMUtils), released on 2015-08-17.
Basic usage:
% pmless Some::Module
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C pmless pmless
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.
~/.bashrc
It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
shcompgen
To activate tcsh completion for this script, put:
complete pmless 'p/*/`pmless`/'
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Specify additional command-line options
This script can read configuration file, which by default is searched at ~/.config/pmless.conf, ~/pmless.conf or /etc/pmless.conf (can be changed by specifying --config-path). All found files will be read and merged.
~/.config/pmless.conf
~/pmless.conf
/etc/pmless.conf
--config-path
To disable searching for configuration files, pass --no-config.
--no-config
Configuration file is in the format of IOD, which is basically INI with some extra features.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
--config-profile SOMENAME
List of available configuration parameters:
format (see --format) module (see --module) naked_res (see --naked-res)
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) 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.
* marks required options.
*
{en_US Set path to configuration file}.
Can be specified multiple times.
{en_US Set configuration profile to use}.
{en_US Do not use any configuration file}.
{en_US Do not read environment for default options}.
{en_US Choose output format, e.g. json, text}.
Default value:
undef
{en_US Set output format to json}.
{en_US When outputing as JSON, strip result envelope}.
0
{en_US 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] }
{en_US Display help message and exit}.
{en_US Display program's version and exit}.
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.