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