pmless - Show Perl module source code with `less`
This document describes version 0.32 of pmless (from Perl distribution App-PMUtils), released on 2014-12-04.
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
You can also install App::BashCompletionProg which makes it easy to add completion for Perinci::CmdLine-based scripts. After you install the module and put . ~/.bash-complete-prog (or . /etc/bash-complete-prog), you can just run bash-completion-prog and the complete command will be added to your ~/.bash-completion-prog. Your next shell session will then recognize tab completion for the command.
. ~/.bash-complete-prog
. /etc/bash-complete-prog
bash-completion-prog
complete
~/.bash-completion-prog
To activate fish completion for this script, execute:
begin; set -lx COMP_SHELL fish; set -lx COMP_MODE gen_command; pmless; end > $HOME/.config/fish/completions/pmless.fish
Or if you want to install globally, you can instead write the generated script to /etc/fish/completions/pmless.fish or /usr/share/fish/completions/pmless.fish. The exact path might be different on your system. Please check your fish_complete_path variable.
/etc/fish/completions/pmless.fish
/usr/share/fish/completions/pmless.fish
fish_complete_path
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
To activate zsh completion for this script, put:
_pmless() { read -l; local cl="$REPLY"; read -ln; local cp="$REPLY"; reply=(`COMP_SHELL=zsh COMP_LINE="$cl" COMP_POINT="$cp" pmless`) } compctl -K _pmless pmless
in your zsh startup (e.g. ~/.zshrc). 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.
~/.zshrc
Please visit the project's homepage at https://metacpan.org/release/App-PMUtils.
Source repository is at https://github.com/sharyanto/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) 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.