Gitiles
Code Review Sign In
gerrit.rockbox.org / rockbox / f40e366950ff8e54c34f2344a1a416371c7446bb / . / docs / CUSTOM_CFG_FORMAT
blob: 9ce9daafe77fc3372fad0655d36d18e02046c6fe [file] [log] [blame]
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]1Custom CFG File Format Specification
Justin Heiner94d3ba22002-09-06 06:20:15 +0000[diff] [blame]2
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]3General Info
4------------
5The .cfg file is used to load settings from a plain text file. A .cfg file may
6reside anywhere on the hard disk. The only restriction is that the filename
7must end in .cfg
Justin Heiner94d3ba22002-09-06 06:20:15 +0000[diff] [blame]8
9Format Rules
10------------
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]11* Format: setting: value
12* Each setting must be on a separate line.
Björn Stenberg0e6088f2002-10-02 16:33:26 +0000[diff] [blame]13* Lines starting with # are ignored.
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]14
15Settings (allowed values) [unit]
16--------------------------------
17volume (0 - 100)
18bass (-15 - 15)
19treble (-15 - 15)
20balance (-100 - 100)
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]21channels (stereo, mono, mono left, mono right)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]22
23shuffle (on, off)
24repeat (off, all, one)
25play selected (on, off)
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]26resume (off, ask, ask once, on)
27scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60) [seconds]
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]28scan accel (0 - 15) [double scan speed every X seconds]
29antiskip (0 - 7) [seconds]
Björn Stenberge2628d92003-02-14 15:54:52 +0000[diff] [blame]30volume fade (on, off)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]31
32sort case (on, off)
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]33show files (all, supported, music, playlists)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]34follow playlist (on, off)
35
36scroll speed (1 - 10) [Hz]
Björn Stenbergf40e3662003-02-25 19:12:14 +0000[diff] [blame^]37scroll delay (0 - 250) [1/10s]
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]38scroll step (1 - 112) [pixels]
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]39bidir limit (0 - 200) [% of screen width]
40contrast (0 - 63)
41backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
Björn Stenbergf40e3662003-02-25 19:12:14 +0000[diff] [blame^]42 15, 20, 25, 30, 45, 60, 90) [seconds]
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]43backlight when plugged (on, off)
44
45disk spindown (3 - 254) [seconds]
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]46battery capacity (1500 - 2400) [mAh]
47idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9,
48 10, 15, 30, 45, 60) [minutes]
49
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]50lang (/path/filename.lng)
51wps (/path/filename.wps)
52
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]53Recorder-specific settings (allowed values) [unit]
54---------------------------------------------------
55loudness (0 - 17)
56bass boost (0 - 100)
57auto volume (0=off, 1=2s, 2=4s, 3=8s)
58
59peak meter release (1 - 126)
60peak meter hold (off, 200ms, 300ms, 500ms,
61 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
Björn Stenbergf40e3662003-02-25 19:12:14 +0000[diff] [blame^]62 15, 20, 30, 1min)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]63peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
64 15, 20, 25, 30, 45, 60, 90,
65 2min, 3min, 5min, 10min, 20min, 45min, 90min)
66peak meter busy (on, off)
67peak meter dbfs (on, off) (on = dbfs, off = linear)
68peak meter min (0 - 89) [dB] or (0 - 100) [%]
69peak meter max (0 - 89) [dB] or (0 - 100) [%]
70
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]71statusbar (on, off)
72scrollbar (on, off)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]73volume display (graphic, numeric)
74battery display (graphic, numeric)
75time format (12hour, 24hour)
Björn Stenberg3ab82d32003-02-17 15:02:57 +0000[diff] [blame]76font (/path/filename.fnt)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]77
78deep discharge (on, off)
79trickle charge (on, off)
Björn Stenbergbda4ec12003-02-17 09:53:11 +0000[diff] [blame]80disk poweroff (on, off)
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]81
82rec quality (0 - 7) (0=smallest size, 7=highest quality)
83rec frequency (48, 44, 32, 24, 22, 16) [kHz]
84rec source (mic, line, spdif)
85rec channels (mono, stereo)
86rec mic gain (0 to 15)
87rec left gain (0 to 15)
88rec right gain (0 to 15)
89
Justin Heiner94d3ba22002-09-06 06:20:15 +0000[diff] [blame]90
91Example File
92------------
Björn Stenberg0e6088f2002-10-02 16:33:26 +0000[diff] [blame]93volume: 70
94bass: 11
95treble: 12
96balance: 0
Björn Stenberg9c16e122003-02-14 14:14:55 +0000[diff] [blame]97time format: 12hour
98volume display: numeric
99show files: supported
Björn Stenberg73470252003-02-17 09:57:00 +0000[diff] [blame]100wps: /.rockbox/car.wps
101lang: /.rockbox/afrikaans.lng
Justin Heiner94d3ba22002-09-06 06:20:15 +0000[diff] [blame]102