devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

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.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10982 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Dominik Riebeling 2006-09-17 20:47:10 +00:00
parent e03fcc2594
commit 9723cb7fb1
2 changed files with 222 additions and 168 deletions
Download patch file Download diff file Expand all files Collapse all files

4
manual/appendix/appendix.tex
View file

@ -5,9 +5,7 @@
\input{appendix/wps_tags.tex} \input{appendix/wps_tags.tex}
\chapter{\label{ref:config_file_options}Config file options} \input{appendix/config_file_options.tex}
\ifpdfoutput{\input{appendix/config_file_options.tex}}
{\fixme{The config file options are omitted in the HTML version of the manual for now.}}
\chapter{User feedback}\label{sec:feedback} \chapter{User feedback}\label{sec:feedback}
\section{Bug reports} \section{Bug reports}

386
manual/appendix/config_file_options.tex
View file

@ -1,201 +1,257 @@
% $Id$ % % $Id$ %
\section{Settings} \chapter{\label{ref:config_file_options}Config file options}
\begin{center} \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}\\ \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
\midrule \midrule\localendhead % endhead breaks with htlatex
\endhead volume & \opt{player}{-78 to +18}%
volume & \opt{player}{-78 to +18}% \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}%
\opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}% \opt{h1xx,h300}{-84 to 0}%
\opt{h1xx,h300}{-84 to 0}% \opt{ipodnano}{-72 to +6}%
\opt{ipodnano}{-72 to +6}% \opt{ipodvideo}{-57 to +6}%
\opt{ipodvideo}{-57 to +6}% \opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}%
\opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}% & dB\\
& dB\\
\nopt{x5}{% \nopt{x5}{%
bass & \opt{MASCODEC}{-15 to +15}% bass & \opt{MASCODEC}{-15 to +15}%
\opt{h1xx,h300}{0 to +24}% \opt{h1xx,h300}{0 to +24}%
\opt{ipod}{-6 to +9}% \opt{ipod}{-6 to +9}%
& dB\\ & dB\\
treble & \opt{MASCODEC}{-15 to +15}% treble & \opt{MASCODEC}{-15 to +15}%
\opt{h1xx,h300}{0 to +6}% \opt{h1xx,h300}{0 to +6}%
\opt{ipod}{-6 to +9}% \opt{ipod}{-6 to +9}%
& dB\\ & dB\\
}% }%
balance & -100 to +100 & \%\\ balance & -100 to +100 & \%\\
channels & stereo, mono, custom & N/A\\ channels & stereo, mono, custom, mono left, mono right, karaoke
& mono left, mono right, karaoke & \\ & N/A\\
shuffle & on, off & N/A\\ shuffle & on, off & N/A\\
repeat & off, all, one, shuffle, ab & N/A\\ repeat & off, all, one, shuffle, ab
play selected & on, off & N/A\\ & N/A\\
resume & on, off & N/A\\ play selected & on, off & N/A\\
scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, & seconds\\ resume & on, off & N/A\\
& 20, 25, 30, 45, 60 &\\ scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60
scan accel & 0 to 15 & seconds\\ & seconds\\
antiskip & 0 to 7 & seconds\\ scan accel & 0 to 15 & seconds\\
volume fade & on, off & N/A\\ antiskip & 0 to 7 & seconds\\
id3 tag priority & v2-v1, v1-v2 & N/A\\ volume fade & on, off & N/A\\
sort case & on, off & N/A\\ id3 tag priority & v2-v1, v1-v2 & N/A\\
show files & all, supported, music, playlists & N/A\\ sort case & on, off & N/A\\
follow playlist & on, off & N/A\\ show files & all, supported, music, playlists
playlist viewer icons & on, off & N/A\\ & N/A\\
playlist viewer indices & on, off & N/A\\ follow playlist & on, off & N/A\\
playlist viewer track display & track name,full path & N/A\\ playlist viewer icons
recursive directory insert & on, off & N/A\\ & on, off & N/A\\
scroll speed & 1 to 25 & Hz\\ playlist viewer indices
scroll delay & 0 to 250 & 1/10s\\ & on, off & N/A\\
scroll step & 1 to 112 & pixels\\ playlist viewer track display
bidir limit & 0 to 200 & \% screen\\ & track name,full path
contrast & 0 to 63 & N/A\\ & N/A\\
backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ recursive directory insert
& 6, 7, 8, 9, 10, 15, 20, & \\ & on, off & N/A\\
& 25, 30, 45, 60, 90 & \\ scroll speed & 1 to 25 & Hz\\
backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ scroll delay & 0 to 250 & 1/10s\\
& 6, 7, 8, 9, 10, 15, 20, & \\ scroll step & 1 to 112 & pixels\\
& 25, 30, 45, 60, 90 & \\ bidir limit & 0 to 200 & \% screen\\
disk spindown & 3 to 254 & seconds\\ contrast & 0 to 63 & N/A\\
battery capacity & 1500 - 3200 & mAh\\ backlight timeout
idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\ & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
& 15, 30, 45, 60 & \\ 45, 60, 90 & seconds\\
lang & /path/filename.lng & N/A\\ backlight timeout plugged
wps & /path/filename.wps & N/A\\ & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
autocreate bookmarks & off,on & N/A\\ 45, 60, 90 & seconds\\
autoload bookmarks & off,on & N/A\\ disk spindown & 3 to 254 & seconds\\
use most-recent-bookmarks & off,on & N/A\\ battery capacity
talk dir & off, number, spell, enter, hover & N/A\\ & 1500 - 3200 & mAh\\
talk file & off, number, spell & N/A\\ idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
talk menu & off, on & N/A\\ & minutes\\
tagcache\_autoupdate & on, off & N/A\\ lang & /path/filename.lng & N/A\\
warn when erasing dynamic playlist & on, off & 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}{ \opt{SWCODEC}{
replaygain & on, off & N/A\\ replaygain & on, off & N/A\\
replaygain type & track, album, track shuffle & N/A\\ replaygain type
replaygain noclip & on, off & N/A\\ & track, album, track shuffle
replaygain preamp & -120 to 120 & 0.1dB\\ & N/A\\
replaygain noclip
& on, off & N/A\\
replaygain preamp
& -120 to 120 & 0.1dB\\
% %
crossfade & off, shuffle, track skip, always & N/A\\ crossfade & off, shuffle, track skip, always
crossfade fade in delay & 0 to 7 & seconds\\ & N/A\\
crossfade fade out delay & 0 to 7 & seconds\\ crossfade fade in delay
crossfade fade in duration & 0 to 15 & seconds\\ & 0 to 7 & seconds\\
crossfade fade out duration & 0 to 15 & seconds\\ crossfade fade out delay
crossfade fade out mode & crossfade, mix & N/A\\ & 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 & on, off & N/A\\
crossfeed direct gain & 0 to 60 & 0.1dB\\ crossfeed direct gain
crossfeed cross gain & 30 to 120 & 0.1dB\\ & 0 to 60 & 0.1dB\\
crossfeed hf attenuation & 60 to 240 & 0.1dB\\ crossfeed cross gain
crossfeed hf cutoff & 500 to 2000 & Hz\\ & 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 enabled & on, off & N/A\\
eq precut& 0 to 240 & 0.1dB\\ eq precut & 0 to 240 & 0.1dB\\
eq band 0 cutoff & 0 to 32768 & Hz\\ eq band 0 cutoff & 0 to 32768 & Hz\\
eq band 1 cutoff & 0 to 32768 & Hz\\ eq band 1 cutoff & 0 to 32768 & Hz\\
eq band 2 cutoff & 0 to 32768 & Hz\\ eq band 2 cutoff & 0 to 32768 & Hz\\
eq band 3 cutoff & 0 to 32768 & Hz\\ eq band 3 cutoff & 0 to 32768 & Hz\\
eq band 4 cutoff & 0 to 32768 & Hz\\ eq band 4 cutoff & 0 to 32768 & Hz\\
eq band 0 q & 0 to 64 & N/A\\ eq band 0 q & 0 to 64 & N/A\\
eq band 1 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 2 q & 0 to 64 & N/A\\
eq band 3 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 4 q & 0 to 64 & N/A\\
eq band 0 gain & -240 to 240 & 0.1dB\\ eq band 0 gain & -240 to 240 & 0.1dB\\
eq band 1 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 2 gain & -240 to 240 & 0.1dB\\
eq band 3 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 band 4 gain & -240 to 240 & 0.1dB\\
% %
beep & off, weak, moderate, strong & N/A\\ beep & off, weak, moderate, strong
dircache & on, off & N/A\\ & N/A\\
tagcache\_ram & on, off & N/A\\ dircache & on, off & N/A\\
tagcache\_ram & on, off & N/A\\
}% }%
\opt{recorder,recorderv2fm}{ \opt{recorder,recorderv2fm}{
loudness & 0 to 17 & N/A\\ loudness & 0 to 17 & N/A\\
superbass & on, off & N/A\\ superbass & on, off & N/A\\
auto volume & off, 20ms, 2s, 4s, 8s & seconds\\ auto volume & off, 20ms, 2s, 4s, 8s
mdb enable & on,off & N/A\\ & seconds\\
mdb strength & 0 to 127 & dB\\ mdb enable & on,off & N/A\\
mdb harmonics & 0 to 100 & \%\\ mdb strength & 0 to 127 & dB\\
mdb center & 20 to 300 & Hz\\ mdb harmonics & 0 to 100 & \%\\
mdb shape & 50 to 300 & Hz\\ mdb center & 20 to 300 & Hz\\
mdb shape & 50 to 300 & Hz\\
}% }%
\opt{HAVE_LCD_BITMAP}{ \opt{HAVE_LCD_BITMAP}{
peak meter release & 1 to 126 & ?\\ peak meter release
peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\ & 1 to 126 & ?\\
& 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, &\\ peak meter hold
& 20, 30, 1min & \\ & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\ 15, 20, 30, 1min & N/A \\
& 15, 20, 25, 30, 45, 60, 90, 2min, &\\ peak meter clip hold
& 3min, 5min, 10min, 20min, &\\ & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
& 45min, 90min & \\ 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
peak meter busy & on, off & N/A\\ & N/A \\
peak meter dbfs & on, off & on:~dbfs,\\ peak meter busy & on, off & N/A\\
& & off:~linear\\ peak meter dbfs & on, off & on:~dbfs, off:~linear\\
peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\ peak meter min & 0 to 89 (dB) or 0 to 100 (\%)
peak meter max & 0 to 89 /(dB) or 0 to 100 (\%) & dB or \%\\ & dB or \%\\
statusbar & on, off & N/A\\ peak meter max & 0 to 89 /(dB) or 0 to 100 (\%)
scrollbar & on, off & N/A\\ & dB or \%\\
volume display & graphic, numeric & N/A\\ statusbar & on, off & N/A\\
battery display & graphic, numeric & N/A\\ scrollbar & on, off & N/A\\
font & /path/filename.fnt & N/A\\ volume display
invert & on, off & N/A\\ & graphic, numeric & N/A\\
disk poweroff & on, off & 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}{ \opt{HAVE_LCD_COLOR}{
backdrop & /path/filename.bmp & N/A\\ backdrop & /path/filename.bmp & N/A\\
foreground color & 000000 to FFFFFF & RRGGBB\\ foreground color & 000000 to FFFFFF & RRGGBB\\
background color & 000000 to FFFFFF & RRGGBB\\ background color & 000000 to FFFFFF & RRGGBB\\
} }
\opt{HAVE_REMOTE_LCD}{ \opt{HAVE_REMOTE_LCD}{
rwps & /path/filename.rwps & N/A\\ rwps & /path/filename.rwps & N/A\\
remote contrast & 5 to 63 & N/A\\ remote contrast
remote invert & on, off & N/A\\ & 5 to 63 & N/A\\
remote flip display & on, off & N/A\\ remote invert
remote backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ & on, off & N/A\\
& 6, 7, 8, 9, 10, 15, 20, & \\ remote flip display
& 25, 30, 45, 60, 90 & \\ & on, off & N/A\\
remote backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ remote backlight timeout
& 6, 7, 8, 9, 10, 15, 20, & \\ & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
& 25, 30, 45, 60, 90 & \\ 30, 45, 60, 90 & seconds\\
remote caption backlight & on, off & N/A\\ remote backlight timeout plugged
remote scroll speed & 0 to 15 & N/A\\ & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
remote scroll step & 1 to 160 & N/A\\ 30, 45, 60, 90 & seconds\\
remote scroll delay & 0 to 250 & N/A\\ remote caption backlight
remote bidir limit & 0 to 200 & N/A\\ & on, off & N/A\\
backlight filters first remote keypress & 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}{ \opt{h1xx,h300}{
remote reduce ticking & on, off & N/A\\ remote reduce ticking
& on, off & N/A\\
}% }%
} }
\opt{CONFIG_RTC}{ \opt{CONFIG_RTC}{
time format & 12hour, 24hour & N/A\\ time format & 12hour, 24hour & N/A\\
}% }%
\opt{HAVE_RECORDING}{ \opt{HAVE_RECORDING}{
rec quality & 0 to 7 & 0: small size,\\ rec quality & 0 to 7 & 0: small size, 7: high quality\\
& & 7: high quality\\ rec frequency
rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\ & 48, 44, 32, 24, 22, 16 & kHz\\
rec source & mic, line, spdif & N/A\\ rec source & mic, line, spdif & N/A\\
rec channels & mono, stereo & N/A\\ rec channels & mono, stereo & N/A\\
rec mic gain & 0 to 15 & N/A\\ rec mic gain & 0 to 15 & N/A\\
rec left gain & 0 to 15 & N/A\\ rec left gain & 0 to 15 & N/A\\
rec right gain & 0 to 15 & N/A\\ rec right gain
editable recordings & off,on & N/A\\ & 0 to 15 & N/A\\
rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\ editable recordings
& 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\ & off,on & N/A\\
pre-recording time & off, 1 to 30 & seconds\\ rec timesplit
rec directory & /recordings,current & N/A\\ & 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}{ \opt{CONFIG_TUNER}{
force fm mono & off, on & N/A\\ force fm mono
& off, on & N/A\\
}% }%
\opt{player}{ \opt{player}{
jump scroll & 0 to 5 & N/A\\ jump scroll
jump scroll delay & 0 to 250 & 0.01s\\ & 0 to 5 & N/A\\
} jump scroll delay
& 0 to 250 & 0.01s\\
}%
\bottomrule \bottomrule
\end{longtable} \end{longtable}
\end{center} \end{center}