summaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: ed8ade88ecfbbaf94c7e32442394635e63c5e573 (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
Basic Installation
==================

This software package uses a build system similar to one generated by GNU
Autoconf and Automake.

The `configure` shell script attempts to find certain system dependencies (e.g.
a shell interpreter) and configure the package to be built and installed on the
system.  Upon successful dependency resolution and configuration, the script
generates a `Makefile` in your current working directory.

The simplest way to configure, build, and install this package is:

 1. Run the `configure` script from the source directory or any other directory.
    For example, from the source directory you can run `./configure`.
 2. Run `make` to build the package.
 3. Run `make install` to install the package.  You will probably need superuser
    privileges to install files into your system.

To uninstall the package, you can run `make uninstall`.


Options
=======

The `configure` script accepts certain command-line options to control package
building and installation.  Run the script with the `--help` option for more
information.


Macros
======

The macro `DESTDIR` affects the root directory into which the `Makefile`
installs the package.  For example, you can install the package into a
filesystem hierarchy under a directory named `dest` in the current directory by
running `make DESTDIR=dest install`.


Separate Build Directory
========================

You can call the `configure` script from any directory on your system, and it
will detect the location of the package source directory.  It is recommended
that you create a directory outside of the package source directory and build
and install the package from there as follows:

    $ ../path/to/package/configure
    $ make
    # make install