diff options
author | Martin Arver <martin.arver@gmail.com> | 2006-03-08 15:57:30 +0000 |
---|---|---|
committer | Martin Arver <martin.arver@gmail.com> | 2006-03-08 15:57:30 +0000 |
commit | abe4e7e9e6cd46cfeb3c4437a54b8520e6f8cd4e (patch) | |
tree | 2d4788ee62f6432e934aea59a70a2236d5af8a64 | |
parent | a245e8840e623115f38cfb90b39c69e1ab6a27db (diff) | |
download | rockbox-abe4e7e9e6cd46cfeb3c4437a54b8520e6f8cd4e.tar.gz rockbox-abe4e7e9e6cd46cfeb3c4437a54b8520e6f8cd4e.zip |
Config file section now reflects the wiki.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@8960 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/advanced_topics/main.tex | 322 |
1 files changed, 122 insertions, 200 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 3068a76acb..ce75cb239b 100644 --- a/manual/advanced_topics/main.tex +++ b/manual/advanced_topics/main.tex | |||
@@ -418,219 +418,141 @@ A .cfg file is used to load settings from a plain text file. A .cfg file | |||
418 | may reside anywhere on the hard disk. The only restriction is that the | 418 | may reside anywhere on the hard disk. The only restriction is that the |
419 | filename must end in .cfg | 419 | filename must end in .cfg |
420 | 420 | ||
421 | Hint: Use the ``Write .cfg file'' feature | 421 | Hint: Use the ``Write .cfg file'' feature (Main Menu{}-{\textgreater} General Settings) to save the current settings, then use a text editor to customize the settings file. |
422 | (Main Menu{}-{\textgreater} General Settings) to save the current | ||
423 | settings, then use a text editor to customize the settings file. | ||
424 | 422 | ||
425 | {\bfseries | 423 | \subsection{Format Rules} |
426 | Format Rules} | ||
427 | 424 | ||
428 | \begin{itemize} | 425 | \begin{itemize} |
429 | \item Format: setting: value | 426 | \item Format: \verb+setting: value+ |
430 | \item Each setting must be on a separate line. | 427 | \item Each setting must be on a separate line. |
431 | \item Lines starting with \# are ignored. | 428 | \item Lines starting with \# are ignored. |
432 | \end{itemize} | 429 | \end{itemize} |
433 | {\bfseries | ||
434 | Settings (allowed values) [unit]} | ||
435 | |||
436 | volume (0 {}- 100) | ||
437 | |||
438 | bass ({}-15 {}- 15) | ||
439 | |||
440 | treble ({}-15 {}- 15) | ||
441 | |||
442 | balance ({}-100 {}- 100) | ||
443 | |||
444 | channels (stereo, stereo narrow, stereo wide, mono, mono left, | ||
445 | |||
446 | mono right, karaoke) | ||
447 | |||
448 | shuffle (on, off) | ||
449 | |||
450 | repeat (off, all, one) | ||
451 | |||
452 | play selected (on, off) | ||
453 | |||
454 | resume (off, ask, ask once, on) | ||
455 | |||
456 | scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60) [secs] | ||
457 | |||
458 | scan accel (0 {}- 15) [double scan speed every X seconds] | ||
459 | |||
460 | antiskip (0 {}- 7) [seconds] | ||
461 | |||
462 | volume fade (on, off) | ||
463 | |||
464 | sort case (on, off) | ||
465 | |||
466 | show files (all, supported, music, playlists) | ||
467 | |||
468 | follow playlist (on, off) | ||
469 | |||
470 | playlist viewer icons | ||
471 | |||
472 | (on, off) | ||
473 | |||
474 | playlist viewer track display | ||
475 | |||
476 | (on, off) | ||
477 | |||
478 | recursive directory insert | ||
479 | |||
480 | (on, off) | ||
481 | |||
482 | scroll speed (0 {}- 15) | ||
483 | |||
484 | scroll delay (0 {}- 250) [1/10s] | ||
485 | |||
486 | scroll step (1 {}- 112) [pixels] | ||
487 | |||
488 | bidir limit (0 {}- 200) [\% of screen width] | ||
489 | |||
490 | contrast (0 {}- 63) | ||
491 | |||
492 | backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, | ||
493 | 30, | ||
494 | |||
495 | 45, 60, 90) [seconds] | ||
496 | |||
497 | backlight when plugged | ||
498 | |||
499 | (on, off) | ||
500 | |||
501 | disk spindown (3 {}- 254) [seconds] | ||
502 | |||
503 | battery capacity (1500 {}- 2400) [mAh] | ||
504 | |||
505 | idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60) | ||
506 | [minutes] | ||
507 | |||
508 | lang (/path/filename.lng) | ||
509 | |||
510 | wps (/path/filename.wps) | ||
511 | |||
512 | autocreate bookmarks (on, off) | ||
513 | |||
514 | autoload bookmarks (on, off) | ||
515 | |||
516 | use most{}-recent{}-bookmarks | ||
517 | |||
518 | (on, off) | ||
519 | |||
520 | talk dir (off, number, spell, hover) | ||
521 | |||
522 | talk file (off, number, spell, hover) | ||
523 | |||
524 | talk menu (off, on) | ||
525 | |||
526 | {\bfseries | ||
527 | Recorder{}-specific settings} | ||
528 | |||
529 | loudness (0 {}- 17) | ||
530 | |||
531 | super bass (on, off) | ||
532 | |||
533 | auto volume (off, 0.02, 2, 4, 8) [seconds] | ||
534 | |||
535 | MDB enable (on, off) | ||
536 | |||
537 | MDB strength (0 {--} 127) [dB] | ||
538 | |||
539 | MDB harmonics (0 {--} 100) [\%] | ||
540 | |||
541 | MDB center frequency (20{}-300) [Hz] | ||
542 | |||
543 | MDB shape (50{}-300) [Hz] | ||
544 | 430 | ||
545 | peak meter release (1 {}- 126) | 431 | \subsection{General Settings} |
546 | 432 | \begin{center} | |
547 | peak meter hold (off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, | 433 | \begin{tabular}{@{}lll@{}}\toprule |
548 | 434 | \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule | |
549 | 9, 10, 15, 20, 30, 1min) | 435 | volume & 0 to 100 & \%\\ |
550 | 436 | bass & -15 to +15 & dB\\ | |
551 | peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, | 437 | treble & -15 to +15 &dB\\ |
552 | 438 | balance & -100 to +100 & \%\\ | |
553 | 439 | channels & stereo, stereo narrow, stereo wide, & N/A\\ | |
554 | 45, 60, 90, 2min, 3min, 5min, 10min, 20min, | 440 | & mono, mono left, mono right, karaoke & \\ |
555 | 441 | shuffle & on, off & N/A\\ | |
556 | 45min, 90min) | 442 | repeat & off, all, one & N/A\\ |
557 | 443 | play selected & on, off & N/A\\ | |
558 | peak meter busy (on, off) | 444 | resume & off, ask, ask once, on & N/A\\ |
559 | 445 | scan min step & 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60 & seconds\\ | |
560 | peak meter dbfs (on, off) (on = dbfs, off = linear) | 446 | scan accel & 0 to 15 & seconds\\ |
561 | 447 | antiskip & 0 to 7 & seconds\\ | |
562 | peak meter min (0 {}- 89) [dB] or (0 {}- 100) [\%] | 448 | volume fade & on, off & N/A\\ |
563 | 449 | id3 tag priority & v2-v1, v1-v2 & N/A\\ | |
564 | peak meter max (0 {}- 89) [dB] or (0 {}- 100) [\%] | 450 | sort case & on, off & N/A\\ |
565 | 451 | show files & all, supported, music, playlists & N/A\\ | |
566 | statusbar (on, off) | 452 | follow playlist & on, off & N/A\\ |
567 | 453 | playlist viewer icons & off,on & N/A\\ | |
568 | scrollbar (on, off) | 454 | playlist viewer indices & off,on & N/A\\ |
569 | 455 | playlist viewer track display & track name,full path & N/A\\ | |
570 | volume display (graphic, numeric) | 456 | recursive directory insert & off,on & N/A\\ |
571 | 457 | scroll speed & 1 to 25 & Hz\\ | |
572 | battery display (graphic, numeric) | 458 | scroll delay & 0 to 250 & 1/10s\\ |
573 | 459 | scroll step & 1 to 112 & pixels\\ | |
574 | time format (12hour, 24hour) | 460 | bidir limit & 0 to 200 & \% of screen width\\ |
575 | 461 | contrast & 0 to 63 & N/A\\ | |
576 | font (/path/filename.fnt) | 462 | backlight timeout & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & seconds\\ |
577 | 463 | & 15, 20, 25, 30, 45, 60, 90 & \\ | |
578 | invert (on, off) | 464 | backlight when plugged & on, off & N/A\\ |
579 | 465 | disk spindown & 3 to 254 & seconds\\ | |
580 | deep discharge (on, off) | 466 | battery capacity & 1500 - 3200 & mAh\\ |
581 | 467 | idle poweroff & off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, & minutes\\ | |
582 | trickle charge (on, off) | 468 | & 15, 30, 45, 60 & \\ |
583 | 469 | lang & /path/filename.lng & N/A\\ | |
584 | disk poweroff (on, off) | 470 | wps & /path/filename.wps & N/A\\ |
585 | 471 | autocreate bookmarks & off,on & N/A\\ | |
586 | rec quality (0 {}- 7) (0=smallest size, 7=highest quality) | 472 | autoload bookmarks & off,on & N/A\\ |
587 | 473 | use most-recent-bookmarks & off,on & N/A\\ | |
588 | rec frequency (48, 44, 32, 24, 22, 16) [kHz] | 474 | talk dir & off,number,spell,enter.hover & N/A\\ |
589 | 475 | talk file & off,number,spell & N/A\\ | |
590 | rec source (mic, line, spdif) | 476 | talk menu & off,on & N/A\\\bottomrule |
591 | 477 | \end{tabular} | |
592 | rec channels (mono, stereo) | 478 | \end{center} |
593 | |||
594 | rec mic gain (0 to 15) | ||
595 | |||
596 | rec left gain (0 to 15) | ||
597 | |||
598 | rec right gain (0 to 15) | ||
599 | |||
600 | editable recordings (on,off) | ||
601 | |||
602 | rec timesplit (off, 00:05, 00:10, 00:20, 00:30, 01:00, 01:12, \newline | ||
603 | 01:20, 02:00, 04:00, 06:00, 08:00, 16:00,\newline | ||
604 | 24:00) [hh:mm] | ||
605 | |||
606 | pre{}-recording time (off, 1{}-30) [secs] | ||
607 | |||
608 | rec directory (/recordings, current) | ||
609 | |||
610 | {\bfseries | ||
611 | FM recorder specific settings} | ||
612 | |||
613 | \textmd{force fm mono (on,off)} | ||
614 | |||
615 | \textbf{Example File} | ||
616 | |||
617 | volume: 70 | ||
618 | |||
619 | bass: 11 | ||
620 | |||
621 | treble: 12 | ||
622 | 479 | ||
623 | balance: 0 | 480 | \subsection{Recorder{}-specific settings} |
481 | \begin{center} | ||
482 | \begin{tabular}{@{}lll@{}}\toprule | ||
483 | \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule | ||
484 | loudness & 0 to 17 & N/A\\ | ||
485 | super bass & on,off & N/A\\ | ||
486 | auto volume & off, 20ms, 2s, 4s, 8s & seconds\\ | ||
487 | MDB enable & on,off & N/A\\ | ||
488 | MDB strength & 0 to 127 & dB\\ | ||
489 | MDB harmonics & 0 to 100 & \%\\ | ||
490 | MDB center frequency & 20 to 300 & Hz\\ | ||
491 | MDB shape & 50 to 300 & Hz\\ | ||
492 | peak meter release & 1 to 126 & ?\\ | ||
493 | peak meter hold & off, 200ms, 300ms, 500ms, & N/A \\ | ||
494 | & 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 1min & \\ | ||
495 | peak meter clip hold & on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,& N/A \\ | ||
496 | & 15, 20, 25, 30, 45, 60, 90, 2min, 3min, 5min, &\\ | ||
497 | & 10min, 20min, 45min, 90min & \\ | ||
498 | peak meter busy & on, off & N/A\\ | ||
499 | peak meter dbfs & on, off & on = dbfs,\\ | ||
500 | & & off = linear\\ | ||
501 | peak meter min & 0 to 89 (dB) or 0 to 100 (\%) & dB or \%\\ | ||
502 | peak meter max & 0 to 89 /dB) or 0 to 100 (\%) & dB or \%\\ | ||
503 | statusbar & on, off & N/A\\ | ||
504 | scrollbar & on, off & N/A\\ | ||
505 | volume display & graphic, numeric & N/A\\ | ||
506 | battery display & graphic, numeric & N/A\\ | ||
507 | time format & 12hour, 24hour & N/A\\ | ||
508 | font & /path/filename.fnt & N/A\\ | ||
509 | invert & on, off & N/A\\ | ||
510 | deep discharge & on, off & N/A\\ | ||
511 | trickle charge & on, off & N/A\\ | ||
512 | disk poweroff & on, off & N/A\\ | ||
513 | rec quality & 0 to 7 & 0=smallest size, 7=highest quality\\ | ||
514 | rec frequency & 48, 44, 32, 24, 22, 16 & kHz\\ | ||
515 | rec source & mic, line, spdif & N/A\\ | ||
516 | rec channels & mono, stereo & N/A\\ | ||
517 | rec mic gain & 0 to 15 & N/A\\ | ||
518 | rec left gain & 0 to 15 & N/A\\ | ||
519 | rec right gain & 0 to 15 & N/A\\ | ||
520 | editable recordings & off,on & N/A\\ | ||
521 | rec timesplit & off, 0:05, 0:10, 0:15, 0:30, 1:00, & h:mm\\ | ||
522 | & 2:00, 4:00, 6:00, 8:00, 16:00, 24:00 & \\ | ||
523 | pre-recording time & off, 1 to 30 & s\\ | ||
524 | rec directory & /recordings,current & N/A\\\bottomrule | ||
525 | \end{tabular} | ||
526 | \end{center} | ||
624 | 527 | ||
625 | time format: 12hour | 528 | \subsection{FM recorder specific settings} |
529 | \begin{center} | ||
530 | \begin{tabular}{@{}lll@{}}\toprule | ||
531 | \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\\midrule | ||
532 | Force FM mono & off,on & N/A\\\bottomrule | ||
533 | \end{tabular} | ||
534 | \end{center} | ||
626 | 535 | ||
627 | volume display: numeric | 536 | \subsection{Example File} |
537 | \begin{verbatim} | ||
538 | volume: 70 | ||
539 | |||
540 | bass: 11 | ||
628 | 541 | ||
629 | show files: supported | 542 | treble: 12 |
543 | |||
544 | balance: 0 | ||
545 | |||
546 | time format: 12hour | ||
630 | 547 | ||
631 | wps: /.rockbox/car.wps | 548 | volume display: numeric |
632 | 549 | ||
633 | lang: /.rockbox/afrikaans.lng | 550 | show files: supported |
551 | |||
552 | wps: /.rockbox/car.wps | ||
553 | |||
554 | lang: /.rockbox/afrikaans.lng | ||
555 | \end{verbatim} | ||
634 | 556 | ||
635 | \section{\label{ref:PartISection1}Differences between binaries} | 557 | \section{\label{ref:PartISection1}Differences between binaries} |
636 | There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge. | 558 | There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge. |