Files
UltraGrid/hd-rum-multi/hd-rum.1
Martin Pulec 4a53df1e29 Added hd-rum manual page
+ added cross-reference to hd-rum-transcode man
+ improved man-generating script
2019-09-11 15:46:17 +02:00

128 lines
2.8 KiB
Groff

'\" t
.\" Title: hd-rum
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 08/26/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "HD\-RUM" "1" "08/26/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
hd-rum \- simple UDP packet reflector
.SH "SYNOPSIS"
.sp
\fBhd\-rum\fR \fIBUF_SIZE\fR \fIPORT\fR \fIADDRESSES\fR
.SH "OPTIONS"
.PP
\fBBUF_SIZE\fR
.RS 4
size of network buffer (eg\&. 8M)
.RE
.PP
\fBPORT\fR
.RS 4
UDP port number to retransmit
.RE
.PP
\fBADDRESSES\fR
.RS 4
list of addresses to transmit to (separated by spaces)
.RE
.SH "EXAMPLES"
.PP
hd\-rum 8M 5004 example\&.com example\&.net 93\&.184\&.216\&.34
.RS 4
Retrasmit traffic on UDP port 5004 to hosts
\fIexample\&.com\fR,
\fIexample\&.net\fR
and
\fI93\&.184\&.216\&.34\fR
.RE
.SH "BUGS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
does not support IPv6
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
program occupies exactly one CPU core even if there is no traffic because of busy\-waiting loop (\fBhd\-rum\-transcode(1)\fR
does not)
.RE
.SH "REPORTING BUGS"
.sp
Report bugs to \fBultragrid\-dev@cesnet\&.cz\fR\&.
.SH "RESOURCES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Synchronizing RTP Packet Reflector TR:
\fBhttps://www\&.fi\&.muni\&.cz/~xrebok/DOCs/PUBs/synchro_rum\&.pdf\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Distributed active element in 10 Gbps network paper:
\fBhttps://www\&.researchgate\&.net/publication/4316461_Distributed_active_element_in_10_Gbps_network\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Reflector usage at UltraGrid wiki
\fBhttps://github\&.com/CESNET/UltraGrid/wiki/Reflector\-settings\fR
.RE
.SH "SEE ALSO"
.sp
hd\-rum\-transcode(1)