#--
# INSTALL
# $Id: INSTALL,v 1.6 2003/11/01 07:15:44 elzubeir Exp $
#--

Requirements
============

  - Python > 2.2.x
    Earlier versions of Python will NOT work. This is mainly because of
    Unicode support. For more information, visit:
    http://www.python.org/doc/2.2.1/whatsnew/node8.html

  - duali-data files
    Those can be found here:
    http://prdownloads.sourceforge.net/arabeyes/duali-data.tar.bz2?download
    [AND/OR]
    http://prdownloads.sourceforge.net/arabeyes/duali-data.zip?download

  - dbm python modules
    It is preferred to have the python bsddb3 module, which can be found
    here: http://pybsddb.sourceforge.net/
    However, pyduali will use whatever database management module is available
    on your system.
 
Setup
=====

Now that you have a current version of Python, you will need to generate
the dictionary files.

This is done by using the 'dict2db.py' script:


Usage
=====

Usage: duali -c filename
        [-h | --help           ]   outputs this usage message
        [-V | --version        ]   program version
        [-c | --check= filename]   input file to spellcheck
        [-C | --charset        ]   character encoding (cp1256, utf-8)
        [-n | --normalize      ]   turn normalization off (default on)
        [-p | --path           ]   dictionaries path
        [-v | --verbose        ]   verbose out (for debugging)


NOTES
=====

  - Normalization
    What this means is it essentially removes all the hamza's from words,
    converts all the TEH_MARBUTA's to HEH's, etc. It guarantees that the
    word is in its simplest written form.

