Combine the settings for scrollbar on/off and its position into one with three possib...
[kugel-rb.git] / manual / appendix / config_file_options.tex
blob3ac20bb203cf5ec0cae2e6932eb0c5f7a6a3bde3
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{masd}{-78 to +18}%
14 \opt{masf}{-100 -to +12}%
15 \opt{h100,h300}{-84 to 0}%
16 \opt{ipodnano}{-72 to +6}%
17 \opt{ipodvideo}{-57 to +6}%
18 \opt{x5}{-73 to +6}
19 \opt{e200}{-74 to +6}
20 \opt{ipodcolor}{-74 to +6}%
21 & dB\\
22 \nopt{x5}{%
23 bass & \opt{masd}{-15 to +15}%
24 \opt{masf}{-12 to +12}%
25 \opt{h100,h300}{0 to +24}%
26 \opt{ipod}{-6 to +9}%
27 \opt{e200}{-24 to +24}%
28 & dB\\
29 treble & \opt{masd}{-15 to +15}%
30 \opt{masf}{-12 to +12}%
31 \opt{h100,h300}{0 to +6}%
32 \opt{ipod}{-6 to +9}%
33 \opt{e200}{-24 to +24}%
34 & 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 & seconds\\
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\\
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 & seconds\\
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 & seconds\\
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 & seconds\\
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\\
90 \opt{HAVE_CAR_ADAPTER_MODE}{
91 car adapter mode & on, off & N/A\\
93 \opt{accessory_supply}{
94 accessory power supply & on, off & N/A\\
96 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
97 & minutes\\
98 max files in playlist & 1000 - 32000 & N/A\\
99 max files in dir & 50 - 10000 & N/A\\
100 lang & /path/filename.lng & N/A\\
101 wps & /path/filename.wps & N/A\\
102 autocreate bookmarks
103 & off, on & N/A\\
104 autoload bookmarks
105 & off, on & N/A\\
106 use most-recent-bookmarks
107 & off, on & N/A\\
108 pause on headphone unplug & off, pause, pause and resume & N/A\\
109 rewind duration on pause & 0 to 15 & seconds\\
110 disable autoresume if phones not present & off, on & N/A\\
111 Last.fm Logging & off, on & N/A\\
112 talk dir & off, number, spell& N/A\\
113 talk dir clip & off, on & N/A\\
114 talk file & off, number, spell& N/A\\
115 talk file clip & off, on & N/A\\
116 talk filetype & off, on & N/A\\
117 talk menu & off, on & N/A\\
118 Announce Battery Level & off, on & N/A\\
119 sort files & alpha, oldest, newest, type & N/A\\
120 sort dirs & alpha, oldest, newest & N/A\\
121 sort interpret number & digits, numbers & N/A\\
122 tagcache\_autoupdate
123 & on, off & N/A\\
124 warn when erasing dynamic playlist
125 & on, off & N/A\\
126 cuesheet support
127 & on, off & N/A\\
128 folder navigation & off, on, random & N/A\\
129 gather runtime data & off, on & N/A\\
130 \opt{usb_charging}{
131 usb charging & on, off & N/A\\
133 skip length & track, 1s, 2s, 3s, 5s, 7s, 10s, 15s, 20s, 1min,
134 90s, 2min, 3min, 5min, 10min, 15min & N/A\\
135 prevent track skip
136 & on, off & N/A\\
137 start in screen & previous, root, files, db, wps, menu,
138 \opt{recording}{recording, }
139 \opt{radio}{radio, }
140 bookmarks & N/A\\
141 playlist catalog directory & /path/to/dir & N/A\\
142 \opt{wheel_acceleration}{
143 list\_accel\_start\_delay & 0 to 10 & ms\\
144 list\_accel\_wait & 1 to 10 & seconds\\
147 \opt{swcodec}{
148 replaygain type
149 & track, album, track shuffle, off
150 & N/A\\
151 replaygain noclip
152 & on, off & N/A\\
153 replaygain preamp
154 & -120 to 120 & 0.1dB\\
156 crossfade & off, shuffle, track skip, always
157 & N/A\\
158 crossfade fade in delay
159 & 0 to 7 & seconds\\
160 crossfade fade out delay
161 & 0 to 7 & seconds\\
162 crossfade fade in duration
163 & 0 to 15 & seconds\\
164 crossfade fade out duration
165 & 0 to 15 & seconds\\
166 crossfade fade out mode
167 & crossfade, mix & N/A\\
169 crossfeed & on, off & N/A\\
170 crossfeed direct gain
171 & 0 to 60 & 0.1dB\\
172 crossfeed cross gain
173 & 30 to 120 & 0.1dB\\
174 crossfeed hf attenuation
175 & 60 to 240 & 0.1dB\\
176 crossfeed hf cutoff
177 & 500 to 2000 & Hz\\
179 eq enabled & on, off & N/A\\
180 eq precut & 0 to 240 & 0.1dB\\
181 eq band 0 cutoff & 0 to 32768 & Hz\\
182 eq band 1 cutoff & 0 to 32768 & Hz\\
183 eq band 2 cutoff & 0 to 32768 & Hz\\
184 eq band 3 cutoff & 0 to 32768 & Hz\\
185 eq band 4 cutoff & 0 to 32768 & Hz\\
186 eq band 0 q & 0 to 64 & N/A\\
187 eq band 1 q & 0 to 64 & N/A\\
188 eq band 2 q & 0 to 64 & N/A\\
189 eq band 3 q & 0 to 64 & N/A\\
190 eq band 4 q & 0 to 64 & N/A\\
191 eq band 0 gain & -240 to 240 & 0.1dB\\
192 eq band 1 gain & -240 to 240 & 0.1dB\\
193 eq band 2 gain & -240 to 240 & 0.1dB\\
194 eq band 3 gain & -240 to 240 & 0.1dB\\
195 eq band 4 gain & -240 to 240 & 0.1dB\\
197 dithering enabled & on, off & N/A\\
198 beep & off, weak, moderate, strong & N/A\\
199 keyclick & off, weak, moderate, strong & N/A\\
200 keyclick repeats & on, off & N/A\\
201 dircache & on, off & N/A\\
202 tagcache\_ram & on, off & N/A\\
205 \opt{masf}{
206 loudness & 0 to 17 & N/A\\
207 superbass & on, off & N/A\\
208 auto volume & off, 20ms, 2s, 4s, 8s
209 & seconds\\
210 mdb enable & on,off & N/A\\
211 mdb strength & 0 to 127 & dB\\
212 mdb harmonics & 0 to 100 & \%\\
213 mdb center & 20 to 300 & Hz\\
214 mdb shape & 50 to 300 & Hz\\
217 \opt{lcd_bitmap}{
218 peak meter release
219 & 1 to 126 & ?\\
220 peak meter hold
221 & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
222 15, 20, 30, 1min & N/A \\
223 peak meter clip hold
224 & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
225 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
226 & N/A \\
227 peak meter busy & on, off & N/A\\
228 peak meter dbfs & on, off & on:~dbfs, off:~linear\\
229 peak meter min & 0 to 89 (dB) or 0 to 100 (\%)
230 & dB or \%\\
231 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%)
232 & dB or \%\\
233 statusbar & off, top, bottom & N/A\\
234 \opt{remote}{
235 remote statusbar & off, top, bottom & N/A\\
237 scrollbar & off, left, right & N/A\\
238 scrollbar width & 3 to LCD width / 10 (\fixme{devise a way
239 to get ranges from config-*.h})& pixels\\
240 volume display
241 & graphic, numeric & N/A\\
242 battery display
243 & graphic, numeric & N/A\\
244 font & /path/filename.fnt & N/A\\
245 kbd & /path/filename.kbd & N/A\\
246 \opt{lcd_invert}{
247 invert & on, off & N/A\\
249 \opt{lcd_flip}{
250 flip display & on, off & N/A\\
252 selector type & pointer, bar (inverse)
253 \opt{lcd_color}{, bar (color), bar (gradient)} & N/A\\
254 show icons & on, off & N/A\\
255 iconset & /path/filename.bmp & N/A\\
256 viewers iconset & /path/filename.bmp & N/A\\
259 \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
260 % causes ondiosp not to build for mysterious reasons.
261 backdrop & /path/filename.bmp & N/A\\
264 \opt{lcd_color}{
265 foreground colour & 000000 to FFFFFF & RRGGBB\\
266 background colour & 000000 to FFFFFF & RRGGBB\\
267 line selector start colour & 000000 to FFFFFF & RRGGBB\\
268 line selector end colour & 000000 to FFFFFF & RRGGBB\\
269 line selector text colour & 000000 to FFFFFF & RRGGBB\\
270 filetype colours & /path/filename.colours & N/A\\
273 \opt{HAVE_REMOTE_LCD}{
274 rwps & /path/filename.rwps & N/A\\
275 remote contrast
276 & 5 to 63 & N/A\\
277 remote invert
278 & on, off & N/A\\
279 remote flip display
280 & on, off & N/A\\
281 remote backlight timeout
282 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
283 30, 45, 60, 90 & seconds\\
284 remote backlight timeout plugged
285 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
286 30, 45, 60, 90 & seconds\\
287 remote caption backlight
288 & on, off & N/A\\
289 remote scroll speed
290 & 0 to 15 & N/A\\
291 remote scroll step
292 & 1 to 160 & N/A\\
293 remote scroll delay
294 & 0 to 2500 & ms\\
295 remote bidir limit
296 & 0 to 200 & N/A\\
297 backlight filters first remote keypress
298 & on, off & N/A\\
299 remote iconset & /path/filename.bmp & N/A\\
300 remote viewers iconset & /path/filename.bmp & N/A\\
301 \opt{h100,h300}{
302 remote reduce ticking
303 & on, off & N/A\\
306 \opt{rtc}{
307 time format & 12hour, 24hour & N/A\\
309 \opt{recording}{
310 rec quality & 0 to 7 & 0: small size, 7: high quality\\
311 rec frequency
312 & 48, 44, 32, 24, 22, 16 & kHz\\
313 rec source & mic, line, spdif & N/A\\
314 rec channels & mono, stereo & N/A\\
315 rec mic gain & 0 to 15 & N/A\\
316 rec left gain & 0 to 15 & N/A\\
317 rec right gain
318 & 0 to 15 & N/A\\
319 editable recordings
320 & off,on & N/A\\
321 rec timesplit
322 & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00,
323 8:00, 16:00, 24:00 & h:mm\\
324 pre-recording time
325 & off, 1 to 30 & seconds\\
326 rec directory & /path/to/dir & N/A\\
328 \opt{spdif_power}{
329 spdif enable & off, on & N/A\\
331 \opt{radio}{
332 force fm mono
333 & off, on & N/A\\
335 \opt{player}{
336 jump scroll
337 & 0 to 5 & N/A\\
338 jump scroll delay
339 & 0 to 250 & 0.01s\\
342 \bottomrule
343 \end{longtable}
344 \end{center}