INSTALL

   1
   2 Short overview for those who don't read manuals:
   3
   4 This software is compiled to binary form using a build system based on the
   5 CMake framework. Therefore, the requirements to build this package are:
   6
   7  - cmake 2.4.3 or newer (available from http://www.cmake.org or maybe as a
   8    package in your Linux distribution)
   9  - GNU make
  10  - working GCC compiler environment
  11  - maybe additional requirements for your operating system, see
  12    doc/platforms/... and FAQ.
  13    Recommended: glibc (Linux standard) or GNU libiconv
  14
  15 COMPILATION:
  16
  17 Run: make
  18
  19 INSTALLATION:
  20
  21 Run: make install
  22
  23 To customize the target paths, some variables can be appended to this line:
  24 PREFIX=/opt/cdrkit/latest (default: CMake preset, e.g. /usr/local)
  25 MANSUBDIR=man (default: share/man)
  26
  27 TROUBLESHOOTING:
  28
  29 Problem: Linking error.
  30 Solution: Look for missing dependencies. If you installed additional libraries
  31 in non-system paths, they may have a conflict with the system libraries which
  32 are already installed. Make sure that the linker gets the right ones, those
  33 that belong to the headers. For example, if you installed libmagic and libiconv
  34 into /usr/local/{include,lib} and your compiler or linker have different
  35 defaults (eg. they use /usr/lib, /usr/include or intermix them), then you can
  36 set CFLAGS and LDFLAGS vars to override the system defaults, assumed by cmake.
  37 Example:
  38 (AIX5l, /usr/lib is default lib dir but /usr/local/include is preferred by gcc
  39 for headers), command:
  40     make clean
  41     make CFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/lib
  42 (cleaning is important to rerun tests. Alternatively, remove build/CMakeCache*)
  43
  44 Problem: Library not found
  45 Solution: Install the library and its development files. Depending on the
  46 system distribution they can be shipped in different packages. Install them
  47 all and make sure that the development files match the version of the main
  48 library package.
  49
  50 Problem: Library not found during configuration though it's installed
  51 Solution: Install the development files, see above for details.
  52
  53 Problem: Library not found though it's installed with dev files
  54 Solution: Install the development files, see above for details. If you use
  55 non-standard paths not known/searched by Cmake and/or your compiler, pass the
  56 location of the headers in CFLAGS and the libraries via LDFLAGS. See examples
  57 above.
  58
  59 Problem: None of those hints helps
  60 Solution: Examine the following files:
  61     build/CMakeFiles/CMakeFiles/CMakeOutput.log
  62     build/CMakeFiles/CMakeOutput.log
  63 and look for failed commands. Some checks are expected to fail if the platform
  64 does not provide a certain feature, others must not fail. Look the failing
  65 check and use THE FORCE to find related problems and solutions.
  66