mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
69 lines
2.3 KiB
Groff
69 lines
2.3 KiB
Groff
.\" This manpage has been automatically generated by docbook2man
|
|
.\" from a DocBook document. This tool can be found at:
|
|
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
|
|
.\" Please send any bug reports, improvements, comments, patches,
|
|
.\" etc. to Steve Cheng <steve@ggi-project.org>.
|
|
.TH "CYCLIENT" "1" "18 November 2010" "" "cyphesis"
|
|
|
|
.SH NAME
|
|
cyclient \- cyphesis world building client
|
|
.SH SYNOPSIS
|
|
|
|
\fB/usr/bin/cyclient\fR [ \fB--section:option=value\fR\fI ...\fR ] [ \fBpackage.function\fR ]
|
|
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The \fBcyclient\fR program connects to a cyphesis server and
|
|
populates the world with data.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
Configuration options are divided up into named sections, which need to
|
|
be specified when modifying or overriding the options. In a config file
|
|
the name of a section is specified in square brackets at the beginning
|
|
of the section. On the command line the section is given at the
|
|
beginning of the option specification, as shown in the synopsis above.
|
|
.SS "CLIENT OPTIONS"
|
|
.PP
|
|
The following options are present in the client section of the config file,
|
|
and overridden by specifying the client section name on the command line.
|
|
.TP
|
|
\fBpackage="define_world" \fR
|
|
Python package which contains the client function.
|
|
|
|
This setting provides the name of the Python package which contains the
|
|
function that should run by the client.
|
|
.TP
|
|
\fBfunction="default" \fR
|
|
Python client function.
|
|
|
|
This setting provides the Python function which should be run by the client.
|
|
.SS "SERVER OPTIONS"
|
|
.PP
|
|
The following options are present in the cyphesis section of the config
|
|
file, and overridden by specifying the cyphesis section name on the
|
|
command line. These options apply to the server, but are also required
|
|
by the client to ensure that the client can connect.
|
|
.TP
|
|
\fBtcpport=6767 \fR
|
|
Network port for server TCP connections.
|
|
|
|
Specifies the port number to use when connecting to the server.
|
|
.TP
|
|
\fBunixport="cyphesis.sock" \fR
|
|
Local liston socket for Unix domain connections.
|
|
|
|
Specifies the filename to use to listen for local trusted client connections.
|
|
.SH "AUTHOR"
|
|
.PP
|
|
Written by Alistair Riddoch.
|
|
.SH "REPORTING BUGS"
|
|
.PP
|
|
Report bugs to <general@worldforge.org>\&.
|
|
.SH "COPYRIGHT"
|
|
.PP
|
|
Copyright 2004 Alistair Riddoch.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBcyphesis\fR(1),
|
|
\fBcyphesis-tools\fR(1),
|
|
\fBcycmd\fR(1)
|