[openjk] 15/15: Add man pages
Simon McVittie
smcv at debian.org
Tue Dec 30 22:11:47 UTC 2014
This is an automated email from the git hooks/post-receive script.
smcv pushed a commit to branch master
in repository openjk.
commit 803a023d81b65594cc52a91caa28db01243443c8
Author: Simon McVittie <smcv at debian.org>
Date: Tue Dec 30 20:36:41 2014 +0000
Add man pages
---
debian/openjk-academy-server.manpages | 1 +
debian/openjk-academy.manpages | 2 +
debian/openjk-outcast.manpages | 1 +
debian/openjk.6 | 84 +++++++++++++++++++++++++
debian/openjk_sp.6 | 81 ++++++++++++++++++++++++
debian/openjkded.6 | 112 ++++++++++++++++++++++++++++++++++
debian/openjo_sp.6 | 81 ++++++++++++++++++++++++
7 files changed, 362 insertions(+)
diff --git a/debian/openjk-academy-server.manpages b/debian/openjk-academy-server.manpages
new file mode 100644
index 0000000..bcef241
--- /dev/null
+++ b/debian/openjk-academy-server.manpages
@@ -0,0 +1 @@
+debian/openjkded.6
diff --git a/debian/openjk-academy.manpages b/debian/openjk-academy.manpages
new file mode 100644
index 0000000..015c465
--- /dev/null
+++ b/debian/openjk-academy.manpages
@@ -0,0 +1,2 @@
+debian/openjk.6
+debian/openjk_sp.6
diff --git a/debian/openjk-outcast.manpages b/debian/openjk-outcast.manpages
new file mode 100644
index 0000000..8a4f41b
--- /dev/null
+++ b/debian/openjk-outcast.manpages
@@ -0,0 +1 @@
+debian/openjo_sp.6
diff --git a/debian/openjk.6 b/debian/openjk.6
new file mode 100644
index 0000000..c61282d
--- /dev/null
+++ b/debian/openjk.6
@@ -0,0 +1,84 @@
+.TH OPENJK 6 2014-12-30
+
+.SH NAME
+openjk \- Jedi Academy multi-player
+
+.SH SYNOPSIS
+.BR openjk
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B openjk
+runs the multi-player version of the first- and third-person action game
+Star Wars Jedi Knight: Jedi Academy, using the OpenJK engine.
+
+.SH OPTIONS
+The wrapper script used for OpenJK 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
+\fB$XDG_DATA_HOME/openjk\fR, defaulting to \fB~/.local/share/openjk\fR
+Configuration and state for Jedi Academy.
+
+.SH ENVIRONMENT
+The wrapper script used to launch OpenJK allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENJK_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenJK command line, such
+as \fBstrace\fR; overridden by \fBOPENJK_BACKTRACE\fR
+.TP
+\fBOPENJK_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenJK crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR openjk_sp (6),
+.BR openjo_sp (6),
+.BR openjkded (6),
+/usr/share/doc/openjk-academy
+.SH AUTHOR
+Jedi Academy was written by Raven Software, based on id Software's
+Quake III Arena engine. The engine used in Debian is OpenJK,
+maintained by the JACoders community, with various enhancements
+taken from ioquake3.
+.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/openjk_sp.6 b/debian/openjk_sp.6
new file mode 100644
index 0000000..4240f6f
--- /dev/null
+++ b/debian/openjk_sp.6
@@ -0,0 +1,81 @@
+.TH OPENJK_SP 6 2014-12-30
+
+.SH NAME
+openjk_sp \- Jedi Academy single-player
+
+.SH SYNOPSIS
+.BR openjk_sp
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B openjk
+runs the single-player version of the first- and third-person action game
+Star Wars Jedi Knight: Jedi Academy, using the OpenJK engine.
+
+.SH OPTIONS
+The wrapper script used for OpenJK 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
+\fB$XDG_DATA_HOME/openjk\fR, defaulting to \fB~/.local/share/openjk\fR
+Configuration and state for Jedi Academy.
+
+.SH ENVIRONMENT
+The wrapper script used to launch OpenJK allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENJK_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenJK command line, such
+as \fBstrace\fR; overridden by \fBOPENJK_BACKTRACE\fR
+.TP
+\fBOPENJK_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenJK crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR openjk (6),
+.BR openjo_sp (6),
+.BR openjkded (6),
+/usr/share/doc/openjk-academy
+.SH AUTHOR
+Jedi Academy was written by Raven Software, based on id Software's
+Quake III Arena engine. The engine used in Debian is OpenJK,
+maintained by the JACoders community, with various enhancements
+taken from ioquake3.
+.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/openjkded.6 b/debian/openjkded.6
new file mode 100644
index 0000000..012e874
--- /dev/null
+++ b/debian/openjkded.6
@@ -0,0 +1,112 @@
+.TH OPENJKDED 6 2014-12-30
+
+.SH NAME
+openjkded \- Jedi Academy dedicated server
+
+.SH SYNOPSIS
+.BR openjkded
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B openjkded
+is the OpenJK dedicated server for the first- and third-person action game
+Star Wars Jedi Knight: Jedi Academy.
+
+.SH OPTIONS
+The wrapper script used for OpenJK 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 OpenJK allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENJK_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenJK command line, such
+as \fBstrace\fR; overridden by \fBOPENJK_BACKTRACE\fR
+.TP
+\fBOPENJK_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenJK crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR openjk (6),
+.BR openjk_sp (6),
+.BR openjo_sp (6),
+/usr/share/doc/openjk-academy-server
+
+.SH AUTHOR
+Jedi Academy was written by Raven Software, based on id Software's
+Quake III Arena engine. The engine used in Debian is OpenJK,
+maintained by the JACoders community, with various enhancements
+taken from ioquake3.
+.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/openjo_sp.6 b/debian/openjo_sp.6
new file mode 100644
index 0000000..a0cbb9e
--- /dev/null
+++ b/debian/openjo_sp.6
@@ -0,0 +1,81 @@
+.TH OPENJO_SP 6 2014-12-30
+
+.SH NAME
+openjo_sp \- Jedi Knight II: Jedi Outcast single-player
+
+.SH SYNOPSIS
+.BR openjo_sp
+.BR "" [ \-h | \-\-help ]
+.BR "" [ \-q | \-\-quiet ]
+.BR "" [ +set
+.IR option " " value ]...
+[\fB+\fIcommand\fR] ...
+
+.SH DESCRIPTION
+.B openjo_sp
+runs the single-player version of the first- and third-person action game
+Star Wars Jedi Knight II: Jedi Outcast, using the OpenJK engine.
+
+.SH OPTIONS
+The wrapper script used for OpenJK 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
+\fB$XDG_DATA_HOME/openjo\fR, defaulting to \fB~/.local/share/openjo\fR
+Configuration and state for Jedi Outcast.
+
+.SH ENVIRONMENT
+The wrapper script used to launch OpenJK allows it to be debugged
+by setting environment variables.
+.TP
+\fBOPENJK_DEBUGGER=\fIcommand\fR
+A debugger or other prefix to prepend to the OpenJK command line, such
+as \fBstrace\fR; overridden by \fBOPENJK_BACKTRACE\fR
+.TP
+\fBOPENJK_BACKTRACE=1\fR
+Use \fBgdb\fR(1) to get a backtrace if OpenJK crashes (the \fBgdb\fR
+package must be installed for this to work)
+
+.SH SEE ALSO
+.BR openjk (6),
+.BR openjk_sp (6),
+.BR openjkded (6),
+/usr/share/doc/openjk-outcast
+.SH AUTHOR
+Jedi Outcast was written by Raven Software, based on id Software's
+Quake III Arena engine. The engine used in Debian is OpenJK,
+maintained by the JACoders community, with various enhancements
+taken from ioquake3.
+.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/openjk.git
More information about the Pkg-games-commits
mailing list