fix insnCodeGen::modifyData's 64-bit conversion
[dyninst.git] / parseThat / README
1 INTRODUCTION
2
3 parseThat is an application that provides a rigorous and robust test of
4 DyninstAPI on arbitrary binaries.  Geared mainly for debugging purposes,
5 parseThat generates copious output for each dyninstAPI feature it uses.
6
7 These output logs can be used to quickly locate the source of parsing or
8 instrumentation bugs, in the rare instance when they occur.
9
10 CONFIGURATION
11
12 Autoconf scripts are used to gather information about the target platform
13 before building.  The top level Makefile, however, will issue configure commands.
14 If a custom configuration is desired, first do a top-level build (to ensure that 
15 the build directory is created).  Then "cd $PLATFORM" and issue the command:
16
17         ../configure <custom config options here>
18
19 By default, the parseThat binary will be placed in the build directory.
20 Use the --prefix flag to install it somewhere else.  For example, to
21 install parseThat in /usr/local/bin:
22
23         ./configure --prefix=/usr/local/bin
24
25 There are a few variables which allow you to control how parseThat is
26 built.
27
28         PLATFORM
29         The configuration scripts will attempt to guess your target
30         platform, but it's sometime helpful to specify your build
31         platform manually.  See the documentation for DyninstAPI in
32         dyninst/dyninstAPI/README for valid values of this variable.
33
34         DYNINST_ROOT
35         The various headers and libraries for DyninstAPI may not be
36         installed in a standard location.  Use this environment
37         variable to manually specify where you placed a source or
38         binary distribution of DyninstAPI.
39
40 BUILDING & INSTALLING
41
42 To build parseThat from scratch, issue the make command.  This will create
43 a platform-specific build directory, configure the Makefile, and build 
44 parseThat.  The top level Makefile (not platform specific) just relays make
45 commands to the platform specific Makefile in the $PLATFORM directory.
46
47 Once successfully built, invoking GNU make with the "install" target will
48 copy the binary to its final destination.
49
50 RUNNING
51
52 Documentation on running parseThat is encoded within the binary itself.
53 It can be viewed by simply running parseThat with the --help flag.