File: event2vrule.1

package info (click to toggle)
flowscan 1.006-13
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 728 kB
  • ctags: 185
  • sloc: sh: 1,670; perl: 1,518; makefile: 148
file content (40 lines) | stat: -rw-r--r-- 1,528 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.TH EVENT2VRULE 1
.SH NAME
event2vrule \- adds 'events' to rrdtool graphs
.SH SYNOPSIS
.B event2vrule <params>
.SH "DESCRIPTION"
Adding Events to Graphs

There is a new graphing feature which allows you to specify events that should be displayed in your graphs. These events are simply a list of points in time at which something of interest occurred.

For instance, one could create a plain text file in the graphs directory called events.txt containing these lines:

  2001/02/10 1538 added support for events to FlowScan graphs
  2001/02/12 1601 allowed the events file to be named on make command line

Then to generate the graphs with those events included one might run:

  $ make -f graphs.mf events=events.txt

This feature was implemented using a new script called event2vrule that is supplied with FlowScan. This script is meant to be used as a ``wrapper'' for running rrdtool(1), similarly to how one might run nohup(1). E.g.:

  $ event2vrule -h 48 events.txt rrdtool graph -s -48h ...

That command will cause these VRULE arguments to be passed to rrdtool, at the end of the argument list:

  COMMENT:\\n
  VRULE:981841080#ff0000:2001/02/10 1538 added support for events to FlowScan graphs
  COMMENT:\\n
  VRULE:982015260#ff0000:2001/02/12 1601 allowed the events file to be named on make command line
  COMMENT:\\n

.SH "SEE ALSO"
.BR add_ds.pl (1),
.BR add_txrx (1),
.BR flowscan (1),
.BR ip2hostname (1),
.BR locker (1)
.SH AUTHOR
This manual page was written by Anibal Monsalve Salazar,
for the Debian Project.