shithub: choc

Download patch

ref: f5040263b6a50961e12e64aa2e19fde049dd48c2
parent: 2b733d6a90586187c7b7fe0bc184af182620c2d8
author: Simon Howard <[email protected]>
date: Sat Dec 29 23:51:56 EST 2007

Add environment variable section to manpage.

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

--- 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 @@
 
 endif
 
-EXTRA_DIST = $(man_MANS) $(MANPAGE_GEN_FILES) 
+EXTRA_DIST = $(man_MANS) $(MANPAGE_GEN_FILES)        \
+	     wikipages
 
--- a/man/docgen
+++ b/man/docgen
@@ -326,6 +326,7 @@
         if c != None:
             print categories[c].manpage_output()
 
+    print_file_contents("environment")
     print_file_contents("footer")
 
 def wiki_output(dir):
--- /dev/null
+++ b/man/environment
@@ -1,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).
+