summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorSimon Howard2008-01-24 19:14:44 +0000
committerSimon Howard2008-01-24 19:14:44 +0000
commit4896a1718949ecba43d83925f631ff808aa9b384 (patch)
tree976a5852386370e14434577c26d583cff3a94969 /man
parent7cd5bca900bccbab5ed785dabc595c073abb2c39 (diff)
downloadchocolate-doom-4896a1718949ecba43d83925f631ff808aa9b384.tar.gz
chocolate-doom-4896a1718949ecba43d83925f631ff808aa9b384.tar.bz2
chocolate-doom-4896a1718949ecba43d83925f631ff808aa9b384.zip
Add manpages for chocolate-setup, chocolate-server, based on the
versions by Jon Dowland for the Chocolate Doom debian package (thanks!) Subversion-branch: /trunk/chocolate-doom Subversion-revision: 1016
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am2
-rw-r--r--man/chocolate-server.634
-rw-r--r--man/chocolate-setup.633
3 files changed, 68 insertions, 1 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 8ad93995..9d38c92c 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -3,7 +3,7 @@ MANPAGE_GEN_FILES=header footer environment docgen
if HAVE_PYTHON
-man_MANS=chocolate-doom.6
+man_MANS=chocolate-doom.6 chocolate-server.6 chocolate-setup.6
chocolate-doom.6: ../src $(MANPAGE_GEN_FILES)
./docgen -m ../src > $@
diff --git a/man/chocolate-server.6 b/man/chocolate-server.6
new file mode 100644
index 00000000..e341fc25
--- /dev/null
+++ b/man/chocolate-server.6
@@ -0,0 +1,34 @@
+.TH chocolate\-server 6
+.SH NAME
+chocolate\-server \- dedicated server for chocolate\-doom
+.SH SYNOPSIS
+.B chocolate\-server
+[OPTIONS]
+.SH DESCRIPTION
+.PP
+Chocolate Doom is a modern doom engine designed to behave
+as similar to the original doom game as is possible.
+.PP
+.B chocolate\-server
+is a dedicated server for Chocolate Doom. It is equivalent to
+running
+.B chocolate\-doom
+with the "-dedicated" option.
+.PP
+Game options are not specified to the server, which merely acts to
+retransmit data between players in the game; parameters for the
+game should be specified by the first player to connect to the server,
+who is designated the controlling player.
+.br
+.SH OPTIONS
+.TP
+\fB-port <n>\fR
+Use the specified UDP port for communications, instead of the default (2342).
+.SH AUTHOR
+Chocolate Doom is written and maintained by Simon Howard.
+.PP
+This manual was written by Jon Dowland.
+.SH COPYRIGHT
+Copyright \(co id Software Inc.
+Copyright \(co 2005-7 Simon Howard.
+
diff --git a/man/chocolate-setup.6 b/man/chocolate-setup.6
new file mode 100644
index 00000000..ae8d4c81
--- /dev/null
+++ b/man/chocolate-setup.6
@@ -0,0 +1,33 @@
+.TH chocolate\-setup 6
+.SH NAME
+chocolate\-setup \- configuration tool for chocolate\-doom
+.SH SYNOPSIS
+.B chocolate\-setup
+[OPTIONS]
+.SH DESCRIPTION
+.PP
+Chocolate Doom is a modern Doom engine designed to behave
+as similar to the original Doom game as is possible.
+.PP
+.B chocolate\-setup
+is a tool for configuring Chocolate Doom. It provides a menu\-based
+interface for the display, joystick, keyboard, mouse, sound and
+compatibility settings.
+.PP
+.B chocolate\-setup
+can also be used to start and join network games.
+.PP
+.SH OPTIONS
+.TP
+\fB-config <file>\fR
+Load configuration from the specified file, instead of default.cfg.
+.TP
+\fB-extraconfig <file>\fR
+Load extra configuration from the specified file, instead of chocolate-doom.cfg.
+.SH AUTHOR
+Chocolate Doom is written and maintained by Simon Howard.
+.PP
+This manual was written by Jon Dowland.
+.SH COPYRIGHT
+Copyright \(co id Software Inc.
+Copyright \(co 2005-7 Simon Howard.