.\"
.\" $Id: vchatctl.8.in,v 1.4 2006/06/03 18:39:43 mickey Exp $
.\"
.Dd Jun 03, 2006
.Os vserver @PACKAGE_VERSION@
.Dt VCHATCTL \&8 "VChat System Managers Manual"
.Sh NAME
.Nm vchatctl
.Nd VChat conference server control utility
.Sh SYNOPSIS
.Nm
.Op Cm /SOCKET Ns = Ns Ar file
.Op Cm command
.Pp
.Nm vchatctl.cgi
.Pp
.Nm webchat_list.cgi
.\" -------------------------------------------------------------------------
.Sh DESCRIPTION
The
.Nm vchatctl
program is used to query data from, alter operational parameters of
and issue commands upon the running
.Xr vserver 8 
process.
.Pp
There are three different modes of operation, which are determined by
the program name,
.Nm
is being called as:
.Pp
.Bl -enum -offset indent -compact
.It
When called as
.Nm ,
standard command mode is activated. In this mode commands may either
be specified directly on the commandline, or when called without
arguments,
.Nm
enters interactive mode and prompts for commands. You may type
.Qq help
at the command prompt to get a list of supported commands.
.Pp
.It
When called with a program name of
.Nm vchatctl.cgi ,
CGI mode is assumed. This mode presents a simple HTML interface
that lists all users currently logged on to
.Xr vserver 8
and kicks the corresponding user off the conference, when you click on
his name in the list.
.Pp
.It
When called with a program name of
.Nm webchat_list.cgi ,
a list of all users currently logged on to
.Xr vserver 8 ,
their current conference channel and the time of their last activity is
output in form of a text/plain document, that is expected to conform to
the requirements of webchat.de for listing your VChat conference server
in their list of chat servers. For more information on this item you
should visit the
.Ad http://www.webchat.de/
site.
.Pp
.El
.Ss Qualifiers
The following commandline qualifiers are recognized by
.Nm :
.Bl -tag -width "-lnum"
.It Cm /SOCKET Ns = Ns Ar file
Use the socket
.Ar file
instead of the default
.Pa @DEFAULT_BASEDIR@vctl
to send control commands to
.Xr vserver 8 .
.El
.\" -------------------------------------------------------------------------
.Sh FILES
.Bl -tag -width /var/run/vchat/vctl -compact
.It Pa @DEFAULT_BASEDIR@vctl
The server control socket of
.Xr vserver 8
where
.Nm
sends control commands to normally resides in
.Pa @DEFAULT_BASEDIR@ .
.It Pa ~/.vchatctl_history
A history of interactively entered commands is saved to this file.
.El
.\" -------------------------------------------------------------------------
.Sh SEE ALSO
.Xr vserver 8
.\" -------------------------------------------------------------------------
.Sh HISTORY
The
.Nm
command first appeared with vserver 2.36n on May 21, 1996.
.\" -------------------------------------------------------------------------
.Sh AUTHORS
.An "Andreas S. Wetzel" Aq mickey@enforcer.cc