modified command line args to psuedoparadyn
[dyninst.git] / visi / test / README_NEW
1 This directory contains test programs for both sides of the visi interface.
2 Server side programs (visualizations) are in the server subdirectory, and
3 client side programs are in the client subdirectory.
4
5 Interface test programs 
6 -----------------------
7 #############
8 psuedoparadyn: 
9 #############
10     This program is a visiLib client application.   It is an interactive
11     test in which a user can specify actions to take that will invoke 
12     visiLib interface routines.  This application writes output prefaced
13     by "###" to stderr.
14
15     to run psuedoparadyn:
16     --------------------
17     psuedoparadyn server_executable <server_args>
18
19     The default values: numMets = 0 numRes = 0 numBins = 1000 binWidth = 0.2
20
21     By changing the definitions DEFAULT_NUM_BUCKETS, and DEFAULT_BUCKET_WIDTH 
22     in psuedoparadyn.C, the default values for numBins and binWidth can be
23     modified.
24
25
26 ##############
27 xtext, xtext2:  
28 ##############  
29     These are visiLib server applications (visualization processes).
30     Both are examples of integrating visi interface routines into an
31     existing visualization application's source code.  Both are based
32     on a simple X application that uses the Athena widget set.
33     The source code for xtext contains references to the README file in 
34     ~paradyn/core/visi/docs/.  The server's output is prefaced by @@@@ 
35     and is written to stderr.
36
37 xtext
38 -----
39     xtext.C includes examples of adding  callbacks to the Paradyn handler for
40     certain Paradyn events (DATAVALUES,FOLD,ADDMETRICSRESROURCES).  Also,
41     it includes an example of adding an upcall to Paradyn by creating a widget
42     which will invoke an upcall to Paradyn (ie. GetMetricsResources) 
43
44     code that was added to the original xtext.C source in order to add it to 
45     Paradyn is surrounded by "///////////////////////////////" in xtext.C
46
47 xtext2
48 ------
49     is an extension to xtext that includes callbacks for all Paradyn events
50     and upcalls.
51       
52 ######################################
53 examples of how run test applications: 
54 ######################################
55 psuedoparadyn:  
56
57     psuedoparadyn rthist 
58         (starts psuedoparadyn with the default arguments, psuedoparadyn then
59          will start the real time histogram visualization)
60         
61     psuedoparadyn tclVisi -f phaseTable.tcl 
62         (starts psuedoparadyn which will start tclVisi with the phaseTable 
63          tcl application)
64
65
66 xtext and xtext2 with paradyn:
67
68      (1) add a visi description to a paradyn config. file 
69          ex.
70              visi Xtext2 {
71                  command "xtext2";
72                  force 1;
73              }
74
75              visi Xtext {
76                  command "xtext";
77              }
78
79      (2) start paradyn and define a process
80      (3) select "Start a Visualization" from the Visualization menu on
81          the Paradyn main window
82      (4) menu options labeled "Xtext2" and "Xtext" will appear in the menu
83          and can be selected to start either one
84
85       note: the force option above is optional, and if set to 1 means that
86             the visualization process (xtext2) will be started without the
87             paradyn process menuing for metrics and resources first.  The
88             default behavior is that menuing occurs before the visualization
89             process is started.