[SCM] multicat packaging branch, master, updated. c7e841c883427feb5a9e8fef629d0ccd12b0377d

Mon Aug 23 20:57:03 UTC 2010

The following commit has been merged in the master branch:
commit 77d0401140283d7fb9f7f368744ad46d971d460e
Author: Rémi Duraffort <ivoire at videolan.org>
Date:   Mon Aug 23 22:54:08 2010 +0200

    Add the manpages.

diff --git a/debian/aggregartp.1 b/debian/aggregartp.1
new file mode 100644
index 0000000..83161c8
--- /dev/null
+++ b/debian/aggregartp.1
@@ -0,0 +1,47 @@
+.TH Aggregartp "1" "August 23, 2010" "Multicat 1.0"
+.SH NAME
+aggregartp \- Splits a single RTP stream to several contribution links with load balancing.
+.SH SYNOPSIS
+.B aggregartp
+[\fI-i <RT priority>\fR] [\fI-t <ttl>\fR] [\fI-o\fR] [\fI-o <SSRC IP>\fR] [\fI-U\fR]
+[\fI-m <mtu>\fR] @<src host> <dest host 1>[\fI,<weight 1>\fR] ... [\fI<dest host N>,<weight N>\fR]
+.SH DESCRIPTION
+Aggregartp split a single RTP stream to several contributions links with load balancing.
+.SH ITEMS
+Host format \fB[<connect addr>[:<connect port>]][@[<bind addr][:<bind port>]]\fR
+.SH OPTIONS
+.B \-h
+Show summary of options
+.TP
+\fB\-i\fR <RT priority>
+Real time priority
+.TP
+\fB\-m\fR <mtu>
+Specify the MTU
+.TP
+\fB\-o\fR <SSRC IP>
+RTP SSRC
+.TP
+\fB\-t\fR <ttl>
+TTL of the packets send by aggregartp
+.TP
+.B \-U
+Prepend RTP header
+.TP
+.B \-w
+Overwrite RTP timestamps
+.SH SEE ALSO
+.BR desaggregartp (1).
+.BR ingests (1).
+.BR multicat (1),
+.BR offsets (1).
+.br
+Read the README file for more information about the configuration of aggregartp.
+.SH AUTHOR
+aggregartp 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).
diff --git a/debian/desaggregartp.1 b/debian/desaggregartp.1
new file mode 100644
index 0000000..045ccba
--- /dev/null
+++ b/debian/desaggregartp.1
@@ -0,0 +1,44 @@
+.TH Desaggregartp "1" "August 23, 2010" "Multicat 1.0"
+.SH NAME
+desaggregartp \- Reorders incoming packets and reconstitutes the original RTP stream.
+.SH SYNOPSIS
+.B desaggregartp
+[\fI-i <RT priority>\fR] [\fI-t <ttl>\fR] [\fI-b <buffer length>\fR] [\fI-U\fR] [\fI-m <mtu>\fR]
+<src host 1> ... [\fI<src host N>\fR] <dest host>
+.SH DESCRIPTION
+Desaggregartp is the companion software of aggregartp. It rorders incoming packets and reconstitutes the original RTP stream.
+.SH ITEMS
+Host format \fB[<connect addr>[:<connect port>]][@[<bind addr][:<bind port>]]\fR
+.SH OPTIONS
+\fB\-b\fR <buffer length>
+buffer length in ms
+.TP
+.B \-h
+Show summary of options
+.TP
+\fB\-i\fR <RT priority>
+Real time priority
+.TP
+\fB\-m\fR <mtu>
+Specify the MTU
+.TP
+\fB\-t\fR <ttl>
+TTL of the packets send by aggregartp
+.TP
+.B \-U
+Strip RTP header
+.SH SEE ALSO
+.BR aggregartp (1).
+.BR ingests (1).
+.BR multicat (1),
+.BR offsets (1).
+.br
+Read the README file for more information about the configuration of desaggregartp.
+.SH AUTHOR
+desaggregartp 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).
diff --git a/debian/ingests.1 b/debian/ingests.1
new file mode 100644
index 0000000..9736fab
--- /dev/null
+++ b/debian/ingests.1
@@ -0,0 +1,38 @@
+.TH Ingests "1" "August 23, 2010" "Multicat 1.0"
+.SH NAME
+ingests \- Build an auxiliary file for multicat
+.SH SYNOPSIS
+.B ingests
+\fI-p <PCR PID>\fR [\fI-m <payload size>\fR]>\fR] <input ts>
+.SH DESCRIPTION
+Ingests is a companion application designed to manipulate TS files. It reads
+the PCR values of the file, and builds the auxiliary file that is necessary
+for multicat.
+The combination of ingests and multicat makes a simple and efficient TS file streamer.
+.SH OPTIONS
+\fB\-m\fR <payloadsize>
+Size of the payload
+.TP
+.B \-h
+Show summary of options
+.TP
+\fB\-m\fR <payloadsize>
+Size of the payload
+.TP
+\fB\-p\fR <PCR PID>
+PCR PID to use
+.SH SEE ALSO
+.BR aggregartp (1).
+.BR desaggregartp (1).
+.BR multicat (1),
+.BR offsets (1).
+.br
+Read the README file for more information about the configuration of ingests.
+.SH AUTHOR
+ingests 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).
diff --git a/debian/multicat.1 b/debian/multicat.1
new file mode 100644
index 0000000..199e8cb
--- /dev/null
+++ b/debian/multicat.1
@@ -0,0 +1,73 @@
+.TH Multicat "1" "August 23, 2010" "Multicat 1.0"
+.SH NAME
+multicat \- Multicast equivalent of Netcat
+.SH SYNOPSIS
+.B multicat
+[\fI-i <RT priority>\fR] [\fI-t <ttl>\fR] [\fI-p <PCR PID>\fR] [\fI-s <chunks>\fR]
+[\fI-n <chunks>\fR] [\fI-d <time>\fR] [\fI-a\fR] [\fI-S <SSRC IP>\fR] [\fI-u\fR]
+[\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
+streams (unicast and multicast), files, character devices or FIFOs. It is thought
+to be a multicast equivalent of the popular netcat tool.
+
+Multicat tries to rebuild the internal clock of the input stream; but it wants
+to remain agnostic of what is transported, so in case of files the said clock
+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
+Host format \fB[<connect addr>[:<connect port>]][@[<bind addr][:<bind port>]]\fR
+.SH OPTIONS
+.B \-a
+Append to existing destination file (risky)
+.TP
+\fB\-d\fR <time>
+Exit after a definite time (in 27 MHz units)
+.TP
+\fB\-i\fR <RT priority>
+Real time priority
+.TP
+.B \-h
+Show summary of options
+.TP
+\fB\-m\fR <payload size>
+Size of the payload chunk, excluding optional RTP header (default 1316)
+.TP
+\fR\-n\fR <chunks>
+Exit after playing N chunks of payload
+.TP
+\fB\-p\fR <PCR PID>
+PCR PID
+.TP
+\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
+.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).
diff --git a/debian/multicat.manpages b/debian/multicat.manpages
new file mode 100644
index 0000000..cadc5e0
--- /dev/null
+++ b/debian/multicat.manpages
@@ -0,0 +1,5 @@
+debian/aggregartp.1
+debian/desaggregartp.1
+debian/ingests.1
+debian/multicat.1
+debian/offsets.1
diff --git a/debian/offsets.1 b/debian/offsets.1
new file mode 100644
index 0000000..ddf409e
--- /dev/null
+++ b/debian/offsets.1
@@ -0,0 +1,25 @@
+.TH Offsets "1" "August 23, 2010" "Multicat 1.0"
+.SH NAME
+offsets \- Manipulate auxiliary files created by ingests
+.SH SYNOPSIS
+.B affsets
+<aux file> <27 MHz timestamp>
+.SH DESCRIPTION
+Offsets is a companion application for multicat, to manipulate auxiliary files.
+Given an offset in time from the beginning of the file, it returns the offset
+of the position in number of packets.
+.SH SEE ALSO
+.BR aggregartp (1).
+.BR desaggregartp (1).
+.BR ingests (1).
+.BR multicat (1),
+.br
+Read the README file for more information about the configuration of offsets.
+.SH AUTHOR
+offsets 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).

-- 
multicat packaging

