Document line selector color config file settings (FS#8880 by Justin Hannigan).
[Rockbox.git] / manual / appendix / config_file_options.tex
blob3f2f8f0ad77e5b93d8bff31ff8143b0cf91794fb
1 % $Id$ %
2 \chapter{\label{ref:config_file_options}Config file options}
3 \begin{center}
4 % define a local version of endhead, as using the output distinction adds
5 % an unwanted newline. endhead breaks with htlatex so we need to remove it
6 % for the html output.
7 \ifpdfoutput{\newcommand{\localendhead}{\endhead}}%
8 {\newcommand{\localendhead}{}}
9 \begin{longtable}{@{}>{\raggedright}p{.35\textwidth}@{}>{\raggedright}p{.4\textwidth}@{}p{.25\textwidth}@{}}
10 \toprule
11 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
12 \midrule\localendhead % endhead breaks with htlatex
13 volume & \opt{player}{-78 to +18}%
14 \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}%
15 \opt{h1xx,h300}{-84 to 0}%
16 \opt{ipodnano}{-72 to +6}%
17 \opt{ipodvideo}{-57 to +6}%
18 \opt{x5}{-73 to +6}
19 \opt{ipodcolor}{-\fixme{??} to +\fixme{??}}%
20 & dB\\
21 \nopt{x5}{%
22 bass & \opt{MASCODEC}{-15 to +15}%
23 \opt{h1xx,h300}{0 to +24}%
24 \opt{ipod}{-6 to +9}%
25 & dB\\
26 treble & \opt{MASCODEC}{-15 to +15}%
27 \opt{h1xx,h300}{0 to +6}%
28 \opt{ipod}{-6 to +9}%
29 & dB\\
31 balance & -100 to +100 & \%\\
32 channels & stereo, mono, custom, mono left, mono right, karaoke
33 & N/A\\
34 shuffle & on, off & N/A\\
35 repeat & off, all, one, shuffle, ab
36 & N/A\\
37 play selected & on, off & N/A\\
38 resume & on, off & N/A\\
39 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60
40 & seconds\\
41 scan accel & 0 to 15 & seconds\\
42 antiskip & 0 to 7 & seconds\\
43 volume fade & on, off & N/A\\
44 id3 tag priority & v2-v1, v1-v2 & N/A\\
45 sort case & on, off & N/A\\
46 show files & all, supported, music, playlists
47 & N/A\\
48 follow playlist & on, off & N/A\\
49 playlist viewer icons
50 & on, off & N/A\\
51 playlist viewer indices
52 & on, off & N/A\\
53 playlist viewer track display
54 & track name,full path
55 & N/A\\
56 recursive directory insert
57 & on, off & N/A\\
58 scroll speed & 1 to 25 & Hz\\
59 scroll delay & 0 to 250 & 1/10s\\
60 scroll step & 1 to 112 & pixels\\
61 bidir limit & 0 to 200 & \% screen\\
62 contrast & 0 to 63 & N/A\\
63 backlight timeout
64 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
65 45, 60, 90 & seconds\\
66 backlight timeout plugged
67 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
68 45, 60, 90 & seconds\\
69 disk spindown & 3 to 254 & seconds\\
70 battery capacity
71 & 1500 - 3200 & mAh\\
72 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
73 & minutes\\
74 lang & /path/filename.lng & N/A\\
75 wps & /path/filename.wps & N/A\\
76 autocreate bookmarks
77 & off, on & N/A\\
78 autoload bookmarks
79 & off, on & N/A\\
80 use most-recent-bookmarks
81 & off, on & N/A\\
82 talk dir & off, number, spell, enter, hover
83 & N/A\\
84 talk file & off, number, spell& N/A\\
85 talk menu & off, on & N/A\\
86 tagcache\_autoupdate
87 & on, off & N/A\\
88 warn when erasing dynamic playlist
89 & on, off & N/A\\
90 cuesheet support
91 & on, off & N/A\\
93 \opt{swcodec}{
94 replaygain & on, off & N/A\\
95 replaygain type
96 & track, album, track shuffle
97 & N/A\\
98 replaygain noclip
99 & on, off & N/A\\
100 replaygain preamp
101 & -120 to 120 & 0.1dB\\
103 crossfade & off, shuffle, track skip, always
104 & N/A\\
105 crossfade fade in delay
106 & 0 to 7 & seconds\\
107 crossfade fade out delay
108 & 0 to 7 & seconds\\
109 crossfade fade in duration
110 & 0 to 15 & seconds\\
111 crossfade fade out duration
112 & 0 to 15 & seconds\\
113 crossfade fade out mode
114 & crossfade, mix & N/A\\
116 crossfeed & on, off & N/A\\
117 crossfeed direct gain
118 & 0 to 60 & 0.1dB\\
119 crossfeed cross gain
120 & 30 to 120 & 0.1dB\\
121 crossfeed hf attenuation
122 & 60 to 240 & 0.1dB\\
123 crossfeed hf cutoff
124 & 500 to 2000 & Hz\\
126 eq enabled & on, off & N/A\\
127 eq precut & 0 to 240 & 0.1dB\\
128 eq band 0 cutoff & 0 to 32768 & Hz\\
129 eq band 1 cutoff & 0 to 32768 & Hz\\
130 eq band 2 cutoff & 0 to 32768 & Hz\\
131 eq band 3 cutoff & 0 to 32768 & Hz\\
132 eq band 4 cutoff & 0 to 32768 & Hz\\
133 eq band 0 q & 0 to 64 & N/A\\
134 eq band 1 q & 0 to 64 & N/A\\
135 eq band 2 q & 0 to 64 & N/A\\
136 eq band 3 q & 0 to 64 & N/A\\
137 eq band 4 q & 0 to 64 & N/A\\
138 eq band 0 gain & -240 to 240 & 0.1dB\\
139 eq band 1 gain & -240 to 240 & 0.1dB\\
140 eq band 2 gain & -240 to 240 & 0.1dB\\
141 eq band 3 gain & -240 to 240 & 0.1dB\\
142 eq band 4 gain & -240 to 240 & 0.1dB\\
144 beep & off, weak, moderate, strong
145 & N/A\\
146 dircache & on, off & N/A\\
147 tagcache\_ram & on, off & N/A\\
150 \opt{recorder,recorderv2fm}{
151 loudness & 0 to 17 & N/A\\
152 superbass & on, off & N/A\\
153 auto volume & off, 20ms, 2s, 4s, 8s
154 & seconds\\
155 mdb enable & on,off & N/A\\
156 mdb strength & 0 to 127 & dB\\
157 mdb harmonics & 0 to 100 & \%\\
158 mdb center & 20 to 300 & Hz\\
159 mdb shape & 50 to 300 & Hz\\
162 \opt{lcd_bitmap}{
163 peak meter release
164 & 1 to 126 & ?\\
165 peak meter hold
166 & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
167 15, 20, 30, 1min & N/A \\
168 peak meter clip hold
169 & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
170 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
171 & N/A \\
172 peak meter busy & on, off & N/A\\
173 peak meter dbfs & on, off & on:~dbfs, off:~linear\\
174 peak meter min & 0 to 89 (dB) or 0 to 100 (\%)
175 & dB or \%\\
176 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%)
177 & dB or \%\\
178 statusbar & on, off & N/A\\
179 scrollbar & on, off & N/A\\
180 volume display
181 & graphic, numeric & N/A\\
182 battery display
183 & graphic, numeric & N/A\\
184 font & /path/filename.fnt & N/A\\
185 invert & on, off & N/A\\
188 \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
189 % causes ondiosp not to build for mysterious reasons.
190 backdrop & /path/filename.bmp & N/A\\
193 \opt{lcd_color}{
194 foreground color & 000000 to FFFFFF & RRGGBB\\
195 background color & 000000 to FFFFFF & RRGGBB\\
196 line selector start color & 000000 to FFFFFF & RRGGBB\\
197 line selector end color & 000000 to FFFFFF & RRGGBB\\
200 \opt{HAVE_REMOTE_LCD}{
201 rwps & /path/filename.rwps & N/A\\
202 remote contrast
203 & 5 to 63 & N/A\\
204 remote invert
205 & on, off & N/A\\
206 remote flip display
207 & on, off & N/A\\
208 remote backlight timeout
209 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
210 30, 45, 60, 90 & seconds\\
211 remote backlight timeout plugged
212 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
213 30, 45, 60, 90 & seconds\\
214 remote caption backlight
215 & on, off & N/A\\
216 remote scroll speed
217 & 0 to 15 & N/A\\
218 remote scroll step
219 & 1 to 160 & N/A\\
220 remote scroll delay
221 & 0 to 250 & N/A\\
222 remote bidir limit
223 & 0 to 200 & N/A\\
224 backlight filters first remote keypress
225 & on, off & N/A\\
226 \opt{h1xx,h300}{
227 remote reduce ticking
228 & on, off & N/A\\
231 \opt{rtc}{
232 time format & 12hour, 24hour & N/A\\
234 \opt{recording}{
235 rec quality & 0 to 7 & 0: small size, 7: high quality\\
236 rec frequency
237 & 48, 44, 32, 24, 22, 16 & kHz\\
238 rec source & mic, line, spdif & N/A\\
239 rec channels & mono, stereo & N/A\\
240 rec mic gain & 0 to 15 & N/A\\
241 rec left gain & 0 to 15 & N/A\\
242 rec right gain
243 & 0 to 15 & N/A\\
244 editable recordings
245 & off,on & N/A\\
246 rec timesplit
247 & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00,
248 8:00, 16:00, 24:00 & h:mm\\
249 pre-recording time
250 & off, 1 to 30 & seconds\\
251 rec directory
252 & /recordings,current & N/A\\
254 \opt{radio}{
255 force fm mono
256 & off, on & N/A\\
258 \opt{player}{
259 jump scroll
260 & 0 to 5 & N/A\\
261 jump scroll delay
262 & 0 to 250 & 0.01s\\
265 \bottomrule
266 \end{longtable}
267 \end{center}