Checking of initial version.
[pdftools:pdfjoin.git] / INSTALL
1 .. -*- mode: rst ; ispell-local-dictionary: "american" -*-
2
3 ====================================
4 pdfjoin Installation Instructions
5 ====================================
6
7 :Author:    Hartmut Goebel <h.goebel@goebel-consult.de>
8 :Version:   Version 0.1dev
9 :Copyright: 2012 by Hartmut Goebel
10 :Licence:   GNU Public Licence v3 (GPLv3)
11 :Homepage:  http://pdfposter.origo.ethz.ch/
12
13
14 Requirements
15 ~~~~~~~~~~~~~~~~~~~~
16
17 ``pdfjoin`` requires
18
19 * Python 2.x (tested with 2.7, but other versions should work, too),
20 * `pyPdf <http://pybrary.net/pyPdf/>`_ > 1.10,
21 * setuptools for installation (see below).
22
23
24 Installation on Windows-Systems
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
27
28 Installation Requirements
29 ----------------------------
30
31 ``pdfjoin`` uses setuptools for installation. Thus you need
32 either
33
34   * network access, so the install script will automatically download
35     and install setuptools if they are not already installed
36
37 or
38
39   * the correct version of setuptools preinstalled using the
40     `EasyInstall installation instructions`__. Those instructions also
41     have tips for dealing with firewalls as well as how to manually
42     download and install setuptools.
43
44 __ http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions
45
46 Installation 
47 -------------------------
48
49 Install ``pdfjoin`` by just running::
50
51    python ./setup.py install
52
53
54
55 Custom Installation Locations
56 ------------------------------
57
58 ``pdfjoin`` is just a single script (aka Python program). So you can
59 copy it where ever you want (maybe fixing the first line). But it's
60 easier to just use::
61
62    # install to /usr/local/bin
63    python ./setup.py install --prefix /usr/local
64
65    # install to your Home directory (~/bin)
66    python ./setup.py install --home ~
67
68 Please mind: This effects also the installation of pyPdf (and
69 setuptools) if they are not already installed.
70
71 For more information about Custom Installation Locations please refer
72 to the `Custom Installation Locations Instructions`__ before
73 installing ``pdfjoin``.
74
75 __ http://peak.telecommunity.com/DevCenter/EasyInstall#custom-installation-locations