summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2009-06-20 22:44:36 +0000
committerMarianne Arnold <pixelma@rockbox.org>2009-06-20 22:44:36 +0000
commit1f07151110ed32bf3f443b9c509bec463c50412d (patch)
tree044d5c833b4667ef124b4e61663451ac447422cf /manual
parent05e3aad62086e56197c917a68aef8d32a6f33dda (diff)
downloadrockbox-1f07151110ed32bf3f443b9c509bec463c50412d.tar.gz
rockbox-1f07151110ed32bf3f443b9c509bec463c50412d.tar.bz2
rockbox-1f07151110ed32bf3f443b9c509bec463c50412d.zip
Remove the 'hand-made' MASCODEC UseOption from the platform files and replace it with other options which automatically parsed from features.txt. Also clean up some outdated left-overs and add some missing information (e.g. be more accurate in the config file section). Try to use the most appropriate features - masd and/or masf depending on their characteristics, large_plugin_buffer in the jpegviewer chapter as this is the restricting factor etc.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21426 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/advanced_topics/main.tex2
-rw-r--r--manual/appendix/config_file_options.tex12
-rw-r--r--manual/appendix/file_formats.tex4
-rw-r--r--manual/configure_rockbox/playback_options.tex2
-rw-r--r--manual/configure_rockbox/recording_settings.tex8
-rw-r--r--manual/getting_started/installation.tex8
-rw-r--r--manual/main_menu/fmradio.tex2
-rw-r--r--manual/main_menu/main.tex3
-rw-r--r--manual/platform/ondiofm.tex1
-rw-r--r--manual/platform/ondiosp.tex1
-rw-r--r--manual/platform/player.tex1
-rw-r--r--manual/platform/recorder.tex1
-rw-r--r--manual/platform/recorderv2fm.tex1
-rw-r--r--manual/plugins/jpegviewer.tex8
-rw-r--r--manual/rockbox_interface/tagcache.tex2
15 files changed, 24 insertions, 32 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index c25a2faad2..41c0ba4adb 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -408,8 +408,6 @@ Example of a configuration file:
menu} The \setting{Manage Settings} menu can be found in the \setting{Main
Menu}. The \setting{Manage Settings} menu allows you to save and load
\fname{.cfg} files.
- \opt{MASCODEC}{The \setting{Manage Settings} menu also
- allows you to load or save different firmware versions.}
\begin{description}
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index f37e0b753b..53ae5d5b35 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -10,8 +10,8 @@
\toprule
\textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
\midrule\localendhead % endhead breaks with htlatex
- volume & \opt{player}{-78 to +18}%
- \opt{recorder,recorderv2fm,ondiosp,ondiofm}{-100 -to +12}%
+ volume & \opt{masd}{-78 to +18}%
+ \opt{masf}{-100 -to +12}%
\opt{h100,h300}{-84 to 0}%
\opt{ipodnano}{-72 to +6}%
\opt{ipodvideo}{-57 to +6}%
@@ -20,12 +20,14 @@
\opt{ipodcolor}{-74 to +6}%
& dB\\
\nopt{x5}{%
- bass & \opt{MASCODEC}{-15 to +15}%
+ bass & \opt{masd}{-15 to +15}%
+ \opt{masf}{-12 to +12}%
\opt{h100,h300}{0 to +24}%
\opt{ipod}{-6 to +9}%
\opt{e200}{-24 to +24}%
& dB\\
- treble & \opt{MASCODEC}{-15 to +15}%
+ treble & \opt{masd}{-15 to +15}%
+ \opt{masf}{-12 to +12}%
\opt{h100,h300}{0 to +6}%
\opt{ipod}{-6 to +9}%
\opt{e200}{-24 to +24}%
@@ -200,7 +202,7 @@
tagcache\_ram & on, off & N/A\\
}%
- \opt{recorder,recorderv2fm}{
+ \opt{masf}{
loudness & 0 to 17 & N/A\\
superbass & on, off & N/A\\
auto volume & off, 20ms, 2s, 4s, 8s
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex
index 07226eaed8..8103037364 100644
--- a/manual/appendix/file_formats.tex
+++ b/manual/appendix/file_formats.tex
@@ -10,7 +10,7 @@
& Directory & \emph{none} & Enter the directory \\
\includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png}
& Audio file &
- \opt{MASCODEC}{\fname{.mp2, .mp3}}%
+ \opt{masd,masf}{\fname{.mp2, .mp3}}%
\opt{swcodec}{\emph{various}\newline%
(see \ref{ref:Supportedaudioformats}})%
% do NOT use \reference{} here as that will break the table.
@@ -55,7 +55,7 @@
\includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
& Video & \fname{.mpg, .mpeg, .mpv, .m2v} & Play the MPEG1/2 video \\
}
-\opt{MASCODEC}{\opt{lcd_bitmap}{
+\opt{masf}{\opt{lcd_bitmap}{
\includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
& Rockbox Video & \fname{.rvf} & View the movie (Rockbox format)\\}
}
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index 5989785e0a..fef0af2c4b 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -69,7 +69,7 @@ you to configure settings related to audio playback.
This can happen if the \dap{} is knocked, shaken or jogged heavily while
Rockbox is trying to read the hard drive.
- \opt{MASCODEC}{
+ \opt{masd,masf}{
The anti-skip buffer can be set to a value between 0 and 7
seconds.
}
diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex
index a0a3743c93..f7b17d524f 100644
--- a/manual/configure_rockbox/recording_settings.tex
+++ b/manual/configure_rockbox/recording_settings.tex
@@ -6,7 +6,7 @@
where you want to store them in the \setting{File Browser} and select
\setting{Set As Recording Directory}.}
-\opt{MASCODEC}{
+\opt{masf}{
\section{Quality}
Choose the quality here (0 to 7). Default is 5, best quality is 7,
smallest file size is 0. This setting effects how much your sound
@@ -46,7 +46,7 @@
\section{Frequency}
\nopt{sansa}{
Choose the recording frequency (sample rate).
- \opt{MASCODEC}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz}
+ \opt{masf}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz}
\opt{h100,h300}{44.1kHz, 22.05kHz and 11.025kHz}
\opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz}
are available. Higher sample rates use up more disk space, but give better
@@ -54,7 +54,7 @@
\opt{swcodec}{\note{The 11.025kHz setting is not available when using%
\setting{MPEG Layer 3} format.}
}%
- \opt{MASCODEC}{
+ \opt{masf}{
The frequency setting also determines which version of the MPEG standard
the sound is recorded using:\\
MPEG v1 for 48, 44.1 and 32\\
@@ -87,7 +87,7 @@
setting to configure how the mono signal is created. Options are L, R and L+R.
}
-\opt{MASCODEC}{
+\opt{masf}{
\section{Independent Frames}
The independent frames option tells the \dap{} to encode with the bit
reservoir disabled, so the frames are independent of each other. This
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 337ed5825a..db356c12fc 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -146,7 +146,7 @@ still available to you.\\
various important aspects of Rockbox, such as the different versions
available.\\}}
-\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need
+\opt{hwcodec}{Rockbox itself comes as a single package. There is no need
to install additional software to run Rockbox.}
\opt{swcodec} {
\opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
@@ -495,8 +495,10 @@ The new build will be installed over your current build.\\
data partiton.\\}
}
-The bootloader only changes rarely, and should not normally
-need to be updated.\\
+\nopt{hwcodec}{
+ The bootloader only changes rarely, and should not normally
+ need to be updated.\\
+}
\note{If you use Rockbox Utility be aware that it cannot detect manually
installed components.}
diff --git a/manual/main_menu/fmradio.tex b/manual/main_menu/fmradio.tex
index 1e1b8a2613..952300c251 100644
--- a/manual/main_menu/fmradio.tex
+++ b/manual/main_menu/fmradio.tex
@@ -15,7 +15,7 @@
This menu option switches to the radio screen.
The FM radio has the ability \opt{recording}{to record and } to
remember station frequency settings (presets).
- \opt{MASCODEC}{\note{The radio will shorten battery life, because the
+ \opt{masf}{\note{The radio will shorten battery life, because the
MAS-chip is set to record mode for instant recordings.}
}
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index 72b0b98acc..2257c14821 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -128,9 +128,6 @@ The \setting{Manage Settings} option allows the saving and re-loading of user
configuration settings, browsing the hard drive for alternate firmwares, and finally
resetting your \dap{} back to initial configuration.
%
-\opt{MASCODEC}{This menu also allows the user to load different versions of the
-Rockbox firmware.}
-%
The details of this menu are covered in
\reference{ref:manage_settings}.
diff --git a/manual/platform/ondiofm.tex b/manual/platform/ondiofm.tex
index 4f6881289d..c49a1363d7 100644
--- a/manual/platform/ondiofm.tex
+++ b/manual/platform/ondiofm.tex
@@ -3,7 +3,6 @@
\def\UseOption{ondiofm}
% To not break the current manual
\edef\UseOption{\UseOption,ondio}
-\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,ONDIO_PAD}
\edef\UseOption{\UseOption,archos}
diff --git a/manual/platform/ondiosp.tex b/manual/platform/ondiosp.tex
index 3c9e656ba9..43d74e76fd 100644
--- a/manual/platform/ondiosp.tex
+++ b/manual/platform/ondiosp.tex
@@ -2,7 +2,6 @@
%platform file for the Ondio SP
\def\UseOption{ondiosp}
\edef\UseOption{\UseOption,ondio}
-\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,ONDIO_PAD}
\edef\UseOption{\UseOption,archos}
\edef\UseOption{\UseOption,rombox}
diff --git a/manual/platform/player.tex b/manual/platform/player.tex
index e3c04eea13..eddd5eddfc 100644
--- a/manual/platform/player.tex
+++ b/manual/platform/player.tex
@@ -1,6 +1,5 @@
% $Id$ %
\def\UseOption{player}
-\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,PLAYER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
diff --git a/manual/platform/recorder.tex b/manual/platform/recorder.tex
index da86c63aa9..9eaf9091d8 100644
--- a/manual/platform/recorder.tex
+++ b/manual/platform/recorder.tex
@@ -1,6 +1,5 @@
% $Id$ %
\def\UseOption{recorder}
-\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,RECORDER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
diff --git a/manual/platform/recorderv2fm.tex b/manual/platform/recorderv2fm.tex
index 5a38b29cd0..99b829d8a5 100644
--- a/manual/platform/recorderv2fm.tex
+++ b/manual/platform/recorderv2fm.tex
@@ -1,6 +1,5 @@
% $Id$ %
\def\UseOption{recorderv2fm}
-\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,RECORDER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
diff --git a/manual/plugins/jpegviewer.tex b/manual/plugins/jpegviewer.tex
index d4f9e23a1e..d9bfe29e56 100644
--- a/manual/plugins/jpegviewer.tex
+++ b/manual/plugins/jpegviewer.tex
@@ -8,9 +8,9 @@ greyscale library}.
the decoding process needs to share memory with audio tracks. To be able to
view a bigger file you may need to stop playback.}
}
-\opt{MASCODEC}{
-\note{This plugin will cause playback to stop.}
-}
+\nopt{large_plugin_buffer}{%
+\note{This plugin will cause playback to stop.}%
+}%
\begin{table}
\begin{btnmap}{}{}
@@ -81,7 +81,7 @@ The menu has the following entries.
\item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
\item[Change Slideshow Timeout.] You can set the timeout for the slideshow
between 1 second and 20 seconds.
-\nopt{MASCODEC}{
+\opt{large_plugin_buffer}{
\item[Show Playback Menu.] From the playback menu you can control the
playback of the currently loaded playlist and change the volume of your \dap.
}
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 297333ffd3..a36ca5aa82 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -58,8 +58,6 @@ its subdirectories will be scanned and added to the database.
Directory Cache}) is enabled. \setting{Update now} includes that check
whether dircache has been enabled or not.}
}%
- \opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove
- deleted files from the database you need to run \setting{Update Now}.}%
\item[Initialize Now]
You can force Rockbox to rescan your disk for tagged files by