NAME

mci - Index your CPAN mini repository

DOCUMENTATION

Let you create and search text based on the content of pod, pl and pm files in your CPAN mini repository.

First indexing

Indexing a CPAN Mini repository takes between two and three hours on a modern box if you have your repository on an old laptop, it's going to take ages. Grab a pre_indexed cpan at http://www.khemir.net/http_share or mail the author if you can't find one at the above URL.

USAGE

 $> mci --option --option  file_1 file_2 ... file_n

Examples

update and search

  $> 

search no update

  $> 

command line completion (in your current shell)

  $> mci --completion_script > /tmp/mci ; source /tmp/mci ; rm /tmp/mci

OPTIONS

  'h|help'                display help
  'v|verbose'             displays extra information when indexing the modules
  'completion_script'     generates a bash completion script
  
  'cpan_mini'             cpan mini location or $ENV{CPAN_MINI} or '/devel/cpan'
  'no_index_update'       search the current database without checking if it is up to date
  'modules_only'          only show containing module name in the search results
  'n|lines=i'             display the first N search matches
  'maximum_document_size' files over that size are not indexed, default is 300 KB
  'verbose'               show extra indexing information or search scores
  'database_information'  show some information about the database

EXIT STATUS

AUTHOR

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