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