| 1 |
$Id: INSTALL,v 1.1 2004/01/19 17:37:47 mbuna Exp $ |
| 2 |
---------------------------------------------------------------- |
| 3 |
PEAK Library :: Parallel Events and Asynchronous tasKing Library |
| 4 |
---------------------------------------------------------------- |
| 5 |
|
| 6 |
INSTALLATION |
| 7 |
============ |
| 8 |
|
| 9 |
The PEAK Library is easy to install on systems where it's |
| 10 |
supported. On most systems, GNU CC (gcc) is recommended to compile |
| 11 |
libpeak. However, on some architectures like POWER or PPC970, gcc |
| 12 |
still lacks some optimization support. We will then try to allow you |
| 13 |
to compile libpeak on such systems. Please note that it's low priority |
| 14 |
unless someone requests it; see the sourceforge.net project page for |
| 15 |
that: http://sourceforge.net/projects/peak. |
| 16 |
|
| 17 |
CONFIGURING COMPILATION |
| 18 |
======================= |
| 19 |
|
| 20 |
To install in /usr/local/lib and /usr/local/include/peak: |
| 21 |
|
| 22 |
./configure |
| 23 |
|
| 24 |
or to install in /usr/lib and /usr/include/peak: |
| 25 |
|
| 26 |
./configure --prefix=/usr |
| 27 |
|
| 28 |
or similarly to install in your home directory (another example..): |
| 29 |
|
| 30 |
./configure --prefix=$HOME |
| 31 |
|
| 32 |
If you plan to use libpeak on a uniprocessor machine *ONLY*, you can |
| 33 |
turn off possible SMP code overhead by adding this configure option: |
| 34 |
|
| 35 |
--enable-uniprocessor-only |
| 36 |
|
| 37 |
At the end of the configure script, you will see a summary of the main |
| 38 |
options (installation paths, detected architecture, multiplexing |
| 39 |
engine used...). At this time you might want to force the use of |
| 40 |
another engine by adding this configure option (example to choose epoll): |
| 41 |
|
| 42 |
--with-engine=epoll |
| 43 |
|
| 44 |
Obviously your system must support the choosen engine. |
| 45 |
|
| 46 |
|
| 47 |
COMPILING |
| 48 |
========= |
| 49 |
|
| 50 |
Then, to compile the library (default is to build a shared and static |
| 51 |
version, if possible): |
| 52 |
|
| 53 |
make |
| 54 |
|
| 55 |
Optionally, you can compile and run the test suite to verify libpeak's |
| 56 |
working correctly: |
| 57 |
|
| 58 |
make check |
| 59 |
|
| 60 |
|
| 61 |
INSTALLING |
| 62 |
========== |
| 63 |
|
| 64 |
Finally, you want to install it with: |
| 65 |
|
| 66 |
make install |
| 67 |
|
| 68 |
This will copy the libraries and its headers at the good |
| 69 |
places. Additionally, a little script named peak-config will be |
| 70 |
installed which allow programs using libpeak to detect it. The |
| 71 |
peak-config script should be in a place defined in your PATH |
| 72 |
environment variable. |
| 73 |
|
| 74 |
Please report installation problems to mbuna@bugged.org. |
