The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 ~                      __   __              __ ~
 ~     ____  ____  ____/ /  / /_____  ____  / / ~
 ~    / __ \/ __ \/ __  /  / __/ __ \/ __ \/ /  ~
 ~   / /_/ / /_/ / /_/ /  / /_/ /_/ / /_/ / /   ~
 ~  / .___/\____/\__,_/   \__/\____/\____/_/    ~
 ~ /_/                                          ~

Summary

Quickly show available class methods and documentation.

Installation:

Install bash completion support.

 % apt install bash-completion

Install cpanm.

 % cpan App::cpanminus

Install module dependencies.

 % cpanm --installdeps .

Install tab completion.

 % source bashrc_pod

Usage:

 # Show help.
 pod
 pod -h

Examples:

View summary of Mojo::UserAgent:

 % pod Mojo::UserAgent

View summary of a specific method.

 % pod Mojo::UserAgent get

Edit the module

 % pod Mojo::UserAgent -e

Edit the module and jump to the specific method definition right away. (Press "n" to next match if neeeded).

 % pod Mojo::UserAgent get -e

Run perldoc on the module (for convience)

 % pod Mojo::UserAgent -d

List all available methods. If no methods are found normally, then this will automatically be enabled. (pod was made to work with Mojo pod styling).

 % pod Mojo::UserAgent -a

Copyright and License

You should have received a LICENSE file, but the license is also noted in the module files. About the only thing you can't do is pretend that you wrote code that you didn't.

Author

((enjoy))

Tim Potapov, tim.potapov[AT]gmail.com