11include ( manual.h ) dnl
2- HEADER(vine_graph_log )
2+ HEADER(vine_plot_performance )
33
44SECTION(NAME)
5- BOLD(vine_graph_log ) - plots TaskVine performance logs.
5+ BOLD(vine_plot_performance ) - plots TaskVine performance logs.
66
77SECTION(SYNOPSIS)
8- CODE(vine_graph_log [ options] vine-perf-log)
8+ CODE(vine_plot_performance [ options] vine-perf-log)
99
1010SECTION(DESCRIPTION)
1111
12- BOLD(vine_graph_log ) is a script to plot some of the statistics from a
12+ BOLD(vine_plot_performance ) is a script to plot some of the statistics from a
1313TaskVine log, as generated by CODE(vine_enable_perf_log) from the C API, or by
14- CODE(q.enable_perf_log) from the Python API. It assumes the availability of
15- CODE(gnuplot).
14+ CODE(q.enable_perf_log) from the Python API.
1615
17- BOLD(vine_graph_log ) generates four plots, all with CODE(timestamp) as
16+ BOLD(vine_plot_performance ) generates four plots, all with CODE(timestamp) as
1817the independent variable:
1918
2019CODE(time):
@@ -33,9 +32,8 @@ SECTION(OPTIONS)
3332OPTIONS_BEGIN
3433OPTION_ARG_SHORT(o,prefix-output)Generate prefix-output.{time,time-log,tasks,tasks-log}.PARAM(output-format). Default is PARAM(work-queue-log).
3534OPTION_ARG_SHORT(o,prefix-output)Generate prefix-output.{time,time-log,tasks,tasks-log}.PARAM(output-format). Default is PARAM(work-queue-log).
36- OPTION_ARG_SHORT(c,gnuplot-path)Specify the location of the gnuplot executable. Default is gnuplot.
3735OPTION_ARG_SHORT(r,range)Range of time to plot, in time units (see -u) from the start of execution. Of the form: min:max, min:, or :max.
38- OPTION_ARG_SHORT(T,output-format)Set output format. Default is png. If "text", then the gnuplot scripts are written instead of the images .
36+ OPTION_ARG_SHORT(T,output-format)Set output format. Default is svg .
3937OPTION_ARG_SHORT(u,time-unit)Time scale to output. One of s,m,h or d, for seconds, minutes (default), hours or days.
4038OPTION_FLAG_SHORT(h)Show help text.
4139OPTIONS_END
@@ -45,37 +43,21 @@ SECTION(EXAMPLES)
4543General use:
4644
4745LONGCODE_BEGIN
48- % vine_graph_log mylog
46+ % vine_plot_performance mylog
4947% ls mylog*.png
5048mylog.tasks.png mylog.tasks-log.png mylog.time.png mylog.time-log.png
5149LONGCODE_END
5250
5351Plot up to the eleventh hour:
5452
5553LONGCODE_BEGIN
56- % vine_graph_log -u h -r :11 mylog
54+ % vine_plot_performance -u h -r :11 mylog
5755
5856LONGCODE_END
5957Generate script text:
6058
61- LONGCODE_BEGIN
62- % vine_graph_log -Ttext mylog
63- % ls mylog*.gnuplot
64- mylog.tasks.png.gnuplot mylog.tasks-log.png.gnuplot mylog.time.png.gnuplot mylog.time-log.png.gnuplot
65- LONGCODE_END
66-
67- Specify gnuplot path:
68-
69- LONGCODE_BEGIN
70- % vine_graph_log -c/some/dir/bin/gnuplot mylog
71- LONGCODE_END
72-
7359SECTION(BUGS)
7460
75- LIST_BEGIN
76- LIST_ITEM(Some formats need a special setup for their gnuplot output terminal. `-T' blindly passes the output format, which may cause gnuplot to fail.)
77- LIST_END
78-
7961SECTION(COPYRIGHT)
8062
8163COPYRIGHT_BOILERPLATE
0 commit comments