This is an automated email from the git hooks/post-receive script.
smcv pushed a commit to branch quake
in repository game-data-packager.
commit 9d640a8ffb672064607bc5b092b250e5f46afee1
Author: Simon McVittie <s...@debian.org>
Date: Fri Oct 15 20:58:50 2010 +0100
Adjust man pages
---
debian/quake3-server.6 | 51 +++++++++++++++++++++++++++++-------------------
debian/quake3.6 | 53 ++++++++++++++++++++++++++++++++++++--------------
2 files changed, 69 insertions(+), 35 deletions(-)
diff --git a/debian/quake3-server.6 b/debian/quake3-server.6
index 13f3113..2aefce9 100644
--- a/debian/quake3-server.6
+++ b/debian/quake3-server.6
@@ -1,28 +1,34 @@
-.TH QUAKE3-SERVER 6 "June 25 , 2008"
+.TH QUAKE3-SERVER 6 2010-10-15
+
.SH NAME
quake3-server \- Quake III Arena dedicated server
+
.SH SYNOPSIS
-.B quake3-server
-[\-h|\-\-help] [\-q|\-\-quiet] [+set \fIoption\fP \fIvalue\fP]...
+.BR quake3-server
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+
.SH DESCRIPTION
-.PP
-This manual page documents briefly the
.B quake3-server
-command.
-.PP
-\fBquake3-server\fP is the Quake III Arena dedicated server.
-It is a multiplayer network game.
+is the dedicated server for Quake III Arena, a multiplayer network game.
+
.SH OPTIONS
-Options passed to the wrapper script:
+The wrapper script used for Quake III Arena 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 console output
+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 passed to the Quake III server binary by the +set
-parameter (note that this is not a full list!) include:
+Options that can be set with \fB+set\fR
+(note that this is not a full list!) include:
.PP
\fBcapturelimit\fR <value>
.PP
@@ -88,7 +94,7 @@ parameter (note that this is not a full list!) include:
.PP
\fBtimelimit\fR <value>
(Measured in minutes)
-.BR
+
.SH FILES
.TP
\fI~/.q3a/baseq3\fR
@@ -96,7 +102,10 @@ Configuration and state for Quake III Arena
.TP
\fI~/.q3a/missionpack\fR
Configuration and state for Quake III: Team Arena, if installed
+
.SH ENVIRONMENT
+The wrapper script used to launch Quake III Arena allows it to be debugged
+by setting environment variables.
.TP
\fBQUAKE3_DEBUGGER=\fIcommand\fR
A debugger or other prefix to prepend to the Quake III command line, such
@@ -105,17 +114,19 @@ as \fBstrace\fR; overridden by \fBQUAKE3_BACKTRACE\fR
\fBQUAKE3_BACKTRACE=1\fR
Use \fBgdb\fR(1) to get a backtrace if Quake III crashes (the \fBgdb\fR
package must be installed)
+
.SH SEE ALSO
-.BR quake3-server (6)
-.br
+.BR quake3 (6),
+.BR ioq3ded (6)
+
.SH AUTHOR
The Quake III server binary used is a modified ioQuake3; originally created by
Id Software, now maintained by the ioQuake3 community.
.PP
-This manual page was written by Jack "jscinoz" Coulter <jsci...@gmail.com>
-for the Debian project (but may be used by others). It is largely based
-on the manual page written by Bruno "Fuddl" Kleinert <fu...@debian.org>
-for the Debian project. Permission is granted to copy, distribute and/or
+This manual page was written by Jack "jscinoz" Coulter <jsci...@gmail.com>,
+Bruno "Fuddl" Kleinert <fu...@gmx.de> and Simon McVittie <s...@debian.org>
+for the Debian project (but may be used by others).
+Permission is granted to copy, distribute and/or
modify this document under the terms of the GNU General Public License,
Version 2, or any later version published by the Free Software Foundation.
.PP
diff --git a/debian/quake3.6 b/debian/quake3.6
index 95bff5a..ff3defb 100644
--- a/debian/quake3.6
+++ b/debian/quake3.6
@@ -1,18 +1,21 @@
-.TH QUAKE3 6 "June 25 , 2008"
+.TH QUAKE3 6 2010-10-15
+
.SH NAME
-quake3 \- Quake III Arena
+quake3 \- Quake III Arena client
+
.SH SYNOPSIS
.B quake3
-[\-h|\-\-help] [\-q|\-\-quiet] [+set \fIoption\fP \fIvalue\fP]...
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+
.SH DESCRIPTION
-.PP
-This manual page documents briefly the
.B quake3
-command.
-.PP
-\fBquake3\fP is the Quake III Arena client. It is a multiplayer network game.
+is the client for Quake III Arena, a multiplayer network game.
+
.SH OPTIONS
-Options passed to the wrapper script:
+The wrapper script used for Quake III Arena in Debian accepts these options:
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a short help summary
@@ -20,7 +23,16 @@ Display a short help summary
\fB\-q\fR, \fB\-\-quiet\fR
Disable all console output
.PP
-Options that can be passed to the Quake III binary by the +set parameter
+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 that can be set with \fB+set\fR
(note that this is not a full list!) include:
.PP
\fBcg_drawFPS\fR <bool>
@@ -78,7 +90,7 @@ Options that can be passed to the Quake III binary by the
+set parameter
\fBr_ignoreGLErrors\fR <bool>
.PP
\fBr_mode\fR <value>
-.BR
+
.SH FILES
.TP
\fI~/.q3a/baseq3\fR
@@ -86,7 +98,10 @@ Configuration and state for Quake III Arena
.TP
\fI~/.q3a/missionpack\fR
Configuration and state for Quake III: Team Arena, if installed
+
.SH ENVIRONMENT
+The wrapper script used to launch Quake III Arena allows it to be debugged
+by setting environment variables.
.TP
\fBQUAKE3_DEBUGGER=\fIcommand\fR
A debugger or other prefix to prepend to the Quake III command line, such
@@ -95,13 +110,21 @@ as \fBstrace\fR; overridden by \fBQUAKE3_BACKTRACE\fR
\fBQUAKE3_BACKTRACE=1\fR
Use \fBgdb\fR(1) to get a backtrace if Quake III crashes (the \fBgdb\fR
package must be installed)
+
.SH SEE ALSO
-.BR quake3-server (6)
-.br
+.BR quake3-server (6),
+.BR ioquake3 (6)
+
.SH AUTHOR
The Quake III Arena binary used is a modified ioQuake3; originally created by
Id Software, now maintained by the ioQuake3 community.
.PP
-This manual page was written by Jack "jscinoz" Coulter <jsci...@gmail.com> for
the Debian project (but may be used by others). It is largely based off the
manual page written by Bruno "Fuddl" Kleinert <fu...@gmx.de> for the Debian
project. Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License, Version 2 any later version
published by the Free Software Foundation.
+This manual page was written by Jack "jscinoz" Coulter <jsci...@gmail.com>,
+Bruno "Fuddl" Kleinert <fu...@gmx.de> and Simon McVittie <s...@debian.org>
+for the Debian project (but may be used by others).
+Permission is granted to copy, distribute and/or
+modify this document under the terms of the GNU General Public License,
+Version 2 any later version published by the Free Software Foundation.
.PP
-On Debian systems, the complete text of the GNU General Public License can be
found in /usr/share/common-licenses/GPL-2.
+On Debian systems, the complete text of the GNU General Public License
+can be found in /usr/share/common-licenses/GPL-2.
--
Alioth's /usr/local/bin/git-commit-notice on
/srv/git.debian.org/git/pkg-games/game-data-packager.git
_______________________________________________
Pkg-games-commits mailing list
Pkg-games-commits@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-games-commits
