www/INSTALL.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Sun, 11 Sep 2016 22:15:35 +0300
changeset 546 3668e902319f
parent 498 78f1ec07fe20
child 555 4a3188fc8951
permissions -rw-r--r--
Add docs about release tarball structure.
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
498
78f1ec07fe20 Fix spelling.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 484
diff changeset
    12
Official sources tarballs 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
546
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    17
Compiled tarball provides:
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    18
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    19
* Compiled dictionaries (with extension ``.dict.dz``) and indexes (with
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    20
  extension ``.index``) in ``/dictd`` directory for use with ``dictd``.
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    21
  Goldendict and other end used dictionary programs understand this format.
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    22
546
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    23
* Documentation in plain text in ``/doc/txt`` directory (with extension
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    24
  ``.rst``) and in HTML in ``/doc/html`` directory (with extension ``.html``).
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    25
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    26
* Import files in TAB format for SRS software in ``/srs`` directory (files with
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    27
  extension ``.tab.txt``). Anki, Mnemosyne, Anymemo and many other SRS packages
3668e902319f Add docs about release tarball structure.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 498
diff changeset
    28
  able to import TAB files. Don't forget to enable HTML markup on import!
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    29
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    30
Compiled tarballs have names like::
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    31
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    32
  gadict-$major.$minor.tar.gz
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    33
  gadict-$major.$minor.zip
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    34
483
370ed8138f62 Downloading
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    35
Source tarballs have names like::
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    36
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    37
  gadict-$major.$minor_src.tar.gz
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    38
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    39
Installation instruction for GoldenDict
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    40
=======================================
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
Get distribution tarball and extract files from ``dictd`` directory in desired
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    43
place.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    44
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    45
Select ``Edit ==> Dictionaries...`` in GoldenDict menu (or just press ``F3``)
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    46
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
    47
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    48
.. NOTE:: Only ``*.dict.dz`` and ``*.index`` files are required for GoldenDict.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    49
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    50
How to build and install with supplied Makefile
236
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    51
===============================================
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    52
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    53
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
    54
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    55
  $ make install
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
For regular user ``prefix`` is set to::
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    58
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    59
  $HOME/usr
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    60
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    61
To install to different place run::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    62
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    63
  $ make install prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    64
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    65
How to uninstall from supplied Makefile
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    66
=======================================
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    67
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    68
To uninstall run one of::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    69
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    70
  $ make uninstall
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    71
  $ make uninstall prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    72
  $ make prefix=PREFIX uninstall uninstall-local-symlink
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    73
484
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    74
accordingly to installation procedure.
91254be1b84c Refine installation docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 483
diff changeset
    75