File: //usr/share/doc/iptraf-ng/Documentation/index.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>IPTraf-ng User's Manual</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="NEXT"
TITLE="About This Document"
HREF="f21.html"></HEAD
><BODY
CLASS="BOOK"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="BOOK"
><A
NAME="MANUAL"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="AEN2"
>IPTraf-ng User's Manual</A
></H1
><P
CLASS="COPYRIGHT"
>Copyright © 1997, 2003 Gerard Paul Java</P
><P
CLASS="COPYRIGHT"
>Copyright © 2016 Phil Cameron</P
><DIV
CLASS="LEGALNOTICE"
><P
></P
><A
NAME="LEGALINFO"
></A
><P
>This manual is released under the terms of the GNU
Free Documentation License of March, 2000 as published by the
Free Software Foundation, reproduced in this manual as Appendix B.</P
><P
>IPTraf-ng is open-source software released under the terms of the GNU General
Public License version 2 or any later version as published by the Free
Software Foundation, reproduced in the LICENSE file in the distribution's
top-level directory.</P
><P
>The accomanying software and the information contained in this
document are provided "AS IS" without warranty of any kind, express or
implied, including, without limitation, the implied warranties
of mercantability or fitness for any particular purpose.</P
><P
>In no event shall the author be liable for any indirect,
special, consequential, or incidental damages arising from the use of this
manual or the accompanying software even if the author has been advised of
the possibility of such damages.</P
><P
>Linux is a registered trademark of Linus Torvalds. Pentium is a
registered trademark of Intel Corporation. All other trademarks are
property of their respective owners.</P
><P
>Some structure declarations were based on code copyrighted by the Regents
of the University of California.</P
><P
></P
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="f21.html"
>About This Document</A
></DT
><DD
><DL
><DT
>1. <A
HREF="f21.html#ADDINFO"
>For Additional Information</A
></DT
><DT
>2. <A
HREF="x27.html"
>Document Conventions</A
></DT
></DL
></DD
><DT
>1. <A
HREF="c66.html"
>Getting Started</A
></DT
><DD
><DL
><DT
>1.1. <A
HREF="c66.html#AEN68"
>About IPTraf-ng</A
></DT
><DT
>1.2. <A
HREF="x96.html"
>Installation</A
></DT
><DD
><DL
><DT
>1.2.1. <A
HREF="x96.html#AEN98"
>System Requirements</A
></DT
><DT
>1.2.2. <A
HREF="x96.html#AEN138"
>Availability</A
></DT
></DL
></DD
><DT
>1.3. <A
HREF="x144.html"
>Starting and Stopping IPTraf-ng</A
></DT
><DT
>1.4. <A
HREF="x171.html"
>Command-line Options</A
></DT
><DT
>1.5. <A
HREF="x262.html"
>Using the Menus</A
></DT
><DT
>1.6. <A
HREF="x270.html"
>Exiting IPTraf-ng</A
></DT
></DL
></DD
><DT
>2. <A
HREF="c277.html"
>Preparing to Use IPTraf-ng</A
></DT
><DD
><DL
><DT
>2.1. <A
HREF="c277.html#NUMBERS"
>Number Display Notations</A
></DT
><DT
>2.2. <A
HREF="x304.html"
>Instances and Logging</A
></DT
><DT
>2.3. <A
HREF="x322.html"
>Screen Update Delays</A
></DT
><DT
>2.4. <A
HREF="x328.html"
>Supported Network Interfaces</A
></DT
></DL
></DD
><DT
>3. <A
HREF="c429.html"
>The IP Traffic Monitor</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="c429.html#UPPERWIN"
>The Upper Window</A
></DT
><DD
><DL
><DT
>3.1.1. <A
HREF="c429.html#AEN587"
>Closed/Idle/Timed Out Connections</A
></DT
><DT
>3.1.2. <A
HREF="c429.html#AEN598"
>Sorting TCP Entries</A
></DT
></DL
></DD
><DT
>3.2. <A
HREF="x606.html"
>Lower Window</A
></DT
><DD
><DL
><DT
>3.2.1. <A
HREF="x606.html#AEN697"
>Entry Details</A
></DT
></DL
></DD
><DT
>3.3. <A
HREF="x938.html"
>Additional Information</A
></DT
></DL
></DD
><DT
>4. <A
HREF="c954.html"
>Network Interface Statistics</A
></DT
><DD
><DL
><DT
>4.1. <A
HREF="c954.html#GENSTATS"
>General Interface Statistics</A
></DT
><DT
>4.2. <A
HREF="x980.html"
>Detailed Interface Statistics</A
></DT
></DL
></DD
><DT
>5. <A
HREF="c1037.html"
>Statistical Breakdowns</A
></DT
><DD
><DL
><DT
>5.1. <A
HREF="c1037.html#PKTSIZE"
>Packet Sizes</A
></DT
><DT
>5.2. <A
HREF="x1062.html"
>TCP and UDP Traffic Statistics</A
></DT
><DD
><DL
><DT
>5.2.1. <A
HREF="x1062.html#AEN1080"
>Sorting TCP/UDP Entries</A
></DT
><DT
>5.2.2. <A
HREF="x1062.html#AEN1088"
>Additional Information</A
></DT
></DL
></DD
></DL
></DD
><DT
>6. <A
HREF="c1101.html"
>LAN Station Statistics</A
></DT
><DD
><DL
><DT
>6.1. <A
HREF="c1101.html#SORTINGLAN"
>Sorting the LAN Station Monitor Entries</A
></DT
><DT
>6.2. <A
HREF="x1142.html"
>Additional Information</A
></DT
></DL
></DD
><DT
>7. <A
HREF="c1147.html"
>Filters</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="c1147.html#IPFILTERS"
>IP Filters</A
></DT
><DD
><DL
><DT
>7.1.1. <A
HREF="c1147.html#AEN1162"
>Defining a New Filter</A
></DT
><DT
>7.1.2. <A
HREF="c1147.html#AEN1760"
>Applying a Filter</A
></DT
><DT
>7.1.3. <A
HREF="c1147.html#AEN1765"
>Editing a Defined Filter</A
></DT
><DT
>7.1.4. <A
HREF="c1147.html#AEN1780"
>Deleting a Defined Filter</A
></DT
><DT
>7.1.5. <A
HREF="c1147.html#AEN1784"
>Detaching a Filter</A
></DT
></DL
></DD
><DT
>7.2. <A
HREF="x1789.html"
>ARP, RARP, and other Non-IP Packet Filters</A
></DT
></DL
></DD
><DT
>8. <A
HREF="c1793.html"
>Configuring IPTraf-ng</A
></DT
><DD
><DL
><DT
>8.1. <A
HREF="c1793.html#TOGGLES"
>Toggles</A
></DT
><DD
><DL
><DT
>8.1.1. <A
HREF="c1793.html#AEN1804"
>Reverse DNS Lookups</A
></DT
><DT
>8.1.2. <A
HREF="c1793.html#AEN1808"
>TCP/UDP Service Names</A
></DT
><DT
>8.1.3. <A
HREF="c1793.html#AEN1819"
>Force promiscuous</A
></DT
><DT
>8.1.4. <A
HREF="c1793.html#AEN1829"
>Color</A
></DT
><DT
>8.1.5. <A
HREF="c1793.html#AEN1833"
>Logging</A
></DT
><DT
>8.1.6. <A
HREF="c1793.html#AEN1870"
>Activity mode</A
></DT
><DT
>8.1.7. <A
HREF="c1793.html#AEN1874"
>Source MAC addrs in traffic monitor</A
></DT
></DL
></DD
><DT
>8.2. <A
HREF="x1880.html"
>Timers</A
></DT
><DD
><DL
><DT
>8.2.1. <A
HREF="x1880.html#AEN1887"
>TCP Timeout</A
></DT
><DT
>8.2.2. <A
HREF="x1880.html#AEN1890"
>Log Interval</A
></DT
><DT
>8.2.3. <A
HREF="x1880.html#AEN1895"
>Screen Update Interval</A
></DT
><DT
>8.2.4. <A
HREF="x1880.html#AEN1905"
>TCP closed/idle persistence</A
></DT
></DL
></DD
><DT
>8.3. <A
HREF="x1915.html"
>Custom Information</A
></DT
><DD
><DL
><DT
>8.3.1. <A
HREF="x1915.html#AEN1918"
>Additional ports</A
></DT
><DT
>8.3.2. <A
HREF="x1915.html#AEN1923"
>Delete port/range</A
></DT
><DT
>8.3.3. <A
HREF="x1915.html#AEN1927"
>LAN Station Identifiers</A
></DT
></DL
></DD
></DL
></DD
><DT
>9. <A
HREF="c1957.html"
>Background Operation</A
></DT
><DT
>A. <A
HREF="a1980.html"
>Messages</A
></DT
><DD
><DL
><DT
>A.1. <A
HREF="a1980.html#IPTRAFMESSAGES"
>IPTraf-ng Messages</A
></DT
><DT
>A.2. <A
HREF="x2335.html"
>Resolving Process Messages</A
></DT
></DL
></DD
><DT
>B. <A
HREF="a2377.html"
>GNU Free Documentation License</A
></DT
><DD
><DL
><DT
>B.1. <A
HREF="a2377.html#GFDL-0"
>PREAMBLE</A
></DT
><DT
>B.2. <A
HREF="x2387.html"
>APPLICABILITY AND DEFINITIONS</A
></DT
><DT
>B.3. <A
HREF="x2397.html"
>VERBATIM COPYING</A
></DT
><DT
>B.4. <A
HREF="x2401.html"
>COPYING IN QUANTITY</A
></DT
><DT
>B.5. <A
HREF="x2407.html"
>MODIFICATIONS</A
></DT
><DT
>B.6. <A
HREF="x2443.html"
>COMBINING DOCUMENTS</A
></DT
><DT
>B.7. <A
HREF="x2448.html"
>COLLECTIONS OF DOCUMENTS</A
></DT
><DT
>B.8. <A
HREF="x2452.html"
>AGGREGATION WITH INDEPENDENT WORKS</A
></DT
><DT
>B.9. <A
HREF="x2456.html"
>TRANSLATION</A
></DT
><DT
>B.10. <A
HREF="x2459.html"
>TERMINATION</A
></DT
><DT
>B.11. <A
HREF="x2462.html"
>FUTURE REVISIONS OF THIS LICENSE</A
></DT
><DT
>B.12. <A
HREF="x2467.html"
>How to use this License for your documents</A
></DT
></DL
></DD
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Tables</B
></DT
><DT
>2-1. <A
HREF="c277.html#AEN284"
>Numeric Display Notations</A
></DT
></DL
></DIV
><DIV
CLASS="LOT"
><DL
CLASS="LOT"
><DT
><B
>List of Figures</B
></DT
><DT
>1-1. <A
HREF="x262.html#AEN267"
>The IPTraf-ng Main Menu</A
></DT
><DT
>2-1. <A
HREF="x304.html#AEN313"
>The logfile prompt dialog</A
></DT
><DT
>3-1. <A
HREF="c429.html#AEN436"
>The IP traffic monitor</A
></DT
><DT
>3-2. <A
HREF="c429.html#AEN603"
>The IP traffic monitor sort criteria</A
></DT
><DT
>4-1. <A
HREF="c954.html#AEN976"
>The general interface statistics screen</A
></DT
><DT
>4-2. <A
HREF="x980.html#AEN1006"
>The detailed interface statistics screen</A
></DT
><DT
>5-1. <A
HREF="c1037.html#AEN1044"
>The packet size statistical breakdown</A
></DT
><DT
>5-2. <A
HREF="x1062.html#AEN1065"
>The TCP/UDP service monitor</A
></DT
><DT
>5-3. <A
HREF="x1062.html#AEN1085"
>The TCP/UDP monitor's sort criteria</A
></DT
><DT
>6-1. <A
HREF="c1101.html#AEN1125"
>The LAN station monitor</A
></DT
><DT
>6-2. <A
HREF="c1101.html#AEN1135"
>The LAN station monitor's sort criteria</A
></DT
><DT
>7-1. <A
HREF="c1147.html#AEN1152"
>The Filters submenu</A
></DT
><DT
>7-2. <A
HREF="c1147.html#AEN1159"
>The IP filter menu</A
></DT
><DT
>7-3. <A
HREF="c1147.html#AEN1167"
>The IP filter name dialog</A
></DT
><DT
>7-4. <A
HREF="c1147.html#AEN1174"
>The filter rule selection screen. Selecting an entry
displays that set for editing</A
></DT
><DT
>7-5. <A
HREF="c1147.html#AEN1299"
>The IP filter parameters dialog</A
></DT
><DT
>8-1. <A
HREF="c1793.html#AEN1799"
>The IPTraf-ng configuration menu</A
></DT
><DT
>8-2. <A
HREF="x1880.html#AEN1884"
>The Timers configuration submenu</A
></DT
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="f21.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>About This Document</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>