2005-12-02 Richard D. Worth <richard@theworths.org>
[ttt] / INSTALL
1 Quick-start build instructions
2 ------------------------------
3 1) Configure the package:
4
5         ./configure
6
7 2) Compile it:
8
9         make
10
11 3) Install it:
12
13         make install
14
15 This final step may require temporary root access (eg. with sudo) if
16 you don't have write permission to the directory in which ttt will
17 be installed.
18
19 NOTE: If you are working with source from CVS rather than from a tar
20 file, then you should use ./autogen.sh in place of ./configure
21 anywhere it is mentioned in these instructions.
22
23 More detailed build instructions
24 --------------------------------
25
26 1) Configure the package
27
28    The first step in building ttt is to configure the package by
29    running the configure script. The configure script attempts to
30    automatically detect as much as possible about your system. So,
31    you should primarily just accept its defaults by running:
32
33         ./configure
34
35    The configure script does accept a large number of options for
36    fine-tuning its behavior. See "./configure --help" for a complete
37    list. The most commonly used options are discussed here.
38
39    --prefix=PREFIX
40
41         This option specifies the directory under which the software
42         should be installed. By default configure will choose a
43         directory such as /usr/local. If you would like to install
44         ttt to some other location, pass the directory to configure
45         with the --prefix option. For example:
46
47                 ./configure --prefix=/opt/ttt
48
49         would install ttt into the /opt/ttt directory. You could
50         also choose a prefix directory within your home directory if
51         you don't have write access to any system-wide directory.
52
53         After installing into a custom prefix, you may need to set
54         the PATH environment variable to allow the software to be
55         found. Assuming the /opt/ttt prefix and assuming you are
56         using the bash shell, the PATH environment variable should be
57         set as follows:
58
59                 PATH=/opt/ttt/bin
60                 export PATH
61
62 2) Compile the package:
63
64    This step is very simple. Just:
65
66         make
67
68    The Makefiles included with ttt are designed to work on as many
69    different systems as possible.
70
71 3) Install the package:
72
73    The final step is to install the package with:
74
75         make install
76
77    If you are installing to a system-wide location you may need to
78    temporarily acquite root access in order to perform this
79    operation. A good way to do this is to use the sudo program:
80
81         sudo make install