Use less ambiguous config file names

1 files changed, 82 insertions, 0 deletions

diff --git a/alsoftrc.sample b/alsoftrc.sample
new file mode 100644
index 00000000..78abb924
--- /dev/null
+++ b/alsoftrc.sample
@@ -0,0 +1,82 @@
+# OpenAL config file. Options that are not under a block or are under the
+# [general] block are for general, non-backend-specific options. Blocks may
+# appear multiple times, and duplicated options will take the last value
+# specified.
+# The system-wide settings can be put in /etc/openal/alsoft.conf and user-
+# specific override settings in ~/.alsoftrc.
+
+# Option and block names are case-insenstive. The supplied values are only
+# hints and may not be honored (though generally it'll try to get as close as
+# possible). These are the current available settings:
+
+format = AL_FORMAT_STEREO16  # Sets the output format. Can be one of:
+                             # AL_FORMAT_MONO8    (8-bit mono)
+                             # AL_FORMAT_STEREO8  (8-bit stereo)
+                             # AL_FORMAT_QUAD8    (8-bit 4-channel)
+                             # AL_FORMAT_51CHN8   (8-bit 5.1 output)
+                             # AL_FORMAT_61CHN8   (8-bit 6.1 output)
+                             # AL_FORMAT_71CHN8   (8-bit 7.1 output)
+                             # AL_FORMAT_MONO16   (16-bit mono)
+                             # AL_FORMAT_STEREO16 (16-bit stereo)
+                             # AL_FORMAT_QUAD16   (16-bit 4-channel)
+                             # AL_FORMAT_51CHN16  (16-bit 5.1 output)
+                             # AL_FORMAT_61CHN16  (16-bit 6.1 output)
+                             # AL_FORMAT_71CHN16  (16-bit 7.1 output)
+                             # Default is AL_FORMAT_STEREO16
+
+cf_level = 0  # Sets the crossfeed level for stereo output. Valid values are:
+              # 0 - No crossfeed
+              # 1 - Low crossfeed
+              # 2 - Middle crossfeed
+              # 3 - High crossfeed (virtual speakers are closer to itself)
+              # 4 - Low easy crossfeed
+              # 5 - Middle easy crossfeed
+              # 6 - High easy crossfeed
+              # Default is 0. Users of headphones may want to try various
+              # settings. Has no effect on non-stereo modes.
+
+frequency = 44100  # Sets the output frequency. Default is 44100
+
+refresh = 8192  # Sets the buffer size, in frames. Default is 8192. Note that
+                # the actual granularity may or may not be less than this.
+
+drivers =  # Sets the backend driver list order, comma-seperated. Unknown
+           # backends and duplicated names are ignored, and unlisted backends
+           # won't be considered for use. An empty list means the default.
+           # Default is:
+           # alsa,oss,dsound,winmm,wave
+
+[alsa]  # ALSA backend stuff
+device = default  # Sets the device name for the default playback device.
+                  # Default is default
+
+periods = 0  # Sets the number of update buffers for playback. A value of 0
+             # means auto-select. Default is 0
+
+capture = default  # Sets the device name for the default capture device.
+                   # Default is default
+
+mmap = true  # Sets whether to try using mmap mode (helps reduce latencies and
+             # CPU consumption). If mmap isn't available, it will automatically
+             # fall back to non-mmap mode. True, yes, on, and non-0 values will
+             # attempt to use mmap. 0 and anything else will force mmap off.
+             # Default is true.
+
+[oss]  # OSS backend stuff
+device = /dev/dsp  # Sets the device name for OSS output. Default is /dev/dsp
+
+periods = 4  # Sets the number of update buffers. Default is 4
+
+capture = /dev/dsp  # Sets the device name for OSS capture. Default is /dev/dsp
+
+[dsound]  # DirectSound backend stuff
+          # Nothing yet...
+
+[winmm]  # Windows Multimedia backend stuff
+         # Nothing yet...
+
+[wave]  # Wave File Writer stuff
+file =  # Sets the filename of the wave file to write to. An empty name
+        # prevents the backend from opening, even when explicitly requested.
+        # THIS WILL OVERWRITE EXISTING FILES WITHOUT QUESTION!
+        # Default is empty