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