From 43f160000c540b129733cbea11a492d2598758e6 Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Sun, 27 Sep 2009 00:08:19 +0000
Subject: Add documentation for OPL_DRIVER environment variable.

Subversion-branch: /branches/opl-branch
Subversion-revision: 1693
---
 man/manpage.template | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'man/manpage.template')

diff --git a/man/manpage.template b/man/manpage.template
index 052ccb63..41f06dc0 100644
--- a/man/manpage.template
+++ b/man/manpage.template
@@ -28,6 +28,17 @@ 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).
+.TP
+\fBOPL_DRIVER\fR
+When using OPL MIDI playback, this environment variable specifies an
+OPL backend driver to use.  Valid options are "SDL" for an SDL-based
+software emulated OPL chip, "Linux" for the Linux hardware OPL driver,
+and "OpenBSD" for the OpenBSD/NetBSD hardware OPL driver.
+
+Generally speaking, a real hardware OPL chip sounds better than software
+emulation; however, modern machines do not often include one.  If
+present, it may still require extra work to set up and elevated
+security privileges to access.
 .SH FILES
 .TP
 \fB$HOME/.chocolate-doom/default.cfg\fR
-- 
cgit v1.2.3