README

   1 ==========================================================================
   2 IPTraf 3.0 README
   3 --------------------------------------------------------------------------
   4 See the RELEASE-NOTES for important update information.
   5 See the INSTALL file for installation instructions.
   6 --------------------------------------------------------------------------
   7
   8 DESCRIPTION
   9 -----------
  10
  11 IPTraf is a console-based network monitoring program for Linux that
  12 displays information about IP traffic.  It returns such information as:
  13
  14         Current TCP connections
  15         UDP, ICMP, OSPF, and other types of IP packets
  16         Packet and byte counts on TCP connections
  17         IP, TCP, UDP, ICMP, non-IP, and other packet and byte counts
  18         TCP/UDP counts by ports
  19         Packet counts by packet sizes
  20         Packet and byte counts by IP address
  21         Interface activity
  22         Flag statuses on TCP packets
  23         LAN station statistics
  24
  25 This program can be used to determine the type of traffic on your network,
  26 and what kind of service is the most heavily used on what machines, among
  27 others.
  28
  29 IPTraf works on Ethernet, FDDI, ISDN, PLIP, loopback, and SLIP/PPP
  30 interfaces.
  31
  32 Updates and announcements are at the iptraf-ng@lists.fedorahosted.org,
  33 see README.contact for more information.
  34
  35 IMPORTANT CHANGES
  36 -----------------
  37
  38 Important changes are detailed in the RELEASE-NOTES file, please take some
  39 time to read it.  There are some changes in the log file names, and the
  40 policies on multiple instances have been somewhat relaxed.
  41
  42 DISTRIBUTION NOTICE
  43 -------------------
  44
  45 This is the general release of IPTraf.  IPTraf has been incorporated into
  46 the Debian GNU/Linux, Turbolinux and S.u.S.E. distributions, as well as
  47 the Trinux security toolkit distribution and Red Hat Powertools.
  48
  49 Linux distributions may have tailored the IPTraf package to suit their
  50 purposes.  Direct questions, comments or inquiries about a
  51 distribution-specific package to its maintainer.
  52
  53 SYSTEM REQUIREMENTS
  54 -------------------
  55
  56 IPTraf 2 and later  requires at least Linux kernel 2.2.  It uses the new
  57 PF_PACKET socket family as its capture mechanism.  This feature is new to
  58 the 2.2 kernel.  Make sure you have the Packet Socket driver compiled in or
  59 installed as a module, or IPTraf will fail (and so will others like it:
  60 tcpdump, netwatch, etc).
  61
  62 IPTraf also requires glibc 2.1 or later.
  63
  64 COPYING AND DISTRIBUTION
  65 ------------------------
  66
  67 This software is OSI Certified Open Source Software
  68 OSI Certified is a certification mark of the Open Source Initiative.
  69
  70 Redistribution and modification of this software is permitted under the
  71 terms of the GNU General Public License.  See the included LICENSE file
  72 for details.
  73
  74 FOR FURTHER INFORMATION
  75 -----------------------
  76
  77 Full information is in the manual in the Documentation directory.  See
  78 also the CHANGES file for a record of fixes and new features.  Updates and
  79 announcements are in the IPTraf Web page indicated above.  Other README
  80 files contain some other bits of information.  The RELEASE-NOTES file
  81 contains important release-specific information.