Documentation updates
[dyninst.git] / parseAPI / README
1
2 This is release 8.0 of the ParseAPI. Currently, this library is
3 available for the x86[_64]/Linux, x86/Windows XP/2000/20003, and
4 POWER/Linux platforms.
5
6 Documentation for the API can be found at
7
8     http://www.dyninst.org/
9
10 as well as in the doc/ subdirectory.
11
12
13 Prerequisites
14 --------------------------
15
16 The ParseAPI is a component of the Dyninst system, and depends on two other
17 components: the SymtabAPI binary format library and the InstructionAPI
18 disassembly library. Both of these components should have been included in the
19 package containing the ParseAPI; if not, they can be obtained from the
20 dyninst.org website.
21
22 The SymtabAPI has further dependencies depending on the platform, including
23 libelf and libdwarf. See the SymtabAPI documentation for details.
24
25
26 Compiling the library
27 --------------------------
28
29 The ParseAPI is built from the top-level Dyninst directory. For UNIX-like
30 systems, The top-level Makefiles are generated by running the ./configure
31 script, which sets platform-specific options. The configure script will attempt
32 to determine the build platform automatically; if it cannot not, you must
33 specify the correct platform by exporting the PLATFORM environment variable
34 with one of the following values:
35
36     i386-unknown-linux2.4       Linux 2.4/2.6 on an Intel x86 processor
37     x86_64-unknown-linux2.4     Linux 2.4/2.6 on an AMD-64 processor
38     i386-unknown-nt4.0          
39     ppc32_linux                 Linux 2.6 on a 32-bit PPC processor
40     ppc64_linux                 Linux 2.6 on a 64-bit PPC processor
41
42 Compile the ParseAPI and its Dyninst component dependencies by typeing 
43 `make ParseAPI`.
44
45 On Windows systems, a Visual Studio solution is provided in the top-level
46 directory.
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         5/17/2011
56
57 ----------------------- Start of Paradyn Copyright --------------------------
58 See the dyninst/COPYRIGHT file for copyright information.
59  
60 We provide the Paradyn Tools (below described as "Paradyn")
61 on an AS IS basis, and do not warrant its validity or performance.
62 We reserve the right to update, modify, or discontinue this
63 software at any time.  We shall have no obligation to supply such
64 updates or modifications or any other form of support to you.
65  
66 By your use of Paradyn, you understand and agree that we (or any
67 other person or entity with proprietary rights in Paradyn) are
68 under no obligation to provide either maintenance services,
69 update services, notices of latent defects, or correction of
70 defects for Paradyn.
71
72 This library is free software; you can redistribute it and/or
73 modify it under the terms of the GNU Lesser General Public
74 License as published by the Free Software Foundation; either
75 version 2.1 of the License, or (at your option) any later version.
76
77 This library is distributed in the hope that it will be useful,
78 but WITHOUT ANY WARRANTY; without even the implied warranty of
79 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
80 Lesser General Public License for more details.
81
82 You should have received a copy of the GNU Lesser General Public
83 License along with this library; if not, write to the Free Software
84 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
85