summaryrefslogtreecommitdiffstats
path: root/docs/CUSTOM_CFG_FORMAT
diff options
context:
space:
mode:
authorBjörn Stenberg <bjorn@haxx.se>2002-10-10 14:05:34 +0000
committerBjörn Stenberg <bjorn@haxx.se>2002-10-10 14:05:34 +0000
commitdcfc20f7e7c7f6266042a241177d7abc5000163d (patch)
tree89418c327f95e8ef88f08dd614416e90ae82a46a /docs/CUSTOM_CFG_FORMAT
parenta0bf4f1744547338ccc36ac66b3e1d4e906030f7 (diff)
downloadrockbox-dcfc20f7e7c7f6266042a241177d7abc5000163d.tar.gz
rockbox-dcfc20f7e7c7f6266042a241177d7abc5000163d.tar.bz2
rockbox-dcfc20f7e7c7f6266042a241177d7abc5000163d.zip
Renamed CUSTOM_EQ_FORMAT to CUSTOM_CFG_FORMAT
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@2561 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'docs/CUSTOM_CFG_FORMAT')
-rw-r--r--docs/CUSTOM_CFG_FORMAT45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/CUSTOM_CFG_FORMAT b/docs/CUSTOM_CFG_FORMAT
new file mode 100644
index 0000000000..87bc18162a
--- /dev/null
+++ b/docs/CUSTOM_CFG_FORMAT
@@ -0,0 +1,45 @@
+Custom CFG
+File Format Specifications
+
+Description / General Info
+--------------------------
+* The .cfg file is used on both the Rockbox Player and Recorder, in order to
+ load custom settings.
+* Currently, only sound settings are supported but this will change in the
+ future.
+
+File Location
+-------------
+The files may reside anywhere on the hard disk. The only restriction is that
+the filename must end in .cfg
+
+Format Rules
+------------
+* Each setting must have it's own line.
+* Lines starting with # are ignored.
+* If a value is out of the acceptable range for the device, which can vary
+ depending on the model, the value will be set to its default value.
+
+Example File
+------------
+volume: 70
+bass: 11
+treble: 12
+balance: 0
+channels: 0
+loudness: 5
+bass boost: 30
+auto volume: 0
+
+This sets each line to the respective values after it.
+
+Value ranges
+------------
+volume: 0 to 100
+bass: player: -15 to 15, recorder: -12 to 12
+treble: player: -15 to 15, recorder: -12 to 12
+balance: -100 to 100
+channels: 0=Stereo, 1=Mono, 2=Mono Left, 3=Mono Right
+loudness: 0 to 17 (recorder only)
+bass boost: 0 to 100 (recorder only)
+auto volume: 0=off, 1=2s, 2=4s, 3=8s (recorder only)