Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 69 lines (53 sloc) 2.869 kb
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
1 Byteman README
2 --------------
84a8006 @adinn basic documentation of the orchestration package
adinn authored
3
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
4 Byteman supports injection of side effects into Java programs for the
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
5 purpose of tracing and testing application behaviour.
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
6
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
7 Installation
f4cfb62 @adinn updated README
adinn authored
8 ------------
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
9
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
10 If you have downloaded a binary release then unzip it into a target
592b60e @adinn modified src release zip so that build products are locatec correctly…
adinn authored
11 install directory. This directory contains everything you need to
12 use byteman. You should set environment variable BYTEMAN_HOME so
13 that it points to the target install directory.
f4cfb62 @adinn updated README
adinn authored
14
32795a9 @adinn corrected error in maven install rules and also added byteman source …
adinn authored
15 If you have downloaded a full release then unzip into a target
592b60e @adinn modified src release zip so that build products are locatec correctly…
adinn authored
16 release directory. The release includes a subdirectory called install
17 which contains everything you need to use byteman. You should set
18 environment variable BYTEMAN_HOME so that it points to the install
19 subdirectory. If you execute command 'ant install' in the target
20 release directory then this will rebuild the byteman release from
21 the sources overwriting the original contents of directory install.
22
23 The install directory contains the following subdirectories
f4cfb62 @adinn updated README
adinn authored
24
be09ee4 @adinn updated Byteman license and ensured it and thrid party license are in…
adinn authored
25 bin -- contains Unix scripts to simplify: using Byteman (bmjava.sh);
592b60e @adinn modified src release zip so that build products are locatec correctly…
adinn authored
26 typechecking Byteman rule scripts (bytemancheck.sh);
27 communicating with the Byteman agent listener (bmsubmit.sh);
28 and installing the agent into a running JVM (bminstall.sh).
29 You will need to change the permissions of these files
32795a9 @adinn corrected error in maven install rules and also added byteman source …
adinn authored
30 in order to execute them directly from the command line.
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
31
be09ee4 @adinn updated Byteman license and ensured it and thrid party license are in…
adinn authored
32 docs -- contains the Byteman Programmer's guide and license
33 information for Byteman plus the third-party software it uses
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
34
592b60e @adinn modified src release zip so that build products are locatec correctly…
adinn authored
35 lib -- contains the Byteman agent and rule engine (byteman.jar);
36 the subset of this code needed to compile/run the submit
37 client (byteman-submit.jar); the subset of this code needed
38 to compile/run the install client (byteman-install.jar).
62712a3 @adinn updated README and changed release version to 1.0.1 ready for releasi…
adinn authored
39
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
40 sample/lib -- contains helper code for the sample scripts
f36cf74 @adinn mentioned use of offline rule type checker program
adinn authored
41
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
42 sample/scripts -- contains example rule scripts showing how to
43 use Byteman
5c9311d @adinn updated README to include new locatoj specs and refer to copyright file
adinn authored
44
e352068 @adinn added note of new contrib directory
adinn authored
45 contrib -- contains software contributed by other Byteman users
46
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
47 Using Byteman
5c9311d @adinn updated README to include new locatoj specs and refer to copyright file
adinn authored
48 -------------
6364099 @adinn updated README to include just the basics and refer the reader to the…
adinn authored
49 Please consult the Programmer's Guide for details of how Byteman
50 operates, how to write Byteman rule scripts and how to run a Java
51 program with the Byteman agent in place.
52
53 Take a look at the sample scripts directory to see some examples of
592b60e @adinn modified src release zip so that build products are locatec correctly…
adinn authored
54 how you can use Byteman to trace application and JVM execution or
55 to gather and present statistics detailing the operation of JVM
56 or application code.
57 (n.b. these examples still need extending to show how to use Byteman
58 for fault injection based testing).
5c9311d @adinn updated README to include new locatoj specs and refer to copyright file
adinn authored
59
60 Copyright
61 ---------
62 See the copyright file in the docs directory for details of the open
63 source license under which this code is released. Note that this code
64 employs the ObjectWeb ASM package to do bytecode manipulation and the
65 JFlex and JavaCUP tokeniser and parser genereators to generate and
66 provide runtime support for the rule parser which are also released
67 under open source licenses.
68
Something went wrong with that request. Please try again.