summaryrefslogtreecommitdiff
path: root/man/manpage.template
diff options
context:
space:
mode:
authorSimon Howard2008-02-25 23:50:07 +0000
committerSimon Howard2008-02-25 23:50:07 +0000
commit3951c995ebb761de6bfc2f852c5a81eb51ba42f5 (patch)
tree08f80b8e4e20cc348c51acce40c503c0396faed7 /man/manpage.template
parent7329c58b0d10b2705594b35ae000301c80e29eb7 (diff)
downloadchocolate-doom-3951c995ebb761de6bfc2f852c5a81eb51ba42f5.tar.gz
chocolate-doom-3951c995ebb761de6bfc2f852c5a81eb51ba42f5.tar.bz2
chocolate-doom-3951c995ebb761de6bfc2f852c5a81eb51ba42f5.zip
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
Diffstat (limited to 'man/manpage.template')
-rw-r--r--man/manpage.template38
1 files changed, 38 insertions, 0 deletions
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.
+