NAME
manwrap-pm - Wrapper and completer for man (extra Perl stuffs)
VERSION
This document describes version 0.005 of manwrap-pm (from Perl distribution App-manwrap-pm), released on 2019-07-24.
SYNOPSIS
To install, install this module and then in your bash (and/or bash startup file):
% alias man='manwrap-pm'
% complete -C manwrap-pm manor, you can use shcompgen to do that for you automatically.
Now man can also accept and complete Perl module names, à la pmman:
% man tex/wr<tab>
% man Text/Wrap _DESCRIPTION
I made this wrapper because I like using pmman for completing Perl module names and reading Perl module documentation:
% pmman tex/wr<tab>
% pmman Text/Wrap _but often, due to years of muscle memory, find myself already typing man as the command:
% man _Thus, this wrapper manwrap-pm (to be aliased as the man command):
% alias man='manwrap-pm'has the ability to complete Perl module names à la pmman but also accepts all the other man switches and later executes man. And you get the best of both worlds.
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C manwrap-pm manwrap-pmin 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 manwrap-pm 'p/*/`manwrap-pm`/'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-manwrap-pm.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-manwrap-pm.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-manwrap-pm
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2017, 2016 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.