NAME

mcd - mini CPAN documentation browser

DOCUMENTATION

mcd lets you search you CPAN mini for modules and display attractive HTML documentation in your browser. This is useful if you don't have an internet connection available or you have a very slow connection.

USAGE

 $> mcd [-option] Module::Name

EXAMPLES

Generate and display a module's documentation in your browser:

 $> mcd -d Module::Name

Generate and display a module's documentation in lynx

 $> mcd -d Module::Name -html_index -browser lynx

Search for modules which names containing a specific string:

 $> mcd -s string

Match modules to regular expression:

 $> mcd -s '\d0x'

OPTIONS

  'h|help'      display help
  's|search'    search for modules
  'b|browse'    generate and browse module ocumentation
  'html_index'  generate a pure HTML index for text based browsers
  'browser'     path to your browser or $ENV{BROWSER} or 'firefox'|'elinks'
  'cpan_mini'   cpan mini location or $ENV{CPAN_MINI} or '/devel/cpan'

EXIT STATUS

0 if no error found.

CAVEAT

You can't use mcd to display core modules documentation. This is due to the fact that core modules come with Perl and are not in your CPAN mini repository although they are referenced in it! You can display the installed core modules documentation with perldoc.

AUTHOR

  Nadim ibn hamouda el Khemir
  CPAN ID: NKH
  mailto: nkh@cpan.org

SEE ALSO

CPAN::Mini::Webserver, elinks