<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
<refentry>

<refmeta>
<refentrytitle>
<application>flow-print</application>
</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>
<application>flow-print</application>
</refname>
<refpurpose>
Display flows in formatted ASCII.
</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>flow-print</command>
<arg>-hlnpw</arg>
<arg>-d<replaceable> debug_level</replaceable></arg>
<arg>-f<replaceable> format</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>flow-print</command> utility will display flow data in
ASCII using pre-defined formats selectable with -f.

<literallayout>
Some of the less descriptive column headers are defined below

Header     Description
-------------------------------
Sif           Source Interface ifIndex.
DiF           Destination Interface ifIndex.
Pr            Protocol.
P             Protocol.
SrcP          Source Port.
DstP          Destination Port.
Pkts          Packets.
Octets        Octets (Bytes).
Active        Time in ms the flow was active.
B/Pk          Bytes per Packet.
Ts            Type of Service.
Fl            Flags, for TCP the cumulative or of the TCP control bits.
srcAS         Source AS.
dstAS         Destination AS.
Start         Start time of the flow.
End           End time of the flow.
router_sc     V7 IP address of router producing shorcuts.
peer_nexthop  V6 IP address of peer next hop IP address.
encap i/o     Version 6 only.  Encapsulation size in/out
duration      Time in ms the flow was active.
input         Input Interface ifIndex.
output        Output Interface ifIndex.
flows         Number of aggregated flows.
mTos          V8.x ToS of pkts that exceeded the contract.
xpackets      V8.x Packets that exceed the contract.
</literallayout>
</para>
</refsect1>

<refsect1>
<title>OPTIONS</title>
<variablelist>

<varlistentry>
<term>-d<replaceable> debug_level</replaceable></term>
<listitem>
<para>
Enable debugging.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-f<replaceable> format</replaceable></term>
<listitem>
<para>
Select format.  The default is appropriate for the export type of the
flow data.  Available formats are:
<literallayout>
    0 1 line, interfaces, hex ports
    1 2 line (includes timing and flags)
    2 2 line candidate TCP syn attack flows
    3 1 line, no interfaces, decimal ports
    4 1 line with AS number
    5 1 line, 132 column
    6 show ip accounting emulation
    7 1 line, 132 column +router_id
    8 1 line, 132 column +encapsulation
    9 1 line with tag values
   10 AS aggregation
   11 Protocol Port aggregation
   12 Source Prefix aggregation
   13 Destination Prefix aggregation
   14 Prefix aggregation
   15 Destination aggregation (Catalyst)
   16 Source Destination aggregation (Catalyst)
   17 Full Flow (Catalyst)
   18 ToS AS Aggregation
   19 ToS Proto Port aggregation
   20 ToS Source Prefix aggregation
   21 ToS Destination Prefix aggregation
   22 ToS Prefix Aggregation
   23 ToS Prefix Port aggregation
   24 Full (Catalyst)
</literallayout>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-h</term>
<listitem>
<para>
Display help.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-l</term>
<listitem>
<para>
Unbuffer output.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-n</term>
<listitem>
<para>
Use symbolic names where appropriate.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-p</term>
<listitem>
<para>
Display header information.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-w</term>
<listitem>
<para>
Wide output.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>EXAMPLES</title>
<informalexample>
<para>
Display flows in <filename>flowfile</filename>
</para>
<para>
  <command>flow-print &lt flowfile</command>
</para>
</informalexample>
</refsect1>

<refsect1>
<title>FILES</title>
<para>
  Configuration files:
    Symbols - <filename>@localstatedir@/sym/*</filename>.
</para>
</refsect1>


<refsect1>
<title>BUGS</title>
<para>
None known.
</para>
</refsect1>

<refsect1>
<title>AUTHOR</title>
<para>
<author>
<firstname>Mark</firstname>
<surname>Fullmer</surname>
</author>
<email>maf@splintered.net</email>
</para>
</refsect1>

<refsect1>
<title>SEE ALSO</title>
<para>
<application>flow-tools</application>(1)
</para>
</refsect1>

</refentry>
