Applied some patches from local VEX features branch
[dyninst.git] / dyninstAPI / README
1
2 This is the version 9.1 release of the Dyninst API.  Currently, the API
3 library is available for the POWER/Linux, x86/Linux, x86_64/Linux, and
4 x86/Windows XP/2000/2003/Windows 7 platforms.
5
6 Documentation for the API can be found at:
7
8     http://www.dyninst.org/
9
10 The dyninst/dyninstAPI/tests directory contains the source code for programs
11 that test the API functions.  These programs are useful as examples of how
12 to use the API.  See the README file in that directory for how to run or
13 rebuild them.
14
15 Setting up the environment
16 --------------------------
17
18 DYNINSTAPI_RT_LIB should be set to the full pathname of the file
19 libdyninstAPI_RT.so (on Windows, libdyninstAPI_RT.dll). 
20
21 On Unix-based systems, you will also need to add $CMAKE_INSTALL_PREFIX/lib
22 to your LD_LIBRARY_PATH environment variable.  On Windows, you will instead
23 need to add %CMAKE_INSTALL_PREFIX%/lib to your PATH environment
24 variable.  This is so that mutator applications can be linked dynamically with
25 the Dyninst library.
26
27 Notes on Using Dyninst with Linux
28 ---------------------------------
29
30 On Linux, Dyninst requires some libraries that are not installed by default
31 in most distributions.  The first is libelf, which is included with most
32 distributions and can be installed using the distribution's package manager.
33 The second is libdwarf.  You can get the latest source code distribution
34 of libdwarf from http://sourceforge.net/projects/libdwarf/.  RPM files for libdwarf
35 are also available from various sites.
36
37 Building the Dyninst API from source
38 ------------------------------------
39
40 See the top-level INSTALL file for build information.
41
42 -----------------------------------------------------------------------------
43
44 This software is derived from the Paradyn system and therefore subject to
45 the same copyright.  A copy of the Paradyn copyright appears at the end of
46 this file.
47
48         The Dyninst API Team
49         12/9/2015
50
51 ----------------------- Start of Paradyn Copyright --------------------------
52 See the dyninst/COPYRIGHT file for copyright information.
53  
54 We provide the Paradyn Tools (below described as "Paradyn")
55 on an AS IS basis, and do not warrant its validity or performance.
56 We reserve the right to update, modify, or discontinue this
57 software at any time.  We shall have no obligation to supply such
58 updates or modifications or any other form of support to you.
59
60 By your use of Paradyn, you understand and agree that we (or any
61 other person or entity with proprietary rights in Paradyn) are
62 under no obligation to provide either maintenance services,
63 update services, notices of latent defects, or correction of
64 defects for Paradyn.
65
66 This library is free software; you can redistribute it and/or
67 modify it under the terms of the GNU Lesser General Public
68 License as published by the Free Software Foundation; either
69 version 2.1 of the License, or (at your option) any later version.
70
71 This library is distributed in the hope that it will be useful,
72 but WITHOUT ANY WARRANTY; without even the implied warranty of
73 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
74 Lesser General Public License for more details.
75
76 You should have received a copy of the GNU Lesser General Public
77 License along with this library; if not, write to the Free Software
78 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
79