www/INSTALL.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 01 Jun 2016 15:45:05 +0300
changeset 488 ed62b3cef9ce
parent 484 91254be1b84c
child 498 78f1ec07fe20
permissions -rw-r--r--
Hold term of use on separate page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
243
deede3c3386f Add coding to RST files.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 236
diff changeset
     1
.. -*- coding: utf-8 -*-
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     3
================================
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     4
 Installing gadict dictionaries
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     5
================================
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
.. contents::
301
1439e072640a Remove CSS hack that suppress displaying document name in TOC by
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
     7
   :local:
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     9
Downloading
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    10
===========
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    11
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    12
Official sources and compiled builds are available at:
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    13
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    14
* http://gadict.defun.work/download/
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    15
* https://sourceforge.net/projects/gadict/files/
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    16
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    17
Compiled tarball provide dictionaries in different formats:
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    18
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    19
* ``dict.dz`` for use with ``dictd``. Goldendict and other end used dictionary
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    20
  programs understand this format.
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    21
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    22
Compiled tarballs have names like::
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    23
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    24
  gadict-$major.$minor.tar.gz
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    25
  gadict-$major.$minor.zip
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    26
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    27
Source tarballs have names like::
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    28
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    29
  gadict-$major.$minor_src.tar.gz
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    30
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    31
Installation instruction for GoldenDict
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    32
=======================================
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    33
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    34
Get distribution tarball and extract files from ``dictd`` directory in desired
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    35
place.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    36
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    37
Select ``Edit ==> Dictionaries...`` in GoldenDict menu (or just press ``F3``)
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    38
and add directory where you extracted files. Press ``Refresh`` button and enjoy!
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    39
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    40
.. NOTE:: Only ``*.dict.dz`` and ``*.index`` files are required for GoldenDict.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    41
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    42
How to build and install with supplied Makefile
236
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    43
===============================================
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    44
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    45
To build and install to ``/usr/local/`` run as root::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
  $ make install
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    49
For regular user ``prefix`` is set to::
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    50
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    51
  $HOME/usr
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    52
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    53
To install to different place run::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    54
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    55
  $ make install prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    56
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    57
How to uninstall from supplied Makefile
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    58
=======================================
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    59
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    60
To uninstall run one of::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    61
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    62
  $ make uninstall
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    63
  $ make uninstall prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    64
  $ make prefix=PREFIX uninstall uninstall-local-symlink
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    65
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    66
accordingly to installation procedure.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    67