[redeclipse] 85/494: Server manpage, small fixes to client manpages

[Martin Werner]

This is an automated email from the git hooks/post-receive script.

arand-guest pushed a commit to branch debdir
in repository redeclipse.

commit ca1ae73c58c986602c3b1dd2f556887756e31aea
Author: Arand Nash <ienorand at gmail.com>
Date:   Fri Mar 11 19:25:47 2011 +0000

    Server manpage, small fixes to client manpages
---
 reclient.6                 |   1 +
 redeclipse-server.6        | 148 +++++++++++++++++++++++++++++++++++++++++++++
 redeclipse-server.manpages |   2 +
 redeclipse.6               |   1 +
 reserver.6                 | 146 ++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 298 insertions(+)

diff --git a/reclient.6 b/reclient.6
index ed84a40..f145cc7 100644
--- a/reclient.6
+++ b/reclient.6
@@ -249,3 +249,4 @@ Red Eclipse is based on the Cube 2 engine.
 .SH "SEE ALSO"
 .BR redeclipse (6),
 .BR reserver (6).
+.BR redeclipse-server (6).
diff --git a/redeclipse-server.6 b/redeclipse-server.6
new file mode 100644
index 0000000..9c92df5
--- /dev/null
+++ b/redeclipse-server.6
@@ -0,0 +1,148 @@
+.TH REDECLIPSE-SERVER 6
+.SH NAME
+redeclipse-server \- script to launch the server for the Red Eclipse FPS game
+.SH SYNOPSIS
+.B redeclipse-server
+[
+.BR \-k {0|1}
+]
+[
+.BI \-h homedir
+]
+[
+.BI \-p packagedir
+]
+[
+.BR \-v {0..4}
+]
+[
+.BI \-x scriptname
+]
+[
+.BI \-o sauerdir
+]
+[
+.BI \-ss servertype
+]
+[
+.BI \-g logfile
+]
+[
+.BI \-su serveruprate
+]
+[
+.BI \-si serverip
+]
+[
+.BI \-sm servermaster
+]
+[
+.BI \-sa servermasterport
+]
+[
+.BI \-sl defaultmap
+]
+[
+.BI \-sp serverport
+]
+[
+.BI \-sP adminpass
+]
+[
+.BI \-sk joinpass
+]
+.SH DESCRIPTION
+Red Eclipse is a single-player and multi-player first-person ego-shooter, built as a total conversion of Cube Engine 2, which lends itself toward a balanced gameplay, with a general theme of agility in a variety of environments.
+.PP
+.B redeclipse-server
+is a script which executes
+.BR reserver (6)
+using the "-p/usr/share/games/redeclipse/data" option, it will accept any additional options.
+.PP
+The recommended way to change the settings of the server is to create and edit the files servexec.cfg and servinit.cfg files in your home directory. Examples are available in
+.IR /usr/share/games/redeclipse/data/examples/ ,
+.SH OPTIONS
+.BI \-h homedir
+Sets your home directory to
+.IR homedir .
+This is where servinit.cfg and servexec.cfg are read from, it defaults to the $HOME shell variable.
+.TP
+.BI \-p packagedir
+Includes the data files found in
+.IR packagedir .
+Can be used for adding additional mods. Packages will be loaded in the order specified. By default redeclipse-server only inludes data files in
+.I /usr/share/games/redeclipse/data
+and in the current working directory.
+.TP
+.BR \-v {0..4}
+Sets verbosity. This affects how much information is printed to the console. 0 is the least verbose, 4 is the most verbose. 
+.IP
+This configuration is stored in init.cfg
+.TP
+.BI \-x scriptname
+Executes script
+.I scriptname
+once the engine has started up and initialized the game. 
+.TP
+.BI \-o sauerdir
+Sets the path to your Sauerbraten directory. If Red Eclipse can find your Sauerbraten directory, you can load and play Sauerbraten maps from withing Red Eclipse. 
+.TP
+.BR \-ss {0..3}
+Sets server type. 0 for local only, 1 for private, 2 for public, 3 for dedicated. Defaults to 1. 
+.TP
+.BI \-g logfile
+Output log to
+.IR logfile .
+.TP
+.BI \-su serveruprate
+Sets upstream rate to
+.IR serveruprate .
+Do not set this unless you know what you are doing, it should normally be left out. 
+.TP
+.BI \-sc maxclients
+Sets the maximum number of clients to
+.IR maxclients .
+.TP
+.BI \-si serverip
+Binds to the ip address
+.IR serverip .
+Only needed for machines with more than one interface.
+.TP
+.BI \-sm servermaster
+uses
+.I servermaster
+as the master server.
+.TP
+.BI \-sa servermasterport
+Contacts the master server using port
+.IR servermasterport .
+.TP
+.BI \-sl defaultmap
+Sets default map to
+.IR defaultmap .
+.TP
+.BI \-sp serverport
+sets the server port to
+.IR serverport .
+.TP
+.BI \-sP adminpass
+Sets the admin password to
+.IR adminpass .
+.TP
+.BI \-sk joinpass
+Sets the join password to
+.IR joinpass .
+Users must know the password before they can connect. 
+.SH EXAMPLES
+.B reserver -p$HOME/mod/data -ss0 -slbath
+.RS 4
+Loads data from an additional directory, sets the server type to local (LAN) and sets the default map to "bath"
+.RE
+.SH AUTHOR
+This manpage was written by Arand Nash <ienorand at gmail.com>
+.SH HISTORY
+Red Eclipse is based on the Cube 2 engine.
+.SH "SEE ALSO"
+.BR redeclipse (6),
+.BR reclient (6).
+.BR reserver (6).
diff --git a/redeclipse-server.manpages b/redeclipse-server.manpages
new file mode 100644
index 0000000..7d18118
--- /dev/null
+++ b/redeclipse-server.manpages
@@ -0,0 +1,2 @@
+debian/redeclipse-server.6
+debian/reserver.6
diff --git a/redeclipse.6 b/redeclipse.6
index fb294c0..77f9c95 100644
--- a/redeclipse.6
+++ b/redeclipse.6
@@ -174,3 +174,4 @@ Red Eclipse is based on the Cube 2 engine.
 .SH "SEE ALSO"
 .BR reclient (6),
 .BR reserver (6).
+.BR redeclipse-server (6).
diff --git a/reserver.6 b/reserver.6
new file mode 100644
index 0000000..3ff6968
--- /dev/null
+++ b/reserver.6
@@ -0,0 +1,146 @@
+.TH RESERVER 6
+.SH NAME
+reserver \- server for the Red Eclipse FPS game
+.SH SYNOPSIS
+.B reclient
+[
+.BR \-k {0|1}
+]
+[
+.BI \-h homedir
+]
+[
+.BI \-p packagedir
+]
+[
+.BR \-v {0..4}
+]
+[
+.BI \-x scriptname
+]
+[
+.BI \-o sauerdir
+]
+[
+.BI \-ss servertype
+]
+[
+.BI \-g logfile
+]
+[
+.BI \-su serveruprate
+]
+[
+.BI \-si serverip
+]
+[
+.BI \-sm servermaster
+]
+[
+.BI \-sa servermasterport
+]
+[
+.BI \-sl defaultmap
+]
+[
+.BI \-sp serverport
+]
+[
+.BI \-sP adminpass
+]
+[
+.BI \-sk joinpass
+]
+.SH DESCRIPTION
+Red Eclipse is a single-player and multi-player first-person ego-shooter, built as a total conversion of Cube Engine 2, which lends itself toward a balanced gameplay, with a general theme of agility in a variety of environments.
+.PP
+The recommended way to change the settings of the server is to create and edit the files servexec.cfg and servinit.cfg files in your home directory. Examples are available in
+.IR /usr/share/games/redeclipse/data/examples/ ,
+.SH OPTIONS
+.BR \-k {0|1}
+Enables or disables kid mode. 0 to disable, 1 to enable.
+.IP
+This option is accepted by reserver, however it seems to have no effect.
+.TP
+.BI \-h homedir
+Sets your home directory to
+.IR homedir .
+This is where servinit.cfg and servexec.cfg are read from, it defaults to the $HOME shell variable.
+.TP
+.BI \-p packagedir
+Includes the data files found in
+.IR packagedir .
+Can be used for adding additional mods. Packages will be loaded in the order specified. By default reserver only inludes data files in the current working directory.
+.TP
+.BR \-v {0..4}
+Sets verbosity. This affects how much information is printed to the console. 0 is the least verbose, 4 is the most verbose. 
+.IP
+This configuration is stored in init.cfg
+.TP
+.BI \-x scriptname
+Executes script
+.I scriptname
+once the engine has started up and initialized the game. 
+.TP
+.BI \-o sauerdir
+Sets the path to your Sauerbraten directory. If Red Eclipse can find your Sauerbraten directory, you can load and play Sauerbraten maps from withing Red Eclipse. 
+.TP
+.BR \-ss {0..3}
+Sets server type. 0 for local only, 1 for private, 2 for public, 3 for dedicated. Defaults to 1. 
+.TP
+.BI \-g logfile
+Output log to
+.IR logfile .
+.TP
+.BI \-su serveruprate
+Sets upstream rate to
+.IR serveruprate .
+Do not set this unless you know what you are doing, it should normally be left out. 
+.TP
+.BI \-sc maxclients
+Sets the maximum number of clients to
+.IR maxclients .
+.TP
+.BI \-si serverip
+Binds to the ip address
+.IR serverip .
+Only needed for machines with more than one interface.
+.TP
+.BI \-sm servermaster
+uses
+.I servermaster
+as the master server.
+.TP
+.BI \-sa servermasterport
+Contacts the master server using port
+.IR servermasterport .
+.TP
+.BI \-sl defaultmap
+Sets default map to
+.IR defaultmap .
+.TP
+.BI \-sp serverport
+sets the server port to
+.IR serverport .
+.TP
+.BI \-sP adminpass
+Sets the admin password to
+.IR adminpass .
+.TP
+.BI \-sk joinpass
+Sets the join password to
+.IR joinpass .
+Users must know the password before they can connect. 
+.SH EXAMPLES
+.B reserver -p/usr/share/games/redeclipse/data -ss0 -slbath
+.RS 4
+Includes data from the specified directory, sets the server type to local (LAN) and sets the default map to "bath"
+.RE
+.SH AUTHOR
+This manpage was written by Arand Nash <ienorand at gmail.com>
+.SH HISTORY
+Red Eclipse is based on the Cube 2 engine.
+.SH "SEE ALSO"
+.BR redeclipse (6),
+.BR reclient (6).
+.BR redeclipse-server (6).

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/redeclipse.git