initial commit from cvs 1.6.2

4 files changed, 391 insertions, 0 deletions

diff --git a/doc/BubBob.py.1 b/doc/BubBob.py.1
new file mode 100644
index 0000000..0b77548
--- /dev/null
+++ b/doc/BubBob.py.1
@@ -0,0 +1,32 @@
+.\" $Id: BubBob.py.1,v 1.2 2005/04/13 18:24:17 opqdonut Exp $
+.\"
+.\" Process this file with
+.\" groff -man -Tascii BubBob.py.1
+.\"
+
+.TH BubBob.py 1 "APRIL 2005" Linux "User Manuals"
+
+.SH NAME
+BubBob.py \- Generic startup script for bub-n-bros
+
+.SH SYNOPSIS
+.B BubBob.py
+.br
+.B python BubBob.py
+
+.SH DESCRIPTION
+.B BubBob.py
+runs
+.BR bb.py (1)
+(the bub-n-bros server) and then tries to open the url of its control
+panel in your webbrowser.
+
+.SH ENVIRONMENT
+The environment variable BROWSER affects the choosing of the browser
+on Unix systems.
+
+.SH SEE ALSO
+.BR bb.py (1)
+.BR Client.py (1)
+.BR python (1)
+
diff --git a/doc/Client.py.1 b/doc/Client.py.1
new file mode 100644
index 0000000..758a8dc
--- /dev/null
+++ b/doc/Client.py.1
@@ -0,0 +1,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)
\ No newline at end of file
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..3c21fcb
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,30 @@
+# 'make compress' to build the docs as gzipped manpages.
+# 'make txt' to build the docs as plain text manpages.
+# 'make html' to build the docs as html-ized manpages.
+
+all: txt html compress
+txt: bb.py.txt Client.py.txt BubBob.py.txt
+html: bb.py.html Client.py.html BubBob.py.html
+
+compress: bb.py.1.gz Client.py.1.gz BubBob.py.1.gz
+
+%.html : %.1
+	groff -man -Thtml $< > $@
+
+%.txt : %.1
+	groff -man -Tascii $< > $@
+
+%.1.gz : %.1
+	gzip -c $< > $@
+
+clean:
+	rm -f bb.py.txt Client.py.txt BubBob.py.txt
+	rm -f bb.py.html Client.py.html BubBob.py.html
+	rm -f *.gz
+
+install:
+	$(INSTALL) -c -o $(MANOWNER) -g $(MANGROUP) -m 644 bb.py.1.gz $(MANDIR)/man1/bubnbros-server.1.gz
+	$(INSTALL) -c -o $(MANOWNER) -g $(MANGROUP) -m 644 Client.py.1.gz $(MANDIR)/man1/bubnbros.1.gz
+	$(INSTALL) -c -o $(MANOWNER) -g $(MANGROUP) -m 644 BubBob.py.1.gz $(MANDIR)/man1/BubBob.1.gz
+
+	### TODO: install for html and txt files!
diff --git a/doc/bb.py.1 b/doc/bb.py.1
new file mode 100644
index 0000000..d7bff4e
--- /dev/null
+++ b/doc/bb.py.1
@@ -0,0 +1,129 @@
+.\" $Id: bb.py.1,v 1.3 2005/04/17 17:19:32 opqdonut Exp $
+.\"
+.\" Process this file with
+.\" groff -man -Tascii bb.py.1
+.\"
+
+.TH bb.py 1 "APRIL 2005" Linux "User Manuals"
+
+.SH NAME
+bb.py \- the bub-n-bros server.
+
+.SH SYNOPSIS
+.B bb.py [
+.I level-file.bin
+.BI "] [" options ]
+.br
+.B python bb.py [
+.I level-file.bin
+.BI "] [" options ]
+.PP
+Note that this script is in the
+.B bubbob/ 
+subdirectory of the original directory layout.
+
+.SH DESCRIPTION
+.B bb.py
+starts an http server that acts as a control panel for the server. The
+server listens on port 
+.B 8000 
+by default. The url for the control panel
+is 
+.BI http:// server : port / 0xN 
+where
+.I 0xN
+is a random hex number (acts as minimal protection). This url is
+printed when the server starts.  You can start and view games and kill
+the server from this panel. The control panel also allows you to type
+in the address of a server to connect to, the script will then open a
+client to that server. The http server also servers java applet
+clients for those players who wish to use one.
+
+When a game is started the script opens a port for the game
+server. This port can then be connected to by a client.  Clients
+autodetect servers running on the local network with UDP ping on port
+.BR 8056 .
+
+.SS Connection forming
+
+The client forms a tcp connection to the server. Or, when using the
+metaserver, the server forms a connection to the client. If this
+fails, the client and server try a simultaneous SYN connect. This
+sometimes works if the server and client are behind firewalls. The
+server then tries to transmit the data over udp. If it gets no
+response from the client it will fall back to the existing tcp
+connection.
+
+.SH OPTIONS
+
+.TP
+.BI "-b " N ", --begin " N ", --start " N
+Start at board (level) number
+.IR N .
+The default is 1. See also the
+.B -s
+option.
+
+.TP
+.B -h, --help
+Display help.
+
+.TP
+.B -i, --infinite
+Restart the server at the end of the game. Normally the server quits
+after a certain period of inactivity. This is useful when used with the
+.B -m
+option to make a public server that is available for a long time.
+
+.TP
+.BI "-l " N ", --lives " N
+Limit number of lives to 
+.IR N .
+If this option is not specified the number of lives will be infinite.
+
+.TP
+.B -m, --metaserver
+Register server with the
+.I Metaserver
+(currently) at 
+.BR codespeak.net:8050 .
+This makes your server visible to everybody, and also facilitates
+joining through a fascistic firewall.
+
+.TP
+.B --port
+.IR TYPE = N
+Sets default listening ports. If type is
+.B LISTEN
+, sets the game server port to
+.IR N .
+The game server port is chosen randomly by default. If the type is
+.B HTTP
+, sets the http server port to
+.IR N .
+The http server port defaults to 
+.BR 8000 . 
+Another port will be chosen if
+none was specified and
+.B 8000 
+is already in use. The server also listens to
+.B UDP
+ping on port 
+.BR 8056 .
+
+.TP
+.BI "-s " N ", --step " N
+Increase board number with
+.I N
+when a board is completed. Defaults to 1. see also the
+.B -b
+option.
+
+.SH OUTPUT
+The server outputs helpful debug information concerning the http and
+game servers.
+
+.SH SEE ALSO
+.BR BubBob.py (1)
+.BR Client.py (1)
+.BR python (1)