multicat.1 2.68 KB
Newer Older
Rémi Duraffort's avatar
Rémi Duraffort committed
1 2 3 4 5
.TH Multicat "1" "August 23, 2010" "Multicat 1.0"
.SH NAME
multicat \- Multicast equivalent of Netcat
.SH SYNOPSIS
.B multicat
6 7
[\fI-i <RT priority>\fR] [\fI-t <ttl>\fR] [\fI-f\fR] [\fI-p <PCR PID>\fR] [\fI-s <chunks>\fR]
[\fI-n <chunks>\fR] [\fI-k <start time>\fR] [\fI-d <duration>\fR] [\fI-a\fR] [\fI-r <file duration>\fR] [\fI-S <SSRC IP>\fR] [\fI-u\fR]
Rémi Duraffort's avatar
Rémi Duraffort committed
8 9 10
[\fI-U\fR] [\fI-m <payload size>\fR] <input item> <output item>
.SH DESCRIPTION
Multicat is a 1 input/1 output application. Inputs and outputs can be network
11
streams (unicast and multicast, IPv4 and IPv6), files, directories, character devices or FIFOs. It is thought
Rémi Duraffort's avatar
Rémi Duraffort committed
12 13 14
to be a multicast equivalent of the popular netcat tool.

Multicat tries to rebuild the internal clock of the input stream; but it wants
15
to remain agnostic of what is transported, so in case of files and directories, the said clock
Rémi Duraffort's avatar
Rémi Duraffort committed
16 17 18 19 20 21
is stored to an auxiliary file (example.aux accompanies example.ts) while
recording. Other inputs are considered "live", and the input clock is simply
derived from the reception time of the packets.
.SH ITEMS
Item format \fB<file path | device path | FIFO path | network host>\fR
.TP
22
Host format \fB[<connect addr>[:<connect port>]][@[<bind addr][:<bind port>]][/<options>]\fR
Rémi Duraffort's avatar
Rémi Duraffort committed
23 24 25 26
.SH OPTIONS
.B \-a
Append to existing destination file (risky)
.TP
27
\fB\-d\fR <duration>
Rémi Duraffort's avatar
Rémi Duraffort committed
28 29
Exit after a definite time (in 27 MHz units)
.TP
30 31
\fB\-f
Output packets as fast as possible
Rémi Duraffort's avatar
Rémi Duraffort committed
32 33 34 35
.TP
.B \-h
Show summary of options
.TP
36 37 38 39 40 41
\fB\-i\fR <RT priority>
Real time priority
.TP
\fB\-k\fR <time>
Start at the given position (in 27 MHz units, negative = from the end)
.TP
Rémi Duraffort's avatar
Rémi Duraffort committed
42 43 44
\fB\-m\fR <payload size>
Size of the payload chunk, excluding optional RTP header (default 1316)
.TP
45
\fB\-n\fR <chunks>
Rémi Duraffort's avatar
Rémi Duraffort committed
46 47 48 49 50
Exit after playing N chunks of payload
.TP
\fB\-p\fR <PCR PID>
PCR PID
.TP
51 52 53
\fB\-r\fR <duration>
In directory mode, rotate file after this duration (default: 97200000000 ticks = 1 hour)
.TP
Rémi Duraffort's avatar
Rémi Duraffort committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67
\fB\-s\fR <chunks>
Skip the first N chunks of payload
.TP
\fB\-S\fR <SSRC IP>
Overwrite or create RTP SSRC
.TP
\fB\-t\fR <ttl>
TTL of the packets send by multicat
.TP
.B \-u
Source has no RTP header
.TP
.B \-U
Destination has no RTP header
68 69 70
.TP
.B \-X
Pass-thought all packets to stdout
Rémi Duraffort's avatar
Rémi Duraffort committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
.SH SEE ALSO
.BR aggregartp (1),
.BR desaggregartp (1).
.BR ingests (1).
.BR offsets (1).
.br
Read the README file for more information about the configuration of multicat.
.SH AUTHOR
multicat was written by Christophe Massiot.
.SH LICENCE
This program is free software; you can redistribute it and/or modify it under the terms of
version 2 of the GNU General Public License as published by the Free Software Foundation.
.PP
This manual page was written by Rémi Duraffort <ivoire at videolan dot org>,
for the Debian project (and may be used by others).