NAME
ggz-cmd - Useful GGZ server control tool
SYNOPSIS
ggz-cmd HOST LOGIN PASSWORD COMMAND [OPTIONS...]
DESCRIPTION
Connects to a GGZ server to execute some command or batch of commands.
The ggz-cmd tool is a command line client to servers of the GGZ Gaming
Zone which is able to broadcast messages to all rooms of such a server.
It expects a command and the login data to be given, and depending on
the command some optional parameters might be needed as well.
It can also be used to check the GGZ server uptime, either by emitting
error messages directly, or through Nagios.
COMMANDS
announce MESSAGE
Broadcasts a message from the lobby to all other rooms. This
requires administrative privileges for the GGZ account which is
used for the login.
checkonline
Reports whether the specified server is currently up and running
or not. The exit code (shell variable $?) is 0 in the case of
success, or greater than 0 otherwise.
checknagios
This is similar to checkonline, but failure exit codes match
those of the Nagios uptime control service. Also, the GGZ
account to use must be a guest account. This command is only of
interest if Nagios is actually used and the GGZ server should be
supervised as part of the network.
batch BATCHFILE
This is a pseudo command which can be used to execute multiple
commands one after the other. Each line in BATCHFILE corresponds
to one invocation of ggz-cmd, except that only the options are
contained, not the command ggz-cmd itself.
SEE ALSO
nagios(8)
AUTHORS
The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org>