[SCM] Packaging for the OpenArena engine branch, master, updated. debian/0.8.5-5-14-gc94edf7

Simon McVittie smcv at debian.org
Fri Oct 15 21:36:13 UTC 2010 

The following commit has been merged in the master branch:
commit e723530ceecad7b05e5908de171c908707ae0f23
Author: Simon McVittie <smcv at debian.org>
Date:   Fri Oct 15 20:58:42 2010 +0100

    Improve the man pages a bit

diff --git a/debian/changelog b/debian/changelog
index d9e700f..ff59e47 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,6 +7,7 @@ openarena (0.8.5-6) UNRELEASED; urgency=low
   * Set up debian/rules so DEB_BUILD_OPTIONS="noopt" does a debug build
   * Add support for arm/armel in q3arch.sh, avoiding a warning during build
     (the resulting binaries worked OK anyway though)
+  * Improve the man pages a bit
 
  -- Simon McVittie <smcv at debian.org>  Mon, 11 Oct 2010 19:40:30 +0100
 
diff --git a/debian/openarena-server.6 b/debian/openarena-server.6
index 6f40a84..405dabc 100644
--- a/debian/openarena-server.6
+++ b/debian/openarena-server.6
@@ -1,26 +1,122 @@
-.TH OPENARENA 6 "December  6, 2006"
+.TH OPENARENA-SERVER 6 2010-10-15
+
 .SH NAME
-openarena-server \- OpenArena server
+openarena-server \- OpenArena dedicated server
+
 .SH SYNOPSIS
-.PP
-\fBopenarena-server\fR [\fB+set \fIoption\fR \fIvalue\fR\fP] ...
+.BR openarena-server
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+
 .SH DESCRIPTION
-This manual page documents briefly the
 .B openarena-server
-command.
-.PP
-\fBopenarena-server\fP is the dedicated server for the first-person shooter OpenArena.
+is the dedicated server for the first-person shooter OpenArena.
+
 .SH OPTIONS
+The wrapper script used for OpenArena in Debian accepts these options:
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a short help summary
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Disable all output
+.PP
+Any console command can also be prefixed with \fB+\fR and used as a
+command-line option (run the server in a terminal to use the console).
+The \fB+set\fR command is generally the most useful to use on the command line.
+.PP
+Options that can be set with \fB+set\fR
+(note that this is not a full list!) include:
+.PP
+\fBcapturelimit\fR <value>
+.PP
+\fBdedicated\fR <bool>
+.PP
+\fBfraglimit\fR <value>
+.PP
+\fBfs_basepath\fR <string>
+.PP
+\fBfs_game\fR <value>
+.PP
+\fBg_allowVote\fR <bool>
+.PP
+\fBg_banIPs\fR <IP address>
+.PP
+\fBg_doWarmup\fR <bool>
+.PP
+\fBg_friendlyFire\fR <bool>
+.PP
+\fBg_gametype\fR <bool>
+.PP
+\fBg_gravity\fR <value>
+.PP
+\fBg_inactivity\fR <value>
+.PP
+\fBg_maxGameClients\fR <value>
+.PP
+\fBg_motd\fR <string>
+.PP
+\fBg_needpass\fR <bool>
+.PP
+\fBg_password\fR <string>
+.PP
+\fBg_quadfactor\fR <value>
+.PP
+\fBg_weaponrespawn\fR <value>
+.PP
+\fBnet_ip\fR <IP adress>
+.PP
+\fBnet_port\fR <value>
+.PP
+\fBnet_qport\fR <value>
+.PP
+\fBnextmap\fR <string>
+.PP
+\fBsv_allowDownload\fR <bool>
+.PP
+\fBsv_floodProtect\fR <bool>
+.PP
+\fBsv_fps\fR <value>
+.PP
+\fBsv_hostname\fR <string>
+.PP
+\fBsv_maxclients\fR <value>
+.PP
+\fBsv_maxPing\fR <value>
+(Measurd in milliseconds)
+.PP
+\fBsv_minPing\fR <value>
+(Measurd in milliseconds)
 .PP
-Possible options which are passed by +set option value are the same, as the server commands which the interactive command line interface of the server accepts.
+\fBsv_pure\fR <bool>
 .PP
+\fBtimelimit\fR <value>
+(Measured in minutes)
+
+.SH ENVIRONMENT
+The wrapper script used to launch OpenArena allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENARENA_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenArena command line, such
+as \fBstrace\fR; overridden by \fBOPENARENA_BACKTRACE\fR
+.TP
+\fBOPENARENA_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenArena crashes (the \fBgdb\fR
+package must be installed for this to work)
+
 .SH SEE ALSO
-.BR openarena (6)
-.br
-/usr/share/doc/openarena-server
-.br
+.BR openarena (6),
+.BR ioquake3-server (6),
+/usr/share/doc/openarena
+
 .SH AUTHOR
-openarena-server was written by the OpenArena Team.
+OpenArena was written by the OpenArena Team. The engine used is a modified
+ioQuake3, originally created by id Software and now maintained by the ioQuake3
+community.
 .PP
-This manual page was written by Bruno "Fuddl" Kleinert <fuddl at debian.org>,
-for the Debian project (but may be used by others).
+This manual page was written by Bruno "Fuddl" Kleinert <fuddl at debian.org>
+and Simon McVittie <smcv at debian.org>, for the Debian project
+(but may be used by others).
diff --git a/debian/openarena.6 b/debian/openarena.6
index f59dcb5..585a04c 100644
--- a/debian/openarena.6
+++ b/debian/openarena.6
@@ -1,39 +1,82 @@
-.TH OPENARENA 6 "December  6, 2006"
+.TH OPENARENA 6 2010-10-15
+
 .SH NAME
 openarena \- OpenArena client
+
 .SH SYNOPSIS
-.PP
-\fBopenarena\fR [\fB+set \fIoption\fR \fIvalue\fR\fP] ...
+.BR openarena
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+
 .SH DESCRIPTION
-This manual page documents briefly the
 .B openarena
-command.
-.PP
-\fBopenarena\fP is the client for the first-person shooter OpenArena.
+is the client for the first-person shooter OpenArena.
+
 .SH OPTIONS
+The wrapper script used for OpenArena in Debian accepts these options:
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a short help summary
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Disable all output
+.PP
+Any console command can also be prefixed with \fB+\fR and used as a
+command-line option (press Shift+Esc to access the in-game console), including:
+.TP
+\fB+set\fR \fIoption\fR \fIvalue\fR
+Set an option (see below for some options)
+.TP
+\fB+connect\fR \fIserver\fR[\fB:\fIport\fR]
+Connect to a server
 .PP
-Options passed by "+set <option> <value>" are the same as the in-game console accepts. For the in-game console press <Shift>+<Esc> to open it.
-.br
-(Note that this is not a full list!)
+Options that can be set with \fB+set\fR
+(note that this is not a full list!) include:
 .TP
 \fBr_fullscreen\fR <bool>
 1: Play in fullscreen mode; 0: Play in window mode
 .TP
 \fBr_mode\fR <num>
-Sets the screen resulotion mode. Set num to \-1 to use a customized resolution. See also r_customheight and r_customwidth!
+Sets the screen resolution mode. Set num to \-1 to use a customized resolution.
+See also r_customheight and r_customwidth!
 .TP
 \fBr_customwidth\fR <pixels>
 Use \fUpixels\fR as width if r_mode is set to \-1.
 .TP
 \fBr_customheight\fR <pixels>
 Use \fUpixels\fR as height if r_mode is set to \-1.
-.PP
+
+.SH FILES
+.TP
+\fI~/.openarena/baseoa\fR
+Configuration and state for OpenArena
+.TP
+\fI~/.openarena/missionpack\fR
+Configuration and state for the "missionpack" mod
+
+.SH ENVIRONMENT
+The wrapper script used to launch OpenArena allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENARENA_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenArena command line, such
+as \fBstrace\fR; overridden by \fBOPENARENA_BACKTRACE\fR
+.TP
+\fBOPENARENA_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenArena crashes (the \fBgdb\fR
+package must be installed for this to work)
+
 .SH SEE ALSO
-.BR openarena-server (6)
-.br
+.BR openarena-server (6),
+.BR ioquake3 (6),
 /usr/share/doc/openarena
 .SH AUTHOR
-openarena was written by the OpenArena Team.
+OpenArena was written by the OpenArena Team. The engine used is a modified
+ioQuake3, originally created by id Software and now maintained by the ioQuake3
+community.
 .PP
-This manual page was written by Bruno "Fuddl" Kleinert <fuddl at debian.org>,
-for the Debian project (but may be used by others).
+This manual page was written by Bruno "Fuddl" Kleinert <fuddl at debian.org>
+and Simon McVittie <smcv at debian.org>, for the Debian project
+(but may be used by others).

-- 
Packaging for the OpenArena engine

More information about the Pkg-games-commits mailing list