summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2010-08-16 09:43:48 +0000
committerMarianne Arnold <pixelma@rockbox.org>2010-08-16 09:43:48 +0000
commit5b47b89d16fe2cef7654dba1edaa5043196c9e14 (patch)
tree8848a014b828469c4209149ef42e945c274dd7a9 /manual
parente8bbbdffd41d140e442f184a11b194af61a263d8 (diff)
downloadrockbox-5b47b89d16fe2cef7654dba1edaa5043196c9e14.tar.gz
rockbox-5b47b89d16fe2cef7654dba1edaa5043196c9e14.tar.bz2
rockbox-5b47b89d16fe2cef7654dba1edaa5043196c9e14.zip
First step of completing the target rename in the manual. Some target specific options were already renamed in the rest of the source (e.g. see r23883) but not where they are actually set - in the platform files - leading to parts included or excluded incorrectly. The problem exists for more targets, this commit deals with the supported Iaudios first. Rename 'x5' to 'iaudiox5' (do the same for 'm5' and 'm3'), fix small errors or add missing info related to them along the way, use more appropriate options and simplify code a bit where possible.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27823 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/appendix/config_file_options.tex14
-rw-r--r--manual/appendix/file_formats.tex2
-rw-r--r--manual/configure_rockbox/sound_settings.tex23
-rw-r--r--manual/configure_rockbox/system_options.tex13
-rw-r--r--manual/configure_rockbox/theme_settings.tex6
-rw-r--r--manual/getting_started/iaudio_install.tex8
-rw-r--r--manual/getting_started/installation.tex16
-rw-r--r--manual/platform/iaudiom3.tex2
-rw-r--r--manual/platform/iaudiom5.tex2
-rw-r--r--manual/platform/iaudiox5.tex2
-rw-r--r--manual/rockbox_interface/main.tex10
11 files changed, 52 insertions, 46 deletions
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index 4e7a2ebcef..4ee8f00faf 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -17,24 +17,24 @@
\opt{ipodnano}{-72 to +6}%
\opt{ipodnano2g}{-74 to +6}%
\opt{ipodvideo,cowond2}{-89 to +6}%
- \opt{x5}{-73 to +6}
+ \opt{iaudiom3,iaudiom5,iaudiox5}{-73 to +6}
\opt{e200,e200v2}{-74 to +6}
\opt{ipodcolor,vibe500}{-74 to +6}%
& dB\\
- \nopt{x5}{%
- bass & \opt{masd}{-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,e200v2,vibe500}{-24 to +24}%
+ \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500}{%
+ -24 to +24}%
& dB\\
- treble & \opt{masd}{-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,e200v2,vibe500}{-24 to +24}%
+ \opt{iaudiom3,iaudiom5,iaudiox5,e200,e200v2,vibe500}{%
+ -24 to +24}%
& dB\\
- }%
balance & -100 to +100 & \%\\
channels & stereo, mono, custom, mono left, mono right, karaoke
& N/A\\
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex
index 56dbbe1701..03a41bb41b 100644
--- a/manual/appendix/file_formats.tex
+++ b/manual/appendix/file_formats.tex
@@ -130,7 +130,7 @@
& & IEEE float 32/64 bit\\
& & ITU-T G.711 a-low/$\mu$-low\\
& & QuickTime IMA ADPCM\\
- \opt{gigabeatf,h100,h300,x5,m5,m3,ipodnano2g,clipv1}{
+ \opt{gigabeatf,h100,h300,iaudiox5,iaudiom5,iaudiom3,ipodnano2g,clipv1}{
Monkey's Audio & \fname{.ape, .mac} & -c1000 to -c3000
files decode fast enough to be useful.}
\opt{gigabeats}{
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index 542f13b248..4ce6bea6d5 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -10,21 +10,22 @@ change to customise your listening experience.
where 0~dB is a reference that indicates the maximum volume that the \dap{}
can produce without possible distortion (clipping). All values lower than
this reference will be negative and yield a progressively softer volume.
- \opt{player,recorder,recorderv2fm,ondio,x5,m5,ipodnano,ipodnano2g,ipodvideo,
- ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS,gigabeats,gigabeatf,vibe500}{
- Values higher than 0~dB are available and can be used to raise the
- volume more than would otherwise be possible. These volume levels will
- ordinarily lead to distorted sound, but might work nicely for music that has
- an otherwise low volume level.}
+ \nopt{h100,h300,ondavx777}{%
+ Values higher than 0~dB are available and can be used to raise the
+ volume more than would otherwise be possible. These volume levels will
+ ordinarily lead to distorted sound, but might work nicely for music that has
+ an otherwise low volume level.
+ }
The volume can be adjusted from a
\opt{player}{minimum of -78~dB to a maximum of +18~dB.}%
\opt{recorder,recorderv2fm,ondio}{minimum of -100~dB to a maximum of +12~dB.}%
\opt{h100,h300}{minimum of -84~dB to a maximum of 0~dB.}%
- \opt{x5,m5,ipod3g,ipod4g,gigabeatf,mrobe100}{minimum of -73~dB to a maximum of +6~dB.}%
+ \opt{iaudiom3,iaudiom5,iaudiox5,ipod3g,ipod4g,gigabeatf,mrobe100}{%
+ minimum of -73~dB to a maximum of +6~dB.}%
\opt{ipodnano}{minimum of -72~dB to a maximum of +6~dB.}%
\opt{ipodvideo,cowond2}{minimum of -89~dB to a maximum of +6~dB.}%
\opt{ipodnano2g,ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS}{minimum of
- -74~dB to a maximum of +6~dB.}%
+ -74~dB to a maximum of +6~dB.}%
\opt{gigabeats}{minimum of -90~dB to a maximum of +6~dB.}%
\opt{gigabeatf,vibe500}{minimum of -74~dB to a maximum of +6~dB.}%
\opt{ipodvideo}{\\Remark: Lowering the volume below -57~dB will also affect the line-out
@@ -41,7 +42,8 @@ change to customise your listening experience.
\opt{h100,h300}{The minimum setting is 0~dB and the maximum is 24~dB.}%
\opt{ipodnano,ipodnano2g,ipodcolor}{The minimum setting is -6~dB and the maximum is 9~dB.}%
\opt{ipodvideo}{The minimum setting is -12~dB and the maximum is 12~dB.}%
- \opt{x5,sansa,sansaAMS,h10,h10_5gb,vibe500}{The minimum setting is -24~dB and the maximum is 24~dB.}
+ \opt{iaudiom3,iaudiom5,iaudiox5,sansa,sansaAMS,h10,h10_5gb,vibe500}{%
+ The minimum setting is -24~dB and the maximum is 24~dB.}
\opt{ipodvideo}{
\section{Bass Cutoff}
@@ -61,7 +63,8 @@ change to customise your listening experience.
\opt{h100,h300}{The minimum setting is 0~dB and the maximum is 6~dB.}%
\opt{ipodnano,ipodnano2g,ipodcolor}{The minimum setting is -6~dB and the maximum is 9~dB.}%
\opt{ipodvideo}{The minimum setting is -12~dB and the maximum is 12~dB.}%
- \opt{x5,sansa,sansaAMS,h10,h10_5gb,vibe500}{The minimum setting is -24~dB and the maximum is 24~dB.}
+ \opt{iaudiom3,iaudiom5,iaudiox5,sansa,sansaAMS,h10,h10_5gb,vibe500}{%
+ The minimum setting is -24~dB and the maximum is 24~dB.}
\opt{ipodvideo}{
\section{Treble Cutoff}
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index ac39db60b6..62825bdb3f 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -42,7 +42,7 @@
\opt{ipod4g}{630~mAh}%
\opt{ipod3g}{630~mAh}%
\opt{ipod1g2g}{1200~mAh}%
- \opt{m5,x5}{950~mAh}%
+ \opt{iaudiom3,iaudiom5,iaudiox5}{950~mAh}%
\opt{gigabeatf}{2000~mAh}%
\opt{gigabeats}{700~mAh}%
\opt{cowond2}{1600~mAh}%
@@ -52,10 +52,13 @@
calculation. Changing this setting has no effect whatsoever on
actual battery life. This setting only affects the accuracy of the
runtime estimation as shown on screen.
- \opt{iaudio}{Rockbox does not automatically distinguish between the
- ``L'' models and the ``simple'' models which determine the default
- value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
- to 2250~mAh for more accuracy in the runtime estimation.}
+ \opt{iaudiom3,iaudiom5,iaudiox5}{Rockbox does not automatically distinguish
+ between the ``L'' models and the ``simple'' models which determine the
+ default value. If your dap{} is an
+ \opt{iaudiom3}{M3L}%
+ \opt{iaudiom5}{M5L}%
+ \opt{iaudiox5}{X5L}
+ set the value to 2250~mAh for more accuracy in the runtime estimation.}
\opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
family at present, and work is on-going into finding a better way to
determine battery life.}
diff --git a/manual/configure_rockbox/theme_settings.tex b/manual/configure_rockbox/theme_settings.tex
index 35cf716828..9bcba6f435 100644
--- a/manual/configure_rockbox/theme_settings.tex
+++ b/manual/configure_rockbox/theme_settings.tex
@@ -19,9 +19,9 @@ customize the visual apperance of Rockbox.
\opt{recorderv2fm}{\url{http://themes.rockbox.org/index.php?target=fmrecorder}}%
\opt{ondiofm}{\url{http://themes.rockbox.org/index.php?target=ondiofm}}%
\opt{ondiosp}{\url{http://themes.rockbox.org/index.php?target=ondiosp}}%
- \opt{m5}{\url{http://themes.rockbox.org/index.php?target=m5}}%
- \opt{x5}{\url{http://themes.rockbox.org/index.php?target=x5}}%
- \opt{m3}{\url{http://themes.rockbox.org/index.php?target=m3}}%
+ \opt{iaudiom5}{\url{http://themes.rockbox.org/index.php?target=m5}}%
+ \opt{iaudiox5}{\url{http://themes.rockbox.org/index.php?target=x5}}%
+ \opt{iaudiom3}{\url{http://themes.rockbox.org/index.php?target=m3}}%
\opt{h100}{\url{http://themes.rockbox.org/index.php?target=h100}}%
\opt{h300}{\url{http://themes.rockbox.org/index.php?target=h300}}%
\opt{h10_5gb}{\url{http://themes.rockbox.org/index.php?target=h10_5gb}}%
diff --git a/manual/getting_started/iaudio_install.tex b/manual/getting_started/iaudio_install.tex
index 1ef566173e..f714efcca0 100644
--- a/manual/getting_started/iaudio_install.tex
+++ b/manual/getting_started/iaudio_install.tex
@@ -11,9 +11,9 @@ Rockbox bootloader can therefore be very minimalistic, as it does not require
\begin{itemize}
\item Download the Rockbox bootloader binary from
\url{http://download.rockbox.org/bootloader/iaudio/}.
- \opt{x5}{Use the \fname{x5v\_fw.bin} file if your \dap{} is a X5V. If it is a X5
- or X5L, use the \fname{x5\_fw.bin} file.}
- \opt{m5}{Use the \fname{m5\_fw.bin} file.}
- \opt{m3}{Use the \fname{cowon\_m3.bin} file.}
+ \opt{iaudiox5}{Use the \fname{x5v\_fw.bin} file if your \dap{} is an X5V (without radio).
+ If it is an X5 or X5L, use the \fname{x5\_fw.bin} file.}
+ \opt{iaudiom5}{Use the \fname{m5\_fw.bin} file.}
+ \opt{iaudiom3}{Use the \fname{cowon\_m3.bin} file.}
\item Copy it to the \fname{FIRMWARE} directory on your \dap{}.
\end{itemize}
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 2ee4f84c29..179210e7f4 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -149,7 +149,7 @@ follow the instructions at
simultaneously. Your \dap{} should enter disk mode and you can try
reconnecting to the computer.
}
- \opt{x5}{
+ \opt{iaudiox5}{
When instructed to connect/disconnect the USB cable, always use
the USB port through the subpack, not the side `USB Host' port. The side port
is intended to be used for USB OTG connections only (digital cameras, memory
@@ -268,7 +268,7 @@ still available to you.\\
\dap{} how to load and start other components of Rockbox and for providing
the dual boot function. This is the component of Rockbox that is installed
to the flash memory of your \playerman.
- \opt{iaudio}{\note{Dual boot does not currently work on the \playertype{}.}}}
+ \opt{iaudiom3,iaudiom5,iaudiox5}{\note{Dual boot does not currently work on the \playertype.}}}
\item[The Rockbox firmware.]
\opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
@@ -476,7 +476,7 @@ structure that Rockbox needs.\\}
\subsubsection{Installing the bootloader}
\opt{h100,h300}{\input{getting_started/iriver_install.tex}}
\opt{ipod}{\input{getting_started/ipod_install.tex}}
- \opt{m3,m5,x5}{\input{getting_started/iaudio_install.tex}}
+ \opt{iaudio}{\input{getting_started/iaudio_install.tex}}
\opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}}
\opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}
\opt{sansa}{\input{getting_started/sansa_install.tex}}
@@ -503,7 +503,7 @@ structure that Rockbox needs.\\}
\end{itemize}
}
-\opt{m3,m5,x5}{
+\opt{iaudiom3,iaudiom5,iaudiox5}{
After installing you \emph{need} to power-cycle the
\dap{} by doing the following steps.
\begin{itemize}
@@ -600,7 +600,7 @@ you turn the unit on, Rockbox should load.}
}
}
-\opt{m3}{
+\opt{iaudiom3}{
\fixme{Add a note about the charging trick and place it here?}
}
@@ -630,7 +630,7 @@ The new build will be installed over your current build.\\
\section{Uninstalling Rockbox}\index{Installation!uninstall}
-\nopt{gigabeatf,m5,x5,archos,mrobe100,gigabeats}{
+\nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos,mrobe100,gigabeats}{
\note{The Rockbox bootloader allows you to choose between Rockbox and
the original firmware. (See \reference{ref:Dualboot} for more information.)}
}
@@ -695,7 +695,7 @@ completely follow the manual uninstallation instructions below.}}
instead of \texttt{i} for install.
}
-\opt{m5,x5}{
+\opt{iaudiom3,iaudiom5,iaudiox5}{
If you would like to go back to using the original \playerman{} software,
connect the \dap{} to your computer, download the original \playername{}
firmware from the \playerman{} website, and copy it to the \fname{FIRMWARE}
@@ -727,7 +727,7 @@ completely follow the manual uninstallation instructions below.}}
\nopt{gigabeats}{
If you wish to clean up your disk, you may also wish to delete the
\fname{.rockbox} directory and its contents.
- \nopt{m5,x5}{Turn the \playerman{} off.
+ \nopt{iaudiom3,iaudiom5,iaudiox5}{Turn the \playerman{} off.
Turn the \dap{} back on and the original \playerman{} software will load.}
}
diff --git a/manual/platform/iaudiom3.tex b/manual/platform/iaudiom3.tex
index b9beafaa84..cf5c347a59 100644
--- a/manual/platform/iaudiom3.tex
+++ b/manual/platform/iaudiom3.tex
@@ -1,5 +1,5 @@
% $Id$ %
-\def\UseOption{m3}
+\def\UseOption{iaudiom3}
\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
\edef\UseOption{\UseOption,IAUDIO_M3_PAD}
\edef\UseOption{\UseOption,IAUDIO_RC_PAD}
diff --git a/manual/platform/iaudiom5.tex b/manual/platform/iaudiom5.tex
index badd96a544..393b86d578 100644
--- a/manual/platform/iaudiom5.tex
+++ b/manual/platform/iaudiom5.tex
@@ -1,5 +1,5 @@
% $Id$ %
-\def\UseOption{m5}
+\def\UseOption{iaudiom5}
\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
\edef\UseOption{\UseOption,IAUDIO_X5_PAD}
\edef\UseOption{\UseOption,IAUDIO_RC_PAD}
diff --git a/manual/platform/iaudiox5.tex b/manual/platform/iaudiox5.tex
index 3b6547cd2e..f05f31781b 100644
--- a/manual/platform/iaudiox5.tex
+++ b/manual/platform/iaudiox5.tex
@@ -1,5 +1,5 @@
% $Id$ %
-\def\UseOption{x5}
+\def\UseOption{iaudiox5}
\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
\edef\UseOption{\UseOption,IAUDIO_X5_PAD}
\edef\UseOption{\UseOption,IAUDIO_RC_PAD}
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 0e4ec9ab4a..8303b647ef 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -9,7 +9,7 @@
% The extension is selected in the preamble, so no further \ifpdfoutput
% is necessary.
\includegraphics[height=8cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-front}
-\opt{m3}{% replace with HAVEREMOTEKEYMAP when the h100 file exists or change specimg
+\opt{iaudiom3}{% replace with HAVEREMOTEKEYMAP when the h100 file exists or change specimg
\end{center}
% spacing between the two pictures, could possibly be improved
\begin{center}
@@ -300,7 +300,7 @@ detail in the following paragraph.
bottom of the unit, there is a connector for the docking station or the
proprietary USB connector for connecting directly to USB.}
%
- \opt{x5,m5}{
+ \opt{iaudiom5,iaudiox5}{
The \dap{} is curved so that the end with the screen on it is thicker than the
other end. Hold the \dap{} wih the thick end towards the top and the screen
facing towards you. Half way up the front of the unit on the right hand side
@@ -325,8 +325,8 @@ detail in the following paragraph.
indicator light, which may feel a bit like a button, but is not.
From the top of the \dap{} on the left hand side is the headphone socket, then the
- remote connector. Below this is a cover which protects the \opt{x5}{USB host
- connector.}\opt{m5}{USB and charging connector}.}
+ remote connector. Below this is a cover which protects the \opt{iaudiox5}{USB
+ host connector.}\opt{iaudiom5}{USB and charging connector}.}
%
\opt{e200,e200v2}{
Hold the \dap{} with the turning wheel at the front and bottom. On the bottom left
@@ -555,7 +555,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
performed by inserting a paperclip gently into the Reset hole.
}%
-\nopt{gigabeatf,m3,m5,x5,archos}
+\nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos}
{
\subsection{Starting the original firmware}
\label{ref:Dualboot}