commit f5040263b6a50961e12e64aa2e19fde049dd48c2
Author: Simon Howard <fraggle@gmail.com>
AuthorDate: Sun Dec 30 04:51:56 2007 +0000
Commit: Simon Howard <fraggle@gmail.com>
CommitDate: Sun Dec 30 04:51:56 2007 +0000
Add environment variable section to manpage.
Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 996
---
man/Makefile.am | 5 +++--
man/docgen | 1 +
man/environment | 17 +++++++++++++++++
3 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/man/Makefile.am b/man/Makefile.am
index d6cbb89c..8ad93995 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,5 +1,5 @@
-MANPAGE_GEN_FILES=header footer docgen
+MANPAGE_GEN_FILES=header footer environment docgen
if HAVE_PYTHON
@@ -10,5 +10,6 @@ chocolate-doom.6: ../src $(MANPAGE_GEN_FILES)
endif
-EXTRA_DIST = $(man_MANS) $(MANPAGE_GEN_FILES)
+EXTRA_DIST = $(man_MANS) $(MANPAGE_GEN_FILES) \
+ wikipages
diff --git a/man/docgen b/man/docgen
index 0319bbc7..8870c60c 100755
--- a/man/docgen
+++ b/man/docgen
@@ -326,6 +326,7 @@ def manpage_output(dir):
if c != None:
print categories[c].manpage_output()
+ print_file_contents("environment")
print_file_contents("footer")
def wiki_output(dir):
diff --git a/man/environment b/man/environment
new file mode 100644
index 00000000..47e3d8ed
--- /dev/null
+++ b/man/environment
@@ -0,0 +1,17 @@
+.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).
+