From 3951c995ebb761de6bfc2f852c5a81eb51ba42f5 Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Mon, 25 Feb 2008 23:50:07 +0000
Subject: Replace manpage header, footer, environment files with a single
 template file. Generate documentation for the default.cfg and
 chocolate-doom.cfg configuration files.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1091
---
 man/manpage.template | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 man/manpage.template

(limited to 'man/manpage.template')

diff --git a/man/manpage.template b/man/manpage.template
new file mode 100644
index 00000000..e2df2b57
--- /dev/null
+++ b/man/manpage.template
@@ -0,0 +1,38 @@
+.TH chocolate\-doom 6
+.SH NAME
+chocolate\-doom \- historically compatible doom engine
+.SH SYNOPSIS
+.B chocolate\-doom
+[\fIOPTIONS\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
+
+@content
+
+.SH ENVIRONMENT
+This section describes environment variables that control Chocolate Doom's
+behavior.
+.TP 
+\fBDOOMWADDIR\fR, \fBDOOMWADPATH\fR
+These environment variables provide paths to search for Doom .WAD files when
+looking for a game IWAD file or a PWAD file specified with the '-file' option.
+\fBDOOMWADDIR\fR specifies a single path in which to look for WAD files,
+while \fBDOOMWWADDIR\fR specifies a colon-separated list of paths to search.
+.TP
+\fBPCSOUND_DRIVER\fR
+When running in PC speaker sound effect mode, this environment variable 
+specifies a PC speaker driver to use for sound effect playback.  Valid
+options are "Linux" for the Linux console mode driver, "BSD" for the
+NetBSD/OpenBSD PC speaker driver, and "SDL" for SDL-based emulated PC speaker 
+playback (using the digital output).
+
+.SH AUTHOR
+Chocolate Doom is written and maintained by Simon Howard.  It is based on
+the LinuxDoom source code, released by Id Software.
+.SH COPYRIGHT
+Copyright \(co id Software Inc.
+Copyright \(co 2005-8 Simon Howard.
+
-- 
cgit v1.2.3