summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/advanced_topics/main.tex113
-rw-r--r--manual/appendix/appendix.tex3
-rw-r--r--manual/appendix/config_file_options.tex111
3 files changed, 117 insertions, 110 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 91008aec7b..e723ca3f23 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -178,7 +178,7 @@ If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get
178%\end{verbatim} 178%\end{verbatim}
179} 179}
180 180
181\opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodnano}{ 181\opt{HAVE_LCD_BITMAP}{
182% \begin{verbatim} 182% \begin{verbatim}
183 %s%?it<%?in<%in. |>%it|%fn> 183 %s%?it<%?in<%in. |>%it|%fn>
184 %s%?ia<%ia|%?d2<%d2|(root)>> 184 %s%?ia<%ia|%?d2<%d2|(root)>>
@@ -192,11 +192,9 @@ If you haven't selected a .wps file in the \fname{/.rockbox} directory, you get
192} 192}
193 193
194\section{\label{ref:SettingsFile}Making your own settings file} 194\section{\label{ref:SettingsFile}Making your own settings file}
195A .cfg file is used to load settings from a plain text file. A .cfg file 195A .cfg file is used to load settings from a plain text file. A .cfg file may reside anywhere on the hard disk. The only restriction is that the filename must end in .cfg
196may reside anywhere on the hard disk. The only restriction is that the
197filename must end in .cfg
198 196
199Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} General Settings}) to save the current settings, then use a text editor to customize the settings file. 197Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} General Settings}) to save the current settings, then use a text editor to customize the settings file. See appendix \ref{ref:config_file_options} for the full reference of available options.
200 198
201\subsection{Format Rules} 199\subsection{Format Rules}
202 200
@@ -206,111 +204,6 @@ Hint: Use the ``Write .cfg file'' feature \textbf({Main Menu{}-{\textgreater} Ge
206\item Lines starting with \# are ignored. 204\item Lines starting with \# are ignored.
207\end{itemize} 205\end{itemize}
208 206
209\subsection{General Settings}
210\begin{center}
211 \begin{longtable}{@{}lll@{}}\toprule
212 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
213 volume & 0 to 100 & \%\\
214 bass & -15 to +15 & dB\\
215 treble & -15 to +15 &dB\\
216 balance & -100 to +100 & \%\\
217 channels & stereo, stereo narrow, stereo wide, & N/A\\
218 & mono, mono left, mono right, karaoke & \\
219 shuffle & on, off & N/A\\
220 repeat & off, all, one & N/A\\
221 play selected & on, off & N/A\\
222 resume & off, ask, ask once, on & N/A\\
223 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60 & seconds\\
224 scan accel & 0 to 15 & seconds\\
225 antiskip & 0 to 7 & seconds\\
226 volume fade & on, off & N/A\\
227 id3 tag priority & v2-v1, v1-v2 & N/A\\
228 sort case & on, off & N/A\\
229 show files & all, supported, music, playlists & N/A\\
230 follow playlist & on, off & N/A\\
231 playlist viewer icons & off,on & N/A\\
232 playlist viewer indices & off,on & N/A\\
233 playlist viewer track display & track name,full path & N/A\\
234 recursive directory insert & off,on & N/A\\
235 scroll speed & 1 to 25 & Hz\\
236 scroll delay & 0 to 250 & 1/10s\\
237 scroll step & 1 to 112 & pixels\\
238 bidir limit & 0 to 200 & \% of screen width\\
239 contrast & 0 to 63 & N/A\\
240 backlight timeout & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & seconds\\
241 & 15, 20, 25, 30, 45, 60, 90 & \\
242 backlight when plugged & on, off & N/A\\
243 disk spindown & 3 to 254 & seconds\\
244 battery capacity & 1500 - 3200 & mAh\\
245 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\
246 & 15, 30, 45, 60 & \\
247 lang & /path/filename.lng & N/A\\
248 wps & /path/filename.wps & N/A\\
249 autocreate bookmarks & off,on & N/A\\
250 autoload bookmarks & off,on & N/A\\
251 use most-recent-bookmarks & off,on & N/A\\
252 talk dir & off,number,spell,enter.hover & N/A\\
253 talk file & off,number,spell & N/A\\
254 talk menu & off,on & N/A\\\bottomrule
255 \end{longtable}
256\end{center}
257
258\subsection{Recorder{}-specific settings}
259\begin{center}
260 \begin{longtable}{@{}lll@{}}\toprule
261 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
262 loudness & 0 to 17 & N/A\\
263 super bass & on,off & N/A\\
264 auto volume & off, 20ms, 2s, 4s, 8s & seconds\\
265 MDB enable & on,off & N/A\\
266 MDB strength & 0 to 127 & dB\\
267 MDB harmonics & 0 to 100 & \%\\
268 MDB center frequency & 20 to 300 & Hz\\
269 MDB shape & 50 to 300 & Hz\\
270 peak meter release & 1 to 126 & ?\\
271 peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\
272 & 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 1min & \\
273 peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\
274 & 15, 20, 25, 30, 45, 60, 90, 2min, 3min, 5min, &\\
275 & 10min, 20min, 45min, 90min & \\
276 peak meter busy & on, off & N/A\\
277 peak meter dbfs & on, off & on = dbfs,\\
278 & & off = linear\\
279 peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\
280 peak meter max & 0 to 89 /dB) or 0 to 100 (\%) & dB or \%\\
281 statusbar & on, off & N/A\\
282 scrollbar & on, off & N/A\\
283 volume display & graphic, numeric & N/A\\
284 battery display & graphic, numeric & N/A\\
285 time format & 12hour, 24hour & N/A\\
286 font & /path/filename.fnt & N/A\\
287 invert & on, off & N/A\\
288 deep discharge & on, off & N/A\\
289 trickle charge & on, off & N/A\\
290 disk poweroff & on, off & N/A\\
291 rec quality & 0 to 7 & 0=smallest size, 7=highest quality\\
292 rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\
293 rec source & mic, line, spdif & N/A\\
294 rec channels & mono, stereo & N/A\\
295 rec mic gain & 0 to 15 & N/A\\
296 rec left gain & 0 to 15 & N/A\\
297 rec right gain & 0 to 15 & N/A\\
298 editable recordings & off,on & N/A\\
299 rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\
300 & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\
301 pre-recording time & off, 1 to 30 & s\\
302 rec directory & /recordings,current & N/A\\\bottomrule
303 \end{longtable}
304\end{center}
305
306\subsection{FM recorder specific settings}
307\begin{center}
308 \begin{tabular}{@{}lll@{}}\toprule
309 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
310 Force FM mono & off,on & N/A\\\bottomrule
311 \end{tabular}
312\end{center}
313
314\subsection{Example File} 207\subsection{Example File}
315\begin{verbatim} 208\begin{verbatim}
316 volume: 70 209 volume: 70
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex
index 997aef6650..be619d0fc9 100644
--- a/manual/appendix/appendix.tex
+++ b/manual/appendix/appendix.tex
@@ -24,6 +24,9 @@
24\chapter{\label{ref:wps_tags}WPS Tags} 24\chapter{\label{ref:wps_tags}WPS Tags}
25\input{appendix/wps_tags.tex} 25\input{appendix/wps_tags.tex}
26 26
27\chapter{\label{ref:config_file_options}Config file options}
28\input{appendix/config_file_options.tex}
29
27\chapter{LCD Screen Sizes} 30\chapter{LCD Screen Sizes}
28\begin{center} 31\begin{center}
29 \begin{tabular}{@{}lll@{}}\toprule 32 \begin{tabular}{@{}lll@{}}\toprule
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
new file mode 100644
index 0000000000..71bd9c345c
--- /dev/null
+++ b/manual/appendix/config_file_options.tex
@@ -0,0 +1,111 @@
1\section{Settings}
2\begin{center}
3 \begin{longtable}{@{}lll@{}}\toprule
4 \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule
5 volume & 0 to 100 & \%\\
6 bass & -15 to +15 & dB\\
7 treble & -15 to +15 &dB\\
8 balance & -100 to +100 & \%\\
9 channels & stereo, stereo narrow, & n/a\\
10 & stereo wide, & \\
11 & mono, mono left, & \\
12 & mono right, karaoke & \\
13 shuffle & on, off & N/A\\
14 repeat & off, all, one & N/A\\
15 play selected & on, off & N/A\\
16 resume & off, ask, ask once, on & N/A\\
17 scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, & seconds\\
18 & 20, 25, 30, 45, 60 &\\
19 scan accel & 0 to 15 & seconds\\
20 antiskip & 0 to 7 & seconds\\
21 volume fade & on, off & N/A\\
22 id3 tag priority & v2-v1, v1-v2 & N/A\\
23 sort case & on, off & N/A\\
24 show files & all, supported, music, playlists & N/A\\
25 follow playlist & on, off & N/A\\
26 playlist viewer icons & off,on & N/A\\
27 playlist viewer indices & off,on & N/A\\
28 playlist viewer track display & track name,full path & N/A\\
29 recursive directory insert & off,on & N/A\\
30 scroll speed & 1 to 25 & Hz\\
31 scroll delay & 0 to 250 & 1/10s\\
32 scroll step & 1 to 112 & pixels\\
33 bidir limit & 0 to 200 & \% of \\
34 & & screen width\\
35 contrast & 0 to 63 & N/A\\
36 backlight timeout & off, on, 1, 2, 3, 4, 5, & seconds\\
37 & 6, 7, 8, 9, 10, 15, 20, & \\
38 & 25, 30, 45, 60, 90 & \\
39 backlight when plugged & on, off & N/A\\
40 disk spindown & 3 to 254 & seconds\\
41 battery capacity & 1500 - 3200 & mAh\\
42 idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\
43 & 15, 30, 45, 60 & \\
44 lang & /path/filename.lng & N/A\\
45 wps & /path/filename.wps & N/A\\
46 autocreate bookmarks & off,on & N/A\\
47 autoload bookmarks & off,on & N/A\\
48 use most-recent-bookmarks & off,on & N/A\\
49 talk dir & off,number,spell,enter.hover & N/A\\
50 talk file & off,number,spell & N/A\\
51 talk menu & off,on & N/A\\
52
53 \opt{recorder,recorderv2fm}{
54 loudness & 0 to 17 & N/A\\
55 super bass & on,off & N/A\\
56 auto volume & off, 20ms, 2s, 4s, 8s & seconds\\
57 MDB enable & on,off & N/A\\
58 MDB strength & 0 to 127 & dB\\
59 MDB harmonics & 0 to 100 & \%\\
60 MDB center frequency & 20 to 300 & Hz\\
61 MDB shape & 50 to 300 & Hz\\
62 deep discharge & on, off & N/A\\
63 trickle charge & on, off & N/A\\
64 }
65
66 \opt{HAVE_LCD_BITMAP}{
67 peak meter release & 1 to 126 & ?\\
68 peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\
69 & 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, &\\
70 & 20, 30, 1min & \\
71 peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\
72 & 15, 20, 25, 30, 45, 60, 90, 2min, &\\
73 & 3min, 5min, 10min, 20min, &\\
74 & 45min, 90min & \\
75 peak meter busy & on, off & N/A\\
76 peak meter dbfs & on, off & on = dbfs,\\
77 & & off = linear\\
78 peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\
79 peak meter max & 0 to 89 /(dB) or 0 to 100 (\%) & dB or \%\\
80 statusbar & on, off & N/A\\
81 scrollbar & on, off & N/A\\
82 volume display & graphic, numeric & N/A\\
83 battery display & graphic, numeric & N/A\\
84 font & /path/filename.fnt & N/A\\
85 invert & on, off & N/A\\
86 disk poweroff & on, off & N/A\\
87 }
88 \opt{CONFIG_RTC}{
89 time format & 12hour, 24hour & N/A\\
90 }
91 \opt{HAVE_RECORDING}{
92 rec quality & 0 to 7 & 0=smallest size,\\
93 & & 7=highest quality\\
94 rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\
95 rec source & mic, line, spdif & N/A\\
96 rec channels & mono, stereo & N/A\\
97 rec mic gain & 0 to 15 & N/A\\
98 rec left gain & 0 to 15 & N/A\\
99 rec right gain & 0 to 15 & N/A\\
100 editable recordings & off,on & N/A\\
101 rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\
102 & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\
103 pre-recording time & off, 1 to 30 & s\\
104 rec directory & /recordings,current & N/A\\
105 }
106 \opt{CONFIG_TUNER}{
107 Force FM mono & off,on & N/A\\
108 }
109 \bottomrule
110 \end{longtable}
111\end{center}