recorder_scope(1)

1
2recorder_scope(1)              Recorder Library              recorder_scope(1)
3
4
5

NAME

7       record_scope - A real-time graphing tool for recorded data
8
9
10

SYNOPSIS

12       recorder_scope [options] channels
13
14
15

DESCRIPTION

17       The  recorder_scope  program  graphs  the  data  collected  by selected
18       record(3) statements in a program.  It  can  also  be  used  to  update
19       recorder  configuration  in real-time while the instrumented program is
20       running.
21
22
23       The channels to display are selected using  regular  expressions.  They
24       must   have   been   shared   by   the   instrumented   program   using
25       recorder_trace_set(3) typically by setting the RECORDER_TRACES environ‐
26       ment  variable,  or  any  other method that your program uses to pass a
27       recorder configuration string to the recorder_trace_set(3) function.
28
29
30

OPTIONS

32       The program accepts the following options:
33
34
35       -c config
36              Send the configuration command to the instrumented program. This
37              makes  it  possible  for  example  to dynamically adjust tracing
38              options.
39
40
41       -s slider
42              Setup a slider on the user interface that can be used to control
43              a  specific trace value, see RECORDER_TRACE(3).  The slider syn‐
44              tax is name=initial:min:max  where  name  is  the  name  of  the
45              recorder  to configure, initial is its initial value, min is the
46              lowest possible value on the slider and max is the highest  pos‐
47              sible value on the slider.
48
49
50       -d duration
51              Set the maximum duration in seconds for the data being displayed
52              on the window. Data older than this duration will not be shown.
53
54
55       -w samples
56              Set the sample window, i.e. the maximum number of  samples  dis‐
57              played  simultaneously.  A  value of 0 will automatically select
58              the window width in pixels.
59
60
61       -t     Toggle timing display in the graphs.  The  same  effect  can  be
62              achieved while the program is running using the 't' key.
63
64
65       -m     Toggle  display of minimum and maximum values in the graphs. The
66              same effect can be achieved while the program is  running  using
67              the 'm' key.
68
69
70       -a     Toggle display of running average values in the graphs. The same
71              effect can be achieved while the program is  running  using  the
72              'a' key.
73
74
75       -n     Toggle  display  of the normal values in the graphs (for example
76              if you are only interested in min  and  max  values).  The  same
77              effect  can  be  achieved while the program is running using the
78              'n' key.
79
80
81       -r ratio
82              Set averaging ratio for -m and -a options, in percent.
83
84
85       -b basename
86              Set the basename for file when saving data or screen shots.
87
88
89       -g WxH@XxY
90              Set the window geometry to W x H pixels at position (X, Y)
91
92

EXAMPLES

94       If the instrumented program contains the following recorder  instrumen‐
95       tation:
96
97
98           int rate = RECORDER_TWEAK(rate);
99           record(my_recorder, "The value of %d is %d", x, y * rate);
100
101
102       then  the  values  of  x  and  y can be exported by running the program
103       instrumented.   For   example,   setting   the   environment   variable
104       RECORDER_TRACES  to  the  value my_recorder=x_value,y_value will export
105       the first two data values  in  recorder  my_recorder  under  the  names
106       x_value and y_value for use by recorder_scope.
107
108
109       To graph these values, you would use:
110
111
112           % recorder_scope x_value y_value
113
114
115
116       To enable tracing for all recorders whose names end in "error":
117
118
119           % recorder_scope -c '.*error'
120
121
122       To set the 'rate' tweak to 10, giving the value of RECORDER_TRACE(rate)
123       or RECORDER_TWEAK(rate) the value 10:
124
125
126           % recorder_scope -c 'rate=10'
127
128
129       To adjust the value of 'rate' using a slider starting at value  10  and
130       where the values can be set between 10 and 39:
131
132
133           % recorder_scope -s 'rate=10:2:39'
134
135
136

ENVIRONMENT VARIABLES

138       The  path  to  the  shared  memory  file  can  be  specified  using the
139       RECORDER_SHARE environment variable. That variable should be  set  con‐
140       sistently  between  the  instrumented  program  and  the recorder_scope
141       application.
142
143
144

BUGS

146       The recorder_scope program normally attempts to use OpenGL  for  faster
147       rendering.  This  may  not  be convenient for example over a remote X11
148       connexion. In that  case,  you  should  set  the  environment  variable
149       RECORDER_NOGL=1 and will have significantly lower performance.
150
151
152
153       Bugs should be reported using https://github.com/c3d/recorder/issues.
154
155
156

AUTHOR

167       Written by Christophe de Dinechin
168
169
170
1711.0                               2019-03-09                 recorder_scope(1)