README.install

   1 Obtaining the sources
   2 =====================
   3
   4 Source tarballs for uid_wrapper can be downloaded from
   5
   6   https://ftp.samba.org/pub/cwrap/
   7
   8 The source code repository for socket wrapper is located under
   9
  10   git://git.samba.org/uid_wrapper.git
  11
  12 To create a local copy, run
  13
  14   $ git clone git://git.samba.org/uid_wrapper.git
  15   $ cd uid_wrapper
  16
  17 Building from sources
  18 =====================
  19
  20 uid_wrapper uses cmake (www.cmake.org) as its build system.
  21
  22 In an unpacked sources base directory, create a directory to
  23 contain the build results, e.g.
  24
  25   $ mkdir obj
  26   $ cd obj
  27
  28 Note that "obj" is just an example. The directory can
  29 be named arbitrarily.
  30
  31 Next, run cmake to configure the build, e.g.
  32
  33   $ cmake -DCMAKE_INSTALL_PREFIX=<prefix> ..
  34
  35 The "<prefix>" should be replaced by the intended installation
  36 target prefix directory, typically /usr or /usr/local.
  37
  38 Note that the target directory does not have to be a direct
  39 or indirect subdirectory of the source base directory: It can
  40 be an arbitrary directory in the system. In the general case,
  41 ".." has to be replaced by a relative or absolute path of the
  42 source base directory in the "cmake" command line.
  43
  44 One can control the build type with "-DCMAKE_BUILD_TYPE=<mode>"
  45 where <mode> can be one of Debug, Release, RelWithDebInfo, and
  46 some more (see cmake.org). The default is "RelWithDebInfo".
  47
  48 After configuring with cmake, run the build with
  49
  50   $ make
  51
  52 Unit testing
  53 ============
  54
  55 In order to support running the test suite after building,
  56 the cmocka unit test framework needs to be installed (cmocka.org),
  57 and you need to specify
  58
  59   -DUNIT_TESTING=ON
  60
  61 in the cmake run. After running "make",
  62
  63   $ make test
  64
  65 runs the test suite.
  66
  67 Installing
  68 ==========
  69
  70 uid_wrapper is installed into the prefix directory
  71 after running "cmake" and "make" with
  72
  73   $ make install
  74