Documentation updates
[dyninst.git] / README.dyninst
1 READ THIS FIRST: how to build DyninstAPI and its subcomponents
2
3 1) Configuration
4
5 Dyninst is now built via CMake. We recommend performing an interactive
6 configuration with "ccmake ." first, in order to see which options are
7 relevant for your system. You may also perform a batch configuration
8 with "cmake .".  Options are passed to CMake with -DVAR=VALUE. Common
9 options include:
10
11 Boost_INCLUDE_DIR
12 CMAKE_BUILD_TYPE
13 CMAKE_INSTALL_PREFIX
14 LIBDWARF_INCLUDE_DIR
15 LIBDWARF_LIBRARIES
16 LIBELF_INCLUDE_DIR
17 LIBELF_LIBRARIES
18 IBERTY_LIBRARY
19
20 CMake's default generator on Linux is normally "Unix Makefiles", and
21 on Windows, it will normally produce project files for the most recent
22 version of Visual Studio on your system. Other generators should work
23 but are not tested. After the CMake step concludes, you will have
24 appropriate Makefiles or equivalent and can build Dyninst.
25
26 We require CMake 2.6 as a minimum on all systems, and CMake 2.8.11
27 allows us to automatically download and build libelf/libdwarf/binutils
28 on ELF systems if they are needed. If you do not have a sufficiently
29 recent CMake, you may need to manually specify the location of these
30 dependencies.
31
32 2) Building and installation
33
34 To build Dyninst and all its components, "make && make install" from
35 the top-level directory of the source tree. To build and install a
36 single component and its dependencies, do the same thing from that
37 component's subdirectory. Libraries will be installed into
38 CMAKE_INSTALL_PREFIX/INSTALL_LIB_DIR, and headers will be installed
39 into CMAKE_INSTALL_PREFIX/INSTALL_INCLUDE_DIR. If you wish to import
40 Dyninst into your own CMake projects, the export information is in
41 CMAKE_INSTALL_PREFIX/INSTALL_CMAKE_DIR.