DataMuseum.dk

top - metrics - download

    Length: 5480 (0x1568)
    Types: TextFile
    Names: »cubeserver.6«

└─⟦b20c6495f⟧ Bits:30007238 EUUGD18: Wien-båndet, efterår 1987
    └─⟦this⟧ »EUUGD18/General/Cubes/cubeserver.6« 

TextFile

.TH CUBESERVER 6 "cubes 5.1" GMP "UNIX Gaming Manual"
.SH NAME
cubeserver \- cubes dice game service
.\"
.\" sccsid: @(#)cubeserver.6 5.1 (G.M. Paris) 89/01/22
.\"
.\"
.\"
.\"	cubes 5.1  Copyright 1988 Gregory M. Paris
.\"		Permission granted to redistribute on a no charge basis.
.\"		All other rights are reserved.
.\"
.\"
.SH SYNOPSIS
.B cubeserver
[
.B \-j
] [
.BR \-b { nrwe }
]
.SH OVERVIEW
The
.I cubeserver
is the program that provides the
.IR cubes
game service.
This manual page is intended for games administrators.
Potential
.I cubes
players should see the manual pages for
.IR cubes ,
.IR cuberank ,
and
.IR cubestat
to find out how to play the game.
.SH "FILE MODES AND OWNERSHIPS"
The
.I cubeserver
is meant to be run setuid to an unprivileged daemon account, often
.IR gdaemon .
The files used by the
.I cubeserver
are assumed to exist, have the same ownership as the executable,
and have permissions mode of 644, 640, or 600.
The Makefile supplied with the
.I cubes
distribution should create all needed files with appropriate
ownership and permissions.
.SH "UNIX DOMAIN CUBES SERVICE"
The
.I cubeserver
can be configured to provide
.I cubes
service in the
.B UNIX
domain.
This service can be provided in addition to,
or as an alternative to the
.B INET
domain service (described below).
At least one of the services must be provided,
or the server will not run.
.PP
The
.B UNIX
domain service allows connections from clients only on the local system,
and could possibly be more efficient than the
.B INET
service.
To configure the server to provide service in this domain,
it must be compiled with the
.B \-DUNIXSOCK=pathname
option, where
.B pathname
is the name of the rendezvous socket.
(The client program also must be compiled with this option.)
.SH "INET DOMAIN CUBES SERVICE"
The
.I cubeserver
can be configured to provide
.I cubes
service in the
.B INET
domain,
allowing the server to be accessed from remote systems.
To provide this networked service,
the server must be compiled with the
.B \-DINETSOCK
option and the
.I cubes
service must be made a ``well known'' service.
.PP
Making the
.I cubes
service well known
usually means adding an entry to the file /etc/services
(see
.IR services (5)).
(Note that the entry should be added to the services file on every
system upon which the client program,
.IR cubes ,
is to be run, not just on the system on which the server is to be run.)\ 
The entry is for the TCP socket that the server uses to communicate
with its clients during game play.
The port number chosen must be greater than 1024
so that the server can run as an unprivileged user.
Although not officially registered in any way,
the following entry is suggested.
.PP
.DT
.nf
.ft B
	cube		3840/tcp	cubes
.fi
.ft P
.SH "CUBES STATUS SERVICE"
If another well known service is defined, namely the
.I cubestat
service, the server will listen on an
.B INET
domain UDP socket for status requests generated by the
.I cubestat
program.
Since the TCP and UDP port number spaces are separate,
it is reasonable to use the same port number for both sockets.
(Remember, the port number chosen must be greater than 1024
so that the server can run as an unprivileged user.)\ 
Again, though not officially registered in any way,
the following entry is suggested.
.PP
.DT
.nf
.ft B
	cubestat	3840/udp	cubestatus
.fi
.ft P
.PP
The current version of the server does not provide status service in the
.B UNIX
domain, regardless of compile time options.
.SH "STARTING THE SERVER"
Normally, the
.I cubeserver
will be started automatically on system boot
by placing the appropriate line in the file /etc/rc.local,
or possibly in another file where similar daemons are started.
Alternatively, it is possible to start the server via a program like
.IR cron .
For this purpose,
when the server is started
it prints its process id on the standard output.
This pid could be saved in a file and be used to turn the daemon
off at a later time,
again using
.IR cron .
To kill the server immediately,
send it a SIGTERM.
More politely, killing the server with SIGHUP
causes it to exit when any game in progress finishes.
.PP
There are two command line options for
.IR cubeserver .
.PP
The
.B \-j
option allows the server to occasionally play the game of
.I cubes
with dice that have jokers on them.
Without this option,
the game is always played with normal six-sided dice.
.PP
The
.BR \-b < when >
option allows specifying when the server will play the game of
.I cubes
in Blitz mode (games end at 7500 rather than 10000 points).
The values of
.RB ` n ',
.RB ` r ',
.RB ` w ',
and
.RB ` e '
tell the server to play in Blitz mode
never, on request, default during working hours,
and enforced during working hours respectively.
The default is
.RB ` e '.
.SH FILES
.ta 3.2i
.nf
/usr/games/lib/cubeserver	the cubeserver executable
/usr/games/lib/cubes.hist	the cubes score file
/usr/games/lib/cubes.monikers	names for the chamelion
.fi
.PP
The cubes.monikers file is a record of names selected by
human players for use by the chamelion player.
This file will grow without bound,
so it might be a good idea to check it on occasion.
A good idea anyway, since
.I cubeserver
does not judge the acceptability of names before using them.
The program has a short list of names compiled in,
so you can avoid problems with this file by linking it to /dev/null.
.DT
.SH "SEE ALSO"
cubes(6), cuberank(6), cubestat(6), services(5), rc(8), cron(8)
.SH AUTHOR
Greg Paris <gmp@rayssd.ray.com>