openmcu.1

mcu for video conference test

'\" t
.\" Man page for openmcu
.\" SGM 16 Jul 2001
.\"
.TH openmcu 1 "16 Jul 2001"
.LO 1
.SH NAME
openmcu \- simple Multi Conference Unit using H.323
.SH SYNOPSIS
.B openmcu
[\fIoptions\fR]...
.SH DESCRIPTION
.PP
.B openmcu
is a simple Mutli Conference Unit using the H.323 protocol. It sets up a
H.323 listener process, and then waits for incoming connections. Whenever an
incoming connection is established, it adds that call to the specified
conference or to the default one if none is specified. You specify one on
your H.323 client when you call the OpenMCU server with address
"room_name@server_name", where room_name is the conference you want to join.

.SH OPTIONS
.PP
All of the command line options to
.B openmcu
can be specified in long form, and the most commonly used options also have
single character equivalents. The long forms can also be used in the
.B openmcu
configuration file.

.TP
\fB\-u\fR, \fB\-\-username\fR \fIstr\fR
Set the local endpoint name to \fIstr\fR.

.TP
\fB\-g\fR, \fB\-\-gatekeeper\fR \fIhost\fR    
Upon startup, register with only with the specified gatekeeper rather than
attempting to find a gatekeeper by using UDP broadcast.

.TP
\fB\-n\fR, \fB\-\-no\-gatekeeper\fR      
Do not attempt to find a gatetkeeper upon startup using UDP broadcast.

.TP
\fB\-\-require\-gatekeeper\fR 
Exit if a gatekeeper cannot be found.

.TP
\fB\-i\fR, \fB\-\-interface\fR \fIIP\fR
Only bind to the specified network interface address.
By default, 
.B openmcu
automatically listens for incoming calls on all TCP/IP network interfaces
available on the host machine. This option is useful for running multiple
copies of
.B openmcu
on the same multi\-homed machine, or for ensuring that only calls from the
external, or internal, network will be received on a particular handset.

.TP
\fB\-\-g711frames\fR \fIcount\fR
Set the number of G.711 frames in capabilities to \fIcount\fR. Defaults to
30.

.TP
\fB\-\-gsmframes\fR \fIcount\fR
Set the number of GSM frames in capabilities to \fIcount\fR. Defaults to
4.

.TP
\fB\-t\fR, \fB\-\-trace\fR 
Enable debug tracing, which displays messages at run\-time to assist in
debugging or problem identification. Specifying this option multiple times
increases the amount of information displayed. Use the \fB\-o\fR option to
write the trace information to a file rather than to stderr.

.TP
\fB\-o\fR, \fB\-\-output\fR \fIfilename\fR
Write trace output (enabled with the \fB\-t\fR option) to the specified file
rather than to stderr.

.TP
\fB\-\-save\fR
Save arguments in configuration file.

.TP
\fB\-v\fR, \fB\-\-video\fR
Enable H261 video handling.

.TP
\fB\-\-videolarge\fR
Set the video size from normal (176x144) to large (352x288).

.TP
\fB\-\-videotxquality\fR \fIn\fR
Set sent video quality to \fIn\fR, default is 9. \fIn\fR has to be between 1
(good) and 31.

.TP
\fB\-\-videofill\fR \fIn\fR
Set the number of updated background blocks per frame to \fIn\fR, default is
2. \fIn\fR has to be between 1 and 99.

.TP
\fB\-\-videotxfps\fR \fIn\fR
Set maximum number of transmited video frames per seceond to \fIn\fR, default
is 10. \fIn\fR has to be between 1 and 30.

.TP
\fB\-\-defaultroom\fR \fIname\fR
Selects the default room \fIname\fR that will be used for connections that
don't specify one, default is room101.

.TP
\fB\-\-no\-defaultroom\fR
Reject connections with no room specified.

.TP
\fB\-\-disable-menu\fR
Disable the command line menu.

.TP
\fB\-h\fR, \fB\-\-help\fR
Display the help message.

.SH CONFIGURATION FILE
.PP
.B openmcu
options can be set in the ohphone configuration file
.B ~/.pwlib_config/openmcu.ini
either by edditing this file or via the \fB\-\-save\fR option.
Options must be located in the section prefixed with [Options]. The long
form of any command line option specified above can be specified in the
configuration file, in the format:

.TP
\fIoption\fR = \fIvalue\fR

.SH INTERNAL MENU
.PP
Unless the \fB\-\-disable\-menu\fR option has been specified
.B openmcu
allows the user to perform various operations whilst running. These
operations are accessed via single line commands which each start with a
single character identifying the function. The available commands are:

.TP
\fB?\fR
Print the menu help.
.TP
\fBv\fR
Report which connections are at each video corner.
.TP
\fBm\fR
Make a call, which will be added to the default room.
.TP
\fBx\fR
Exit.
.TP
\fBs\fR
Report statistics.
.TP
\fBz\fR
Put message in log file (for debugging).

.SH EXAMPLES
.PP

.TP
openmcu -n
Start the program without registering with a gatekeeper.

.SH FILES
.PP
~/.pwlib_config/openmcu.ini

.SH BUGS
.PP
None that I know of.

.SH "SEE ALSO"
None