NAME

siim - Create and search a full text indexed database

DOCUMENTATION

Let you create and search full text indexed database based on the content of files.

USAGE

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

Examples

Adding files to an index database

  $> find directories_you_want_indexed | xargs perl siim -i test -a

Searching for text

  $> siim -i test -s 'your query'

Indexing perl modules

  $> find /devel/perl_modules/My_Module -type f -readable -size -300k| grep -v blib | grep -v _build | xargs siim -p -i test -a

Removing some files

  $> xargs siim -i test -r file file ...

Checking the index database and displaying the documents it contains

  $> siim -p -i test -c

command line completion (in your current shell)

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

OPTIONS

  'h|help'                display help
  'v|verbose'             display score, state, timing, ...
  'completion_script'     generates a bash completion script
  
  'i|index_directory=s'   path to the database index
  
  'a|add_files'           add files to the database
  'stopwords_file=s'      path to files containing stopwords
  'maximum_document_size' default is 300 KB
  'p|perl_mode'           pre-defined perl stopword list
  
  'r|remove_files'        remove files from the database
  'c|check_index'         check the database and display file state
  's|search=s'            search strings in the database
  
  'delete_database'       deletes the database in the index directory
  'database_information'  shows some database information

EXIT STATUS

1 - command line error

2 - database or command error

AUTHOR

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