[SCM] liblivemedia/master: Add initial set of manpages

Thu Dec 1 21:33:54 UTC 2016

The following commit has been merged in the master branch:
commit 0477b50d6ccffaaa270c00c97e3f754201132a0a
Author: Sebastian Ramacher <sramacher at debian.org>
Date:   Thu Dec 1 22:29:59 2016 +0100

    Add initial set of manpages

diff --git a/debian/MPEG2TransportStreamIndexer.1 b/debian/MPEG2TransportStreamIndexer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/MPEG2TransportStreamIndexer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/live555MediaServer.1 b/debian/live555MediaServer.1
new file mode 100644
index 0000000..56c6b8c
--- /dev/null
+++ b/debian/live555MediaServer.1
@@ -0,0 +1,45 @@
+.TH LIVE555MEDIASERVER "1" "December 2016" "LIVE555MEDIASERVER" "User Commands"
+.SH NAME
+live555MediaServer \- RTSP server
+.SH SYNOPSIS
+live555MediaServer [options]
+.SH DESCRIPTION
+.sp
+The "LIVE555 Media Server" is a complete RTSP server application. It can stream
+several kinds of media file (which must be stored in the current working
+directory - i.e., the directory from which you launch the application - or a
+subdirectory.):
+.IP
+A MPEG Transport Stream file (with file name suffix ".ts")
+.IP
+A Matroska or WebM file (with filename suffix ".mkv" or ".webm")
+.IP
+An Ogg file (with filename suffix ".ogg", "ogv", or ".opus")
+.IP
+A MPEG-1 or 2 Program Stream file (with file name suffix ".mpg")
+.IP
+A MPEG-4 Video Elementary Stream file (with file name suffix ".m4e")
+.IP
+A H.264 Video Elementary Stream file (with file name suffix ".264")
+.IP
+A H.265 Video Elementary Stream file (with file name suffix ".265")
+.IP
+A VOB video+audio file (with file name suffix ".vob")
+.IP
+A DV video file (with file name suffix ".dv")
+.IP
+A MPEG-1 or 2 (including layer III - i.e., 'MP3') audio file (with file name suffix ".mp3")
+.IP
+A WAV (PCM) audio file (with file name suffix ".wav")
+.IP
+An AMR audio file (with file name suffix ".amr")
+.IP
+An AC-3 audio file (with file name suffix ".ac3")
+.IP
+An AAC (ADTS format) audio file (with file name suffix ".aac")
+.sp
+.SH SEE ALSO
+.sp
+\fIopenRTSP(1)\fP
+.sp
+\fIhttp://www.live555.com/mediaServer/\fP
diff --git a/debian/live555ProxyServer.1 b/debian/live555ProxyServer.1
new file mode 100644
index 0000000..e5e7a37
--- /dev/null
+++ b/debian/live555ProxyServer.1
@@ -0,0 +1,22 @@
+.TH LIVE555PROXYSERVER "1" "December 2016" "LIVE555PROXYSERVER" "User Commands"
+.SH NAME
+live555ProxyServer \- RTSP/RTP proxy server
+.SH SYNOPSIS
+live555ProxyServer [options] <url>...
+.SH DESCRIPTION
+.sp
+The "LIVE555 Proxy Server" is a unicast RTSP server that acts as a 'proxy' for
+one or more 'back-end' unicast or multicast RTSP/RTP streams (i.e., served by
+other server(s)).
+.sp
+The key feature of a proxy server is that it reads each 'back-end' stream only
+once, regardless of how many separate clients are streaming from the proxy
+server. This makes the proxy server ideal, for example, for streaming from a
+RTSP-enabled video camera (which might not be able to handle more than one
+connection at a time).
+.sp
+.SH SEE ALSO
+.sp
+\fIopenRTSP(1)\fP, \fIlive555MediaServer(1)\fP
+.sp
+\fIhttp://www.live555.com/proxyServer/\fP
diff --git a/debian/livemedia-utils.manpages b/debian/livemedia-utils.manpages
new file mode 100644
index 0000000..0f65186
--- /dev/null
+++ b/debian/livemedia-utils.manpages
@@ -0,0 +1 @@
+debian/*.1
diff --git a/debian/openRTSP.1 b/debian/openRTSP.1
new file mode 100644
index 0000000..d5f1ce8
--- /dev/null
+++ b/debian/openRTSP.1
@@ -0,0 +1,181 @@
+.TH OPENRTSP "1" "December 2016" "OPENRTSP" "User Commands"
+.SH NAME
+.sp
+openRTSP \- open, stream, receive, and (optionally) record media streams that
+are specified by a RTSP URL
+.sp
+playSIP \- SIP session recorder
+.SH SYNOPSIS
+.sp
+vobStreamer [options...]
+.sp
+playISP [options...]
+.SH DESCRIPTION
+.sp
+The program will open the given URL (using RTSP's "DESCRIBE" command), retrieve
+the session's SDP description, and then, for each audio/video subsession whose
+RTP payload format it understands, "SETUP" and "PLAY" the subsession.
+.sp
+The received data for each subsession is written into a separate output file,
+named according to its MIME type. For example, if the session contains a MPEG-1
+or 2 audio subsession (RTP payload type 14) - e.g., MP3 - and a MPEG-1 or 2
+video subsession (RTP payload type 32), then each subsession's data will be
+extracted from the incoming RTP packets and written to files named "audio-MPA-1"
+and "video-MPV-2" (respectively). (You will probably then need to rename these
+files - by giving them an appropriate filename extension (e.g., ".mp3" and
+".mpg") - in order to be able to play them using common media player tools.)
+.SH OPTIONS
+.TP
+\fB\-4\fP
+output a '.mp4'-format file (to 'stdout', unless the "-P <interval-in-seconds>"
+option is also given)
+.TP
+\fB\-a\fP
+play only the audio stream (to 'stdout', unless the "-P <interval-in-seconds>"
+option is also given)
+.TP
+\fB\-A\fP <codec-number>
+specify the static RTP payload format number of the audio codec to request from
+the server ("playSIP" only)
+.TP
+\fB\-b\fP <buffer-size>
+change the output file buffer size
+.TP
+\fB\-B\fP <buffer-size>
+change the input network socket buffer size
+.TP
+\fB\-c\fP
+play continuously
+.TP
+\fB\-C\FP
+Explicitly ask for a multicast stream even if the server's "DESCRIBE" response
+doesn't specift a multicast address. (Note that not all servers will support
+this.) ("openRTSP" only)
+.TP
+\fB\-d\fP <duration>
+specify an explicit duration
+.TP
+\fB\-D\fP <maximum-inter-packet-gap>
+specify a maximum period of inactivity to wait before exiting
+.TP
+\fB\-E\fP <absolute-seek-end-time>
+request that the server end streaming at the specified absolute time (format:
+"YYYYMMDDTHHMMSSZ" or "YYYYMMDDTHHMMSS.<frac>Z") (used only with
+-U<initial-absolute-seek-time>)
+.TP
+\fB\-f\fP <frame-rate>
+specify the video frame rate (used only with "-q", "-4", or "-i")
+.TP
+\fB\-F\fP <fileName-prefix>
+specify a prefix for each output file name
+.TP
+\fB\-g\fP <user-agent-name>
+specify a user agent name to use in outgoing requests
+.TP
+\fB\-h\fP <height>
+specify the video image height (used only with "-q", "-4", or "-i")
+.TP
+\fB\-H\fP
+output a QuickTime 'hint track' for each audio/video track (used only with "-q"
+or "-4")
+.TP
+\fB\-i\fP
+output a '.avi'-format file (to 'stdout', unless the "-P <interval-in-seconds>"
+option is also given)
+.TP
+\fB\-I\fP <interface-name-or-address>
+specify a particular network interface on which to receive data
+.TP
+\fB\-k\fP <username> <password>
+specify a user name and password that's required to authenticate an incoming
+"REGISTER" command (used with "-R" only)
+.TP
+\fB\-K\fP
+Periodically send a RTSP "OPTIONS" command, to keep the connection alive. (This
+is useful with buggy servers that don't listen to our periodic RTCP "RR" packets
+instead.)
+.TP
+\fB\-l\fP
+try to compensate for packet losses (used only with "-q", "-4", or "-i")
+.TP
+\fB\-m\fP
+output each incoming frame into a separate file
+.TP
+\fB\-M\fP <MIME-subtype>
+specify the MIME subtype of a dynamic RTP payload format for the audio codec to
+request from the server ("playSIP" only)
+.TP
+\fB\-n\fP
+be notified when RTP data packets start arriving
+.TP
+\fB\-o\fP
+request the server's command options, without sending "DESCRIBE" ("openRTSP"
+only)
+.TP
+\fB\-O\fP
+don't request the server's command options; just send "DESCRIBE" ("openRTSP"
+only)
+.TP
+\fB\-p\fP <starting-port-number>
+specify the client port number(s)
+.TP
+\fB\-P\fP <interval-in-seconds>
+write new output files every <interval-in-seconds> seconds
+.TP
+\fB\-q\fP
+output a QuickTime '.mov'-format file (to 'stdout', unless the "-P
+<interval-in-seconds>" option is also given)
+.TP
+\fB\-Q\fP
+output 'QOS' statistics about the data stream (when the program exits)
+.TP
+\fB\-r\fP
+play the RTP streams, but don't receive them ourself
+.TP
+\fB\-R\fP [<port-number>]
+Waits for an incoming "REGISTER" command, specifying a "rtsp://" URL to play.
+This option is used instead of a "rtsp://" URL on the command line. ("openRTSP"
+only)
+.TP
+\fB\-s\fP <initial-seek-time>
+request that the server seek to the specified time (in seconds) before streaming
+.TP
+\fB\-S\fP <byte-offset>
+assume a simple RTP payload format (skipping over a special header of the
+specified size)
+.TP
+\fB\-t\fP
+stream RTP/RTCP data over TCP, rather than (the usual) UDP. ("openRTSP" only)
+.TP
+\fB\-T\fP <http-port-number>
+like "-t", except using RTSP-over-HTTP tunneling. ("openRTSP" only)
+.TP
+\fB\-u\fP <username> <password>
+specify a user name and password for digest authentication
+.TP
+\fB\-U\fP <initial-absolute-seek-time>
+request that the server seek to the specified absolute time (format:
+"YYYYMMDDTHHMMSSZ" or "YYYYMMDDTHHMMSS.<frac>Z") before streaming
+.TP
+\fB\-v\fP
+play only the video stream (to 'stdout', unless the "-P <interval-in-seconds>"
+option is also given)
+.TP
+\fB\-V\fP
+print less verbose diagnostic output
+.TP
+\fB\-w\fP <width>
+specify the video image width (used only with "-q", "-4", or "-i")
+.TP
+\fB\-y\fP
+try to synchronize the audio and video tracks (used only with "-q" or "-4")
+.TP
+\fB\-z\fP <scale>
+request that the server scale the stream (fast-forward, slow, or reverse play)
+.SH SEE ALSO
+.sp
+\fIopenRTSP(1)\fP,
+\fIplaySIP(1)\fP
+.sp
+\fIhttp://www.live555.com/openRTSP/\fP,
+\fIhttp://www.live555.com/playSIP/\fP
diff --git a/debian/playSIP.1 b/debian/playSIP.1
new file mode 100644
index 0000000..5e7bd87
--- /dev/null
+++ b/debian/playSIP.1
@@ -0,0 +1 @@
+.so openRTSP.1
diff --git a/debian/registerRTSPStream.1 b/debian/registerRTSPStream.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/registerRTSPStream.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/sapWatch.1 b/debian/sapWatch.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/sapWatch.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testAMRAudioStreamer.1 b/debian/testAMRAudioStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testAMRAudioStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testDVVideoStreamer.1 b/debian/testDVVideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testDVVideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testEOF.1 b/debian/testEOF.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testEOF.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testH264VideoStreamer.1 b/debian/testH264VideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testH264VideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testH264VideoToTransportStream.1 b/debian/testH264VideoToTransportStream.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testH264VideoToTransportStream.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testH265VideoStreamer.1 b/debian/testH265VideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testH265VideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testH265VideoToTransportStream.1 b/debian/testH265VideoToTransportStream.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testH265VideoToTransportStream.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMKVStreamer.1 b/debian/testMKVStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMKVStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMP3Receiver.1 b/debian/testMP3Receiver.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMP3Receiver.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMP3Streamer.1 b/debian/testMP3Streamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMP3Streamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG1or2AudioVideoStreamer.1 b/debian/testMPEG1or2AudioVideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG1or2AudioVideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG1or2ProgramToTransportStream.1 b/debian/testMPEG1or2ProgramToTransportStream.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG1or2ProgramToTransportStream.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG1or2Splitter.1 b/debian/testMPEG1or2Splitter.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG1or2Splitter.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG1or2VideoReceiver.1 b/debian/testMPEG1or2VideoReceiver.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG1or2VideoReceiver.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG1or2VideoStreamer.1 b/debian/testMPEG1or2VideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG1or2VideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG2TransportReceiver.1 b/debian/testMPEG2TransportReceiver.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG2TransportReceiver.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG2TransportStreamTrickPlay.1 b/debian/testMPEG2TransportStreamTrickPlay.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG2TransportStreamTrickPlay.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG2TransportStreamer.1 b/debian/testMPEG2TransportStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG2TransportStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testMPEG4VideoStreamer.1 b/debian/testMPEG4VideoStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testMPEG4VideoStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testOggStreamer.1 b/debian/testOggStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testOggStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testOnDemandRTSPServer.1 b/debian/testOnDemandRTSPServer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testOnDemandRTSPServer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testRTSPClient.1 b/debian/testRTSPClient.1
new file mode 100644
index 0000000..0e7c53a
--- /dev/null
+++ b/debian/testRTSPClient.1
@@ -0,0 +1,16 @@
+.TH LIVEMEDIAUTILS "1" "December 2016" "LIVEMEDIAUTILS" "User Commands"
+.SH NAME
+test* \- various utilities to test receiving and streaming of RTP streams
+.SH SYNOPSIS
+vobStreamer [\-i] [\-a|\-v] [\-p <RTSP-server-port-number>]
+<VOB-files>
+.SH DESCRIPTION
+.sp
+liblivemedia contains various utility programs to test streaming of receiving
+RTP streams using various formats.
+.SH SEE ALSO
+.sp
+\fIopenRTSP(1)\fP,
+\fIplaySIP(1)\fP
+.sp
+\fIhttp://www.live555.com/liveMedia/#testProgs\fP
diff --git a/debian/testRelay.1 b/debian/testRelay.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testRelay.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testReplicator.1 b/debian/testReplicator.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testReplicator.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/testWAVAudioStreamer.1 b/debian/testWAVAudioStreamer.1
new file mode 100644
index 0000000..143c6d6
--- /dev/null
+++ b/debian/testWAVAudioStreamer.1
@@ -0,0 +1 @@
+.so testRTSPClient.1
diff --git a/debian/vobStreamer.1 b/debian/vobStreamer.1
new file mode 100644
index 0000000..c1e2202
--- /dev/null
+++ b/debian/vobStreamer.1
@@ -0,0 +1,23 @@
+.TH VOBSTREAMER "1" "December 2016" "VOBSTREAMER" "User Commands"
+.SH NAME
+vobStreamer \- display information from VA API driver
+.SH SYNOPSIS
+vobStreamer [\-i] [\-a|\-v] [\-p <RTSP-server-port-number>]
+<VOB-files>
+.SH DESCRIPTION
+.sp
+vobStreamer reads one or more ".vob" files (e.g., from a DVD), extracts the
+audio and video streams, and transmits them using RTP multicast.
+.SH OPTIONS
+.TP
+\fB\-a\fP
+transmit only the audio stream
+.TP
+\fB\-i\fP
+stream only 'key' video frames - i.e., I-frames (to reduce the output bitrate)
+.TP
+\fB\-p\fP <RTSP-server-port-number>
+specify the port number for the built-in RTSP server (default: 554)
+.TP
+\fB\-v\fP
+transmit only the video stream

-- 
liblivemedia packaging

