[iortcw] 09/10: Add some simple man pages

Simon McVittie smcv at debian.org
Tue Dec 30 22:11:31 UTC 2014 

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

smcv pushed a commit to branch master
in repository iortcw.

commit a611b951e55adee18a458880f4ea6a7239a51404
Author: Simon McVittie <smcv at debian.org>
Date:   Tue Dec 30 20:20:57 2014 +0000

    Add some simple man pages
---
 debian/rtcw-server.manpages |   1 +
 debian/rtcw.manpages        |   2 +
 debian/wolfded.6            | 110 ++++++++++++++++++++++++++++++++++++++++++++
 debian/wolfmp.6             |  82 +++++++++++++++++++++++++++++++++
 debian/wolfsp.6             |  78 +++++++++++++++++++++++++++++++
 5 files changed, 273 insertions(+)

diff --git a/debian/rtcw-server.manpages b/debian/rtcw-server.manpages
new file mode 100644
index 0000000..0e819d4
--- /dev/null
+++ b/debian/rtcw-server.manpages
@@ -0,0 +1 @@
+debian/wolfded.6
diff --git a/debian/rtcw.manpages b/debian/rtcw.manpages
new file mode 100644
index 0000000..ae85723
--- /dev/null
+++ b/debian/rtcw.manpages
@@ -0,0 +1,2 @@
+debian/wolfsp.6
+debian/wolfmp.6
diff --git a/debian/wolfded.6 b/debian/wolfded.6
new file mode 100644
index 0000000..6d79572
--- /dev/null
+++ b/debian/wolfded.6
@@ -0,0 +1,110 @@
+.TH WOLFDED 6 2014-12-30
+
+.SH NAME
+wolfded \- Return to Castle Wolfenstein dedicated server
+
+.SH SYNOPSIS
+.BR wolfded
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B wolfded
+is the dedicated server for the first-person shooter Return to Castle
+Wolfenstein.
+
+.SH OPTIONS
+The wrapper script used for RTCW 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
+\fBdedicated\fR \fI0-2\fR
+.PP
+\fBfs_game\fR <value>
+.PP
+\fBg_allowVote\fR <bool>
+.PP
+\fBg_banIPs\fR <IP address>
+.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
+\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
+\fBsv_pure\fR <bool>
+.PP
+\fBtimelimit\fR <value>
+(Measured in minutes)
+
+.SH ENVIRONMENT
+The wrapper script used to launch RTCW allows it to be debugged
+by setting environment variables.
+.TP
+\fBRTCW_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the RTCW command line, such
+as \fBstrace\fR; overridden by \fBRTCW_BACKTRACE\fR
+.TP
+\fBRTCW_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if RTCW crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR wolfsp (6),
+.BR wolfmp (6),
+/usr/share/doc/rtcw-server
+
+.SH AUTHOR
+RTCW multi-player was written by Gray Matter Studios, Nerve Software and
+id Software. The engine used is iortcw, maintained by the ioquake3 and
+iortcw communities.
+.PP
+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/wolfmp.6 b/debian/wolfmp.6
new file mode 100644
index 0000000..d4803a3
--- /dev/null
+++ b/debian/wolfmp.6
@@ -0,0 +1,82 @@
+.TH WOLFMP 6 2014-12-30
+
+.SH NAME
+wolfmp \- Return to Castle Wolfenstein multi-player
+
+.SH SYNOPSIS
+.BR wolfmp
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B wolfmp
+runs the multi-player version of the first-person shooter
+Return to Castle Wolfenstein.
+
+.SH OPTIONS
+The wrapper script used for RTCW 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 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 resolution mode. Set num to \-1 to use a customized
+resolution set via r_customheight and r_customwidth, or \-2 to use
+your normal desktop resolution.
+.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.
+
+.SH FILES
+.TP
+\fI~/.wolf/main\fR
+Configuration and state for RTCW
+
+.SH ENVIRONMENT
+The wrapper script used to launch RTCW allows it to be debugged
+by setting environment variables.
+.TP
+\fBRTCW_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the RTCW command line, such
+as \fBstrace\fR; overridden by \fBRTCW_BACKTRACE\fR
+.TP
+\fBRTCW_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if RTCW crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR wolfded (6),
+.BR wolfsp (6),
+/usr/share/doc/rtcw
+.SH AUTHOR
+RTCW multi-player was written by Gray Matter Studios, Nerve Software and
+id Software. The engine used is iortcw, maintained by the ioquake3 and
+iortcw communities.
+.PP
+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/wolfsp.6 b/debian/wolfsp.6
new file mode 100644
index 0000000..9a4248b
--- /dev/null
+++ b/debian/wolfsp.6
@@ -0,0 +1,78 @@
+.TH WOLFSP 6 2014-12-30
+
+.SH NAME
+wolfsp \- Return to Castle Wolfenstein single-player
+
+.SH SYNOPSIS
+.BR wolfsp
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B wolfsp
+runs the single-player version of the first-person shooter
+Return to Castle Wolfenstein.
+
+.SH OPTIONS
+The wrapper script used for RTCW 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)
+.PP
+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 resolution mode. Set num to \-1 to use a customized
+resolution set via r_customheight and r_customwidth, or \-2 to use
+your normal desktop resolution.
+.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.
+
+.SH FILES
+.TP
+\fI~/.wolf/main\fR
+Configuration and state for RTCW
+
+.SH ENVIRONMENT
+The wrapper script used to launch RTCW allows it to be debugged
+by setting environment variables.
+.TP
+\fBRTCW_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the RTCW command line, such
+as \fBstrace\fR; overridden by \fBRTCW_BACKTRACE\fR
+.TP
+\fBRTCW_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if RTCW crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR wolfded (6),
+.BR wolfmp (6),
+/usr/share/doc/rtcw
+.SH AUTHOR
+RTCW single-player was written by Gray Matter Studios and id Software.
+The engine used is iortcw, maintained by the ioquake3 and iortcw communities.
+.PP
+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).

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

More information about the Pkg-games-commits mailing list