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