INSTALL.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Sun, 05 Aug 2012 23:26:34 +0300
changeset 249 5ad075a475f2
parent 243 deede3c3386f
child 301 1439e072640a
permissions -rw-r--r--
TODO convention.
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
.. include:: header.rst
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
=================================
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
 Installing gadict dictionaries.
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
=================================
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
.. contents::
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
Document version.
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
=================
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
.. include:: VERSION.rst
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    14
Obtaining.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    15
==========
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    16
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    17
For distribution tarbol use (for regular users)::
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    18
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    19
  gadict-$major.$minor.tar.bz2
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    20
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    21
For source tarboll use::
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    22
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    23
  gadict-$major.$minor_src.tar.gz
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    24
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    25
``$major`` and ``$minor`` represent version components.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    26
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    27
To get these files use appropriate links:
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
 * https://sourceforge.net/projects/gadict/files/v$major.$minor/gadict-$major.$minor_src.tar.gz
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    30
 * https://sourceforge.net/projects/gadict/files/v$major.$minor/gadict-$major.$minor.tar.gz
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 229
diff changeset
    31
236
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    32
Manual installation instruction for GoldenDict.
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    33
===============================================
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    34
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    35
Get distribution tarboll and extract all files to any directory. Select::
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    36
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    37
 Edit ==> Dictionaries...
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    38
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    39
in GoldenDict menu (or just press ``F3``) and add directory to where you
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    40
extracted files. Press ``Refresh`` button. That's all.
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    41
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    42
**Note** only ``*.dict.dz`` and ``*.index`` files are required for GoldenDict.
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    43
You can safely remove other fils.
19a1a3d73121 Manual installation instruction for GoldenDict.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
    44
229
b7b92f209bd5 Fix header.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 228
diff changeset
    45
How to build and install from supplied Makefile.
b7b92f209bd5 Fix header.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 228
diff changeset
    46
================================================
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
229
b7b92f209bd5 Fix header.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 228
diff changeset
    48
To build and install in /usr/local/ run as root::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    49
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    50
  $ make install
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    51
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    52
If you run as regular user ``prefix`` set to::
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    53
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    54
  $HOME/usr
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    55
229
b7b92f209bd5 Fix header.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 228
diff changeset
    56
To build and install in different place run::
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    57
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    58
  $ make install prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    59
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    60
How to uninstall from supplied Makefile.
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    61
========================================
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    62
226
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    63
To uninstall run one command from list accordingly to installation procedure::
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    64
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    65
  $ make uninstall
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    66
  $ make uninstall prefix=PREFIX
7f69e82d1a32 Move installation instruction to separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    67
  $ make prefix=PREFIX uninstall uninstall-local-symlink
227
d988124ee012 Split file on sections.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    68