[SCM] Packaging for Red Eclipse branch, master, updated. 5dc6003aa3da59e1bee4514f97ff78bfdd434b6b

Mon Dec 19 20:53:53 UTC 2011

The following commit has been merged in the master branch:
commit b1d8bc9408f9cd0d9c7c9a415c3f504c047c49f5
Author: Martin Erik Werner <martinerikwerner at gmail.com>
Date:   Mon Dec 19 18:47:56 2011 +0100

    Manpages accepted upstream, Debian adaptions in a patch

diff --git a/debian/patches/adapt-manpages.patch b/debian/patches/adapt-manpages.patch
new file mode 100644
index 0000000..276bceb
--- /dev/null
+++ b/debian/patches/adapt-manpages.patch
@@ -0,0 +1,163 @@
+From e15c93c32fac6a0a5103c629fbebe5b83f8c9169 Mon Sep 17 00:00:00 2001
+From: Martin Erik Werner <martinerikwerner at gmail.com>
+Date: Mon, 19 Dec 2011 18:19:06 +0100
+Subject: [PATCH] Adapt manpages
+
+Adapt manpages to the way the scripts and paths are set up in Debian
+---
+ src/install/nix/redeclipse-server.6 |   26 +++++++++++++++-----------
+ src/install/nix/redeclipse.6        |   35 ++++++++++++++++++++---------------
+ 2 files changed, 35 insertions(+), 26 deletions(-)
+
+diff --git a/src/install/nix/redeclipse-server.6 b/src/install/nix/redeclipse-server.6
+index cea5517..ad8216a 100644
+--- a/src/install/nix/redeclipse-server.6
++++ b/src/install/nix/redeclipse-server.6
+@@ -1,8 +1,8 @@
+ .TH REDECLIPSE-SERVER 6 2011-12-10 "Red Eclipse 1.2" "Red Eclipse Manual"
+ .SH NAME
+-server.sh \- script to launch the server for the Red Eclipse FPS game
++redeclipse-server \- script to launch the server for the Red Eclipse FPS game
+ .SH SYNOPSIS
+-.B ./server.sh
++.B redeclipse-server
+ [
+ .BI \-h homedir
+ ]
+@@ -54,13 +54,15 @@ server.sh \- script to launch the server for the Red Eclipse FPS game
+ .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 server.sh
+-is a script which executes the Red Eclipse dedicated server located in the
+-.I bin
+-subdirectory (relative to the location of server.sh) It will accept any additional options.
++.B redeclipse-server
++is a script which executes
++.BR redeclipse-server
++from the
++.I /usr/lib/games/redeclipse
++directory, 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 the directory
+-.IR data/examples
++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/doc/redeclipse/examples/
+ .SH OPTIONS
+ .TP
+ .BI \-h homedir
+@@ -71,7 +73,9 @@ This is where servinit.cfg and servexec.cfg are read from, it defaults to $HOME/
+ .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 the working directory and in the subdirecory
++Can be used for adding additional mods. Packages will be loaded in the order specified. By default redeclipse-server only inludes data files in the working directory
++.I /usr/share/games/redeclipse/data
++and in the subdirecory
+ .I temp
+ of the home directory.
+ .TP
+@@ -138,11 +142,11 @@ Users must know the password before they can connect.
+ .B \-\-help
+ Display this manpage
+ .SH EXAMPLES
+-.B ./server.sh -p$HOME/mod/data -ss0 -slbath -sPpass
++.B redeclipse-server -p$HOME/mod/data -ss0 -slbath -sPpass
+ .RS 4
+ Loads data from an additional directory, sets the server type to local (LAN), sets the default map to "bath" and sets the admin password to "pass"
+ .RE
+-.B ./server.sh -h$HOME/redeclipse-server_configs/
++.B redeclipse-server -h$HOME/redeclipse-server_configs/
+ .RS 4
+ Reads and writes the configuration files to the specified directory instead of $HOME/.redeclipse/
+ .RE
+diff --git a/src/install/nix/redeclipse.6 b/src/install/nix/redeclipse.6
+index 873c33b..daa4620 100644
+--- a/src/install/nix/redeclipse.6
++++ b/src/install/nix/redeclipse.6
+@@ -1,8 +1,8 @@
+ .TH REDECLIPSE 6 2011-12-10 "Red Eclipse 1.2" "Red Eclipse Manual"
+ .SH NAME
+-redeclipse.sh \- script to launch the Red Eclipse FPS game client
++redeclipse \- script to launch the Red Eclipse FPS game client
+ .SH SYNOPSIS
+-.B ./redeclipse.sh
++.B redeclipse
+ [
+ .BI \-dw width
+ ]
+@@ -66,12 +66,12 @@ redeclipse.sh \- script to launch the Red Eclipse FPS game client
+ .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.sh
+-is a script which executes the Red Eclipse binary located in the
+-.I bin
+-subdirectory (relative to the location of redelipse.sh)
+-.br
+-It passes the "\-r" option to the client binary by default, and accepts any additional arguments
++.B redeclipse
++is a script which executes
++.BR redeclipse
++from the
++.I /usr/lib/games/redeclipse
++directory using the "\-r" option, it will accept any additional options.
+ .PP
+ The recommended way to change the settings of the client are to edit the
+ .I config.cfg
+@@ -79,14 +79,14 @@ and
+ .I init.cfg
+ files in the home directory.
+ .PP
+-The Red Eclipse client starts a local loopback server upon launch which it uses to connect to for singleplayer, hence many of the server options are accepted by the reclient binary as well (see
+-.BR server (6)).
++The redeclipse client starts a local loopback server upon launch which it uses to connect to for singleplayer, hence many of the server options are accepted by the redeclipse binary as well (see
++.BR redeclipse-server (6)).
+ To edit the specific settings related to the loopback server, use the
+ .I localexec.cfg
+ and
+ .I localinit.cfg
+ files in the home directory.
+-.SH CAVEATS:
++.SH CAVEATS
+ Many of these options will, if used, be permanently saved in the init.cfg file.
+ .SH OPTIONS
+ .TP
+@@ -155,7 +155,9 @@ Red Eclipse will look for files in this directory in addition the normal install
+ .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 only inludes data files in its working directory and in the
++Can be used for adding additional mods. Packages will be loaded in the order specified. By default redeclipse only inludes data files in its working directory
++.IR /usr/share/games/redeclipse/data/ ,
++and in the
+ .I temp
+ subdirectory of the home directory.
+ .TP
+@@ -186,17 +188,20 @@ Contacts the master server using port
+ .BI \-g logfile
+ Output log to
+ .IR logfile .
++.TP
++.B \-\-help
++Display this manpage
+ .SH EXAMPLES
+ .PP
+-.B ./redeclipse.sh -p$HOME/mod/data
++.B redeclipse -p$HOME/mod/data
+ .RS 4
+ Load data from an additional directory.
+ .RE
+-.B ./redeclipse.sh -h$HOME/redeclipse_configs/
++.B redeclipse -h$HOME/redeclipse_configs/
+ .RS 4
+ Reads and writes the configuration files to the specified directory instead of $HOME/.redeclipse/
+ .RE
+-.B ./redeclipse.sh -x"mode 7; trialweapon 0; map hinder"
++.B redeclipse -x"mode 7; trialweapon 0; map hinder"
+ .RS 4
+ Sets game mode to time trial, trialmode weapon to empty hands, and starts a game on the map "hinder".
+ .RE
+-- 
+1.7.7.3
+
diff --git a/debian/patches/series b/debian/patches/series
index 0411096..800e52c 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,2 +1,3 @@
 windowed-by-default.patch
 build-with-debug-symbols.patch
+adapt-manpages.patch
diff --git a/debian/redeclipse-server.6 b/debian/redeclipse-server.6
deleted file mode 100644
index ad8216a..0000000
--- a/debian/redeclipse-server.6
+++ /dev/null
@@ -1,160 +0,0 @@
-.TH REDECLIPSE-SERVER 6 2011-12-10 "Red Eclipse 1.2" "Red Eclipse Manual"
-.SH NAME
-redeclipse-server \- script to launch the server for the Red Eclipse FPS game
-.SH SYNOPSIS
-.B redeclipse-server
-[
-.BI \-h homedir
-]
-[
-.BI \-p packagedir
-]
-[
-.BR \-v {0..4}
-]
-[
-.BI \-x \(dqcommand(s)\(dq
-]
-[
-.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
-]
-]
-.B \-\-help
-]
-.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 redeclipse-server
-from the
-.I /usr/lib/games/redeclipse
-directory, 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/doc/redeclipse/examples/
-.SH OPTIONS
-.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 $HOME/.redeclipse/
-.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 the working directory
-.I /usr/share/games/redeclipse/data
-and in the subdirecory
-.I temp
-of the home 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.
-.TP
-.BI \-x "\(dqcommand 1; command 2; ...\(dq"
-.
-Executes a list of commands once the Red Eclipse server has started up.
-.BI \-x scriptname
-Executes script
-.I scriptname
-once the Red Eclipse server has started up.
-.TP
-.BI \-o sauerdir
-Sets the path to your Sauerbraten directory. If the Red Eclipse server can find your Sauerbraten directory, it will be able to load and distribute maps from it.
-.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.
-.B \-\-help
-Display this manpage
-.SH EXAMPLES
-.B redeclipse-server -p$HOME/mod/data -ss0 -slbath -sPpass
-.RS 4
-Loads data from an additional directory, sets the server type to local (LAN), sets the default map to "bath" and sets the admin password to "pass"
-.RE
-.B redeclipse-server -h$HOME/redeclipse-server_configs/
-.RS 4
-Reads and writes the configuration files to the specified directory instead of $HOME/.redeclipse/
-.RE
-.SH AUTHORS
-Red Eclipse's main developers are Quinton "quin" Reeves and Lee "eihrul" Salzman
-.PP
-This manual page was written by Martin Erik Werner <martinerikwerner at gmail.com> for the Debian project (and may be used by others).
-.SH HISTORY
-Red Eclipse was forked as a continuation of the game Bloodfrontier, which in turn was based on the Cube2 engine and the Sauerbraten game. Red Eclipse and Sauerbraten are now developed in parallel.
-.SH "SEE ALSO"
-.BR redeclipse (6)
diff --git a/debian/redeclipse-server.manpages b/debian/redeclipse-server.manpages
index 7f056b8..ed8b065 100644
--- a/debian/redeclipse-server.manpages
+++ b/debian/redeclipse-server.manpages
@@ -1 +1 @@
-debian/redeclipse-server.6
+src/install/nix/redeclipse-server.6
diff --git a/debian/redeclipse.6 b/debian/redeclipse.6
deleted file mode 100644
index daa4620..0000000
--- a/debian/redeclipse.6
+++ /dev/null
@@ -1,215 +0,0 @@
-.TH REDECLIPSE 6 2011-12-10 "Red Eclipse 1.2" "Red Eclipse Manual"
-.SH NAME
-redeclipse \- script to launch the Red Eclipse FPS game client
-.SH SYNOPSIS
-.B redeclipse
-[
-.BI \-dw width
-]
-[
-.BI \-dh height
-]
-[
-.BI \-dd depth
-]
-[
-.BI \-dc depth
-]
-[
-.BI \-da samples
-]
-[
-.BR \-dv {0|1}
-]
-[
-.BR \-df {0|1}
-]
-[
-.BI \-ds bits
-]
-[
-.BR \-du {0..3}
-]
-[
-.BR \-k {0|1}
-]
-[
-.BI \-h homedir
-]
-[
-.BI \-p packagedir
-]
-[
-.BR \-v {0..4}
-]
-[
-.BI \-r scriptname
-]
-[
-.BI \-x \(dqcommand(s)\(dq
-]
-[
-.BI \-o sauerdir
-]
-[
-.BI \-sm servermaster
-]
-[
-.BI \-sa servermasterport
-]
-[
-.BI \-g logfile
-]
-[
-.B \-\-help
-]
-.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
-is a script which executes
-.BR redeclipse
-from the
-.I /usr/lib/games/redeclipse
-directory using the "\-r" option, it will accept any additional options.
-.PP
-The recommended way to change the settings of the client are to edit the
-.I config.cfg
-and
-.I init.cfg
-files in the home directory.
-.PP
-The redeclipse client starts a local loopback server upon launch which it uses to connect to for singleplayer, hence many of the server options are accepted by the redeclipse binary as well (see
-.BR redeclipse-server (6)).
-To edit the specific settings related to the loopback server, use the
-.I localexec.cfg
-and
-.I localinit.cfg
-files in the home directory.
-.SH CAVEATS
-Many of these options will, if used, be permanently saved in the init.cfg file.
-.SH OPTIONS
-.TP
-.BI \-dw width
-Sets screen width to
-.IR width .
-If height not specified, also sets height to 3/4 of width. min is 320.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-dh height
-Sets screen height to
-.IR height .
-If width not specified, also sets width to 4/3 of height. min is 320.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-dd depth
-Sets z-buffer depth to
-.IR depth .
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-dc depth
-Sets colour depth (bits per pixel) to
-.IR depth .
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-da samples
-Sets full-scene anti-aliasing (FSAA) to
-.I samples
-samples.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BR \-dv {0|1}
-Turns vertical sync on or off. 0 to disable, 1 to enable. Defaults to 0.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BR \-df {0|1}
-Turns fullscreen mode on or off. 0 to disable, 1 to enable. Defaults to 1.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-ds bits
-Sets stencil buffer bits to
-.IR bits .
-.IP
-This configuration is stored in init.cfg
-.TP
-.BR \-du {0..3}
-Set shader quality. 0 for none, 1 for shaders with fastest quality, max is 3. Defaults to 1 where hardware supports it.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BR \-k {0|1}
-Enables or disables kid mode, which reduces blood and death effects somewhat. 1 enables reduced gore, defaults to 0.
-.TP
-.BI \-h homedir
-Sets your home directory to
-.IR homedir .
-Red Eclipse will look for files in this directory in addition the normal installation directory. All user files will be written to the home directory. Defaults to $HOME/.redeclipse/
-.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 only inludes data files in its working directory
-.IR /usr/share/games/redeclipse/data/ ,
-and in the
-.I temp
-subdirectory of the home 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, defaults to 0.
-.IP
-This configuration is stored in init.cfg
-.TP
-.BI \-r scriptname
-Executes the specified init script before OpenGL and various libraries are initialized. If no file specified, executes init.cfg in the home directory.
-.TP
-.BI \-x "\(dqcommand 1; command 2; ...\(dq"
-.
-Executes a list of commands once Red Eclipse has started up.
-.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
-.BI \-sm servermaster
-Connects to
-.I servermaster
-to get the list of available servers. May also use this setting if the local client server is configured to be public?
-.TP
-.BI \-sa servermasterport
-Contacts the master server using port
-.IR servermasterport .
-.TP
-.BI \-g logfile
-Output log to
-.IR logfile .
-.TP
-.B \-\-help
-Display this manpage
-.SH EXAMPLES
-.PP
-.B redeclipse -p$HOME/mod/data
-.RS 4
-Load data from an additional directory.
-.RE
-.B redeclipse -h$HOME/redeclipse_configs/
-.RS 4
-Reads and writes the configuration files to the specified directory instead of $HOME/.redeclipse/
-.RE
-.B redeclipse -x"mode 7; trialweapon 0; map hinder"
-.RS 4
-Sets game mode to time trial, trialmode weapon to empty hands, and starts a game on the map "hinder".
-.RE
-.SH AUTHORS
-Red Eclipse's main developers are Quinton "quin" Reeves and Lee "eihrul" Salzman
-.PP
-This manual page was written by Martin Erik Werner <martinerikwerner at gmail.com> for the Debian project (and may be used by others).
-.SH HISTORY
-Red Eclipse was forked as a continuation of the game Bloodfrontier, which in turn was based on the Cube2 engine and the Sauerbraten game. Red Eclipse and Sauerbraten are now developed in parallel.
-.SH "SEE ALSO"
-.BR redeclipse-server (6).
diff --git a/debian/redeclipse.manpages b/debian/redeclipse.manpages
index de3bdb2..2f10dca 100644
--- a/debian/redeclipse.manpages
+++ b/debian/redeclipse.manpages
@@ -1 +1 @@
-debian/redeclipse.6
+src/install/nix/redeclipse.6

-- 
Packaging for Red Eclipse

