.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "UDP-RECEIVER 1"
.TH UDP-RECEIVER 1 "November 18, 2016" "current" "Udpcast"
.\" 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"
udp\-receiver \- receive files broadcast by udp\-sender
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&./udp\-receiver [\-\-file \fIfile\fR] [\-\-pipe \fIpipe\fR] [\-\-portbase \fIportbase\fR] [\-\-interface \fInet-interface\fR] [\-\-log \fIfile\fR] [\-\-ttl \fItime-to-live\fR] [\-\-mcast\-rdv\-address \fImcast-rdv-address\fR] [\-\-nokbd] [\-\-exitWait milliseconds] [\-\-stat\-period \fIn\fR] [\-\-print\-uncompressed\-position \fIflag\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Udp\-receiver\*(C'\fR is used to receive files sent by
\&\f(CW\*(C`udp\-sender\*(C'\fR (for instance a disk image).
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "Basic options"
.IX Subsection "Basic options"
.IP "\-\-file \fIfile\fR" 4
.IX Item "--file file"
Writes received data to \fIfile\fR. If this parameter is not
supplied, received data is written to stdout instead.
.IP "\-\-pipe \fIcommand\fR" 4
.IX Item "--pipe command"
Sends data through \fIpipe\fR after receiving it. This is useful
for decompressing the data, or for filling in unused filesystem blocks
that may have been stripped out by udp-sender. The \fIcommand\fR gets
a direct handle on the output file or device, and thus may seek inside
it, if needed. \f(CW\*(C`Udpcast\*(C'\fR itself also keeps a handle on the
file, which is used for an informational progress display. The
\&\fIcommand\fR's stdin is a pipe from udp-receiver. Example:
\&\f(CW\*(C`udp\-receiver \-p "gzip \-dc"\*(C'\fR
.IP "\-\-log \fIfile\fR" 4
.IX Item "--log file"
Logs some stuff into \fIfile\fR.
.IP "\-\-nosync" 4
.IX Item "--nosync"
Do not open target in synchronous mode. This is the default when writing to a file or a pipe.
.IP "\-\-sync" 4
.IX Item "--sync"
Write to target in synchronous mode. This is the default when writing to a device (character or block)
.IP "\-\-nokbd" 4
.IX Item "--nokbd"
Do not read start signal from keyboard, and do not display any
message telling the user to press any key to start.
.IP "\-\-start\-timeout \fIsec\fR" 4
.IX Item "--start-timeout sec"
receiver aborts at start if it doesn't see a sender within this many
seconds. Furthermore, the sender needs to start transmission of data within
this delay. Once transmission is started, the timeout no longer applies.
.IP "\-\-receive\-timeout \fIsec\fR" 4
.IX Item "--receive-timeout sec"
receiver aborts during transmission if it doesn't see a packet
from the sender within this many seconds. This timeout only applies
once transmission has started.
.SS "Networking options"
.IX Subsection "Networking options"
.IP "\-\-portbase \fIportbase\fR" 4
.IX Item "--portbase portbase"
Default ports to use for udpcast. Two ports are used:
\&\fIportbase\fR and \fIportbase+1\fR . Thus, \fIPortbase\fR must be
even. Default is \f(CW9000\fR. The same \fIportbase\fR must be
specified for both \f(CW\*(C`udp\-sender\*(C'\fR and \f(CW\*(C`udp\-receiver\*(C'\fR.
.IP "\-\-interface \fIinterface\fR" 4
.IX Item "--interface interface"
Network interface used to send out the data. Default is \f(CW\*(C`eth0\*(C'\fR
.IP "\-\-ttl \fIttl\fR" 4
.IX Item "--ttl ttl"
Time to live for connection request packet (by default connection
request is broadcast to the \s-1LAN\s0's broadcast address. If ttl is set,
the connection request is multicast instead to \f(CW224.0.0.1\fR with
the given ttl, which should enable udpcast to work between LANs. Not
tested though.
.IP "\-\-mcast\-rdv\-address \fIaddress\fR" 4
.IX Item "--mcast-rdv-address address"
Uses a non-standard multicast address for the control connection
(which is used by the sender and receivers to \*(L"find\*(R" each other). This
is \fBnot\fR the address that is used to transfer the data. By
default \f(CW\*(C`mcast\-rdv\-address\*(C'\fR is the Ethernet broadcast address if
\&\f(CW\*(C`ttl\*(C'\fR is 1, and \f(CW224.0.0.1\fR otherwise. This setting
should not be used except in very special situations, such as when
\&\f(CW224.0.0.1\fR cannot be used for policy reasons.
.IP "\-\-exit\-wait \fImilliseconds\fR" 4
.IX Item "--exit-wait milliseconds"
When transmission is over, receiver will wait for this time after
receiving the final \s-1REQACK.\s0 This is done in order to guard against
loss of the final \s-1ACK.\s0 Is 500 milliseconds by default.
.IP "\-\-ignore\-lost\-data" 4
.IX Item "--ignore-lost-data"
Do not stop reception when data loss is detected, but instead fill
with random data. This is useful for multimedia transmission where
100% integrity is not need.
.SS "Statistics options"
.IX Subsection "Statistics options"
.IP "\-\-stat\-period \fIseconds\fR" 4
.IX Item "--stat-period seconds"
Every so much milliseconds, print some statistics to stderr: how
much bytes received so far log, position in uncompressed file (if
applicable), overall bitrate... By default, this is printed every
half second.
.IP "\-\-print\-uncompressed\-position \fIflag\fR" 4
.IX Item "--print-uncompressed-position flag"
By default, udp-receiver only prints the position in uncompressed file
if the 2 following conditions are met:
.RS 4
.IP "\(bu" 4
Output is piped via a compressor (\f(CW\*(C`\-p \*(C'\fR option).
.IP "\(bu" 4
The final output is seekable (file or device)
.RE
.RS 4
.Sp
With the \f(CW\*(C`\-\-print\-uncompressed\-position\*(C'\fR, options, you can
change this behavior:
.IP "\(bu" 4
If flag is 0, uncompressed position will \fBnever\fR be printed,
even if above conditions are met
.IP "\(bu" 4
If flag is 1, uncompressed position will \fBalways\fR be
printed, even if above conditions are \fBnot\fR met
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
udp-sender
.SH "AUTHOR"
.IX Header "AUTHOR"
Alain Knaff