1CYCLIENT(1) cyphesis CYCLIENT(1)
2
3
4
6 cyclient - cyphesis world building client
7
9 /usr/bin/cyclient [ --section:option=value ... ] [ package.function ]
10
11
13 The cyclient program connects to a cyphesis server and populates the
14 world with data.
15
17 Configuration options are divided up into named sections, which need to
18 be specified when modifying or overriding the options. In a config file
19 the name of a section is specified in square brackets at the beginning
20 of the section. On the command line the section is given at the begin‐
21 ning of the option specification, as shown in the synopsis above.
22
23 CLIENT OPTIONS
24 The following options are present in the client section of the config
25 file, and overriden by specifying the client section name on the com‐
26 mand line.
27
28 package="define_world"
29 Python package which contains the client function.
30
31 This setting provides the name of the Python package which con‐
32 tains the function that should run by the client.
33
34 function="default"
35 Python client function.
36
37 This setting provides the Python function which should be run by
38 the client.
39
40 SERVER OPTIONS
41 The following options are present in the cyphesis section of the config
42 file, and overriden by specifying the cyphesis section name on the com‐
43 mand line. These options apply to the server, but are also required by
44 the client to ensure that the client can connect.
45
46 tcpport=6767
47 Network port for server TCP connections.
48
49 Specifies the port number to use when connecting to the server.
50
51 unixport="cyphesis.sock"
52 Local liston socket for Unix domain connections.
53
54 Specifies the filename to use to listen for local trusted client
55 connections.
56
58 Written by Alistair Riddoch.
59
61 Report bugs to <general@worldforge.org>.
62
64 Copyright 2004 Alistair Riddoch.
65
67 cyphesis(1), cyphesis-tools(1), cycmd(1)
68
69
70
71 18 November 2010 CYCLIENT(1)