1Welcome to Apache Serf, a high-performance asynchronous HTTP client library.
2
3The Apache Serf library is a C-based HTTP client library built upon the Apache
4Portable Runtime (APR) library. It multiplexes connections, running the
5read/write communication asynchronously. Memory copies and transformations are
6kept to a minimum to provide high performance operation.
7
8  * Site: http://serf.apache.org//
9  * Code: http://svn.apache.org/repos/asf/serf/
10  * Issues: https://issues.apache.org/jira/browse/SERF
11  * Mail: dev@serf.apache.org
12  * People: Justin Erenkrantz, Greg Stein
13
14----
15
161. INSTALL
17
181.1. SCons build system
19
20Apache Serf uses SCons 2.3 for its build system. If it is not installed
21on your system, then you can install it onto your system. If you do not
22have permissions, then you can download and install the "local"
23version into your home directory. When installed privately, simply
24create a symlink for 'scons' in your PATH to /path/to/scons/scons.py.
25
26Fetch the scons-local package:
27  http://prdownloads.sourceforge.net/scons/scons-local-2.3.0.tar.gz
28
29
301.2 Building Apache Serf
31
32To build serf:
33
34$ scons APR=/path/to/apr APU=/path/to/apu OPENSSL=/openssl/base PREFIX=/path/to/prefix
35
36The switches are recorded into .saved_config, so they only need to be
37specified the first time scons is run.
38
39PREFIX should specify where serf should be installed.  PREFIX defaults to
40/usr/local.
41
42The default for the other three switches (APR, APU, OPENSSL) is /usr.
43
44The build system looks for apr-1-config at $APR/bin/apr-1-config, or
45the path should indicate apr-1-config itself. Similarly for the path
46to apu-1-config.
47
48OPENSSL should specify the root of the install (eg. /opt/local). The
49includes will be found OPENSSL/include and libraries at OPENSSL/lib.
50
51If you wish to use VPATH-style builds (where objects are created in a
52distinct directory from the source), you can use:
53
54$ scons -Y /path/to/serf/source
55
56If you plan to install the library on a system that uses different
57paths for architecture dependent files, specify LIBDIR. LIBDIR defaults
58to /usr/local/lib otherwise. Example for a 64 bit GNU/Linux system:
59
60$ scons PREFIX=/usr/ LIBDIR=/usr/lib64
61
62At any point, the current settings can be examined:
63
64$ scons --help
65
66
671.3 Running the test suite
68
69$ scons check
70
71
721.4 Installing Apache Serf
73
74$ scons install
75
76Note that the PREFIX variable should have been specified in a previous
77invocation of scons (and saved into .saved_config), or it can be
78specified on the install command line:
79
80$ scons PREFIX=/some/path install
81
82Distribution package maintainers regulary install to a buildroot, and
83would normally use something like below in their build systems, with
84placeholders for the specific paths:
85
86$ scons PREFIX=/usr/ LIBDIR=/usr/lib64
87$ scons install --install-sandbox=/path/to/buildroot
88
89
901.4 Cleaning up the build
91
92$ scons -c
93