From 85f4ed1f40ac1139149e4daf580309bc62e01e1c Mon Sep 17 00:00:00 2001 From: ivoire Date: Mon, 23 Aug 2010 21:39:38 +0000 Subject: Add manpages git-svn-id: svn://svn.videolan.org/multicat/trunk@13 271ca591-50e6-457e-a4d7-9fbfa1de8f49 --- Makefile | 2 ++ aggregartp.1 | 47 +++++++++++++++++++++++++++++++++++++ desaggregartp.1 | 44 ++++++++++++++++++++++++++++++++++ ingests.1 | 38 ++++++++++++++++++++++++++++++ multicat.1 | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ offsets.1 | 25 ++++++++++++++++++++ 6 files changed, 229 insertions(+) create mode 100644 aggregartp.1 create mode 100644 desaggregartp.1 create mode 100644 ingests.1 create mode 100644 multicat.1 create mode 100644 offsets.1 diff --git a/Makefile b/Makefile index 37fcae0..8bab82d 100644 --- a/Makefile +++ b/Makefile @@ -43,6 +43,8 @@ clean: install: all @install -d $(BIN) @install multicat ingests aggregartp desaggregartp offsets $(BIN) + @install multicat.1 ingests.1 aggregartp.1 desaggregartp.1 offsets.1 $(MAN) uninstall: @rm $(BIN)/multicat $(BIN)/ingests $(BIN)/aggregartp $(BIN)/desaggregartp $(BIN)/offsets + @rm $(MAN)/multicat.1 $(MAN)/ingests.1 $(MAN)/aggregartp.1 $(MAN)/desaggregartp.1 $(MAN)/offsets.1 diff --git a/aggregartp.1 b/aggregartp.1 new file mode 100644 index 0000000..83161c8 --- /dev/null +++ b/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 \fR] [\fI-t \fR] [\fI-o\fR] [\fI-o \fR] [\fI-U\fR] +[\fI-m \fR] @ [\fI,\fR] ... [\fI,\fR] +.SH DESCRIPTION +Aggregartp split a single RTP stream to several contributions links with load balancing. +.SH ITEMS +Host format \fB[[:]][@[]]\fR +.SH OPTIONS +.B \-h +Show summary of options +.TP +\fB\-i\fR +Real time priority +.TP +\fB\-m\fR +Specify the MTU +.TP +\fB\-o\fR +RTP SSRC +.TP +\fB\-t\fR +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 , +for the Debian project (and may be used by others). diff --git a/desaggregartp.1 b/desaggregartp.1 new file mode 100644 index 0000000..045ccba --- /dev/null +++ b/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 \fR] [\fI-t \fR] [\fI-b \fR] [\fI-U\fR] [\fI-m \fR] + ... [\fI\fR] +.SH DESCRIPTION +Desaggregartp is the companion software of aggregartp. It rorders incoming packets and reconstitutes the original RTP stream. +.SH ITEMS +Host format \fB[[:]][@[]]\fR +.SH OPTIONS +\fB\-b\fR +buffer length in ms +.TP +.B \-h +Show summary of options +.TP +\fB\-i\fR +Real time priority +.TP +\fB\-m\fR +Specify the MTU +.TP +\fB\-t\fR +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 , +for the Debian project (and may be used by others). diff --git a/ingests.1 b/ingests.1 new file mode 100644 index 0000000..9736fab --- /dev/null +++ b/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 \fR [\fI-m \fR]>\fR] +.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 +Size of the payload +.TP +.B \-h +Show summary of options +.TP +\fB\-m\fR +Size of the payload +.TP +\fB\-p\fR +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 , +for the Debian project (and may be used by others). diff --git a/multicat.1 b/multicat.1 new file mode 100644 index 0000000..199e8cb --- /dev/null +++ b/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 \fR] [\fI-t \fR] [\fI-p \fR] [\fI-s \fR] +[\fI-n \fR] [\fI-d