The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

TITLE

mod-doc - Given a module name, display its distribution documentation

SYNOPSIS

 mod-doc LWP::UserAgent
 mod-doc -help
 mod-doc -version

OPTIONS

-browser

This option specifies the command used to run the browser. The default is start under MSWin32, open under darwin, and firefox anywhere else.

-cpan

This option specifies the URL of the CPAN repository used for the module lookup. This defaults based on your CPAN::Mini, CPAN, or CPANPLUS setup.

-help

This option displays the documentation for this script. The script then exits.

url

This option specifies the URL of the documentation root. The name of the distribution containing this will be appended, and the result passed to the selected browser.

There are two canned URLs that can be specified by name:

meta => 'http://metacpan.org/release',
search => 'http://search.cpan.org/dist',

The default is http://search.cpan.org/dist.

-version

This option displays the version of this script. The script then exits.

DETAILS

This Perl script finds the name of the distribution that contains a given module and displays its documentation in the specified browser.

It does this by looking up the module in the index of the

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2012-2014 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.