mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
140 lines
3.8 KiB
Text
140 lines
3.8 KiB
Text
|
|
<refentry id="cyclient">
|
|
|
|
<refmeta>
|
|
<refentrytitle>cyclient</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cyclient</refname>
|
|
<refpurpose>cyphesis world building client</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyclient</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
<arg choice="opt">package.function</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
The <command>cyclient</command> program connects to a cyphesis server and
|
|
populates the world with data.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Options</title>
|
|
<para>
|
|
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.
|
|
</para>
|
|
<refsect2><title>Client Options</title>
|
|
<para>
|
|
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.
|
|
</para>
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><fieldsynopsis>
|
|
<varname>package</varname>
|
|
<initializer>="define_world"</initializer>
|
|
</fieldsynopsis>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Python package which contains the client function.
|
|
</para>
|
|
<para>
|
|
This setting provides the name of the Python package which contains the
|
|
function that should run by the client.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><fieldsynopsis>
|
|
<varname>function</varname>
|
|
<initializer>="default"</initializer>
|
|
</fieldsynopsis>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Python client function.
|
|
</para>
|
|
<para>
|
|
This setting provides the Python function which should be run by the client.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect2>
|
|
|
|
<refsect2><title>Server Options</title>
|
|
<para>
|
|
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.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><fieldsynopsis>
|
|
<varname>tcpport</varname>
|
|
<initializer>=6767</initializer>
|
|
</fieldsynopsis>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Network port for server TCP connections.
|
|
</para>
|
|
<para>
|
|
Specifies the port number to use when connecting to the server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><fieldsynopsis>
|
|
<varname>unixport</varname>
|
|
<initializer>="cyphesis.sock"</initializer>
|
|
</fieldsynopsis>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Local liston socket for Unix domain connections.
|
|
</para>
|
|
<para>
|
|
Specifies the filename to use to listen for local trusted client connections.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1><title>Author</title>
|
|
<para>
|
|
Written by Alistair Riddoch.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Reporting bugs</title>
|
|
<para>
|
|
Report bugs to <email>general@worldforge.org</email>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Copyright</title>
|
|
<para>
|
|
Copyright 2004 Alistair Riddoch.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>cyphesis</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>cyphesis-tools</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>cycmd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|