← Back to branch summary

~ubuntu-branches/ubuntu/dapper/flow-tools/dapper

« back to all changes in this revision

Viewing changes to docs/flow-report.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Radu Spineanu
  • Date: 2005-06-02 20:12:57 UTC
  • mfrom: (1.1.1 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20050602201257-jv0qdk3hjhpdf04b
Tags: 1:0.68-2
http://bugs.debian.org/311568
Fixed a bashism in init script (closes: #311568)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/flow-report.1.in
64
64
can be used by a front end to produce readable reports, graphs,
65
65
and charts\&.
66
66
.PP
67
 
Reports are definied by the \&'stat-report\&' keyword followed by a report
68
 
name\&.  Each report has a type defined below and other commands\&.  Reports
69
 
are grouped into a definition with the \&'stat-definition\&' keyword
70
 
followed by a definition name\&.  Each definition can invoke a filter
 
67
Reports are definied in a configuration file by the \&'stat-report\&' keyword
 
68
followed by a report name\&.  Each report has a type defined below and other
 
69
commands\&.  Reports are grouped into a definition with the \&'stat-definition\&'
 
70
keyword followed by a definition name\&.  Each definition can invoke a filter
71
71
and optionally apply tags\&.
72
72
.PP
 
73
Words in the configuration file of the form @VAR or @{VAR:default} will be
 
74
expanded at run-time by setting variable names with the -v option\&.
 
75
.PP
73
76
Generated reports consist of comment lines and report lines\&.  Comment
74
77
lines begin with a # and include details such as the options used, report
75
78
name, records in the report, and the report line format\&.  Some of the
506
509
.IP "-v\fI variable binding\fP" 10
507
510
Set a variable FOO=bar\&.
508
511
.IP "-h" 10
509
 
Display help\&.
 
512
Display help\&.  -hh will list the available reports\&.
510
513
.SH "EXAMPLES"
511
514
.PP
512
515
An example of report configuration file
566
569
Flows without a packet or octet count are ignored\&.
567
570
.SH "FILES"
568
571
.PP
569
 
Symbols are located in \fB@localstatedir@/sym/*\fP
 
572
  Configuration files:
 
573
    Symbols - \fB@localstatedir@/sym/*\fP\&.
 
574
    Tag - \fB@localstatedir@/cfg/tag\&.cfg\fP\&.
 
575
    Filter - \fB@localstatedir@/cfg/filter\&.cfg\fP\&.
 
576
    Mask - \fB@localstatedir@/cfg/mask\&.cfg\fP\&.
 
577
    Report - \fB@localstatedir@/cfg/stat\&.cfg\fP\&.
 
578
    Xlate - \fB@localstatedir@/cfg/xlate\&.cfg\fP\&.
570
579
.SH "BUGS"
571
580
.PP
572
581
None known\&.
576
585
.SH "SEE ALSO"
577
586
.PP
578
587
\fBflow-tools\fP(1)
579
 
...\" created by instant / docbook-to-man, Mon 01 Dec 2003, 03:22
 
588
...\" created by instant / docbook-to-man, Wed 07 Jan 2004, 23:53