.. -*- coding: utf-8 -*-

================================
 Installing gadict dictionaries
================================
.. contents::
   :local:

Downloading
===========

Official sources tarballs and compiled builds are available at:

* http://gadict.defun.work/download/
* https://sourceforge.net/projects/gadict/files/

Compiled tarball provides dictionaries in different formats:

* ``dict.dz`` for use with ``dictd``. Goldendict and other end used dictionary
  programs understand this format.

Compiled tarballs have names like::

  gadict-$major.$minor.tar.gz
  gadict-$major.$minor.zip

Source tarballs have names like::

  gadict-$major.$minor_src.tar.gz

Installation instruction for GoldenDict
=======================================

Get distribution tarball and extract files from ``dictd`` directory in desired
place.

Select ``Edit ==> Dictionaries...`` in GoldenDict menu (or just press ``F3``)
and add directory where you extracted files. Press ``Refresh`` button and enjoy!

.. NOTE:: Only ``*.dict.dz`` and ``*.index`` files are required for GoldenDict.

How to build and install with supplied Makefile
===============================================

To build and install to ``/usr/local/`` run as root::

  $ make install

For regular user ``prefix`` is set to::

  $HOME/usr

To install to different place run::

  $ make install prefix=PREFIX

How to uninstall from supplied Makefile
=======================================

To uninstall run one of::

  $ make uninstall
  $ make uninstall prefix=PREFIX
  $ make prefix=PREFIX uninstall uninstall-local-symlink

accordingly to installation procedure.