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