# Debian::DictionariesCommon - phpMan

## NAME
    [Debian::DictionariesCommon].pm - dictionaries-common library

## SYNOPSIS
        use [Debian::DictionariesCommon] q(:all)
        $dictionaries = parseinfo ('/var/lib/dictionaries-common/ispell/iwolof');
        loaddb ('ispell')
        updatedb ('wordlist')

## DESCRIPTION
    Common functions for use from the dictionaries-common system.

## CALLING FUNCTIONS
    "dico_checkroot"
        Check for rootness and fail if not.

    "build_emacsen_support"
        Put info from dicts info files into emacsen-ispell-dicts.el

    "build_jed_support"
        Put info from dicts info files into jed-ispell-dicts.sl

    "build_squirrelmail_support"
        Build support file for squirrelmail with a list of available
        dictionaries and associated spellchecker calls, in php format.

    "$libdir = getlibdir($class)"
        Return info dir for given class.

    "$default = dico_getsysdefault($class)"
        Return system default value for given class.

    "$libdir = getuserdefault"
        Return value for user default ispell dictionary.

    "dico_get_spellchecker_params($class,\%language)"
        Get right params for $class (currently unused) and $language

    "\%dictionaries = loaddb($class)"
        Read class .db file and return a reference to a hash with its
        contents.

    "\%result = parseinfo($file)"
        Parse given info file and return a reference to a hash with the
        relevant data.

    "setsysdefault($value)"
        Set value for system default ispell dictionary.

    "setuserdefault"
        Set value for user default ispell dictionary, after asking to select
        it from the available values.

    "updatedb($class)"
        Parse info files for given class and update class .db file under
        dictionaries-common cache dir.

## SEE ALSO
    Debian dictionaries-common policy.

## AUTHORS
     Rafael Laboissiere
     Agustin Martin