summaryrefslogtreecommitdiff
path: root/doc/install.rst
blob: a0931b44f6363c6428befeda2ea93d3642ffc665 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
============
Installation
============

libHX uses GNU autotools as a build environment, which means that
all you have to run as a end-user is the configure with any
options that you need, plus the usual make and make install as
desired.

Pay attention to multi-lib Linux distributions where you most
likely need to specify a different libdir instead of using the
default “lib”. In case of the Debian-style multi-arch/multi-lib
proposal (http://wiki.debian.org/Multiarch)::

.. code-block:: sh

	./configure --libdir='${prefix}/lib/x86_64-linux-gnu'

and the classic-style 32-64 2-lib distributions::

.. code-block:: sh

	./configure --libdir='${prefix}/lib64'

Requirements
------------

* GNU C Compiler 3.3.5 or newer. Other compilers (non-GCC) have
  not been tested in months — use at your own risk.

* approximately 80–160 KB of disk space on Linux for the shared
  library (depends on platform) and header files.

A C++ compiler is only needed if you want to build the C++ test
programs that come with libHX. By default, if there is no C++
compiler present, these will not be built.

* No external libraries are needed for compilation of libHX.
  Helper files, like libxml_helper.h, may reference their include
  files, but they are not used during compilation.


Portability notice
==================

libHX runs on contemporary versions of Linux and Windows. It ought to work on
Solaris and the BSD distributions, but this is not build-tested at this time.

C99 is mandatory. The integer type ``int`` should at best have 32 bits at
least.