?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
test_X plugins PLA integration
[maemo-rb.git] / manual / appendix / config_file_options.tex
blob3db416ecfaee2c7881ca498d637340f979ff398b
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 \rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor}
10 \begin{longtable}{>{\raggedright}p{.3\textwidth}>{\raggedright}p{.4\textwidth}p{.2\textwidth}}
11 \toprule
12 \rowcolor{tblhdrbgcolor}\tblhdrstrut\textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
13 \midrule\localendhead % endhead breaks with htlatex
14 volume & \opt{masd}{-78 to +18}%
15 \opt{masf}{-100 -to +12}%
16 \opt{iriverh100,iriverh300}{-84 to 0}%
17 \opt{ipodnano}{-72 to +6}%
18 \opt{ipodvideo,cowond2}{-89 to +6}%
19 \opt{iaudiom3,iaudiom5,iaudiox5}{-73 to +6}
20 \opt{e200,e200v2,ipodcolor,vibe500,ipodnano2g}{-74 to +6}%
21 & dB\\
22 bass & \opt{masd}{-15 to +15}%
23 \opt{masf}{-12 to +12}%
24 \opt{iriverh100,iriverh300}{0 to +24}%
25 \opt{ipod}{-6 to +9}%
26 \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500}{%
27 -24 to +24}%
28 & dB\\
29 treble & \opt{masd}{-15 to +15}%
30 \opt{masf}{-12 to +12}%
31 \opt{iriverh100,iriverh300}{0 to +6}%
32 \opt{ipod}{-6 to +9}%
33 \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500}{%
34 -24 to +24}%
35 & dB\\
36 balance & -100 to +100 & \%\\
37 channels & stereo, mono, custom, mono left, mono right, karaoke
38 & N/A\\
39 stereo\_width & 0 to 250 & \%\\
40 shuffle & on, off & N/A\\
41 repeat & off, all, one, shuffle, ab
42 & N/A\\
43 play selected & on, off & N/A\\
44 party mode & on, off & N/A\\
45 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60
46 & s\\
47 seek acceleration & very fast, fast, normal, slow, very slow & N/A\\
48 antiskip & 5s, 15s, 30s, 1min, 2min, 3min, 5min, 10min & N/A\\
49 volume fade & on, off & N/A\\
50 sort case & on, off & N/A\\
51 show files & all, supported, music, playlists & N/A\\
52 show filename exts & off, on, unknown, view\_all & N/A\\
53 follow playlist & on, off & N/A\\
54 playlist viewer icons
55 & on, off & N/A\\
56 playlist viewer indices
57 & on, off & N/A\\
58 playlist viewer track display
59 & track name,full path
60 & N/A\\
61 recursive directory insert
62 & on, off, ask & N/A\\
63 scroll speed & 1 to 25 & Hz\\
64 scroll delay & 0 to 2500 & ms\\
65 scroll step & \fixme{devise a way to get ranges from config-*.h} & pixels\\
66 screen scroll step & \fixme{devise a way to get ranges from config-*.h} & pixels\\
67 Screen Scrolls Out Of View & on, off & N/A\\
68 bidir limit & 0 to 200 & \% screen\\
69 scroll paginated & on, off & N/A\\
70 hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\
71 \opt{lcd_bitmap}{
72 show path in browser & off, current directory, full path & N/A\\
73 }
74 contrast & 0 to 63 & N/A\\
75 backlight timeout
76 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
77 45, 60, 90, 120 & s\\
78 backlight timeout plugged
79 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
80 45, 60, 90, 120 & s\\
81 backlight filters first keypress & on, off & N/A\\
82 backlight on button hold & normal, off, on & N/A\\
83 caption backlight & on, off & N/A\\
84 brightness & \fixme{devise a way to get ranges from config-*.h} & N/A\\
85 disk spindown & 3 to 254 & s\\
86 battery capacity & \fixme{devise a way to get ranges from config-*.h} & mAh\\
87 \opt{battery_types}{
88 battery type & alkaline, nimh & N/A\\
89 }
90 \opt{HAVE_CAR_ADAPTER_MODE}{
91 car adapter mode & on, off & N/A\\
92 }
93 \opt{accessory_supply}{
94 accessory power supply & on, off & N/A\\
95 }
96 \opt{usb_hid}{
97 usb hid & on, off & N/A\\
98 usb keypad mode
99 & multimedia, presentation, browser\opt{usb_hid_mouse}{, mouse}& N/A\\
100 }
101 \opt{multidrive_usb}{
102 usb skip first drive & on, off & N/A\\
103 }
104
105 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
106 & min\\
107 sleeptimer duration & 5 to 300 (in steps of 5)
108 & min\\
109 sleeptimer on startup & off, on & N/A\\
110 keypress restarts sleeptimer & off, on & N/A\\
111 max files in playlist & 1000 - 32000 & N/A\\
112 max files in dir & 50 - 10000 & N/A\\
113 lang & /path/filename.lng & N/A\\
114 wps & /path/filename.wps & N/A\\
115 autocreate bookmarks
116 & off, on & N/A\\
117 autoload bookmarks
118 & off, on & N/A\\
119 use most-recent-bookmarks
120 & off, on & N/A\\
121 pause on headphone unplug & off, pause, pause and resume & N/A\\
122 rewind duration on pause & 0 to 15 & s\\
123 disable autoresume if phones not present & off, on & N/A\\
124 Last.fm Logging & off, on & N/A\\
125 talk dir & off, number, spell& N/A\\
126 talk dir clip & off, on & N/A\\
127 talk file & off, number, spell& N/A\\
128 talk file clip & off, on & N/A\\
129 talk filetype & off, on & N/A\\
130 talk menu & off, on & N/A\\
131 Announce Battery Level & off, on & N/A\\
132 \opt{hotkey}{
133 hotkey wps & off, view playlist, show track info,
134 pitchscreen, open with, delete & N/A\\
135 \nopt{touchscreen}{hotkey tree & off, open with, delete, insert,
136 insert shuffled & N/A\\}
137 }
138 sort files & alpha, oldest, newest, type & N/A\\
139 sort dirs & alpha, oldest, newest & N/A\\
140 sort interpret number & digits, numbers & N/A\\
141 tagcache\_autoupdate
142 & on, off & N/A\\
143 warn when erasing dynamic playlist
144 & on, off & N/A\\
145 cuesheet support
146 & on, off & N/A\\
147 folder navigation & off, on, random & N/A\\
148 gather runtime data & off, on & N/A\\
149 \opt{usb_charging_enable}{
150 usb charging & on, off, force & N/A\\
151 }
152 skip length & outro, track, 1s, 2s, 3s, 5s, 7s, 10s, 15s, 20s, 1min,
153 90s, 2min, 3min, 5min, 10min, 15min & N/A\\
154 prevent track skip
155 & on, off & N/A\\
156 start in screen & previous, root, files, dB, wps, menu,
157 \opt{recording}{recording, }
158 \opt{radio}{radio, }
159 bookmarks & N/A\\
160 playlist catalog directory & /path/to/dir & N/A\\
161 \nopt{wheel_acceleration}{
162 list\_accel\_start\_delay & 0 to 10 & ms\\
163 list\_accel\_wait & 1 to 10 & s\\
164 }
165 %
166 \opt{swcodec}{
167 replaygain type
168 & track, album, track shuffle, off
169 & N/A\\
170 replaygain noclip
171 & on, off & N/A\\
172 replaygain preamp
173 & -120 to 120 & 0.1~dB\\
174 %
175 \opt{crossfade}{
176 crossfade & off, auto track change, man track skip, shuffle,
177 shuffle or man track skip, always
178 & N/A\\
179 crossfade fade in delay
180 & 0 to 7 & s\\
181 crossfade fade out delay
182 & 0 to 7 & s\\
183 crossfade fade in duration
184 & 0 to 15 & s\\
185 crossfade fade out duration
186 & 0 to 15 & s\\
187 crossfade fade out mode
188 & crossfade, mix & N/A\\
189 }
190 %
191 crossfeed & on, off & N/A\\
192 crossfeed direct gain
193 & 0 to 60 & 0.1~dB\\
194 crossfeed cross gain
195 & 30 to 120 & 0.1~dB\\
196 crossfeed hf attenuation
197 & 60 to 240 & 0.1~dB\\
198 crossfeed hf cutoff
199 & 500 to 2000 & Hz\\
200 %
201 eq enabled & on, off & N/A\\
202 eq precut & 0 to 240 & 0.1~dB\\
203 eq band 0 cutoff & 0 to 32768 & Hz\\
204 eq band 1 cutoff & 0 to 32768 & Hz\\
205 eq band 2 cutoff & 0 to 32768 & Hz\\
206 eq band 3 cutoff & 0 to 32768 & Hz\\
207 eq band 4 cutoff & 0 to 32768 & Hz\\
208 eq band 0 q & 0 to 64 & N/A\\
209 eq band 1 q & 0 to 64 & N/A\\
210 eq band 2 q & 0 to 64 & N/A\\
211 eq band 3 q & 0 to 64 & N/A\\
212 eq band 4 q & 0 to 64 & N/A\\
213 eq band 0 gain & -240 to 240 & 0.1~dB\\
214 eq band 1 gain & -240 to 240 & 0.1~dB\\
215 eq band 2 gain & -240 to 240 & 0.1~dB\\
216 eq band 3 gain & -240 to 240 & 0.1~dB\\
217 eq band 4 gain & -240 to 240 & 0.1~dB\\
218 %
219 dithering enabled & on, off & N/A\\
220 %
221 timestretch enabled & on, off & N/A\\
222 %
223 compressor threshold & 0 to -24 & -3~dB\\
224 compressor makeup gain & off, auto & N/A\\
225 compressor ratio & 2:1, 4:1, 6:1, 10:1, limit
226 & N/A\\
227 compressor knee & hard knee, soft knee
228 & N/A\\
229 compressor release time & 100 to 1000 & 100~ms\\
230 %
231 beep & off, weak, moderate, strong & N/A\\
232 keyclick & off, weak, moderate, strong & N/A\\
233 keyclick repeats & on, off & N/A\\
234 dircache & on, off & N/A\\
235 tagcache\_ram & on, off & N/A\\
236 }%
237
238 \opt{masf}{
239 loudness & 0 to 17 & N/A\\
240 superbass & on, off & N/A\\
241 auto volume & off, 20ms, 2s, 4s, 8s
242 & N/A\\
243 mdb enable & on,off & N/A\\
244 mdb strength & 0 to 127 & dB\\
245 mdb harmonics & 0 to 100 & \%\\
246 mdb center & 20 to 300 & Hz\\
247 mdb shape & 50 to 300 & Hz\\
248 }%
249
250 \opt{lcd_bitmap}{
251 peak meter release
252 & 1 to 126 & ?\\
253 peak meter hold
254 & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
255 15, 20, 30, 1min & N/A \\
256 peak meter clip hold
257 & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
258 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
259 & N/A \\
260 peak meter busy & on, off & N/A\\
261 peak meter dbfs & on, off & on:~dbfs, off:~linear\\
262 peak meter min & 0 to 89 (dB) or 0 to 100 (\%)
263 & dB or \%\\
264 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%)
265 & dB or \%\\
266 statusbar & off, top, bottom & N/A\\
267 \opt{remote}{
268 remote statusbar & off, top, bottom & N/A\\
269 }
270 scrollbar & off, left, right & N/A\\
271 scrollbar width & 3 to LCD width / 10 (\fixme{devise a way
272 to get ranges from config-*.h})& pixels\\
273 volume display
274 & graphic, numeric & N/A\\
275 battery display
276 & graphic, numeric & N/A\\
277 font & /path/filename.fnt & N/A\\
278 kbd & /path/filename.kbd & N/A\\
279 \opt{lcd_invert}{
280 invert & on, off & N/A\\
281 }
282 \opt{lcd_flip}{
283 flip display & on, off & N/A\\
284 }
285 selector type & pointer, bar (inverse)
286 \opt{lcd_color}{, bar (color), bar (gradient)} & N/A\\
287 show icons & on, off & N/A\\
288 iconset & /path/filename.bmp & N/A\\
289 viewers iconset & /path/filename.bmp & N/A\\
290 }%
291
292 \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
293 % causes ondiosp not to build for mysterious reasons.
294 backdrop & /path/filename.bmp & N/A\\
295 }%
296
297 \opt{lcd_color}{
298 foreground colour & 000000 to FFFFFF & RRGGBB\\
299 background colour & 000000 to FFFFFF & RRGGBB\\
300 line selector start colour & 000000 to FFFFFF & RRGGBB\\
301 line selector end colour & 000000 to FFFFFF & RRGGBB\\
302 line selector text colour & 000000 to FFFFFF & RRGGBB\\
303 filetype colours & /path/filename.colours & N/A\\
304 }
305
306 \opt{HAVE_REMOTE_LCD}{
307 rwps & /path/filename.rwps & N/A\\
308 remote contrast
309 & 5 to 63 & N/A\\
310 remote invert
311 & on, off & N/A\\
312 remote flip display
313 & on, off & N/A\\
314 remote backlight timeout
315 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
316 30, 45, 60, 90 & s\\
317 remote backlight timeout plugged
318 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
319 30, 45, 60, 90 & s\\
320 remote caption backlight
321 & on, off & N/A\\
322 remote scroll speed
323 & 0 to 15 & N/A\\
324 remote scroll step
325 & 1 to 160 & N/A\\
326 remote scroll delay
327 & 0 to 2500 & ms\\
328 remote bidir limit
329 & 0 to 200 & N/A\\
330 backlight filters first remote keypress
331 & on, off & N/A\\
332 remote iconset & /path/filename.bmp & N/A\\
333 remote viewers iconset & /path/filename.bmp & N/A\\
334 \opt{iriverh100,iriverh300}{
335 remote reduce ticking
336 & on, off & N/A\\
337 }%
338 }
339 \opt{rtc}{
340 time format & 12hour, 24hour & N/A\\
341 }%
342 \opt{recording}{
343 rec quality & 0 to 7 & 0: small size, 7: high quality\\
344 rec frequency
345 & 48, 44, 32, 24, 22, 16 & kHz\\
346 rec source & mic, line, spdif & N/A\\
347 rec channels & mono, stereo & N/A\\
348 rec mic gain & 0 to 15 & N/A\\
349 rec left gain & 0 to 15 & N/A\\
350 rec right gain
351 & 0 to 15 & N/A\\
352 editable recordings
353 & off,on & N/A\\
354 rec timesplit
355 & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00,
356 8:00, 16:00, 24:00 & h:mm\\
357 pre-recording time
358 & off, 1 to 30 & s\\
359 rec path & /path/to/dir & N/A\\
360 }%
361 \opt{spdif_power}{
362 spdif enable & off, on & N/A\\
363 }%
364 \opt{radio}{
365 force fm mono
366 & off, on & N/A\\
367 }%
368 \opt{player}{
369 jump scroll
370 & 0 to 5 & N/A\\
371 jump scroll delay
372 & 0 to 250 & 0.01~s\\
373 }%
374
375 \bottomrule
376 \end{longtable}
377 \end{center}
thomasjfox's rockbox modifications (mameo port)