summaryrefslogtreecommitdiff
path: root/doc/Client.py.1
blob: 758a8dccd0f5ac9b4c3bcb65a40d7dceac82f79a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
.\" $Id: Client.py.1,v 1.3 2005/05/06 21:32:38 arigo Exp $
.\"
.\" Process this file with
.\" groff -man -Tascii Client.py.1
.\"

.TH Client.py 1 "APRIL 2005" Linux "User Manuals"

.SH NAME
Client.py \- the bub-n-bros client

.SH SYNOPSIS
.B python Client.py [
.I options
.BI "] [" host [: port ]]
.PP
Note that this script is in the
.B display/ 
subdirectory of the original directory layout.

.SH DESCRIPTION
This is the bub-n-bros client that connects to bub-n-bros servers
started with
.BR bb.py "(1) or " BubBob.py (1) .
It supports many different audio and video drivers and is very
multi-platform.

.SH OPTIONS

.TP 
.I host
Search for a game on the given machine, and connect to one if found. 
If this is not defined, search for servers on the local network.

.TP
.IB host : port
Connect to server running on given port on given host. If this is not
defined, search for servers on the local network.

.TP
.BI --bits= N
This option concerns only the
.B windows
audio driver. Set bits per sample. Valid values are 8 and 16 (default).

.TP
.BI "-d " DRIVER ", --display=" DRIVER
Use video driver
.IR DRIVER .
Valid drivers are:

.RS
.TP
.B X
X Window driver for Linux and Unix systems with an X server
running. See the 
.B --shm
option.
.TP
.B windows
MS Windows driver.
.TP
.B pygame
PyGame gaming library for python (if installed) has video output. Use
it if this is specified. See
.BR http://www.pygame.org " and the " --transparency " option."
.TP
.B gtk
Use the PyGTK library (if installed). See
.BR http://www.pygtk.org/ " and the " --zoom " option."
.RE

.TP
.B -h, --help
Display help.

.TP
.BI --fmt= format
This option concerns only the
.B linux
audio driver. Set the sound data format. Defaults to
.BR S16_NE .
You can get a list of supported formats with
.BR --fmt=list .

.TP
.BI --freq= N
This option concerns only the 
.BR linux " and " windows
audio drivers. Set mixing frequency to
.I N
(in Hz). Defaults to 44100.

.TP
.B -m, --metaserver
Connect with the help of the Metaserver (see 
.BR bb.py (1)
for more info).  Run
.I Client.py -m
to print a table of currently running servers, pick the
the exact IP address and port of the server of your choice
from the table, and run again
.I Client.py -m
.BR host:port .

.TP
.BI "--port TCP=" port
In conjunction with the
.I -m
option, force a specific
.I port
on which to listen for an incoming TCP connexion from the
remote server.  This is only used if a direct connexion to
the server fails.  A random port number is picked by default.
This option is useful if you are behind a firewall but can
let TCP connexions on specific ports reach you.

.TP
.BI "--port UDP=" port
Force a specific
.I port
on which to listen for incoming UDP traffic (animation
data).  Useful if you are behind a firewall but can let UDP
traffic on a given
.I port
pass through.  This is optional: animation data is routed
over the TCP link if it does not appear to reach the client.
A random port number is picked by default.

.TP
.BI "-s " DRIVER ", --sound=" DRIVER
Use driver
.I DRIVER
for audio. Valid drivers are:

.RS
.TP
.B pygame
Use the audio capabilities of the PyGame library
.RB ( http://www.pygame.org ).

.TP
.B linux
Use the linux audio mixer. See the
.BR --freq " and " --fmt " options."

.TP
.B windows
Use the Windows audio mixer. See the
.BR --freq " and " --bits "options."

.TP
.B off
No sounds.
.RE


.TP
.B --shm=yes, --shm=no
This option concerns only the
.B X
display driver.  Disable or enable the
.B shm
(Shared Memory) extension. It is enabled by default and should only be
disabled for remote X connections and old X servers.

.TP
.B -t
Use the
.B TCP
protocol. The default is to autodetect the protocol. See the
.B -u
option.

.TP
.B --transparency=yes, --transparency=no
This option concerns only the 
.B pygame
display driver. Disable or enable transparent bubbles. Enabled by
default. Disabling makes game a bit faster.

.TP
.B -u
Use the
.B UDP
protocol. The default is to autodetect the protocol. See the
.B -t
option.

.TP
.BI --zoom= N %
This option concerns only the 
.B gtk
display driver. Scale output by
.IR N %.

.SH SEE ALSO
.BR bb.py (1)
.BR Client.py (1)
.BR python (1)