Commit ecf4ad4a authored by Simon McVittie's avatar Simon McVittie

Update man pages for use of shared launcher

parent ad3c06ad
......@@ -6,6 +6,9 @@ etqw \- Enemy Territory: Quake Wars client
.SH SYNOPSIS
.B etqw
.BR "" [ \-h | \-\-help ]
.BR "" [ \-\-quiet ]
.BR "" [ \-\-smp ]
.IR "" [ "debugging options" ]
.BR "" [ +set
.IR option " " value ]...
......@@ -20,11 +23,22 @@ The wrapper script used for ETQW in Debian accepts these options:
\fB\-h\fR, \fB\-\-help\fR
Display a short help summary
.TP
\fB\-\-quiet\fR
Suppress console output
.TP
\fB\-\-smp\fR
Use the multi-threaded version of the client and the modified
copy of SDL that is bundled with it. The default is to use the
single-threaded client and the system copy of SDL. Both versions
are included in the etqw-bin package.
.TP
\fB\-\-debugger=\fIDEBUGGER\fR
Prepend a debugger or other prefix (such as \fBstrace\fR) to the ETQW
command line
.TP
\fB\-\-print\-backtrace\fR
Use \fBgdb\fR(1) to get a backtrace if ETQW crashes (the \fBgdb\fR
package must be installed)
.PP
Any console command can also be prefixed with \fB+\fR and used as a
command-line option (press Ctrl+Alt and the key above Tab to access the
......@@ -35,18 +49,6 @@ in-game console).
\fI~/.etqwcl\fR
Configuration and state for ETQW
.SH ENVIRONMENT
The wrapper script used to launch ETQW allows it to be debugged
by setting environment variables.
.TP
\fBQUAKE4_DEBUGGER=\fIcommand\fR
A debugger or other prefix to prepend to the ETQW command line, such
as \fBstrace\fR; overridden by \fBQUAKE4_BACKTRACE\fR
.TP
\fBQUAKE4_BACKTRACE=1\fR
Use \fBgdb\fR(1) to get a backtrace if ETQW crashes (the \fBgdb\fR
package must be installed)
.SH AUTHOR
ETQW was written by Splash Damage and originally published by Activision.
It is proprietary software.
......
......@@ -43,12 +43,12 @@ syntax whereby engine switches are prefixed with a minus sign, and you can
give console commands by prefixing with a plus sign. See the examples section
for some common cases.
.PP
Additionally, if \fBquake\fR is run via a symbolic link whose name contains
\fBarmagon\fR, \fBhipnotic\fR, \fBdissolution\fR or \fBrogue\fR,
Additionally, if \fBquake\fR is run via a symbolic link whose name is
\fBquake-armagon\fR or \fBquake-dissolution\fR,
it will play one of the Quake mission packs, \fBScourge of Armagon\fR
(by Hipnotic Software) or \fBDissolution of Eternity\fR (by Rogue
Entertainment). Similarly, if run via a symbolic link whose name contains
\fBdopa\fR it will play Quake Episode 5: Dimensions of the Past (by
Entertainment). Similarly, if run via a symbolic link whose name is
\fBquake-dopa\fR it will play Quake Episode 5: Dimensions of the Past (by
MachineGames). This requires that additional data files are installed.
.SH OPTIONS
These options are accepted for \fBWRAPPER-OPTIONS\fR in the
......@@ -59,6 +59,14 @@ Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.TP
\fB\-\-debugger=\fIDEBUGGER\fR
Prepend a debugger or other prefix (such as \fBstrace\fR) to the engine
command line
.TP
\fB\-\-print\-backtrace\fR
Use \fBgdb\fR(1) to get a backtrace if the engine crashes (the \fBgdb\fR
package must be installed)
.SH EXAMPLES
These are all engine dependent.
.TP
......
......@@ -46,6 +46,17 @@ Select a non-default Quake II engine binary
.B \-\-demo
Use the demo data, even if you have both the demo and the full version
installed
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Disable all console output
.TP
\fB\-\-debugger=\fIDEBUGGER\fR
Prepend a debugger or other prefix (such as \fBstrace\fR) to the engine
command line
.TP
\fB\-\-print\-backtrace\fR
Use \fBgdb\fR(1) to get a backtrace if the engine crashes (the \fBgdb\fR
package must be installed)
.SH EXAMPLES
Play the demo in cooperative mode:
.B quake2 --demo +map demo1 +set coop 1
......
......@@ -7,6 +7,7 @@ quake3 \- Quake III Arena client
.B quake3
.BR "" [ \-h | \-\-help ]
.BR "" [ \-q | \-\-quiet ]
.IR "" [ "debugging options" ]
.BR "" [ +set
.IR option " " value ]...
......@@ -25,11 +26,19 @@ Disable all console output
.TP
\fB\-\-demo\fR
Run the demo version, even if the full game is installed
.TP
\fB\-\-debugger=\fIDEBUGGER\fR
Prepend a debugger or other prefix (such as \fBstrace\fR) to the engine
command line
.TP
\fB\-\-print\-backtrace\fR
Use \fBgdb\fR(1) to get a backtrace if the engine crashes (the \fBgdb\fR
package must be installed)
.PP
Additionally, if \fBquake3\fR is run via a symbolic link whose name
contains \fBteam-arena\fR or \fBteamarena\fR, it will play the expansion pack,
is \fBquake3-team-arena\fR, it will play the expansion pack,
\fBQuake III Team Arena\fR. This requires that additional data files are
installed. Similarly, a symbolic link containing \fBdemo\fR is equivalent
installed. Similarly, a symbolic link named \fBquake3-demo\fR is equivalent
to the \fB\-\-demo\fR option.
.PP
Any console command can also be prefixed with \fB+\fR and used as a
......@@ -108,18 +117,6 @@ Configuration and state for Quake III Arena
\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
as \fBstrace\fR; overridden by \fBQUAKE3_BACKTRACE\fR
.TP
\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 ioquake3 (6)
......
......@@ -4,8 +4,11 @@
quake4 \- Quake 4 client
.SH SYNOPSIS
.B quake3
.B quake4
.BR "" [ \-h | \-\-help ]
.BR "" [ \-\-quiet ]
.BR "" [ \-\-smp ]
.IR "" [ "debugging options" ]
.BR "" [ +set
.IR option " " value ]...
......@@ -19,11 +22,22 @@ The wrapper script used for Quake 4 in Debian accepts these options:
\fB\-h\fR, \fB\-\-help\fR
Display a short help summary
.TP
\fB\-\-quiet\fR
Suppress console output
.TP
\fB\-\-smp\fR
Use the multi-threaded version of the client and the modified
copy of SDL that is bundled with it. The default is to use the
single-threaded client and the system copy of SDL. Both versions
are included in the quake4-bin package.
.TP
\fB\-\-debugger=\fIDEBUGGER\fR
Prepend a debugger or other prefix (such as \fBstrace\fR) to the engine
command line
.TP
\fB\-\-print\-backtrace\fR
Use \fBgdb\fR(1) to get a backtrace if the engine crashes (the \fBgdb\fR
package must be installed)
.PP
Any console command can also be prefixed with \fB+\fR and used as a
command-line option (press Ctrl+Alt and the key above Tab to access the
......@@ -34,18 +48,6 @@ in-game console).
\fI~/.quake4\fR
Configuration and state for Quake 4
.SH ENVIRONMENT
The wrapper script used to launch Quake 4 allows it to be debugged
by setting environment variables.
.TP
\fBQUAKE4_DEBUGGER=\fIcommand\fR
A debugger or other prefix to prepend to the Quake 4 command line, such
as \fBstrace\fR; overridden by \fBQUAKE4_BACKTRACE\fR
.TP
\fBQUAKE4_BACKTRACE=1\fR
Use \fBgdb\fR(1) to get a backtrace if Quake 4 crashes (the \fBgdb\fR
package must be installed)
.SH AUTHOR
Quake 4 was written by id Software and originally published by Activision.
It is proprietary software.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment