summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2006-09-17 20:47:10 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2006-09-17 20:47:10 +0000
commit9723cb7fb1020c2aeb2cf36d611a31c43bf0dfc6 (patch)
tree501c3b01fd70d85154b53b4cc2b2cde93f72f8f0 /manual
parente03fcc2594ac383949ed7b60ccc7535c154851fb (diff)
downloadrockbox-9723cb7fb1020c2aeb2cf36d611a31c43bf0dfc6.tar.gz
rockbox-9723cb7fb1020c2aeb2cf36d611a31c43bf0dfc6.zip
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
Diffstat (limited to 'manual')
-rw-r--r--manual/appendix/appendix.tex4
-rw-r--r--manual/appendix/config_file_options.tex386
2 files changed, 222 insertions, 168 deletions
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 @@
5 5
6\input{appendix/wps_tags.tex} 6\input{appendix/wps_tags.tex}
7 7
8\chapter{\label{ref:config_file_options}Config file options} 8\input{appendix/config_file_options.tex}
9\ifpdfoutput{\input{appendix/config_file_options.tex}}
10{\fixme{The config file options are omitted in the HTML version of the manual for now.}}
11 9
12\chapter{User feedback}\label{sec:feedback} 10\chapter{User feedback}\label{sec:feedback}
13\section{Bug reports} 11\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 @@
1% $Id$ % 1% $Id$ %
2\section{Settings} 2\chapter{\label{ref:config_file_options}Config file options}
3\begin{center} 3\begin{center}
4 \begin{longtable}{@{}lll@{}}\toprule 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 \begin{longtable}{@{}>{\raggedright}p{.35\textwidth}@{}>{\raggedright}p{.4\textwidth}@{}p{.25\textwidth}@{}}
9 \toprule
5 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\ 10 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
6 \midrule 11 \midrule\localendhead % endhead breaks with htlatex
7 \endhead 12 volume & \opt{player}{-78 to +18}%
8 volume & \opt{player}{-78 to +18}% 13 \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}%
9 \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}% 14 \opt{h1xx,h300}{-84 to 0}%
10 \opt{h1xx,h300}{-84 to 0}% 15 \opt{ipodnano}{-72 to +6}%
11 \opt{ipodnano}{-72 to +6}% 16 \opt{ipodvideo}{-57 to +6}%
12 \opt{ipodvideo}{-57 to +6}% 17 \opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}%
13 \opt{ipodcolor,x5}{-\fixme{??} to +\fixme{??}}% 18 & dB\\
14 & dB\\
15 \nopt{x5}{% 19 \nopt{x5}{%
16 bass & \opt{MASCODEC}{-15 to +15}% 20 bass & \opt{MASCODEC}{-15 to +15}%
17 \opt{h1xx,h300}{0 to +24}% 21 \opt{h1xx,h300}{0 to +24}%
18 \opt{ipod}{-6 to +9}% 22 \opt{ipod}{-6 to +9}%
19 & dB\\ 23 & dB\\
20 treble & \opt{MASCODEC}{-15 to +15}% 24 treble & \opt{MASCODEC}{-15 to +15}%
21 \opt{h1xx,h300}{0 to +6}% 25 \opt{h1xx,h300}{0 to +6}%
22 \opt{ipod}{-6 to +9}% 26 \opt{ipod}{-6 to +9}%
23 & dB\\ 27 & dB\\
24 }% 28 }%
25 balance & -100 to +100 & \%\\ 29 balance & -100 to +100 & \%\\
26 channels & stereo, mono, custom & N/A\\ 30 channels & stereo, mono, custom, mono left, mono right, karaoke
27 & mono left, mono right, karaoke & \\ 31 & N/A\\
28 shuffle & on, off & N/A\\ 32 shuffle & on, off & N/A\\
29 repeat & off, all, one, shuffle, ab & N/A\\ 33 repeat & off, all, one, shuffle, ab
30 play selected & on, off & N/A\\ 34 & N/A\\
31 resume & on, off & N/A\\ 35 play selected & on, off & N/A\\
32 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, & seconds\\ 36 resume & on, off & N/A\\
33 & 20, 25, 30, 45, 60 &\\ 37 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60
34 scan accel & 0 to 15 & seconds\\ 38 & seconds\\
35 antiskip & 0 to 7 & seconds\\ 39 scan accel & 0 to 15 & seconds\\
36 volume fade & on, off & N/A\\ 40 antiskip & 0 to 7 & seconds\\
37 id3 tag priority & v2-v1, v1-v2 & N/A\\ 41 volume fade & on, off & N/A\\
38 sort case & on, off & N/A\\ 42 id3 tag priority & v2-v1, v1-v2 & N/A\\
39 show files & all, supported, music, playlists & N/A\\ 43 sort case & on, off & N/A\\
40 follow playlist & on, off & N/A\\ 44 show files & all, supported, music, playlists
41 playlist viewer icons & on, off & N/A\\ 45 & N/A\\
42 playlist viewer indices & on, off & N/A\\ 46 follow playlist & on, off & N/A\\
43 playlist viewer track display & track name,full path & N/A\\ 47 playlist viewer icons
44 recursive directory insert & on, off & N/A\\ 48 & on, off & N/A\\
45 scroll speed & 1 to 25 & Hz\\ 49 playlist viewer indices
46 scroll delay & 0 to 250 & 1/10s\\ 50 & on, off & N/A\\
47 scroll step & 1 to 112 & pixels\\ 51 playlist viewer track display
48 bidir limit & 0 to 200 & \% screen\\ 52 & track name,full path
49 contrast & 0 to 63 & N/A\\ 53 & N/A\\
50 backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ 54 recursive directory insert
51 & 6, 7, 8, 9, 10, 15, 20, & \\ 55 & on, off & N/A\\
52 & 25, 30, 45, 60, 90 & \\ 56 scroll speed & 1 to 25 & Hz\\
53 backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ 57 scroll delay & 0 to 250 & 1/10s\\
54 & 6, 7, 8, 9, 10, 15, 20, & \\ 58 scroll step & 1 to 112 & pixels\\
55 & 25, 30, 45, 60, 90 & \\ 59 bidir limit & 0 to 200 & \% screen\\
56 disk spindown & 3 to 254 & seconds\\ 60 contrast & 0 to 63 & N/A\\
57 battery capacity & 1500 - 3200 & mAh\\ 61 backlight timeout
58 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\ 62 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
59 & 15, 30, 45, 60 & \\ 63 45, 60, 90 & seconds\\
60 lang & /path/filename.lng & N/A\\ 64 backlight timeout plugged
61 wps & /path/filename.wps & N/A\\ 65 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
62 autocreate bookmarks & off,on & N/A\\ 66 45, 60, 90 & seconds\\
63 autoload bookmarks & off,on & N/A\\ 67 disk spindown & 3 to 254 & seconds\\
64 use most-recent-bookmarks & off,on & N/A\\ 68 battery capacity
65 talk dir & off, number, spell, enter, hover & N/A\\ 69 & 1500 - 3200 & mAh\\
66 talk file & off, number, spell & N/A\\ 70 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60
67 talk menu & off, on & N/A\\ 71 & minutes\\
68 tagcache\_autoupdate & on, off & N/A\\ 72 lang & /path/filename.lng & N/A\\
69 warn when erasing dynamic playlist & on, off & N/A\\ 73 wps & /path/filename.wps & N/A\\
74 autocreate bookmarks
75 & off, on & N/A\\
76 autoload bookmarks
77 & off, on & N/A\\
78 use most-recent-bookmarks
79 & off, on & N/A\\
80 talk dir & off, number, spell, enter, hover
81 & N/A\\
82 talk file & off, number, spell& N/A\\
83 talk menu & off, on & N/A\\
84 tagcache\_autoupdate
85 & on, off & N/A\\
86 warn when erasing dynamic playlist
87 & on, off & N/A\\
70% 88%
71 \opt{SWCODEC}{ 89 \opt{SWCODEC}{
72 replaygain & on, off & N/A\\ 90 replaygain & on, off & N/A\\
73 replaygain type & track, album, track shuffle & N/A\\ 91 replaygain type
74 replaygain noclip & on, off & N/A\\ 92 & track, album, track shuffle
75 replaygain preamp & -120 to 120 & 0.1dB\\ 93 & N/A\\
94 replaygain noclip
95 & on, off & N/A\\
96 replaygain preamp
97 & -120 to 120 & 0.1dB\\
76% 98%
77 crossfade & off, shuffle, track skip, always & N/A\\ 99 crossfade & off, shuffle, track skip, always
78 crossfade fade in delay & 0 to 7 & seconds\\ 100 & N/A\\
79 crossfade fade out delay & 0 to 7 & seconds\\ 101 crossfade fade in delay
80 crossfade fade in duration & 0 to 15 & seconds\\ 102 & 0 to 7 & seconds\\
81 crossfade fade out duration & 0 to 15 & seconds\\ 103 crossfade fade out delay
82 crossfade fade out mode & crossfade, mix & N/A\\ 104 & 0 to 7 & seconds\\
105 crossfade fade in duration
106 & 0 to 15 & seconds\\
107 crossfade fade out duration
108 & 0 to 15 & seconds\\
109 crossfade fade out mode
110 & crossfade, mix & N/A\\
83% 111%
84 crossfeed & on, off & N/A\\ 112 crossfeed & on, off & N/A\\
85 crossfeed direct gain & 0 to 60 & 0.1dB\\ 113 crossfeed direct gain
86 crossfeed cross gain & 30 to 120 & 0.1dB\\ 114 & 0 to 60 & 0.1dB\\
87 crossfeed hf attenuation & 60 to 240 & 0.1dB\\ 115 crossfeed cross gain
88 crossfeed hf cutoff & 500 to 2000 & Hz\\ 116 & 30 to 120 & 0.1dB\\
117 crossfeed hf attenuation
118 & 60 to 240 & 0.1dB\\
119 crossfeed hf cutoff
120 & 500 to 2000 & Hz\\
89% 121%
90 eq enabled & on, off & N/A\\ 122 eq enabled & on, off & N/A\\
91 eq precut& 0 to 240 & 0.1dB\\ 123 eq precut & 0 to 240 & 0.1dB\\
92 eq band 0 cutoff & 0 to 32768 & Hz\\ 124 eq band 0 cutoff & 0 to 32768 & Hz\\
93 eq band 1 cutoff & 0 to 32768 & Hz\\ 125 eq band 1 cutoff & 0 to 32768 & Hz\\
94 eq band 2 cutoff & 0 to 32768 & Hz\\ 126 eq band 2 cutoff & 0 to 32768 & Hz\\
95 eq band 3 cutoff & 0 to 32768 & Hz\\ 127 eq band 3 cutoff & 0 to 32768 & Hz\\
96 eq band 4 cutoff & 0 to 32768 & Hz\\ 128 eq band 4 cutoff & 0 to 32768 & Hz\\
97 eq band 0 q & 0 to 64 & N/A\\ 129 eq band 0 q & 0 to 64 & N/A\\
98 eq band 1 q & 0 to 64 & N/A\\ 130 eq band 1 q & 0 to 64 & N/A\\
99 eq band 2 q & 0 to 64 & N/A\\ 131 eq band 2 q & 0 to 64 & N/A\\
100 eq band 3 q & 0 to 64 & N/A\\ 132 eq band 3 q & 0 to 64 & N/A\\
101 eq band 4 q & 0 to 64 & N/A\\ 133 eq band 4 q & 0 to 64 & N/A\\
102 eq band 0 gain & -240 to 240 & 0.1dB\\ 134 eq band 0 gain & -240 to 240 & 0.1dB\\
103 eq band 1 gain & -240 to 240 & 0.1dB\\ 135 eq band 1 gain & -240 to 240 & 0.1dB\\
104 eq band 2 gain & -240 to 240 & 0.1dB\\ 136 eq band 2 gain & -240 to 240 & 0.1dB\\
105 eq band 3 gain & -240 to 240 & 0.1dB\\ 137 eq band 3 gain & -240 to 240 & 0.1dB\\
106 eq band 4 gain & -240 to 240 & 0.1dB\\ 138 eq band 4 gain & -240 to 240 & 0.1dB\\
107% 139%
108 beep & off, weak, moderate, strong & N/A\\ 140 beep & off, weak, moderate, strong
109 dircache & on, off & N/A\\ 141 & N/A\\
110 tagcache\_ram & on, off & N/A\\ 142 dircache & on, off & N/A\\
143 tagcache\_ram & on, off & N/A\\
111 }% 144 }%
112 145
113 \opt{recorder,recorderv2fm}{ 146 \opt{recorder,recorderv2fm}{
114 loudness & 0 to 17 & N/A\\ 147 loudness & 0 to 17 & N/A\\
115 superbass & on, off & N/A\\ 148 superbass & on, off & N/A\\
116 auto volume & off, 20ms, 2s, 4s, 8s & seconds\\ 149 auto volume & off, 20ms, 2s, 4s, 8s
117 mdb enable & on,off & N/A\\ 150 & seconds\\
118 mdb strength & 0 to 127 & dB\\ 151 mdb enable & on,off & N/A\\
119 mdb harmonics & 0 to 100 & \%\\ 152 mdb strength & 0 to 127 & dB\\
120 mdb center & 20 to 300 & Hz\\ 153 mdb harmonics & 0 to 100 & \%\\
121 mdb shape & 50 to 300 & Hz\\ 154 mdb center & 20 to 300 & Hz\\
155 mdb shape & 50 to 300 & Hz\\
122 }% 156 }%
123 157
124 \opt{HAVE_LCD_BITMAP}{ 158 \opt{HAVE_LCD_BITMAP}{
125 peak meter release & 1 to 126 & ?\\ 159 peak meter release
126 peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\ 160 & 1 to 126 & ?\\
127 & 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, &\\ 161 peak meter hold
128 & 20, 30, 1min & \\ 162 & off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
129 peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\ 163 15, 20, 30, 1min & N/A \\
130 & 15, 20, 25, 30, 45, 60, 90, 2min, &\\ 164 peak meter clip hold
131 & 3min, 5min, 10min, 20min, &\\ 165 & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45,
132 & 45min, 90min & \\ 166 60, 90, 2min, 3min, 5min, 10min, 20min, 45min, 90min
133 peak meter busy & on, off & N/A\\ 167 & N/A \\
134 peak meter dbfs & on, off & on:~dbfs,\\ 168 peak meter busy & on, off & N/A\\
135 & & off:~linear\\ 169 peak meter dbfs & on, off & on:~dbfs, off:~linear\\
136 peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\ 170 peak meter min & 0 to 89 (dB) or 0 to 100 (\%)
137 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%) & dB or \%\\ 171 & dB or \%\\
138 statusbar & on, off & N/A\\ 172 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%)
139 scrollbar & on, off & N/A\\ 173 & dB or \%\\
140 volume display & graphic, numeric & N/A\\ 174 statusbar & on, off & N/A\\
141 battery display & graphic, numeric & N/A\\ 175 scrollbar & on, off & N/A\\
142 font & /path/filename.fnt & N/A\\ 176 volume display
143 invert & on, off & N/A\\ 177 & graphic, numeric & N/A\\
144 disk poweroff & on, off & N/A\\ 178 battery display
179 & graphic, numeric & N/A\\
180 font & /path/filename.fnt & N/A\\
181 invert & on, off & N/A\\
182 disk poweroff & on, off & N/A\\
145 }% 183 }%
146 184
147 \opt{HAVE_LCD_COLOR}{ 185 \opt{HAVE_LCD_COLOR}{
148 backdrop & /path/filename.bmp & N/A\\ 186 backdrop & /path/filename.bmp & N/A\\
149 foreground color & 000000 to FFFFFF & RRGGBB\\ 187 foreground color & 000000 to FFFFFF & RRGGBB\\
150 background color & 000000 to FFFFFF & RRGGBB\\ 188 background color & 000000 to FFFFFF & RRGGBB\\
151 } 189 }
152 190
153 \opt{HAVE_REMOTE_LCD}{ 191 \opt{HAVE_REMOTE_LCD}{
154 rwps & /path/filename.rwps & N/A\\ 192 rwps & /path/filename.rwps & N/A\\
155 remote contrast & 5 to 63 & N/A\\ 193 remote contrast
156 remote invert & on, off & N/A\\ 194 & 5 to 63 & N/A\\
157 remote flip display & on, off & N/A\\ 195 remote invert
158 remote backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\ 196 & on, off & N/A\\
159 & 6, 7, 8, 9, 10, 15, 20, & \\ 197 remote flip display
160 & 25, 30, 45, 60, 90 & \\ 198 & on, off & N/A\\
161 remote backlight timeout plugged & off, on, 1, 2, 3, 4, 5, & seconds\\ 199 remote backlight timeout
162 & 6, 7, 8, 9, 10, 15, 20, & \\ 200 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
163 & 25, 30, 45, 60, 90 & \\ 201 30, 45, 60, 90 & seconds\\
164 remote caption backlight & on, off & N/A\\ 202 remote backlight timeout plugged
165 remote scroll speed & 0 to 15 & N/A\\ 203 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
166 remote scroll step & 1 to 160 & N/A\\ 204 30, 45, 60, 90 & seconds\\
167 remote scroll delay & 0 to 250 & N/A\\ 205 remote caption backlight
168 remote bidir limit & 0 to 200 & N/A\\ 206 & on, off & N/A\\
169 backlight filters first remote keypress & on, off & N/A\\ 207 remote scroll speed
208 & 0 to 15 & N/A\\
209 remote scroll step
210 & 1 to 160 & N/A\\
211 remote scroll delay
212 & 0 to 250 & N/A\\
213 remote bidir limit
214 & 0 to 200 & N/A\\
215 backlight filters first remote keypress
216 & on, off & N/A\\
170 \opt{h1xx,h300}{ 217 \opt{h1xx,h300}{
171 remote reduce ticking & on, off & N/A\\ 218 remote reduce ticking
219 & on, off & N/A\\
172 }% 220 }%
173 } 221 }
174 \opt{CONFIG_RTC}{ 222 \opt{CONFIG_RTC}{
175 time format & 12hour, 24hour & N/A\\ 223 time format & 12hour, 24hour & N/A\\
176 }% 224 }%
177 \opt{HAVE_RECORDING}{ 225 \opt{HAVE_RECORDING}{
178 rec quality & 0 to 7 & 0: small size,\\ 226 rec quality & 0 to 7 & 0: small size, 7: high quality\\
179 & & 7: high quality\\ 227 rec frequency
180 rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\ 228 & 48, 44, 32, 24, 22, 16 & kHz\\
181 rec source & mic, line, spdif & N/A\\ 229 rec source & mic, line, spdif & N/A\\
182 rec channels & mono, stereo & N/A\\ 230 rec channels & mono, stereo & N/A\\
183 rec mic gain & 0 to 15 & N/A\\ 231 rec mic gain & 0 to 15 & N/A\\
184 rec left gain & 0 to 15 & N/A\\ 232 rec left gain & 0 to 15 & N/A\\
185 rec right gain & 0 to 15 & N/A\\ 233 rec right gain
186 editable recordings & off,on & N/A\\ 234 & 0 to 15 & N/A\\
187 rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\ 235 editable recordings
188 & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\ 236 & off,on & N/A\\
189 pre-recording time & off, 1 to 30 & seconds\\ 237 rec timesplit
190 rec directory & /recordings,current & N/A\\ 238 & off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00,
239 8:00, 16:00, 24:00 & h:mm\\
240 pre-recording time
241 & off, 1 to 30 & seconds\\
242 rec directory
243 & /recordings,current & N/A\\
191 }% 244 }%
192 \opt{CONFIG_TUNER}{ 245 \opt{CONFIG_TUNER}{
193 force fm mono & off, on & N/A\\ 246 force fm mono
247 & off, on & N/A\\
194 }% 248 }%
195 \opt{player}{ 249 \opt{player}{
196 jump scroll & 0 to 5 & N/A\\ 250 jump scroll
197 jump scroll delay & 0 to 250 & 0.01s\\ 251 & 0 to 5 & N/A\\
198 } 252 jump scroll delay
253 & 0 to 250 & 0.01s\\
254 }%
199 \bottomrule 255 \bottomrule
200 \end{longtable} 256 \end{longtable}
201\end{center} 257\end{center}
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-22 11:31:17 +0000