[Pkg-voip-commits] [janus] 01/01: manpages from upstream

Mon Jan 2 18:53:53 UTC 2017

This is an automated email from the git hooks/post-receive script.

vseva pushed a commit to branch master
in repository janus.

commit 2719e75f052dc813353730ea878653da4ba4594c
Author: Victor Seva <vseva at sipwise.com>
Date:   Mon Jan 2 19:14:06 2017 +0100

    manpages from upstream
---
 debian/TODO                        |   5 -
 debian/janus.manpages              |   1 +
 debian/patches/0003-manpages.patch | 213 +++++++++++++++++++++++++++++++++++++
 debian/patches/series              |   1 +
 4 files changed, 215 insertions(+), 5 deletions(-)

diff --git a/debian/TODO b/debian/TODO
index 2e9a49c..2665cab 100644
--- a/debian/TODO
+++ b/debian/TODO
@@ -1,7 +1,2 @@
 * help with srtp
 * package usrsctp ? https://github.com/sctplab/usrsctp
-
-+++ lintian output +++
-W: janus: binary-without-manpage usr/bin/janus
--> https://github.com/meetecho/janus-gateway/issues/723
-W: janus: package-has-unnecessary-activation-of-ldconfig-trigger
diff --git a/debian/janus.manpages b/debian/janus.manpages
new file mode 100644
index 0000000..a0abfeb
--- /dev/null
+++ b/debian/janus.manpages
@@ -0,0 +1 @@
+debian/tmp/usr/share/man/man1/janus.1
diff --git a/debian/patches/0003-manpages.patch b/debian/patches/0003-manpages.patch
new file mode 100644
index 0000000..3d0ad5f
--- /dev/null
+++ b/debian/patches/0003-manpages.patch
@@ -0,0 +1,213 @@
+From 8485d0956bd7f383a1ab5c91a8877e3857eeeb8c Mon Sep 17 00:00:00 2001
+From: Lorenzo Miniero <lminiero at gmail.com>
+Date: Mon, 2 Jan 2017 14:38:10 +0100
+Subject: [PATCH] Added manpages for janus and janus-pp-rec (addresses #723)
+
+---
+ Makefile.am                   |   3 +
+ janus.1                       | 129 ++++++++++++++++++++++++++++++++++++++++++
+ postprocessing/janus-pp-rec.1 |  46 +++++++++++++++
+ 3 files changed, 178 insertions(+)
+ create mode 100644 janus.1
+ create mode 100644 postprocessing/janus-pp-rec.1
+
+--- a/Makefile.am
++++ b/Makefile.am
+@@ -129,6 +129,8 @@ janus_LDADD = \
+ 	-lsrtp \
+ 	$(NULL)
+ 
++man1_MANS = janus.1
++
+ BUILT_SOURCES = cmdline.c cmdline.h
+ 
+ cmdline.c: janus.ggo
+@@ -326,6 +328,7 @@ endif
+ 
+ if ENABLE_POST_PROCESSING
+ bin_PROGRAMS += janus-pp-rec
++man1_MANS += postprocessing/janus-pp-rec.1
+ 
+ janus_pp_rec_SOURCES = \
+ 	postprocessing/pp-g711.c \
+--- /dev/null
++++ b/janus.1
+@@ -0,0 +1,129 @@
++.TH JANUS 1
++.SH NAME
++janus \- WebRTC server/gateway
++.SH SYNOPSIS
++.B janus
++[options]
++.SH DESCRIPTION
++.B janus
++is a WebRTC server/gateway developed by Meetecho conceived to be a general purpose one. As such, it doesn't provide any functionality per se other than implementing the means to set up a WebRTC media communication with a browser or application, exchanging JSON messages with it over different transports, and relaying RTP/RTCP and messages between clients and the server-side application logic they're attached to. Any specific feature/application is provided by server side plugins, that br [...]
++.TP
++The reason for this is simple: we wanted something that would have a small footprint (hence a C implementation) and that we could only equip with what was really needed (hence pluggable modules). That is, something that would allow us to deploy either a full-fledged WebRTC server on the cloud, or a small nettop/box to handle a specific use case.
++.SH OPTIONS
++.TP
++.BR \-h ", " \-\-help
++Print help and exit
++.TP
++.BR \-V ", " \-\-version
++Print version and exit
++.TP
++.BR \-b ", " \-\-daemon
++Launch Janus in background as a daemon (default=off)
++.TP
++.BR \-p ", " \-\-pid-file=\fIpath\fR
++Open the specified PID file when starting Janus (default=none)
++.TP
++.BR \-N ", " \-\-disable-stdout
++Disable stdout based logging (default=off)
++.TP
++.BR \-L ", " \-\-log-file=\fIpath\fR
++Log to the specified file (default=stdout only)
++.TP
++.BR \-i ", " \-\-interface=\fIipaddress\fR
++Interface to use (will be the public IP)
++.TP
++.BR \-P ", " \-\-plugins-folder=\fIpath\fR
++Plugins folder (default=./plugins)
++.TP
++.BR \-C ", " \-\-config=\fIfilename\fR
++Configuration file to use
++.TP
++.BR \-F ", " \-\-configs-folder=\fIpath\fR
++Configuration files folder (default=./conf)
++.TP
++.BR \-c ", " \-\-cert-pem=\fIfilename\fR
++DTLS certificate
++.TP
++.BR \-k ", " \-\-cert-key=\fIfilename\fR
++DTLS certificate key
++.TP
++.BR \-S ", " \-\-stun-server=\fIip:port\fR
++STUN server(:port) to use, if needed (e.g., gateway behind NAT, default=none)
++.TP
++.BR \-1 ", " \-\-nat-1-1=\fIip\fR
++Public IP to put in all host candidates, assuming a 1:1 NAT is in place (e.g., Amazon EC2 instances, default=none)
++.TP
++.BR \-E ", " \-\-ice-enforce-list=\fIlist\fR
++Comma-separated list of the only interfaces to use for ICE gathering; partial strings are supported (e.g., eth0 or eno1,wlan0, default=none)
++.TP
++.BR \-X ", " \-\-ice-ignore-list=\fIlist\fR
++Comma-separated list of interfaces or IP addresses to ignore for ICE gathering; partial strings are supported (e.g., vmnet8,192.168.0.1,10.0.0.1 or vmnet,192.168., default=vmnet)
++.TP
++.BR \-6 ", " \-\-ipv6-candidates
++Whether to enable IPv6 candidates or not (experimental) (default=off)
++.TP
++.BR \-l ", " \-\-libnice-debug
++Whether to enable libnice debugging or not (default=off)
++.TP
++.BR \-I ", " \-\-ice-lite
++Whether to enable the ICE Lite mode or not (default=off)
++.TP
++.BR \-T ", " \-\-ice-tcp
++Whether to enable ICE-TCP or not (warning: only works with ICE Lite) (default=off)
++.TP
++.BR \-U ", " \-\-force-bundle
++Whether to force BUNDLE or not (whether audio, video and data will always be bundled) (default=off)
++.TP
++.BR \-u ", " \-\-force-rtcp-mux
++Whether to force rtcp-mux or not (whether RTP and RTCP will always be muxed) (default=off)
++.TP
++.BR \-q ", " \-\-max-nack-queue=\fInumber\fR
++Maximum size of the NACK queue per user for retransmissions
++.TP
++.BR \-r ", " \-\-rtp-port-range=\fImin\-max\fR
++Port range to use for RTP/RTCP
++.TP
++.BR \-n ", " \-\-server-name=\fIname\fR
++Public name of this Janus instance (default=MyJanusInstance)
++.TP
++.BR \-d ", " \-\-debug-level=\fI1\-7\fR
++Debug/logging level (0=disable debugging, 7=maximum debug level; default=4)
++.TP
++.BR \-D ", " \-\-debug-timestamps
++Enable debug/logging timestamps (default=off)
++.TP
++.BR \-o ", " \-\-disable-colors
++Disable color in the logging (default=off)
++.TP
++.BR \-a ", " \-\-apisecret=\fIrandomstring\fR
++API secret all requests need to pass in order to be accepted by Janus (useful when wrapping Janus API requests in a server, none by default)
++.TP
++.BR \-A ", " \-\-token-auth
++Enable token-based authentication for all requests (default=off)
++.TP
++.BR \-e ", " \-\-event-handlers
++Enable event handlers (default=off)
++.SH EXAMPLES
++\fBjanus\fR \- Launch Janus with all options from configurations files
++.TP
++\fBjanus \-b \-L /tmp/januslog\fR \- Launch Janus as a daemon and log to the specified file
++.TP
++\fBjanus \-6\fR \- Launch Janus with IPv6 support enabled
++.TP
++\fBjanus \-u \-U\fR \- Launch Janus with rtcpmux and BUNDLE always forced on
++.SH BUGS
++.TP
++If you think you found a bug or want to contribute a feature, you can issue or a pull request on https://github.com/meetecho/janus-gateway/issues.
++.TP
++Anyway, before doing that make sure you read the documentation at http://janus.conf.meetecho.com/docs/ and that it has not been discussed already at https://groups.google.com/forum/#!forum/meetecho-janus. We only use Github for code issues, and \fBNOT\fR for configuration or usage issues: use the group for that.
++.SH SEE ALSO
++.TP
++https://github.com/meetecho/janus-gateway \- Official repository
++.TP
++http://janus.conf.meetecho.com \- Demos and documentation
++.TP
++https://groups.google.com/forum/#!forum/meetecho-janus \- Community
++.TP
++http://www.meetecho.com/blog/ \- Tutorials and blog posts on Janus
++.SH AUTHORS
++Lorenzo Miniero (lorenzo at meetecho.com)
+--- /dev/null
++++ b/postprocessing/janus-pp-rec.1
+@@ -0,0 +1,46 @@
++.TH JANUS-PP-REC 1
++.SH NAME
++janus-pp-rec \- Janus recordings post-processing utility.
++.SH SYNOPSIS
++.B janus-pp-rec
++[\fB\-\-header\fR \fIsource.mjr\fR]
++[\fB\-\-parse\fR \fIsource.mjr\fR]
++.IR source.mjr
++.IR destination.[opus|wav|webm|mp4|srt]
++.SH DESCRIPTION
++.B janus-pp-rec
++is a simple utility that allows you to post-process recordings generated by Janus plugins (e.g., VideoRoom or others). More specifically, since Janus recordings (.mjr files) are basically a structured dump of RTP packets, this utility reorders them all and extracts the frames in order to stick them together and save them to a playable media file. No transcoding is done.
++.TP
++The target file depends on the codec used in the recording: for instance, VP8 and VP9 frames can only be converted to a .webm file, while H.264 frames can only be converted to a .mp4 file. Right now, you can convert VP8/VP9 recordings to .webm, H.264 recordings to .mp4, G.711 recordings to .wav, Opus recordings to .opus and Data Channel recordings to .srt.
++.SH OPTIONS
++.TP
++.BR \-h ", " \-\-help
++Print help and exit
++.TP
++.BR \-\-header\ \fIsource.mjr\fR
++Only parse the recording header and then exit
++.TP
++.BR \-\-parse\ \fIsource.mjr\fR
++Only parse the recording header and reorder the packets, and then exit
++.SH EXAMPLES
++\fBjanus-pp-rec \-\-header rec1234.mjr\fR \- Parse the recordings header (shows metadata info)
++.TP
++\fBjanus-pp-rec \-\-parse rec1234.mjr\fR \- Parse the recordings packets without processing them
++.TP
++\fBjanus-pp-rec rec1234.mjr rec1234.webm\fR \- Convert a VP8 .mjr recording to a .webm file
++.SH BUGS
++.TP
++If you think you found a bug or want to contribute a feature, you can issue or a pull request on https://github.com/meetecho/janus-gateway/issues.
++.TP
++Anyway, before doing that make sure you read the documentation at http://janus.conf.meetecho.com/docs/ and that it has not been discussed already at https://groups.google.com/forum/#!forum/meetecho-janus. We only use Github for code issues, and \fBNOT\fR for configuration or usage issues: use the group for that.
++.SH SEE ALSO
++.TP
++https://github.com/meetecho/janus-gateway \- Official repository
++.TP
++http://janus.conf.meetecho.com \- Demos and documentation
++.TP
++https://groups.google.com/forum/#!forum/meetecho-janus \- Community
++.TP
++http://www.meetecho.com/blog/ \- Tutorials and blog posts on Janus
++.SH AUTHORS
++Lorenzo Miniero (lorenzo at meetecho.com)
diff --git a/debian/patches/series b/debian/patches/series
index b1058d8..cf725dd 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,2 +1,3 @@
 0001-disable-demos.patch
 0002-fix-typo.patch
+0003-manpages.patch

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-voip/janus.git

