File: flow-rptfmt.html.in

package info (click to toggle)

flow-tools 1%3A0.68-12.1

links: PTS
area: main
in suites: jessie, jessie-kfreebsd, wheezy
size: 5,136 kB
ctags: 5,259
sloc: ansic: 43,197; sh: 1,674; perl: 661; python: 629; yacc: 303; makefile: 208; lex: 49

file content (275 lines) | stat: -rw-r--r-- 3,390 bytes

parent folder | download | duplicates (4)

<HTML
><HEAD
><TITLE
>flow-rptfmt</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.73
"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
><SPAN
CLASS="APPLICATION"
>flow-rptfmt</SPAN
></A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6"
></A
><H2
>Name</H2
><SPAN
CLASS="APPLICATION"
>flow-rptfmt</SPAN
>&nbsp;--&nbsp;Format the output of flow-report in ASCII or HTML</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN10"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>flow-rptfmt</B
>  [-hHnp] [-a<TT
CLASS="REPLACEABLE"
><I
> alarm_time</I
></TT
>] [-f<TT
CLASS="REPLACEABLE"
><I
> format</I
></TT
>] [-F<TT
CLASS="REPLACEABLE"
><I
> fields</I
></TT
>] [-m<TT
CLASS="REPLACEABLE"
><I
> max_lines</I
></TT
>] [-s<TT
CLASS="REPLACEABLE"
><I
> sort_field</I
></TT
>]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN24"
></A
><H2
>DESCRIPTION</H2
><P
>The <B
CLASS="COMMAND"
>flow-rptfmt</B
> utility processes the CSV output of
flow-report into formatted ASCII or HTML.  Sorting, maximum display lines,
field filter, header display, and name substitution are supported during
post processing.  Additionally an alarm can be set for use in CGI scripts
to limit the CPU time of formatting.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN28"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-a<TT
CLASS="REPLACEABLE"
><I
> alarm_time</I
></TT
></DT
><DD
><P
>Exit after <TT
CLASS="REPLACEABLE"
><I
>alarm_time</I
></TT
> seconds.</P
></DD
><DT
>-f<TT
CLASS="REPLACEABLE"
><I
> ascii</I
></TT
>|<TT
CLASS="REPLACEABLE"
><I
>html</I
></TT
></DT
><DD
><P
>Set output format.  Defaults to ASCII.</P
></DD
><DT
>-F<TT
CLASS="REPLACEABLE"
><I
> display_fields</I
></TT
></DT
><DD
><P
>Limit columns to <TT
CLASS="REPLACEABLE"
><I
>display_fields</I
></TT
></P
></DD
><DT
>-h</DT
><DD
><P
>Help.</P
></DD
><DT
>-H</DT
><DD
><P
>Display header information.</P
></DD
><DT
>-m <TT
CLASS="REPLACEABLE"
><I
>max_lines</I
></TT
></DT
><DD
><P
>Limit rows to max_lines.</P
></DD
><DT
>-n</DT
><DD
><P
>Enable symbol table lookups.</P
></DD
><DT
>-p</DT
><DD
><P
>Display in percent total form.</P
></DD
><DT
>-s<TT
CLASS="REPLACEABLE"
><I
> sort_field</I
></TT
></DT
><DD
><P
>Sort on <TT
CLASS="REPLACEABLE"
><I
>sort_field</I
></TT
>.  Prepend with + for ascending,
- for descending sort.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN76"
></A
><H2
>EXAMPLES</H2
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN78"
></A
><P
></P
><P
>Format the output of daily-ip-protocol.txt in ASCII.  Display the ip-protocol
and octets fields in percent total format with symbols.  Limit output to top
5 sorted by octets.</P
><P
>    <B
CLASS="COMMAND"
>cat daily-ip-protocol.txt | flow-rptfmt -fascii -Fip-protocol,octets -p -n -m5 </B
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN82"
></A
><H2
>BUGS</H2
><P
>Sorting could be faster.  Percent totals could be faster.  May not work
with flow-report prior to 0.68.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN85"
></A
><H2
>AUTHOR</H2
><P
>Mark Fullmer
<TT
CLASS="EMAIL"
>&#60;<A
HREF="mailto:maf@splintered.net"
>maf@splintered.net</A
>&#62;</TT
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN92"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="APPLICATION"
>flow-tools</SPAN
>(1)</P
></DIV
></BODY
></HTML
>