diff options
author | Martin Arver <martin.arver@gmail.com> | 2006-03-23 15:23:53 +0000 |
---|---|---|
committer | Martin Arver <martin.arver@gmail.com> | 2006-03-23 15:23:53 +0000 |
commit | 55e67fc1dc96e0c709acda0f056a8965008c8e57 (patch) | |
tree | fab220fddcb32adc3f4a3aaa5a2ff72c1b2408b7 /manual/advanced_topics | |
parent | 50b5b65ddc219aa6543872bd4f0ee83d67fff109 (diff) | |
download | rockbox-55e67fc1dc96e0c709acda0f056a8965008c8e57.tar.gz rockbox-55e67fc1dc96e0c709acda0f056a8965008c8e57.zip |
Move config file options to the appendix. These options should be grouped in sections with regards to the type of option (recording, sound etc) they represent
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9208 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/advanced_topics')
-rw-r--r-- | manual/advanced_topics/main.tex | 113 |
1 files changed, 3 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} |
195 | A .cfg file is used to load settings from a plain text file. A .cfg file | 195 | A .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 |
196 | may reside anywhere on the hard disk. The only restriction is that the | ||
197 | filename must end in .cfg | ||
198 | 196 | ||
199 | Hint: 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. | 197 | Hint: 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 |