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