diff --git a/doc/man/media-dispatcher.1 b/doc/man/media-dispatcher.1 index fd5c7dc..10024dc 100644 --- a/doc/man/media-dispatcher.1 +++ b/doc/man/media-dispatcher.1 @@ -1,66 +1,77 @@ .\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH "media-dispatcher" 1 "May 28, 2008" "media-dispatcher" "MediaProxy" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) +.TH "media-dispatcher" 1 "Aug 21, 2019" "AG Projects" "SIP Communication Software" .SH NAME -media\-dispatcher \- the MediaProxy dispatcher +media-dispatcher - The MediaProxy dispatcher .SH SYNOPSIS -.B media\-dispatcher +.B media-dispatcher .RI [ options ] .SH DESCRIPTION .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. MediaProxy is a distributed far end NAT traversal solution for media streams of SIP calls. MediaProxy has a dispatcher running on the same host with the OpenSIPS proxy and multiple media relays distributed over the network. .PP \fBmedia\-dispatcher\fP is to be run on a system running the OpenSIPS proxy that is configured to use MediaProxy as a media relay. The dispatcher will take care of distributing the media sessions over all the available relays that have joined the dispatcher, as well as doing accounting upon receiving session statistics from the relay when a session ends. The dispatcher also offers a management interface that can be interogated from a frontend that wishes to display statistics about media sessions. Upon receiving such a request, the dispatcher will interrogate in turn all the available media relays for the appropriate information, returning it back to the caller. .PP The MediaProxy dispatcher features secure encrypted communication with the relays, advanced accounting capabilities using multiple backends as well as automatic load balancing among the active relays. The management interface can also use encrypted communications if needed. .SH OPTIONS .TP .B \-h, \-\-help Show summary of options. .TP .B \-\-version -Show version of program. +Show program version. +.TP +.B \-\-systemd +Run as a systemd simple service and log to journal. .TP .B \-\-no\-fork -Run the process in the foreground (for debugging). +Run in the foreground and log to terminal (for debugging). +.TP +.B \-\-config\-dir=PATH +Set the configuration directory (default is \fB/etc/mediaproxy\fP). +.TP +.B \-\-runtime\-dir=PATH +Set the runtime directory (default is \fB/run/mediaproxy\fP). +.TP +.B \-\-debug +Enable verbose logging. .TP -.B \-\-pid=file -Set the proces pid file to \fB`file'\fP. If not specified the default -pid file is \fB/var/run/mediaproxy/dispatcher.pid\fP . +.B \-\-debug\-memory +Enable memory debugging. .SH SEE ALSO .BR media-relay (1), .PP For more information, please refer to the MediaProxy page which can be found at http://ag-projects.com/MediaProxy.html .SH AUTHOR Dan Pascu . diff --git a/doc/man/media-relay.1 b/doc/man/media-relay.1 index 4e8e25d..c9a4b78 100644 --- a/doc/man/media-relay.1 +++ b/doc/man/media-relay.1 @@ -1,63 +1,74 @@ .\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH "media-relay" 1 "May 28, 2008" "media-relay" "MediaProxy" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) +.TH "media-relay" 1 "Aug 21, 2019" "AG Projects" "SIP Communication Software" .SH NAME -media\-relay \- the MediaProxy relay +media-relay - The MediaProxy relay .SH SYNOPSIS -.B media\-relay +.B media-relay .RI [ options ] .SH DESCRIPTION .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. MediaProxy is a distributed far end NAT traversal solution for media streams of SIP calls. MediaProxy has a dispatcher running on the same host with the OpenSIPS proxy and multiple media relays distributed over the network. .PP \fBmedia\-relay\fP is to be run on a system that wishes to participate in media relaying. It can be run on the same host as the dispatcher, or on multiple remote hosts. The relay takes care of establishing a path between devices behind NAT and forwards the media streams between them. To do so, the relay requires a Linux kernel, version 2.6.18 or newer compiled with support for connection tracking, the connection tracking event notification API and the netfilter "NOTRACK" target. .PP The MediaProxy relay features secure encrypted communication with the dispatcher and has gracefull shutdown capabilities, where it refuses to accept new sessions and shuts down after all the existing sessions are done. .SH OPTIONS .TP .B \-h, \-\-help Show summary of options. .TP .B \-\-version -Show version of program. +Show program version. +.TP +.B \-\-systemd +Run as a systemd simple service and log to journal. .TP .B \-\-no\-fork -Run the process in the foreground (for debugging). +Run in the foreground and log to terminal (for debugging). +.TP +.B \-\-config\-dir=PATH +Set the configuration directory (default is \fB/etc/mediaproxy\fP). +.TP +.B \-\-runtime\-dir=PATH +Set the runtime directory (default is \fB/run/mediaproxy\fP). +.TP +.B \-\-debug +Enable verbose logging. .TP -.B \-\-pid=file -Set the proces pid file to \fB`file'\fP. If not specified the default -pid file is \fB/var/run/mediaproxy/relay.pid\fP . +.B \-\-debug\-memory +Enable memory debugging. .SH SEE ALSO .BR media-dispatcher (1), .PP For more information, please refer to the MediaProxy page which can be found at http://ag-projects.com/MediaProxy.html .SH AUTHOR Dan Pascu .