The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Pod::Cpandoc - perldoc that works for modules you don't have installed

SYNOPSIS

    cpandoc Acme::BadExample
        -- works even if you don't have Acme::BadExample installed!

    cpandoc -v '$?'
        -- passes everything through to regular perldoc

    cpandoc -tT Acme::BadExample | grep -i acme
        -- options are respected even if the module was scraped

    vim `cpandoc -l Web::Scraper`
        -- getting the idea yet?

SNEAKY INSTALL

    cpanm Pod::Cpandoc

    then: alias perldoc=cpandoc
    or:   function perldoc () { cpandoc "$@" }

    Now `perldoc Acme::BadExample` works!

perldoc should continue to work for everything that you're used to, since cpandoc passes all options through to it. cpandoc is merely a subclass that falls back to scraping a CPAN index when it fails to find your queried file in @INC.

SEE ALSO

The sneaky install was inspired by https://github.com/defunkt/hub.

AUTHOR

Shawn M Moore sartak@gmail.com

COPYRIGHT

Copyright 2011 Shawn M Moore.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.