]> gitweb.fperrin.net Git - iftop.git/blobdiff - iftop.8
gitignore
[iftop.git] / iftop.8
diff --git a/iftop.8 b/iftop.8
index 860b7853463fdeab42afa2c30f7006f2ecaa47f0..0dbaac0a5457afb10ef04e2c8d14f0885558e5e6 100644 (file)
--- a/iftop.8
+++ b/iftop.8
@@ -3,7 +3,7 @@
 .\" iftop.8:
 .\" Manual page for iftop.
 .\"
-.\" $Id: iftop.8,v 1.27 2010/11/27 11:06:12 pdw Exp $
+.\" $Id: iftop.8,v 1.31 2014/01/05 17:22:39 pdw Exp $
 .\"
 
 .SH NAME
@@ -11,7 +11,7 @@ iftop - display bandwidth usage on an interface by host
 
 .SH SYNOPSIS
 \fBiftop\fP \fB-h\fP |
-[\fB-nNpblBP\fP] [\fB-i\fP \fIinterface\fP] [\fB-f\fP \fIfilter code\fP] [\fB-F\fP \fInet\fP/\fImask\fP]
+[\fB-nNpblP\fP] [\fB-u\fP \fIunit\fP] [\fB-i\fP \fIinterface\fP] [\fB-f\fP \fIfilter code\fP] [\fB-F\fP \fInet\fP/\fImask\fP]
 [\fB-G\fP \fInet6\fP/\fImask6\fP]
 .SH DESCRIPTION
 \fBiftop\fP listens to network traffic on a named \fIinterface\fP, or on the
@@ -31,7 +31,7 @@ By default, \fBiftop\fP counts all IP packets that pass through the filter, and
 the direction of the packet is determined according to the direction the packet
 is moving across the interface.  Using the \fB-F\fP option it is possible to
 get \fBiftop\fP to show packets entering and leaving a given network.  For
-example, \fBiftop -F 10.0.0.0/255.0.0.0\fP will analyse packets flowing in and
+example, \fBiftop \-F 10.0.0.0/255.0.0.0\fP will analyse packets flowing in and
 out of the 10.* network.
 
 Some other filter ideas:
@@ -72,8 +72,14 @@ The default is not to display that address category.
 \fB-b\fP
 Don't display bar graphs of traffic. 
 .TP
+\fB-m\fP \fIlimit\fP
+Set the upper limit for the bandwidth scale.  Specified as a number with a 'K', 'M' or 'G' suffix.
+.TP
+\fB-u\fP \fIbits\fP|\fIbytes\fP|\fIpackets\fP
+Display bandwidth rates in the given unit (per second).
+.TP
 \fB-B\fP
-Display bandwidth rates in bytes/sec rather than bits/sec.
+Synonym for \fB-u\fP \fIbits\fP.
 .TP
 \fB-i\fP \fIinterface\fP
 Listen to packets on \fIinterface\fP.
@@ -97,6 +103,10 @@ bitmasking.
 \fB-c\fP \fIconfig file\fP
 Specifies an alternate config file.  If not specified, iftop will use
 \fB~/.iftoprc\fP if it exists.  See below for a description of config files
+.TP
+\fB-t\fP \fItext output mode\fP
+Use text interface without ncurses and print the output to STDOUT.
+
 
 .SH DISPLAY
 
@@ -113,7 +123,6 @@ instance,
 foo.example.com  =>  bar.example.com      1Kb  500b   100b
                  <=                       2Mb    2Mb    2Mb
 
-.Sp
 .fi
 shows, on the first line, traffic from \fBfoo.example.com\fP to
 \fBbar.example.com\fP; in the preceding 2 seconds, this averaged 1Kbit/s,
@@ -196,7 +205,6 @@ directive is a name value pair, for example:
 
 interface: eth0
 
-.Sp
 .fi
 sets the network interface.  The following config directives are supported:
 
@@ -231,8 +239,11 @@ Hides source host names.
 \fBhide-destination:\fP \fI(yes|no)\fP
 Hides destination host names.
 .TP
+\fBbandwidth-unit:\fP \fI(bits|bytes|packets)\fP
+Use the specified unit for bandwidth display. The default is bits.
+.TP
 \fBuse-bytes:\fP \fI(yes|no)\fP
-Use bytes for bandwidth display, rather than bits.
+\fBuse-bytes: yes\fP is a synonym of \fBbandwidth-unit: packets\fP.
 .TP
 \fBsort:\fP \fI(2s|10s|40s|source|destination)\fP
 Sets which column is used to sort the display.
@@ -310,7 +321,7 @@ Configuration file for iftop.
 Paul Warren <pdw@ex-parrot.com>
 
 .SH VERSION
-$Id: iftop.8,v 1.27 2010/11/27 11:06:12 pdw Exp $
+$Id: iftop.8,v 1.31 2014/01/05 17:22:39 pdw Exp $
 
 .SH COPYING
 This program is free software; you can redistribute it and/or modify
@@ -323,7 +334,7 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.