--- embedaddon/iftop/iftop.8 2012/02/21 16:57:34 1.1.1.1 +++ embedaddon/iftop/iftop.8 2016/10/18 14:04:50 1.1.1.2 @@ -3,7 +3,7 @@ .\" iftop.8: .\" Manual page for iftop. .\" -.\" $Id: iftop.8,v 1.1.1.1 2012/02/21 16:57:34 misho Exp $ +.\" $Id: iftop.8,v 1.1.1.2 2016/10/18 14:04:50 misho Exp $ .\" .SH NAME @@ -11,8 +11,8 @@ iftop - display bandwidth usage on an interface by hos .SH SYNOPSIS \fBiftop\fP \fB-h\fP | -[\fB-nNpbBP\fP] [\fB-i\fP \fIinterface\fP] [\fB-f\fP \fIfilter code\fP] [\fB-F\fP \fInet\fP/\fImask\fP] - +[\fB-nNpblBP\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 first interface it can find which looks like an external interface if none is @@ -25,13 +25,13 @@ By default, \fBiftop\fP will look up the hostnames ass finds in packets. This can cause substantial traffic of itself, and may result in a confusing display. You may wish to suppress display of DNS traffic by using filter code such as \fBnot port domain\fP, or switch it off entirely, -by using the \fB-n\fP option or by pressing \fBR\fP when the program is running. +by using the \fB-n\fP option or by pressing \fBr\fP when the program is running. 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: @@ -43,7 +43,7 @@ Ignore ethernet broadcast packets. Count web traffic only, unless it is being directed through a local web cache. .TP \fBicmp\fP -How much bandwith are users wasting trying to figure out why the network is +How much bandwidth are users wasting trying to figure out why the network is slow? .SH OPTIONS @@ -65,9 +65,16 @@ the specified interface is also counted. \fB-P\fP Turn on port display. .TP +\fB-l\fP +Display and count datagrams addressed to or from link-local IPv6 addresses. +The default is not to display that address category. +.TP \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-B\fP Display bandwidth rates in bytes/sec rather than bits/sec. .TP @@ -79,16 +86,25 @@ Use \fIfilter code\fP to select the packets to count. counted, so the specified code is evaluated as \fB(\fP\fIfilter code\fP\fB) and ip\fP. .TP \fB-F\fP \fInet\fP/\fImask\fP -Specifies a network for traffic analysis. If specified, iftop will only +Specifies an IPv4 network for traffic analysis. If specified, iftop will only include packets flowing in to or out of the given network, and packet direction is determined relative to the network boundary, rather than to the interface. You may specify \fImask\fP as a dotted quad, such as /255.255.255.0, or as a single number specifying the number of bits set in the netmask, such as /24. .TP +\fB-G\fP \fInet6\fP/\fImask6\fP +Specifies an IPv6 network for traffic analysis. The value of \fImask6\fP can be +given as a prefix length or as a numerical address string for more compound +bitmasking. +.TP \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 When running, \fBiftop\fP uses the whole screen to display network usage. At @@ -104,7 +120,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, @@ -187,7 +202,6 @@ directive is a name value pair, for example: interface: eth0 -.Sp .fi sets the network interface. The following config directives are supported: @@ -213,6 +227,9 @@ Puts the interface into promiscuous mode. \fBport-display:\fP \fI(off|source-only|destination-only|on)\fP Controls display of port numbers. .TP +\fBlink-local:\fP \fI(yes|no)\fP +Determines displaying of link-local IPv6 addresses. +.TP \fBhide-source:\fP \fI(yes|no)\fP Hides source host names. .TP @@ -229,17 +246,20 @@ Sets which column is used to sort the display. Controls the appearance of each item in the display. .TP \fBshow-totals:\fP \fI(yes|no)\fP -Shows cummulative total for each item. +Shows cumulative total for each item. .TP \fBlog-scale:\fP \fI(yes|no)\fP Use a logarithmic scale for bar graphs. .TP \fBmax-bandwidth:\fP \fIbw\fP -Fixes the maximum for the bar graph scale to \fIbw\fP, e.g. "10M" +Fixes the maximum for the bar graph scale to \fIbw\fP, e.g. "10M". Note that the value has to always be in bits, regardless if the option to display in bytes has been chosen. .TP \fBnet-filter:\fP \fInet/mask\fP Defines an IP network boundary for determining packet direction. .TP +\fBnet-filter6:\fP \fInet6/mask6\fP +Defines an IPv6 network boundary for determining packet direction. +.TP \fBscreen-filter:\fP \fIregexp\fP Sets a regular expression to filter screen output. @@ -295,7 +315,7 @@ Configuration file for iftop. Paul Warren .SH VERSION -$Id: iftop.8,v 1.1.1.1 2012/02/21 16:57:34 misho Exp $ +$Id: iftop.8,v 1.1.1.2 2016/10/18 14:04:50 misho Exp $ .SH COPYING This program is free software; you can redistribute it and/or modify @@ -308,7 +328,7 @@ but WITHOUT ANY WARRANTY; without even the implied war 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.