manual/appendix/config_file_options.tex

   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{fuzeplus}{-99 to +6}%
  21                   \opt{e200,e200v2,ipodcolor,vibe500,ipodnano2g}{-74 to +6}%
  22                                         & dB\\
  23     bass        & \opt{masd}{-15 to +15}%
  24                   \opt{masf}{-12 to +12}%
  25                   \opt{iriverh100,iriverh300}{0 to +24}%
  26                   \opt{ipod}{-6 to +9}%
  27                   \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500,fuzeplus}{%
  28                       -24 to +24}%
  29                                         & dB\\
  30     treble      & \opt{masd}{-15 to +15}%
  31                   \opt{masf}{-12 to +12}%
  32                   \opt{iriverh100,iriverh300}{0 to +6}%
  33                   \opt{ipod}{-6 to +9}%
  34                   \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500,fuzeplus}{%
  35                       -24 to +24}%
  36                                         & 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                                         & s\\
  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\\
  74     }
  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        & s\\
  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        & s\\
  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          & s\\
  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\\
  90     }
  91     \opt{HAVE_CAR_ADAPTER_MODE}{
  92       car adapter mode & on, off & N/A\\
  93     }
  94     \opt{accessory_supply}{
  95       accessory power supply & on, off & N/A\\
  96     }
  97     \opt{usb_hid}{
  98         usb hid & on, off & N/A\\
  99         usb keypad mode
 100                     & multimedia, presentation, browser\opt{usb_hid_mouse}{, mouse}& N/A\\
 101     }
 102     \opt{multidrive_usb}{
 103         usb skip first drive & on, off & N/A\\
 104     }
 105     \opt{quickscreen}{
 106         qs top & any setting name, - for none & N/A\\
 107         qs bottom & any setting name, - for none & N/A\\
 108         qs left & any setting name, - for none & N/A\\
 109         qs right & any setting name, - for none & N/A\\
 110         shortcuts instead of quickscreen & off, on & N/A\\
 111     }
 112
 113     idle poweroff   & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
 114                                         & min\\
 115     sleeptimer duration   & 5 to 300 (in steps of 5)
 116                                         & min\\
 117     sleeptimer on startup & off, on     & N/A\\
 118     keypress restarts sleeptimer & off, on & N/A\\
 119     max files in playlist & 1000 - 32000 & N/A\\
 120     max files in dir & 50 - 10000       & N/A\\
 121     lang            & /path/filename.lng & N/A\\
 122     wps             & /path/filename.wps & N/A\\
 123     autocreate bookmarks
 124                     & off, on           & N/A\\
 125     autoload bookmarks
 126                     & off, on           & N/A\\
 127     use most-recent-bookmarks
 128                     & off, on           & N/A\\
 129     pause on headphone unplug & off, pause, pause and resume & N/A\\
 130     rewind duration on pause & 0 to 15  & s\\
 131     disable autoresume if phones not present & off, on & N/A\\
 132     Last.fm Logging & off, on           & N/A\\
 133     talk dir        & off, number, spell& N/A\\
 134     talk dir clip   & off, on           & N/A\\
 135     talk file       & off, number, spell& N/A\\
 136     talk file clip  & off, on           & N/A\\
 137     talk filetype   & off, on           & N/A\\
 138     talk menu       & off, on           & N/A\\
 139     Announce Battery Level & off, on    & N/A\\
 140     \opt{hotkey}{
 141     hotkey wps      & off, view playlist, show track info,
 142         pitchscreen, open with, delete  & N/A\\
 143     \nopt{touchscreen}{hotkey tree     & off, open with, delete, insert,
 144         insert shuffled                 & N/A\\}
 145     }
 146     sort files      & alpha, oldest, newest, type & N/A\\
 147     sort dirs       & alpha, oldest, newest & N/A\\
 148     sort interpret number & digits, numbers & N/A\\
 149     tagcache\_autoupdate
 150                     & on, off           & N/A\\
 151     warn when erasing dynamic playlist
 152                     & on, off           & N/A\\
 153     cuesheet support
 154                     & on, off           & N/A\\
 155     folder navigation & off, on, random & N/A\\
 156     constrain next folder & off, on     & N/A\\
 157     gather runtime data & off, on       & N/A\\
 158     \opt{usb_charging_enable}{
 159       usb charging  & on, off, force    & N/A\\
 160     }
 161     skip length     & outro, track, 1s, 2s, 3s, 5s, 7s, 10s, 15s, 20s, 1min,
 162             90s, 2min, 3min, 5min, 10min, 15min & N/A\\
 163     prevent track skip
 164                     & on, off           & N/A\\
 165     start in screen & previous, root, files, dB, wps, menu,
 166       \opt{recording}{recording, }
 167       \opt{radio}{radio, }
 168       bookmarks                         & N/A\\
 169     playlist catalog directory & /path/to/dir & N/A\\
 170     \nopt{wheel_acceleration}{
 171       list\_accel\_start\_delay & 0 to 10  & ms\\
 172       list\_accel\_wait        & 1 to 10  & s\\
 173     }
 174 %
 175     \opt{swcodec}{
 176       replaygain type
 177                     & track, album, track shuffle, off
 178                                         & N/A\\
 179       replaygain noclip
 180                     & on, off           & N/A\\
 181       replaygain preamp
 182                     & -120 to 120       & 0.1~dB\\
 183 %
 184       \opt{crossfade}{
 185       crossfade     & off, auto track change, man track skip, shuffle,
 186                     shuffle or man track skip, always
 187                                         & N/A\\
 188       crossfade fade in delay
 189                     & 0 to 7            & s\\
 190       crossfade fade out delay
 191                     & 0 to 7            & s\\
 192       crossfade fade in duration
 193                     & 0 to 15           & s\\
 194       crossfade fade out duration
 195                     & 0 to 15           & s\\
 196       crossfade fade out mode
 197                     & crossfade, mix    & N/A\\
 198       }
 199 %
 200       crossfeed     & on, off           & N/A\\
 201       crossfeed direct gain
 202                     & 0 to 60           & 0.1~dB\\
 203       crossfeed cross gain
 204                     & 30 to 120         & 0.1~dB\\
 205       crossfeed hf attenuation
 206                     & 60 to 240         & 0.1~dB\\
 207       crossfeed hf cutoff
 208                     & 500 to 2000       & Hz\\
 209 %
 210       eq enabled    & on, off           & N/A\\
 211       eq precut     & 0 to 240          & 0.1~dB\\
 212       eq low shelf filter & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 213       eq peak filter 1 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 214       eq peak filter 2 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 215       eq peak filter 3 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 216       eq peak filter 4 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 217       eq peak filter 5 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 218       eq peak filter 6 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 219       eq peak filter 7 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 220       eq peak filter 8 & cutoff (in Hz), q (0 to 64), gain (-240 to 240)\\
 221       eq high shelf filter & cutoff (in Hz), q (0 to 64), gain (-240 to 240 (0.1~dB))\\
 222 %
 223       dithering enabled & on, off       & N/A\\
 224 %
 225       timestretch enabled & on, off     & N/A\\
 226 %
 227       compressor threshold      & 0 to -24      & -3~dB\\
 228       compressor makeup gain    & off, auto     & N/A\\
 229       compressor ratio          & 2:1, 4:1, 6:1, 10:1, limit
 230                                                 & N/A\\
 231       compressor knee           & hard knee, soft knee
 232                                                 & N/A\\
 233       compressor release time   & 100 to 1000   & 100~ms\\
 234 %
 235       beep          & off, weak, moderate, strong & N/A\\
 236       keyclick      & off, weak, moderate, strong & N/A\\
 237       keyclick repeats & on, off        & N/A\\
 238       dircache      & on, off           & N/A\\
 239       tagcache\_ram & on, off           & N/A\\
 240     }%
 241
 242     \opt{masf}{
 243       loudness      & 0 to 17           & N/A\\
 244       superbass     & on, off           & N/A\\
 245       auto volume   & off, 20ms, 2s, 4s, 8s
 246                                         & N/A\\
 247       mdb enable    & on,off            & N/A\\
 248       mdb strength  & 0 to 127          & dB\\
 249       mdb harmonics & 0 to 100          & \%\\
 250       mdb center    & 20 to 300         & Hz\\
 251       mdb shape     & 50 to 300         & Hz\\
 252     }%
 253
 254     \opt{lcd_bitmap}{
 255       peak meter release
 256                     & 1 to 126          & ?\\
 257        peak meter hold
 258                     & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
 259                       15, 20, 30, 1min  & N/A \\
 260        peak meter clip hold
 261                     & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
 262                       60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
 263                                         & N/A \\
 264       peak meter busy & on, off         & N/A\\
 265       peak meter dbfs & on, off         & on:~dbfs, off:~linear\\
 266       peak meter min  & 0 to 89 (dB) or 0 to 100 (\%)
 267                                         & dB or \%\\
 268       peak meter max  & 0 to 89 /(dB) or 0 to 100 (\%)
 269                                         & dB or \%\\
 270       statusbar     & off, top, bottom  & N/A\\
 271       \opt{remote}{
 272         remote statusbar & off, top, bottom & N/A\\
 273       }
 274       scrollbar     & off, left, right  & N/A\\
 275       scrollbar width & 3 to LCD width / 10 (\fixme{devise a way
 276                     to get ranges from config-*.h})& pixels\\
 277       volume display
 278                     & graphic, numeric  & N/A\\
 279       battery display
 280                     & graphic, numeric  & N/A\\
 281       font          & /path/filename.fnt & N/A\\
 282       kbd           & /path/filename.kbd & N/A\\
 283       \opt{lcd_invert}{
 284         invert        & on, off           & N/A\\
 285       }
 286       \opt{lcd_flip}{
 287         flip display  & on, off           & N/A\\
 288       }
 289       selector type   & pointer, bar (inverse)
 290         \opt{lcd_color}{, bar (color), bar (gradient)} & N/A\\
 291       show icons    & on, off           & N/A\\
 292       iconset       & /path/filename.bmp & N/A\\
 293       viewers iconset & /path/filename.bmp & N/A\\
 294     }%
 295
 296     \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
 297                   % causes ondiosp not to build for mysterious reasons.
 298       backdrop      & /path/filename.bmp    & N/A\\
 299     }%
 300
 301     \opt{lcd_color}{
 302       foreground colour & 000000 to FFFFFF   & RRGGBB\\
 303       background colour & 000000 to FFFFFF   & RRGGBB\\
 304       line selector start colour & 000000 to FFFFFF  & RRGGBB\\
 305       line selector end colour   & 000000 to FFFFFF  & RRGGBB\\
 306       line selector text colour  & 000000 to FFFFFF  & RRGGBB\\
 307       filetype colours & /path/filename.colours & N/A\\
 308     }
 309
 310     \opt{HAVE_REMOTE_LCD}{
 311       rwps      & /path/filename.rwps   & N/A\\
 312       remote contrast
 313                 & 5 to 63               & N/A\\
 314       remote invert
 315                 & on, off               & N/A\\
 316       remote flip display
 317                 & on, off               & N/A\\
 318       remote backlight timeout
 319                 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
 320                   30, 45, 60, 90        & s\\
 321       remote backlight timeout plugged
 322                 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
 323                   30, 45, 60, 90        & s\\
 324       remote caption backlight
 325                 & on, off               & N/A\\
 326       remote scroll speed
 327                 & 0 to 15               & N/A\\
 328       remote scroll step
 329                 & 1 to 160              & N/A\\
 330       remote scroll delay
 331                 & 0 to 2500             & ms\\
 332       remote bidir limit
 333                 & 0 to 200              & N/A\\
 334       backlight filters first remote keypress
 335                 & on, off               & N/A\\
 336       remote iconset & /path/filename.bmp & N/A\\
 337       remote viewers iconset & /path/filename.bmp & N/A\\
 338       \opt{iriverh100,iriverh300}{
 339         remote reduce ticking
 340                 & on, off               & N/A\\
 341       }%
 342     }
 343     \opt{rtc}{
 344       time format & 12hour, 24hour      & N/A\\
 345     }%
 346     \opt{recording}{
 347      rec quality & 0 to 7               & 0: small size, 7: high quality\\
 348      rec frequency
 349                 & 48, 44, 32, 24, 22, 16 & kHz\\
 350      rec source & mic, line, spdif      & N/A\\
 351      rec channels & mono, stereo        & N/A\\
 352      rec mic gain & 0 to 15             & N/A\\
 353      rec left gain & 0 to 15            & N/A\\
 354      rec right gain
 355                 & 0 to 15               & N/A\\
 356      editable recordings
 357                 & off,on                & N/A\\
 358      rec timesplit
 359                 & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00,
 360                   8:00, 16:00, 24:00    & h:mm\\
 361      pre-recording time
 362                 & off, 1 to 30          & s\\
 363      rec path & /path/to/dir            & N/A\\
 364     }%
 365     \opt{spdif_power}{
 366       spdif enable & off, on            & N/A\\
 367     }%
 368     \opt{radio}{
 369       force fm mono
 370                 & off, on               & N/A\\
 371     }%
 372     \opt{player}{
 373       jump scroll
 374                 & 0 to 5                & N/A\\
 375       jump scroll delay
 376                 & 0 to 250              & 0.01~s\\
 377     }%
 378
 379     \bottomrule
 380   \end{longtable}
 381 \end{center}