From 9723cb7fb1020c2aeb2cf36d611a31c43bf0dfc6 Mon Sep 17 00:00:00 2001 From: Dominik Riebeling Date: Sun, 17 Sep 2006 20:47:10 +0000 Subject: Rework the config file options table: allow the fields to break automatically, reformat the source for better readability and adjust table width. Finally include the table in the HTML output. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10982 a1c6a512-1295-4272-9138-f99709370657 --- manual/appendix/appendix.tex | 4 +- manual/appendix/config_file_options.tex | 386 ++++++++++++++++++-------------- 2 files changed, 222 insertions(+), 168 deletions(-) (limited to 'manual') diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex index a5b9083b06..c41c5f4df0 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex @@ -5,9 +5,7 @@ \input{appendix/wps_tags.tex} -\chapter{\label{ref:config_file_options}Config file options} -\ifpdfoutput{\input{appendix/config_file_options.tex}} -{\fixme{The config file options are omitted in the HTML version of the manual for now.}} +\input{appendix/config_file_options.tex} \chapter{User feedback}\label{sec:feedback} \section{Bug reports} diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex index c9c5f00dfa..c3daa90756 100644 --- a/manual/appendix/config_file_options.tex +++ b/manual/appendix/config_file_options.tex @@ -1,201 +1,257 @@ % $Id$ % -\section{Settings} +\chapter{\label{ref:config_file_options}Config file options} \begin{center} - \begin{longtable}{@{}lll@{}}\toprule +% define a local version of endhead, as using the output distinction adds +% an unwanted newline. endhead breaks with htlatex so we need to remove it +% for the html output. +\ifpdfoutput{\newcommand{\localendhead}{\endhead}}{} + \begin{longtable}{@{}>{\raggedright}p{.35\textwidth}@{}>{\raggedright}p{.4\textwidth}@{}p{.25\textwidth}@{}} + \toprule \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\ - \midrule - \endhead - volume & \opt{player}{-78 to +18}% - \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}% - \opt{h1xx,h300}{-84 to 0}% - \opt{ipodnano}{-72 to +6}% - \opt{ipodvideo}{-57 to +6}% - \opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}% - & dB\\ + \midrule\localendhead % endhead breaks with htlatex + volume & \opt{player}{-78 to +18}% + \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}% + \opt{h1xx,h300}{-84 to 0}% + \opt{ipodnano}{-72 to +6}% + \opt{ipodvideo}{-57 to +6}% + \opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}% + & dB\\ \nopt{x5}{% - bass & \opt{MASCODEC}{-15 to +15}% - \opt{h1xx,h300}{0 to +24}% - \opt{ipod}{-6 to +9}% - & dB\\ - treble & \opt{MASCODEC}{-15 to +15}% - \opt{h1xx,h300}{0 to +6}% - \opt{ipod}{-6 to +9}% - & dB\\ + bass & \opt{MASCODEC}{-15 to +15}% + \opt{h1xx,h300}{0 to +24}% + \opt{ipod}{-6 to +9}% + & dB\\ + treble & \opt{MASCODEC}{-15 to +15}% + \opt{h1xx,h300}{0 to +6}% + \opt{ipod}{-6 to +9}% + & dB\\ }% - balance & -100 to +100 & \%\\ - channels & stereo, mono, custom & N/A\\ - & mono left, mono right, karaoke & \\ - shuffle & on, off & N/A\\ - repeat & off, all, one, shuffle, ab & N/A\\ - play selected & on, off & N/A\\ - resume & on, off & N/A\\ - scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, & seconds\\ - & 20, 25, 30, 45, 60 &\\ - scan accel & 0 to 15 & seconds\\ - antiskip & 0 to 7 & seconds\\ - volume fade & on, off & N/A\\ - id3 tag priority & v2-v1, v1-v2 & N/A\\ - sort case & on, off & N/A\\ - show files & all, supported, music, playlists & N/A\\ - follow playlist & on, off & N/A\\ - playlist viewer icons & on, off & N/A\\ - playlist viewer indices & on, off & N/A\\ - playlist viewer track display & track name,full path & N/A\\ - recursive directory insert & on, off & N/A\\ - scroll speed & 1 to 25 & Hz\\ - scroll delay & 0 to 250 & 1/10s\\ - scroll step & 1 to 112 & pixels\\ - bidir limit & 0 to 200 & \% screen\\ - contrast & 0 to 63 & N/A\\ - backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ - & 6, 7, 8, 9, 10, 15, 20, & \\ - & 25, 30, 45, 60, 90 & \\ - backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ - & 6, 7, 8, 9, 10, 15, 20, & \\ - & 25, 30, 45, 60, 90 & \\ - disk spindown & 3 to 254 & seconds\\ - battery capacity & 1500 - 3200 & mAh\\ - idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\ - & 15, 30, 45, 60 & \\ - lang & /path/filename.lng & N/A\\ - wps & /path/filename.wps & N/A\\ - autocreate bookmarks & off,on & N/A\\ - autoload bookmarks & off,on & N/A\\ - use most-recent-bookmarks & off,on & N/A\\ - talk dir & off, number, spell, enter, hover & N/A\\ - talk file & off, number, spell & N/A\\ - talk menu & off, on & N/A\\ - tagcache\_autoupdate & on, off & N/A\\ - warn when erasing dynamic playlist & on, off & N/A\\ + balance & -100 to +100 & \%\\ + channels & stereo, mono, custom, mono left, mono right, karaoke + & N/A\\ + shuffle & on, off & N/A\\ + repeat & off, all, one, shuffle, ab + & N/A\\ + play selected & on, off & N/A\\ + resume & on, off & N/A\\ + scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60 + & seconds\\ + scan accel & 0 to 15 & seconds\\ + antiskip & 0 to 7 & seconds\\ + volume fade & on, off & N/A\\ + id3 tag priority & v2-v1, v1-v2 & N/A\\ + sort case & on, off & N/A\\ + show files & all, supported, music, playlists + & N/A\\ + follow playlist & on, off & N/A\\ + playlist viewer icons + & on, off & N/A\\ + playlist viewer indices + & on, off & N/A\\ + playlist viewer track display + & track name,full path + & N/A\\ + recursive directory insert + & on, off & N/A\\ + scroll speed & 1 to 25 & Hz\\ + scroll delay & 0 to 250 & 1/10s\\ + scroll step & 1 to 112 & pixels\\ + bidir limit & 0 to 200 & \% screen\\ + contrast & 0 to 63 & N/A\\ + backlight timeout + & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, + 45, 60, 90 & seconds\\ + backlight timeout plugged + & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, + 45, 60, 90 & seconds\\ + disk spindown & 3 to 254 & seconds\\ + battery capacity + & 1500 - 3200 & mAh\\ + idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60 + & minutes\\ + lang & /path/filename.lng & N/A\\ + wps & /path/filename.wps & N/A\\ + autocreate bookmarks + & off, on & N/A\\ + autoload bookmarks + & off, on & N/A\\ + use most-recent-bookmarks + & off, on & N/A\\ + talk dir & off, number, spell, enter, hover + & N/A\\ + talk file & off, number, spell& N/A\\ + talk menu & off, on & N/A\\ + tagcache\_autoupdate + & on, off & N/A\\ + warn when erasing dynamic playlist + & on, off & N/A\\ % \opt{SWCODEC}{ - replaygain & on, off & N/A\\ - replaygain type & track, album, track shuffle & N/A\\ - replaygain noclip & on, off & N/A\\ - replaygain preamp & -120 to 120 & 0.1dB\\ + replaygain & on, off & N/A\\ + replaygain type + & track, album, track shuffle + & N/A\\ + replaygain noclip + & on, off & N/A\\ + replaygain preamp + & -120 to 120 & 0.1dB\\ % - crossfade & off, shuffle, track skip, always & N/A\\ - crossfade fade in delay & 0 to 7 & seconds\\ - crossfade fade out delay & 0 to 7 & seconds\\ - crossfade fade in duration & 0 to 15 & seconds\\ - crossfade fade out duration & 0 to 15 & seconds\\ - crossfade fade out mode & crossfade, mix & N/A\\ + crossfade & off, shuffle, track skip, always + & N/A\\ + crossfade fade in delay + & 0 to 7 & seconds\\ + crossfade fade out delay + & 0 to 7 & seconds\\ + crossfade fade in duration + & 0 to 15 & seconds\\ + crossfade fade out duration + & 0 to 15 & seconds\\ + crossfade fade out mode + & crossfade, mix & N/A\\ % - crossfeed & on, off & N/A\\ - crossfeed direct gain & 0 to 60 & 0.1dB\\ - crossfeed cross gain & 30 to 120 & 0.1dB\\ - crossfeed hf attenuation & 60 to 240 & 0.1dB\\ - crossfeed hf cutoff & 500 to 2000 & Hz\\ + crossfeed & on, off & N/A\\ + crossfeed direct gain + & 0 to 60 & 0.1dB\\ + crossfeed cross gain + & 30 to 120 & 0.1dB\\ + crossfeed hf attenuation + & 60 to 240 & 0.1dB\\ + crossfeed hf cutoff + & 500 to 2000 & Hz\\ % - eq enabled & on, off & N/A\\ - eq precut& 0 to 240 & 0.1dB\\ - eq band 0 cutoff & 0 to 32768 & Hz\\ - eq band 1 cutoff & 0 to 32768 & Hz\\ - eq band 2 cutoff & 0 to 32768 & Hz\\ - eq band 3 cutoff & 0 to 32768 & Hz\\ - eq band 4 cutoff & 0 to 32768 & Hz\\ - eq band 0 q & 0 to 64 & N/A\\ - eq band 1 q & 0 to 64 & N/A\\ - eq band 2 q & 0 to 64 & N/A\\ - eq band 3 q & 0 to 64 & N/A\\ - eq band 4 q & 0 to 64 & N/A\\ - eq band 0 gain & -240 to 240 & 0.1dB\\ - eq band 1 gain & -240 to 240 & 0.1dB\\ - eq band 2 gain & -240 to 240 & 0.1dB\\ - eq band 3 gain & -240 to 240 & 0.1dB\\ - eq band 4 gain & -240 to 240 & 0.1dB\\ + eq enabled & on, off & N/A\\ + eq precut & 0 to 240 & 0.1dB\\ + eq band 0 cutoff & 0 to 32768 & Hz\\ + eq band 1 cutoff & 0 to 32768 & Hz\\ + eq band 2 cutoff & 0 to 32768 & Hz\\ + eq band 3 cutoff & 0 to 32768 & Hz\\ + eq band 4 cutoff & 0 to 32768 & Hz\\ + eq band 0 q & 0 to 64 & N/A\\ + eq band 1 q & 0 to 64 & N/A\\ + eq band 2 q & 0 to 64 & N/A\\ + eq band 3 q & 0 to 64 & N/A\\ + eq band 4 q & 0 to 64 & N/A\\ + eq band 0 gain & -240 to 240 & 0.1dB\\ + eq band 1 gain & -240 to 240 & 0.1dB\\ + eq band 2 gain & -240 to 240 & 0.1dB\\ + eq band 3 gain & -240 to 240 & 0.1dB\\ + eq band 4 gain & -240 to 240 & 0.1dB\\ % - beep & off, weak, moderate, strong & N/A\\ - dircache & on, off & N/A\\ - tagcache\_ram & on, off & N/A\\ + beep & off, weak, moderate, strong + & N/A\\ + dircache & on, off & N/A\\ + tagcache\_ram & on, off & N/A\\ }% \opt{recorder,recorderv2fm}{ - loudness & 0 to 17 & N/A\\ - superbass & on, off & N/A\\ - auto volume & off, 20ms, 2s, 4s, 8s & seconds\\ - mdb enable & on,off & N/A\\ - mdb strength & 0 to 127 & dB\\ - mdb harmonics & 0 to 100 & \%\\ - mdb center & 20 to 300 & Hz\\ - mdb shape & 50 to 300 & Hz\\ + loudness & 0 to 17 & N/A\\ + superbass & on, off & N/A\\ + auto volume & off, 20ms, 2s, 4s, 8s + & seconds\\ + mdb enable & on,off & N/A\\ + mdb strength & 0 to 127 & dB\\ + mdb harmonics & 0 to 100 & \%\\ + mdb center & 20 to 300 & Hz\\ + mdb shape & 50 to 300 & Hz\\ }% \opt{HAVE_LCD_BITMAP}{ - peak meter release & 1 to 126 & ?\\ - peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\ - & 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, &\\ - & 20, 30, 1min & \\ - peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\ - & 15, 20, 25, 30, 45, 60, 90, 2min, &\\ - & 3min, 5min, 10min, 20min, &\\ - & 45min, 90min & \\ - peak meter busy & on, off & N/A\\ - peak meter dbfs & on, off & on:~dbfs,\\ - & & off:~linear\\ - peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\ - peak meter max & 0 to 89 /(dB) or 0 to 100 (\%) & dB or \%\\ - statusbar & on, off & N/A\\ - scrollbar & on, off & N/A\\ - volume display & graphic, numeric & N/A\\ - battery display & graphic, numeric & N/A\\ - font & /path/filename.fnt & N/A\\ - invert & on, off & N/A\\ - disk poweroff & on, off & N/A\\ + peak meter release + & 1 to 126 & ?\\ + peak meter hold + & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, + 15, 20, 30, 1min & N/A \\ + peak meter clip hold + & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, + 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min + & N/A \\ + peak meter busy & on, off & N/A\\ + peak meter dbfs & on, off & on:~dbfs, off:~linear\\ + peak meter min & 0 to 89 (dB) or 0 to 100 (\%) + & dB or \%\\ + peak meter max & 0 to 89 /(dB) or 0 to 100 (\%) + & dB or \%\\ + statusbar & on, off & N/A\\ + scrollbar & on, off & N/A\\ + volume display + & graphic, numeric & N/A\\ + battery display + & graphic, numeric & N/A\\ + font & /path/filename.fnt & N/A\\ + invert & on, off & N/A\\ + disk poweroff & on, off & N/A\\ }% \opt{HAVE_LCD_COLOR}{ - backdrop & /path/filename.bmp & N/A\\ - foreground color & 000000 to FFFFFF & RRGGBB\\ - background color & 000000 to FFFFFF & RRGGBB\\ + backdrop & /path/filename.bmp & N/A\\ + foreground color & 000000 to FFFFFF & RRGGBB\\ + background color & 000000 to FFFFFF & RRGGBB\\ } \opt{HAVE_REMOTE_LCD}{ - rwps & /path/filename.rwps & N/A\\ - remote contrast & 5 to 63 & N/A\\ - remote invert & on, off & N/A\\ - remote flip display & on, off & N/A\\ - remote backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ - & 6, 7, 8, 9, 10, 15, 20, & \\ - & 25, 30, 45, 60, 90 & \\ - remote backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ - & 6, 7, 8, 9, 10, 15, 20, & \\ - & 25, 30, 45, 60, 90 & \\ - remote caption backlight & on, off & N/A\\ - remote scroll speed & 0 to 15 & N/A\\ - remote scroll step & 1 to 160 & N/A\\ - remote scroll delay & 0 to 250 & N/A\\ - remote bidir limit & 0 to 200 & N/A\\ - backlight filters first remote keypress & on, off & N/A\\ + rwps & /path/filename.rwps & N/A\\ + remote contrast + & 5 to 63 & N/A\\ + remote invert + & on, off & N/A\\ + remote flip display + & on, off & N/A\\ + remote backlight timeout + & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, + 30, 45, 60, 90 & seconds\\ + remote backlight timeout plugged + & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, + 30, 45, 60, 90 & seconds\\ + remote caption backlight + & on, off & N/A\\ + remote scroll speed + & 0 to 15 & N/A\\ + remote scroll step + & 1 to 160 & N/A\\ + remote scroll delay + & 0 to 250 & N/A\\ + remote bidir limit + & 0 to 200 & N/A\\ + backlight filters first remote keypress + & on, off & N/A\\ \opt{h1xx,h300}{ - remote reduce ticking & on, off & N/A\\ + remote reduce ticking + & on, off & N/A\\ }% } \opt{CONFIG_RTC}{ - time format & 12hour, 24hour & N/A\\ + time format & 12hour, 24hour & N/A\\ }% \opt{HAVE_RECORDING}{ - rec quality & 0 to 7 & 0: small size,\\ - & & 7: high quality\\ - rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\ - rec source & mic, line, spdif & N/A\\ - rec channels & mono, stereo & N/A\\ - rec mic gain & 0 to 15 & N/A\\ - rec left gain & 0 to 15 & N/A\\ - rec right gain & 0 to 15 & N/A\\ - editable recordings & off,on & N/A\\ - rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\ - & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\ - pre-recording time & off, 1 to 30 & seconds\\ - rec directory & /recordings,current & N/A\\ + rec quality & 0 to 7 & 0: small size, 7: high quality\\ + rec frequency + & 48, 44, 32, 24, 22, 16 & kHz\\ + rec source & mic, line, spdif & N/A\\ + rec channels & mono, stereo & N/A\\ + rec mic gain & 0 to 15 & N/A\\ + rec left gain & 0 to 15 & N/A\\ + rec right gain + & 0 to 15 & N/A\\ + editable recordings + & off,on & N/A\\ + rec timesplit + & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00, + 8:00, 16:00, 24:00 & h:mm\\ + pre-recording time + & off, 1 to 30 & seconds\\ + rec directory + & /recordings,current & N/A\\ }% \opt{CONFIG_TUNER}{ - force fm mono & off, on & N/A\\ + force fm mono + & off, on & N/A\\ }% \opt{player}{ - jump scroll & 0 to 5 & N/A\\ - jump scroll delay & 0 to 250 & 0.01s\\ - } + jump scroll + & 0 to 5 & N/A\\ + jump scroll delay + & 0 to 250 & 0.01s\\ + }% \bottomrule \end{longtable} \end{center} -- cgit v1.2.3