.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "speedometer 1"
.TH speedometer 1 "2011-12-10" "speedometer" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
speedometer \- measure and display the rate of data across a network connection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   speedometer [options] tap [[\-c] tap] ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Monitor network traffic or speed/progress of a file transfer. At least
one tap option (\fB\-f\fR, \fB\-rx\fR, \fB\-tx\fR) must be entered. Option \fB\-c\fR
starts a new column, otherwise taps are piled vertically.
.PP
Note: before you use the program, satrt generating traffic by
transferring files in/out e.g. with \fIscp\fR\|(1) in the network you're
measuring.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-b\fR" 4
.IX Item "-b"
Use old blocky display instead of smoothed display even when \s-1UTF\-8\s0
encoding is detected.
.IP "\fB\-f filename [size]\fR" 4
.IX Item "-f filename [size]"
Display download speed with progress bar. This option must be used if
directly following another file tap without an expected size
specified.
.IP "\fB\-i interval\fR" 4
.IX Item "-i interval"
Interval in seconds. Examples: 5 or 0.25". Default is 1.
.IP "\fB\-p\fR" 4
.IX Item "-p"
Use plain-text display (one tap only).
.IP "\fB\-rx iface\fR" 4
.IX Item "-rx iface"
Display bytes received on network interface.
.IP "\fB\-tx iface\fR" 4
.IX Item "-tx iface"
Display bytes transmitted on network interface.
.IP "\fB\-z\fR" 4
.IX Item "-z"
Report zero size on files that don't exist instead of waiting for them
to be created
.PP
\&\s-1EXAMPLES\s0
.PP
How long it will take for my 38MB transfer to finish?
.PP
.Vb 1
\&    speedometer favorite_episode.rm $(( 38 * 1024 * 1024 ))
.Ve
.PP
How quickly is another transfer going?
.PP
.Vb 1
\&    speedometer dl/big.avi
.Ve
.PP
How fast is this \s-1LAN\s0?
.PP
.Vb 3
\&    host\-a$ cat /dev/zero | nc \-l \-p 12345
\&    host\-b$ nc host\-a 12345 > /dev/null
\&    host\-b$ speedometer \-rx eth0
.Ve
.PP
How fast is the upstream on this \s-1ADSL\s0 line?
.PP
.Vb 1
\&    speedometer \-tx ppp0
.Ve
.PP
How fast can I write data to my filesystem? (with at least 1GB free)
.PP
.Vb 2
\&    dd bs=1000000 count=1000 if=/dev/zero of=bigfile &
\&    speedometer bigfile
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
None.
.SH "FILES"
.IX Header "FILES"
None.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIhtop\fR\|(1)
\&\fIiotop\fR\|(1)
\&\fIscp\fR\|(1)
\&\fItop\fR\|(1)
\&\fIvmstat\fR\|(1)
.SH "AUTHORS"
.IX Header "AUTHORS"
Program was written by Ian Ward <ian.ward@excess.org>
.PP
This manual page was written by Jari Aalto <jari.aalto@cante.net>.
Released under license \s-1GNU\s0 \s-1GPL\s0 version 2 or (at your option) any later
version. For more information about license, visit
<http://www.gnu.org/copyleft/gpl.html>.