Add manpage

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 360

5 files changed, 77 insertions, 0 deletions

diff --git a/man/Makefile b/man/Makefile
new file mode 100644
index 00000000..eb6ec29f
--- /dev/null
+++ b/man/Makefile
@@ -0,0 +1,8 @@
+
+chocolate-doom.6: chocolate-doom-options.in head foot Makefile doom-options.in
+	cp head $@
+	echo .SH DOOM OPTIONS >> $@
+	awk -F"\t" '{print ".TP\n\\fB"$$1"\\fR"; $$1=""; print }' < doom-options.in >>$@
+	echo .SH CHOCOLATE\\-DOOM OPTIONS >> $@
+	awk -F"\t" '{print ".TP\n\\fB"$$1"\\fR"; $$1=""; print }' < chocolate-doom-options.in >>$@
+	m4 -DAUTHORS="`cat ../AUTHORS`" foot >> $@
diff --git a/man/chocolate-doom-options.in b/man/chocolate-doom-options.in
new file mode 100644
index 00000000..2d2cc23a
--- /dev/null
+++ b/man/chocolate-doom-options.in
@@ -0,0 +1,14 @@
+-1	Sets screenmultiply to 1
+-2	Sets screenmultiply to 2, doubling up the screen by 2x.
+-extraconfig <file>	Specifies a configuration file to use for Chocolate Doom-specific settings. The default is 'chocolate-doom.cfg'
+-fullscreen	Runs the game fullscreen. 
+-nofullscreen	Runs the game in a window
+-window	runs the game in a window
+-gameversion <ver>	Emulates a specific release of Doom 1.9.  Valid values are "1.9", "ultimate" and "final".
+-grabmouse	Grabs the mouse during play
+-nograbmouse	Does not grab the mouse during play
+-iwad <file>	Specifies an IWAD file to use. If unspecified, chocolate doom will look for doom2.wad, doom.wad, tnt.wad, plutonia.wad, in /usr/share/games/doom, and the current directory.
+-longtics	When recording demos, records in the the modified "Doom v1.91" format to avoid losing turning resolution.
+-merge <file>	Loads a PWAD but simulates merging it into the main IWAD
+-novert	Turns on novert
+-nonovert	Turns off novert
diff --git a/man/doom-options.in b/man/doom-options.in
new file mode 100644
index 00000000..eee117fe
--- /dev/null
+++ b/man/doom-options.in
@@ -0,0 +1,30 @@
+-deathmatch	start a deathmatch game
+-altdeath	start a deathmatch game (alternative mode)
+-timer x	exit a deathmatch level after x minutes
+-avg	austin virtual gaming (same as -timer 20)
+-cdrom	use C:\DOOMDATA for configuration data
+-config x	use x as the configuration file
+-devparm	developer mode: F1 saves a PCX screenshot in the current working directory
+-dup	put two network commands in each network packet
+-episode e	start playing on episode e (from 1-4)
+-extratic	send two packets per tic for network redundancy
+-fast	monsters move faster
+-file f...	add the PWADs f...
+-loadgame s	load the save in slot s
+-maxdemo x	set the maximum byte size of the recorded demo
+-nodes	define the number of players in a network game
+# <not implemented yet> -nodraw	no drawing of the screen is performed
+-nomonsters	disable all monsters
+-respawn	monsters respawn after being killed
+-nomusic	disable music
+-nosfx	disable sound effects
+-nosound	equivalent to -nomusic -nosfx
+-playdemo x	play demo from file x.lmp
+-record	record a demo to file x.lmp
+-recordfrom x y	start recording y.lmp from save slot x
+-skill x 	set the game skill (0-5; 5 being hardest)
+-statcopy x	register a stats driver at memory location x
+-timedemo x	play x.lmp at double speed and display the redraw count
+-warp [x y|zz]	start the game at level ExMy or MAPyy
+-wart x y	load PWAD ExMy.WAD and warp to level ExMy
+-turbo x	multiple player speed by x%. If unspecified, x defaults to 200. Values are rounded up to 10 and down to 400.
diff --git a/man/foot b/man/foot
new file mode 100644
index 00000000..cdd5b79e
--- /dev/null
+++ b/man/foot
@@ -0,0 +1,7 @@
+.\" this section from foot
+.SH AUTHOR
+chocolate\-doom is written and maintained by
+AUTHORS.
+The manpage was written by Jon Dowland <jon@alcopop.org>.
+.SH COPYRIGHT
+Copyright \(co 2006 Simon Howard.
diff --git a/man/head b/man/head
new file mode 100644
index 00000000..11aac8e0
--- /dev/null
+++ b/man/head
@@ -0,0 +1,18 @@
+.\" this section from head
+.TH chocolate\-doom 6
+.SH NAME
+chocolate\-doom \- historically compatible doom engine
+.SH SYNOPSIS
+.B chocolate\-doom
+[\fIDOOM OPTIONS\fR]
+[\fICHOCOLATE\-DOOM OPTIONS\fR]
+.SH DESCRIPTION
+.PP
+chocolate\-doom is a modern doom engine designed to behave
+as similar to the original doom game as is possible.
+.br
+Command-line arguments are divided up into \fBDOOM
+OPTIONS\fR, a subset of the original doom's command line
+arguments, and \fBCHOCOLATE\-DOOM OPTIONS\fR which are
+specific to this engine.
+.\" this section generated from vanilla-doom-options.in