.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NETSEND 1"
.TH NETSEND 1 "netsend" "perl v5.36.0" "netsend"
.\" 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"
netsend \- a speedy filetransfer and network diagnostic program
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
netsend [\s-1OPTIONS\s0] \s-1PROTOCOL MODE\s0 { \s-1COMMAND\s0 | \s-1HELP\s0 }
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "PROTOCOL"
.IX Header "PROTOCOL"
Protocol is one of
.IP "\fBtcp\fR, \fBudp\fR, \fBudplite\fR, \fBdccp\fR, \fBsctp\fR or \fBtipc\fR." 4
.IX Item "tcp, udp, udplite, dccp, sctp or tipc."
.PP
When using tipc, you must also specify a socket type, e.g. \fBnetsend tipc \s-1MODE\s0 \-t \s-1SOCK_STREAM\s0\fR.
.SH "MODE"
.IX Header "MODE"
Mode is either \fBreceive\fR or \fBtransmit\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-r Nn,Nd,Nm,Nf\fR" 4
.IX Item "-r Nn,Nd,Nm,Nf"
.Vb 1
\&    Round trip probes options:
\&
\&    Nn \- Number of iterations of round trip probes. Default is to perform 10 attempts.
\&         Don\*(Aqt set to less then 5 because measurement results will not very predicating.
\&
\&    Nd \- Size of rtt payload. This is the number of bytes piggybacking (plus the
\&         netsend rtt header). Default is 500 byte, maybe your mtu minus netsend header
\&         minus protocol header (tcp, udp) will better fit for your needs.
\&
\&    Nm \- for the round trip time probes netsend calculates a deviation. With this
\&         flag you can adjust the filter. Default is 4. Lower values drain more probes
\&         out, so be carefully with this option.
\&
\&         For example: if you have measured rtt probes of 4, 5, 5, 6 and 15 ms. The
\&         average is 7. Covariance is 16.4 and deviation is 4.04. If you select 2 here as
\&         the multiplier, then you filter all rtt probes with higher values then 8.08 (for 
\&         this example you filer 15ms out).
\&
\&         This will help to discard some nonesense probes who are evoked through cold code
\&         paths (cache misses, page faults, ...) or network anomalies. Use this option
\&         carefully!
\&
\&  \-f    forces to don\*(Aqt perform rtt probes but take N milliseconds as average value. With
\&        this option you can figure out the behaviour of satelite links (e.g you say \-D500f)
.Ve
.IP "\fB\-b\fR" 4
.IX Item "-b"
.Vb 2
\&        followed by a number: sets read/write buffer size to use. Default is 8192 for read/write and
\&        size_of_file_to_send for mmap/sendfile.
.Ve
.IP "\fB\-m\fR" 4
.IX Item "-m"
.Vb 1
\&        followed by a memadvise(2) option: normal, sequential, random, willneed, dontneed, noreuse.
.Ve
.IP "\fB\-p\fR" 4
.IX Item "-p"
.Vb 1
\&        followed by a number: set TCP/UDP/DCCP/SCTP port to use. Default is 6666.
.Ve
.IP "\fB\-P\fR" 4
.IX Item "-P"
.Vb 1
\&        followed by scheduling policy: sched_rr, sched_fifo, sched_batch or sched_other
.Ve
.IP "\fB\-s\fR" 4
.IX Item "-s"
.Vb 3
\&        followed by a setsockopt(2) optname and optval. netsend maps setsockopt levels and
\&        optlen internally.  running \*(Aqnetsend \-s list\*(Aq will print a list of all setsockopt
\&        optnames currently recognized by netsend.
.Ve
.IP "\fB\-T\fR" 4
.IX Item "-T"
.Vb 1
\&        followed by either human or machine: sets output format
.Ve
.IP "\fB\-u\fR" 4
.IX Item "-u"
.Vb 5
\&        followed by the transmit function to use. One of sendfile, mmap, splice or rw.
\&        When not specified, rw (read/write) is used.
\&        Note that not all protocols support all transfer methods, e.g. TIPCs connectionless sockets (SOCK_RDM and SOCK_DGRAM)
\&        do not support the sendfile system call. Also, the amount of data that can be sent in a single operation may be limited
\&        by the network protocol used.
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.RS 1
Listen for incoming \s-1SCTP\s0 connections, incoming data goes to stdout:
.Sp
.RS 4
\&./netsend \-T human \-v stressful sctp receive
.RE
.RE
.RS 1
.Sp
.RS 1
Send file largefile via \s-1TCP\s0 with output in machine parseable format:
.Sp
.RS 4
\&./netsend \-T machine tcp transmit largefile host.example.org
.RE
.RE
.RS 1
.Sp
.RS 1
Receive data via \s-1TCP\s0 with \s-1MD5SIG\s0 from peer 10.0.0.1:
.Sp
.RS 4
\&./netsend tcp transmit \-C largefile ffff::10.0.0.1
\&./netsend tcp receive \-C ffff::10.0.0.1
.RE
.RE
.RS 1
.RE
.RE
.RS 1
.RE
.RE
.RS 1
.RE
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
netsend returns a zero exist status if it succeeds.
Non zero is returned in case of failure. Following failure codes
are implemented:
.PP
.Vb 7
\&  0 \- succeed
\&  1 \- failure in memory handling
\&  2 \- command line option error
\&  3 \- failure which fit in any categories
\&  4 \- network error
\&  5 \- failure in netsend header (maybe corrupted hardware)
\&  6 \- netsend internal error (should never happen[tm])
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 2
\&  Hagen Paul Pfeifer
\&  Florian Westphal
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://netsend.berlios.de