contrib/serf/README

   1 Welcome to serf, a high-performance asynchronous HTTP client library.
   2
   3 The serf library is a C-based HTTP client library built upon the Apache
   4 Portable Runtime (APR) library. It multiplexes connections, running the
   5 read/write communication asynchronously. Memory copies and transformations are
   6 kept to a minimum to provide high performance operation.
   7
   8   * Status: http://code.google.com/p/serf/wiki/
   9   * Site: http://code.google.com/p/serf/
  10   * Code: http://serf.googlecode.com/svn/
  11   * Issues: http://code.google.com/p/serf/issues/list
  12   * Mail: serf-dev@googlegroups.com
  13   * People: Justin Erenkrantz, Greg Stein
  14
  15 ----
  16
  17 1. INSTALL
  18
  19 1.1. SCons build system
  20
  21 serf uses SCons 2.x for its build system. If it is not installed on
  22 your system, then you can install it onto your system. If you do not
  23 have permissions, then you can download and install the "local"
  24 version into your home directory. When installed privately, simply
  25 create a symlink for 'scons' in your PATH to /path/to/scons/scons.py.
  26
  27 Fetch the scons-local package:
  28   http://prdownloads.sourceforge.net/scons/scons-local-2.0.1.tar.gz
  29
  30
  31 1.2 Building serf
  32
  33 To build serf:
  34
  35 $ scons APR=/path/to/apr APU=/path/to/apu OPENSSL=/openssl/base PREFIX=/path/to/prefix
  36
  37 The switches are recorded into .saved_config, so they only need to be
  38 specified the first time scons is run.
  39
  40 PREFIX should specify where serf should be installed.  PREFIX defaults to
  41 /usr/local.
  42
  43 The default for the other three switches (APR, APU, OPENSSL) is /usr.
  44
  45 The build system looks for apr-1-config at $APR/bin/apr-1-config, or
  46 the path should indicate apr-1-config itself. Similarly for the path
  47 to apu-1-config.
  48
  49 OPENSSL should specify the root of the install (eg. /opt/local). The
  50 includes will be found OPENSSL/include and libraries at OPENSSL/lib.
  51
  52 If you wish to use VPATH-style builds (where objects are created in a
  53 distinct directory from the source), you can use:
  54
  55 $ scons -Y /path/to/serf/source
  56
  57 At any point, the current settings can be examined:
  58
  59 $ scons --help
  60
  61
  62 1.3 Running the test suite
  63
  64 $ scons check
  65
  66
  67 1.4 Installing serf
  68
  69 $ scons install
  70
  71 Note that the PREFIX variable should have been specified in a previous
  72 invocation of scons (and saved into .saved_config), or it can be
  73 specified on the install command line:
  74
  75 $ scons PREFIX=/some/path install
  76
  77
  78 1.4 Cleaning up the build
  79
  80 $ scons -c