len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2025-10-13 10:07:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reorganise/partially rewrite the installation chapter to present Rockbox Utility as the

Browse source 
preferred installation method, and don't have important information only under manual 
install.  For now retain manual install as a subsection.  Patch originally in FS#9895


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20034 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Alex Parker 2009-02-17 23:19:01 +00:00
parent fd91631ceb
commit 42ef5b0c88
8 changed files with 339 additions and 408 deletions
Download patch file Download diff file Expand all files Collapse all files

21
manual/getting_started/gigabeat_install.tex
View file

@ -1,11 +1,5 @@
% $Id$
Installing the bootloader is only needed once. It simply requires you
to replace a file on your \dap{} with the Rockbox bootloader. To be able
booting the original firmware please make sure to rename the original file
properly. If you ever wish to uninstall Rockbox you should keep a backup copy
of the original file.
\begin{itemize}
\item Download the Rockbox bootloader from
\url{http://download.rockbox.org/bootloader/gigabeat/}
@ -16,17 +10,8 @@ of the original file.
\item In that directory you'll find a file called \fname{FWIMG01.DAT}. This too
may be hidden. Rename the file to \fname{FWIMG01.DAT.ORIG}. Make sure you
spelled that name correctly as it is needed for booting the \playerman{} firmware.
\warn{If you do not complete this step then you will be unable to uninstall Rockbox
without a copy of the original firmware from the original install CD.}
\item Now copy the file \fname{FWIMG01.DAT} you downloaded to that directory.
Make sure the spelling is correct.
\end{itemize}
\warn{After installing the bootloader you \emph{need} to power-cycle the
\dap{} by doing the following steps. Failure to do so may result in problems.}
\begin{itemize}
\item Eject / unmount USB drive and unplug the USB cable.
\item Unplug any power adapter.
\item Hold the \ButtonPower{} button to turn off the \dap{}.
\item Slide the battery switch located on the bottom of the \dap{} from
`on' to `off'
\item Slide the battery switch back from `off' to `on'
\end{itemize}
\end{itemize}

19
manual/getting_started/h10_install.tex
View file

@ -1,22 +1,3 @@
\subsubsection{UMS and MTP}
The \playertype{} can be connected to a computer in two different modes:
\begin{itemize}
\item Universal Mass Storage (UMS): In this mode, it will appear on your computer as a regular disk. This mode works with all major operating systems, including Windows, Linux and Mac OS X.
\item Media Transfer Protocol (MTP): In this mode, it will appear on your computer as a Media Device. MTP was created by Microsoft for use with DAPs and only works with Windows XP and Media Player 10.
\end{itemize}
The \playerlongtype{} is \opt{h10}{only available as a MTP device, but}\opt{h10_5gb}{available as both a MTP and as a UMS device, depending on where and when you bought it. You can tell which you have by how it appears when you connect it to a computer. If it appears as a regular disk then it is UMS. If it appears as a Media Device on Windows XP, or if it does not appear at all on other operating systems, then it is MTP. Even if you have a MTP \dap{}, it} can be forced into UMS mode using the UMS trick.
\subsubsection{UMS mode and the UMS trick}
It is possible to force a MTP \playertype{} to start up in UMS mode using the following procedure:
\begin{enumerate}
\item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to push the small reset button inside the hole between the Hold switch and remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
\item Connect your \playertype{} to the computer using the data cable.
\item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
\item Continue holding \ButtonRight{} until the USB Connected screen appears.
\item The \dap{} will now appear as a regular disk on your computer.
\end{enumerate}
\note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally power the player off so step 1 is no longer necessary.}
\subsubsection{Installation}
\begin{enumerate}
\item Download

2
manual/getting_started/iaudio_install.tex
View file

@ -15,6 +15,4 @@ Rockbox bootloader can therefore be very minimalistic, as it does not require
or X5L, use the \fname{x5\_fw.bin} file.}
\opt{m5}{Use the \fname{m5\_fw.bin} file.}
\item Copy it to the \fname{FIRMWARE} directory on your \dap{}.
\item Turn the \dap{} off, remove the USB cable and insert the charger. The
Rockbox bootloader will automatically be flashed.
\end{itemize}

525
manual/getting_started/installation.tex
View file

@ -1,37 +1,143 @@
% $Id$ %
\chapter{Installation}\label{sec:installation}
\opt{ipodnano}{
\note{Rockbox presently runs only on the original Ipod Nano. Rockbox does
\emph{not} run on the second, third, or fourth generation Ipod Nano.
For information on identifying which Ipod you own, see this page on
Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
Installing Rockbox is generally a quick and easy procedure. However
before beginning there are a few things it is important to know.
\section{Before Starting}
\opt{e200}{\fixme{NOTE: These instructions will not work on the
``Rhapsody'' version of the E200 series (also known as E200R). Please
follow the instructions at
\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
\opt{ipodnano,ipodvideo,e200,c200}{
\begin{description}
\item[Supported hardware versions.]
\opt{ipodnano}{
The \playertype{} is available in multiple versions, not
all of which run Rockbox. Rockbox presently runs only on
the original Ipod Nano. Rockbox does
\emph{not} run on the second, third, or fourth generation Ipod Nano.
For information on identifying which Ipod you own, see this page on
Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
}
}
\opt{ipodvideo}{
\note{Rockbox presently runs only on the 5th and 5.5th generation Ipod videos.
Rockbox does \emph{not} run on the newer, 6th/Classic generation Ipod.
For information on identifying which Ipod you own, see this page on Apple's
website: \url{http://www.info.apple.com/kbnum/n61688}.
\opt{ipodvideo}{
The \playertype{} is the 5th/5.5th generation \playerman{} only.
Rockbox does \emph{not} run on the newer, 6th/Classic generation Ipod.
For information on identifying which Ipod you own, see this page on Apple's
website: \url{http://www.info.apple.com/kbnum/n61688}.
}
}
\opt{e200,c200}{
\note{Rockbox doesn't function on the newer v2 models. They can be identified
by checking the Sandisk firmware version number under
Settings $\rightarrow$ Info. The v1
firmware is named 01.xx.xx, while the v2 firmware begins with 03.}
\opt{e200,c200}{
The \playertype{} is available in multiple versions, not
all of which run Rockbox. Rockbox doesn't run on the
newer v2 models. They can be identified
by checking the Sandisk firmware version number under
Settings $\rightarrow$ Info. The v1
firmware is named 01.xx.xx, while the v2 firmware begins with 03.
}
\end{description}
}
\section{Overview}
There are two ways of installing Rockbox: automated and manual. While the
manual way is older, more tested and proven to work correctly, the
automated installation is based on a nice graphical application that does
almost everything for you. It is still important that you have
an overview of the installation process to be able to select the correct
installation options.
\opt{h300}{
\begin{description}
\item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
\emph{permanently} lose the ability to playback files with DRM.
\end{description}
}
\begin{description}
\item[USB connection.] To transfer Rockbox to your \dap{} you need to
connect it to your computer. For manual installation/uninstallation, or
should autodetection fail during automatic installation, you need to know
where to access the \dap{}. On Windows this means you need to know
the drive letter associated with the \dap{}. On Linux you need to know
the mount point of your \dap{}. On Mac OS X you need to know the volume
name of your \dap{}.
\opt{ipod}{
If you have Itunes installed and it is configured to open automatically
when your \dap{} is attached (the default behaviour),
then wait for it to open and then quit it. You
also need to ensure the ``Enable use as disk'' option is enabled for
your \dap{} in Itunes. Your \dap{} should then enter disk mode
automatically when connected to a
computer via USB. If your computer does not recognise your \dap{}, you may
need to enter disk mode manually. Disconnect your \dap{} from the
computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
\ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
\dap{} should enter disk mode and you can try reconnecting to the computer.
}
\opt{ipod3g,ipod4g,ipodcolor,ipodmini}{
\index{Firewire}Firewire detection is not supported in Rockbox at
the moment. Please use USB only.
}
\opt{x5}{
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
sticks, etc.).
}
\opt{sansa}{The following steps require you to change the setting in
\setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
original firmware.
\warn{Never extract files to your \dap{} while it is in recovery mode.}
}
\opt{h10,h10_5gb}{
The installation requires you to use UMS mode and so
may require use of the UMS trick, whereby it is possible to force a MTP
\playertype{} to start up in UMS mode as follows:
\begin{enumerate}
\item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to
push the small reset button inside the hole between the Hold switch and
remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
\item Connect your \playertype{} to the computer using the data cable.
\item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
\item Continue holding \ButtonRight{} until the USB Connected screen appears.
\item The \dap{} will now appear as a regular disk on your computer.
\end{enumerate}
\note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
power the player off so step 1 is no longer necessary.}
}
\opt{gigabeatf}{During installation, do not connect your \dap{}
using the cradle but plug the USB cable directly to the \dap{}.
}
\end{description}
\opt{ipod,sansa}{
\begin{description}
\item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
requires you to have administrative (Windows) or root (Linux) rights.
Consequently when doing either the automatic or manual bootloader install,
please ensure that you are logged in with an administrator account or have root rights.
\end{description}
}
\opt{ipod}{
\begin{description}
\item[File system format.] Rockbox only works on Ipods formatted with
the FAT32 filesystem (i.e. Ipods initialised by Itunes
for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
initialised by Itunes for the Mac). More information and instructions for
converting an Ipod to FAT32 can be found on the
\wikilink{IpodConversionToFAT32} wiki
page on the Rockbox website. Note that after conversion, you can still use
a FAT32 Ipod with a Mac.
\end{description}
}
\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
There are two ways to install Rockbox: automated and manual. The automated
way is the preferred method of installing Rockbox for the majority of
people. Rockbox Utility is a graphical
application that does almost everything for you.
However, should you encounter a problem, then the manual way is
still available to you.
\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need
to install additional software for running Rockbox.}
to install additional software to run Rockbox.}
\opt{swcodec} {
\opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
two of which need to be installed in order to run Rockbox:}
@ -43,7 +149,7 @@ installation options.
\item[The \playerman{} bootloader.]
The \playerman{} bootloader is the program that tells your \dap{} how to load
and start the original firmware. It is also responsible for any emergency,
recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
memory in your \playerman{} and comes factory-installed. It is not necessary
to modify this in order to install Rockbox.}
@ -56,9 +162,10 @@ installation options.
\opt{HAVE_RB_BL_IN_FLASH}{
The bootloader is the program that tells your
\dap{} how to load and start other components of Rockbox. This is the
component of Rockbox that is installed to the flash memory of your
\playerman.}
\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{}.}}}
\item[The Rockbox firmware.]
\opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
@ -82,168 +189,125 @@ installation options.
separately. They are not required to run Rockbox itself but
a lot of themes require the fonts package to be installed.
\item[Themes.] The view of Rockbox can be customized by themes. Depending
\item[Themes.] The appearance of Rockbox can be customised by themes. Depending
on your taste you might want to install additional themes to change
the look of Rockbox.
\end{description}
}
\section{Prerequisites}\label{sec:prerequisites}
\index{Installation!Prerequisites}
Before installing Rockbox you should make sure you meet the prerequisites.
You may need some additional tools for installation. In most cases these will already be available on your computer, but if not, installing some additional
software might be necessary.
\begin{description}
\item[USB connection.] To transfer Rockbox to your \dap{} you need to
connect it to your computer. For manual installation/uninstallation, or
should autodetection fail during automatic installation, you need to know
where to access the \dap{}. On Windows this means you need to figure out
the drive letter associated with the \dap{}. On Linux you need to know the
mount point of your \dap{}.
\opt{ipod}{
Your \dap{} should enter disk mode automatically when connected to a
computer via USB. If your computer does not recognise your \dap{}, you may
need to enter the disk mode manually. Disconnect your \dap{} from the
computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
\ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
\dap{} should enter disk mode and you can try reconnecting to the computer.
}
\opt{ipod3g,ipod4g,ipodcolor,ipodmini}{
\note{\index{Firewire}Firewire detection is not supported in Rockbox at
the moment. Please use USB only.}
}
\opt{x5}{
\note{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
sticks, etc)!}
}
\opt{sansa}{\warn{The following steps require you to change the setting in
\setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
original firmware. Never extract files to your \dap{} while it is in
recovery mode.}}
\opt{h10,h10_5gb}{\warn{The following steps require you to use UMS mode and so
may require use of the UMS trick as described in the bootloader installation
section.}}
\opt{gigabeatf}{\warn{During installation, do not connect your \dap{}
using the cradle but plug the USB cable directly to the \dap{}.}}
\end{description}
For manual installation and customization additional software is required.
\begin{description}
\item[ZIP utility.]\index{zip}
Rockbox is distributed as a compressed archive using the
\fname{.zip} format. Your computer will normally already have a means of
handling such archive files. Windows XP has built-in support for
\fname{.zip} files and presents them to you as directories unless you
have installed a third party program that handles compressed files. For
other operating systems this may vary. If the \fname{.zip} file format
is not recognised on your computer you can find a program to handle them
at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/}, both of
which can be downloaded and used free of charge.
\item[Text editor.] As you will see in the following chapters, Rockbox is
highly configurable. In addition to saving configurations,
Rockbox also allows you to create customised configuration files. If you
would like to edit custom configuration files on your computer, you will
need a text editor like Windows' ``Wordpad''.
\end{description}
\opt{ipod}{
\note{In addition to the requirements described above, Rockbox only works on
Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by Itunes
for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
initialized by Itunes for the Mac). More information and instructions for
converting an Ipod to FAT32 can be found on the
\wikilink{IpodConversionToFAT32} wiki
page on the Rockbox website. Note that after conversion, you can still use
a FAT32 Ipod on a Mac.
}
}
\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
\opt{ipodvideo}{\warn{There are separate versions of Rockbox for the 30GB and
60GB/80GB models. You must ensure you download the correct version for your
\dap{}.}}
\subsection{Automated Installation}
\opt{mrobe100}
To automatically install Rockbox, download the official installer and
housekeeping tool \caps{Rockbox Utility}. It allows you to:
\begin{itemize}
\item Automatically install all needed components for using Rockbox
(``Small Installation'')
\item Automatically install all suggested components (``Full Installation'')
\item Selectively install optional components
\item Install additional themes
\item Install voice files and generate talk clips
\item Uninstall all components you installed using Rockbox Utility
(``Minimal Installation'').
\item Automatically install all suggested components (``Complete Installation'').
\item Selectively install optional components.
\nopt{player}{\item Install additional fonts and themes.}
\item Install voice files and generate talk clips.
\item Uninstall all components you installed using Rockbox Utility.
\end{itemize}
Prebuilt binaries for Windows, Linux and MacOS~X are
available at the \wikilink{RockboxUtility} wiki page.
\\*
\warn{When first starting \caps{Rockbox Utility} run ``Autodetect'',
Prebuilt binaries for Windows, Linux and Mac OS X are
available at the \wikilink{RockboxUtility} wiki page.\\
When first starting \caps{Rockbox Utility} run ``Autodetect'',
found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
can detect most player types. If autodetection fails or is unable to detect
the mountpoint, make sure to enter the correct values. The mountpoint indicates
the location of the \dap{} in your filesystem. On Windows, this is the drive
letter the \dap{} gets assigned, on other systems this is a path in the
filesystem.}
filesystem.\\*
\opt{ipodvideo}
{\warn{Autodetection is unable to distinguish between the
{\note{Autodetection is unable to distinguish between the
\playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
30~GB model. This will usually work but you might want to check the
detected value, especially if you experience problems with Rockbox.}
}
\note{Rockbox Utility currently lacks some guiding messages. Please have a
look at the manual installation instructions if you are stuck
during installation.}
\opt{h100,h300}{
Rockbox Utility will ask you for a compatible copy of the original
firmware. This is because for legal reasons we cannot distribute
the bootloader directly. Instead, we have to patch the Iriver firmware
with the Rockbox bootloader.
\subsection{Manual Installation}
Download a supported version of the Iriver firmware for your
\playername{} from the Iriver website, links can be found on
\wikilink{IriverBoot}.
Supported Iriver firmware versions currently include
\opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
Likewise, the iHP110 and iHP115 use the same firmware, called
\fname{ihp\_100.hex}. Be sure to use the correct firmware file for
your player.}
\opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
\note{The US \playername{} firmware is not supported and cannot be
patched to be used with the bootloader. If you wish to install Rockbox
on a US \playername{}, you must first install a non-US version of the
original firmware and then install one of the supported versions patched
with the Rockbox bootloader.
\warn{Installing non-US firmware on a US \playername{} will
permanently remove DRM support from the player.}}}
If the file that you downloaded is a \fname{.zip} file, use an unzip
utility like mentioned in the prerequisites section to extract
the \fname{.hex} from the \fname{.zip} file
to your desktop. Likewise, if the file that you downloaded is an
\fname{.exe} file, double-click on the \fname{.exe} file to extract
the \fname{.hex} file to your desktop.
When running Linux you should be able to extract \fname{.exe}
files using \fname{unzip}.
}
\subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
There are three different types of firmware binaries available from the
There are three different versions of Rockbox available from the
Rockbox website:
\label{Version}
Release version, current build and daily build. You need to decide which one
you want to install and get the appropriate version for your \dap{}.
Release version, current build and archived daily build. You need to decide which one
you want to install and get the appropriate version for your \dap{}. If you
select either ``Minimal Installation'' or ``Complete Installation'' from the
``Quick Start'' tab, then Rockbox Utility will automatically install the
release version of Rockbox. Using the ``Installation'' tab will allow you
to select which version you wish to install.
\begin{description}
\item[Release.] The release version is the latest stable release, free
of known critical bugs. The current stable release of Rockbox is
of known critical bugs. For a manual install, the current stable release of Rockbox is
available at \url{http://www.rockbox.org/download/}.
\item[Current Build.] The current build is built at each source code change to
the Rockbox SVN repository and represents the current state of Rockbox
development. This means that the build could contain bugs but most of
the time is safe to use. You can download the current build from
the time is safe to use. For a manual install, you can download the current build from
\url{http://build.rockbox.org/}.
\item[Archived Build.] In addition to the release version and the current build,
there is also an archive of daily builds available for download. These are
built once a day from the latest source code in the SVN repository. You can
download archived builds from \url{http://www.rockbox.org/daily.shtml}.
built once a day from the latest source code in the SVN repository. For a manual install,
you can download archived builds from \url{http://www.rockbox.org/daily.shtml}.
\end{description}
\warn{Because current builds and daily builds are development versions which
\note{Because current and archived builds are development versions that
change frequently, they may behave differently than described in this manual,
or they may introduce new (and maybe annoying) bugs. If you do not want to
get undefined behaviour from your \dap{}, you should stick to the current
stable release if there is one for your \dap{}. If you want to help with
project development, you can try development builds and help by reporting bugs.
Just be aware that these are development builds that are highly functional
but not perfect!}
or they may introduce new (and potentially annoying) bugs. Unless you wish to
try the latest and greatest features at the price of possibly greater instability,
or you wish to help with development, you should stick with the release.\\*}
Please now go to \reference{ref:finish_install} to complete the installation procedure.
\subsection{Manual Installation}
The manual installation method is still available to you, should you need or desire it
by following the instructions below. If you have used Rockbox Utility
to install Rockbox, then you do not need to follow the next section and can skip
straight to \reference{ref:finish_install}
\subsubsection{Installing the firmware}\label{sec:installing_firmware}
@ -251,6 +315,9 @@ you want to install and get the appropriate version for your \dap{}.
\item Download your chosen version of Rockbox from the links in the
previous section.
\opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and
60GB/80GB models. You must ensure you download the correct version for your
\dap{}.}}
\item Connect your \dap{} to the computer via USB
\opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire} as described in
@ -269,50 +336,18 @@ structure that Rockbox needs.}
\end{enumerate}
\opt{archos}{
\note{
If the contents of the \fname{.zip} file are extracted correctly, you will
have a file called \fname{\firmwarefilename} in the main directory of your
\daps{} drive, and also a directory called \fname{.rockbox}, which contains a
number of other directories and system files needed by Rockbox. If you receive a
``-1'' error when you start Rockbox, you have not extracted the contents of
the \fname{.zip} file to the proper location.
}
If the contents of the \fname{.zip} file are extracted correctly, you will
have a file called \fname{\firmwarefilename} in the main directory of your
\daps{} drive, and also a directory called \fname{.rockbox}, which contains a
number of other directories and system files needed by Rockbox.
}
% This has nothing to do with swcodec, just that these players need our own
% bootloader so we can decide where we want the main binary.
\opt{swcodec}{
\note{
If the contents of the \fname{.zip} file are extracted correctly, you will
have a directory called \fname{.rockbox}, which contains all the files needed
by Rockbox, in the main directory of your \daps{} drive. If you receive a
``-1'' error when you start Rockbox, you have not extracted the contents of
the \fname{.zip} file to the proper location.
}
}
\nopt{player}{
\subsubsection{Installing the fonts package}{\index{Installation!Fonts}\label{sec:installing_fonts}
Rockbox has a fonts package that is available at
\url{http://www.rockbox.org/daily.shtml} or from the \emph{extras} link in
the menu on the Rockbox website. The fonts package rarely changes and is
therefore not included in the firmware \fname{.zip} file. When installing
Rockbox for the first time, you should install the fonts package.
\begin{enumerate}
\item Download the fonts package from the link above.
\item Take the file that you downloaded above, and use the ``Extract
all'' command of your unzip program to extract the files in the
\fname{.zip} file onto your \dap{}. As with the firmware installation, the
entire contents of the fonts \fname{.zip} should be extracted directly to the
root of your \daps{} drive. Do not try to create a separate directory
on your \dap{} for the fonts! The \fname{.zip} already contains the
correct internal structure.
\end{enumerate}
}
If the contents of the \fname{.zip} file are extracted correctly, you will
have a directory called \fname{.rockbox}, which contains all the files needed
by Rockbox, in the main directory of your \daps{} drive.
}
\opt{swcodec}{
@ -327,20 +362,71 @@ structure that Rockbox needs.}
\opt{gigabeats}{\input{getting_started/gigabeats_install.tex}}
}
\subsection{Finishing the install}\label{ref:finish_install}
\opt{gigabeatf}{
After installing you \emph{need} to power-cycle the
\dap{} by doing the following steps. Failure to do so may result in problems.
\begin{itemize}
\item Safely eject / unmount your \dap{} and unplug the USB cable.
\item Unplug any power adapter.
\item Hold the \ButtonPower{} button to turn off the \dap{}.
\item Slide the battery switch located on the bottom of the \dap{} from
`on' to `off'.
\item Slide the battery switch back from `off' to `on'.
\end{itemize}
}
\opt{m5,x5}{
After installing you \emph{need} to power-cycle the
\dap{} by doing the following steps.
\begin{itemize}
\item Safely eject / unmount your \dap{} and unplug the USB cable.
\item Hold the \ButtonPower{} button to turn off the \dap{}.
\item Insert the charger. The Rockbox bootloader will automatically be flashed.
\end{itemize}
}
\opt{h10,h10_5gb,ipod,mrobe100,sansa,archos}{
Safely eject / unmount the USB drive, unplug the cable and restart.
}
\opt{h100,h300}{
\begin{itemize}
\item Safely eject / unmount your \dap{}.
\item \warn{Before proceeding further, make sure that your player has a full charge
or that it is connected to the power adaptor. Interrupting the next step
due to a power failure most likely will brick your \dap{}.}
Update your \daps{} firmware with the patched bootloader. To do this, turn
the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
\setting{Yes} when asked to confirm if you want to upgrade the
firmware. The \playerman{} will display a message indicating that the
firmware update is in progress. Do \emph{not} interrupt this process. When the
firmware update is complete the player will turn itself off. (The update
firmware process usually takes a minute or so.). You are now ready to go.
\end{itemize}
}
\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
\index{Speech}\index{Installation!Optional Steps}
If you wish to use speech support you will also need a voice file, English ones
are available from \url{http://www.rockbox.org/daily.shtml}. Download the
``voice'' package for your player and unzip it directly to the root of your \dap.
You should now find an \fname{english.voice} in the \fname{/.rockbox/langs}
directory on your \dap{}. Voice menus are enabled by default and will come
If you wish to use speech support you will also need a voice file. Voice files
allow Rockbox to speak the user interface to you. Rockbox Utility can install
an English voice file, or you can download it from \url{http://www.rockbox.org/daily.shtml}
and unzip it to the root of your \dap{}.
Rockbox Utility can also aid you in the creation of voice files with different voices
or in other languages if you have a suitable speech engine installed on your computer.
Voice menus are enabled by default and will come
into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
on voice settings.
Rockbox Utility can also aid in the production of talk files, which allow Rockbox
to speak file and folder names.
\section{Running Rockbox}
Remove your \dap{} from the computer's USB port. %
\nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When
you next turn the unit on, Rockbox should load. }%
you next turn the unit on, Rockbox should load.}%
\opt{ipod}{Hard resetting the Ipod by holding
\opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
\opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}}
@ -354,22 +440,24 @@ use.
\note{
If you have loaded music onto your \dap{} using Itunes,
you will not be able to see your music properly in the \setting{File Browser}.
This is because Itunes changes your files' names and hides them in
directories in the \fname{Ipod\_Control} directory. Files placed on your
\dap{} using Itunes can be viewed by initializing and using Rockbox's database.
See \reference{ref:database} for more information.
This is because Itunes changes your files' names and hides them in
directories in the \fname{Ipod\_Control} directory. Files placed on your
\dap{} using Itunes can be viewed by initialising and using Rockbox's database.
See \reference{ref:database} for more information.
}
}
\section{Updating Rockbox}
Updating Rockbox is easy even if you do not use the Rockbox Utility.
Download a Rockbox build.
(The latest release of the Rockbox software will always be available from
\url{http://www.rockbox.org/download/}). Unzip the build to the root directory
of your \dap{} like you did in the installation stage. If your unzip
Rockbox can be easily updated with Rockbox Utility.
You can also update Rockbox manually - download a Rockbox build
as detailed above, and unzip the build to the root directory
of your \dap{} as in the manual installation stage. If your unzip
program asks you whether to overwrite files, choose the ``Yes to all'' option.
The new build will be installed over your current build.
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.}
@ -438,27 +526,50 @@ completely follow the manual uninstallation instructions below.}}
}
\opt{h100,h300}{
\note{
If you want to remove the Rockbox bootloader, simply flash an unpatched
\playerman{} firmware. Be aware that doing so will also remove the bootloader
USB mode. As that mode can come in quite handy (especially when
having disk errors) it is recommended to keep the bootloader. It also
USB mode. As that mode can come in quite handy (especially if you experience
disk errors) it is recommended to keep the bootloader. It also
gives you the possibility of trying Rockbox anytime later by simply
installing the distribution files.
\opt{h100}{
The Rockbox bootloader will automatically start the original firmware if
the \fname{.rockbox} directory has been deleted.
}%
\opt{h300}{%
}
\opt{h300}{
Although if you retain the Rockbox bootloader, you will need to hold the
\ButtonRec{} button each time you want to start the original firmware.
}
}
}
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.
Turn the \dap{} back on and the original \playerman{} software will load.
}
Turn the \dap{} back on and the original \playerman{} software will load.}
\section{Troubleshooting}
\begin{description}
\item[``-1 error'']
If you receive a ``-1 error'' from the bootloader, then
the bootloader cannot find the Rockbox firmware. This is usually a result of
not extracting the contents of the \fname{.zip} file to the proper location,
and should not happen when Rockbox has been installed with Rockbox Utility.
To fix this, either install Rockbox with the Rockbox Utility which will take care
of this for you, or recheck the Manual Install section to see where the files
need to be located.
\opt{sansa,ipod}{
\item[Bootloader install problems]
If you have trouble installing the bootloader,
please ensure that you are either logged in as an administrator (Windows), or
you have root rights (Linux)}
\opt{h100,h300}{
\item[Immediately loading original firmware.]
If the original firmware is immediately
loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
has not been correctly installed. The original firmware update will only perform
the update if the filename is correct, including case. Make sure that the patched
Iriver firmware is called \fname{.hex}.}
\end{description}

51
manual/getting_started/ipod_install.tex
View file

@ -1,31 +1,12 @@
% $Id$ %
\opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front,
it is a 1st generation and is compatible with Rockbox. If, on the other hand,
your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
is currently no Rockbox port available. Do not attempt to install the
bootloader on a 2nd generation Nano}}
In order to make your \dap{} load and execute the Rockbox firmware you
have just installed, you will need to install the Rockbox
bootloader. Unless bugs are found in the bootloader code, or
significant new feature are added, you will only have to perform this
step once.
\subsubsection{Bootloader installation from Windows}
\begin{enumerate}
\item Make sure you are logged into your computer as Administrator, or a
user with Administrator privileges and connect your \dap{}. If you have
configured iTunes to open automatically when your \dap{} is attached
(the default behaviour), then wait for it to open and then quit it. You
also need to ensure the ``Enable use as disk'' option is enabled for
your \dap{} in iTunes.
\item Download ipodpatcher.exe from
\download{bootloader/ipod/ipodpatcher/win32/ipodpatcher.exe}
and run it.
and run it whilst logged in with an administrator account.
\item If all has gone well, you should see some information displayed about
your \dap{} and a message asking you if you wish to install the Rockbox
@ -35,17 +16,11 @@ install the bootloader. After a short time you should see the message
ipodpatcher.
\item \note{If ipodpatcher fails to install the bootloader for you, please
be certain that you do indeed have a supported iPod model. If you do, run
be certain that you do indeed have a supported iPod model and are logged in
as an administrator. If you do, run
ipodpatcher once more and try again. If you don't, then do not attempt to
install again.}
\item Make sure that you have correctly extracted a build of Rockbox so that
you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
in the root of your \daps{} drive and that you have also installed the fonts
package -- see \reference{sec:installing_fonts} for more information.
\item Disconnect your \dap{} in the usual way. The bootloader is now installed.
\end{enumerate}
\subsubsection{Bootloader installation from Mac OS X}
@ -53,10 +28,7 @@ package -- see \reference{sec:installing_fonts} for more information.
\begin{enumerate}
\item Attach your \dap{} to your Mac and wait for its icon to appear in
Finder. If you have configured iTunes to open automatically when your
\dap{} is attached (the default behaviour), then wait for it to open and
then quit it. You also need to ensure the ``Enable use as disk'' option
is enabled for your \dap{} in iTunes.
Finder.
\item Download and open ipodpatcher.dmg from
\download{bootloader/ipod/ipodpatcher/macosx/ipodpatcher.dmg}
@ -76,18 +48,12 @@ be certain that you do indeed have a supported iPod model. If you do, run
ipodpatcher once more and try again. If you don't, then do not attempt to
install again.}
\item Your \dap{} will now automatically reconnect itself to your Mac.
Wait for it to connect, and then eject and unplug it in the normal way.
\note{You should unplug your ipod immediately after ejecting it to
prevent Rockbox immediately rebooting your \dap{} into disk mode when it
detects that your \dap{} is attached to a computer. }
\item Make sure that you have correctly extracted a build of Rockbox so that
you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
in the root of your \daps{} drive and that you have also installed the fonts
package -- see \reference{sec:installing_fonts} for more information.
\end{enumerate}
\subsubsection{Bootloader installation from Linux}
@ -110,7 +76,7 @@ steps will assume you have saved it in your home directory.
./ipodpatcher
\end{code}
\warn{You may need to be the root user in order for ipodpatcher to have
\note{You need to be the root user in order for ipodpatcher to have
sufficient permission to perform raw disk access to your \dap{}.}
\item If all has gone well, you should see some information displayed about
@ -119,11 +85,4 @@ bootloader. Press i followed by ENTER, and ipodpatcher will now install the
bootloader. After a short time you should see the message ``[INFO] Bootloader
installed successfully.'' Press ENTER again to exit ipodpatcher.
\item Make sure that you have correctly extracted a build of Rockbox so that
you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
in the root of your \daps{} drive and that you have also installed the fonts
package -- see \reference{sec:installing_fonts} for more information.
\item Disconnect your \dap{} in the usual way. The bootloader is now installed.
\end{enumerate}

87
manual/getting_started/iriver_install.tex
View file

@ -1,102 +1,29 @@
% $Id$ %
Installing the bootloader is the trickiest part of the installation.
The Rockbox bootloader allows users to boot into either the Rockbox
firmware or the \playerman{} firmware. For legal reasons, we cannot distribute
the bootloader. Instead, we have developed a program that will patch the
Iriver firmware with the Rockbox bootloader. These instructions will explain
how to download and patch the Iriver firmware with the Rockbox bootloader
and install it on your jukebox.
As explained above, we cannot distribute the bootloader directly, and
thus need to patch a compatible version of the Iriver firmware, which
can be downloaded as described above.
\begin{enumerate}
\item Download a supported version of the Iriver firmware for your
\playername{} from the Iriver website, links can be found on
\wikilink{IriverBoot}.
Supported Iriver firmware versions currently include
\opt{IRIVER_H100_PAD}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
Likewise, the iHP110 and iHP115 use the same firmware, called
\fname{ihp\_100.hex}. Be sure to use the correct firmware file for
your player.}
\opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
\note{The US \playername{} firmware is not supported and cannot be
patched to be used with the bootloader. If you wish to install Rockbox
on a US \playername, you must first install a non-US version of the
original firmware and then install one of the supported versions patched
with the Rockbox bootloader.
\warn{Installing non-US firmware on a US \playername{} will
permanently remove DRM support from the player.}}
}%
If the file that you downloaded is a \fname{.zip} file, use an unzip
utility like mentioned in the prerequisites section to extract
the \fname{.hex} from the \fname{.zip} file
to your desktop. Likewise, if the file that you downloaded is an
\fname{.exe} file, double-click on the \fname{.exe} file to extract
the \fname{.hex} file to your desktop.
When running Linux you should be able extracting \fname{.exe}
files using \fname{unzip}.
%
\item Download the firmware patcher \fname{fwpatcher.exe} from
\url{http://download.rockbox.org/bootloader/iriver/} and save it to your desktop.
\warn{The firmware patcher contains Unicode support, which is not supported by
\note{The firmware patcher contains Unicode support, which is not supported by
all versions of Windows. If you have difficulty with the firmware patcher, try
downloading the alternate firmware patcher \fname{fwpatchernu.exe}, which is
built without Unicode support.}
%
\item Go to your desktop and double-click on whichever version of the firmware
patcher you downloaded in the prior step.
\item Go to your desktop and double-click on the firmware patcher.
%
\item In the firmware patcher dialog box, click on the \setting{Browse}
button and navigate
to the \fname{.hex} file that you previously downloaded to your desktop.
to the \fname{.hex} file that you previously downloaded.
%
\item Click \setting{Patch}. The firmware patcher will patch the
original firmware to include the Rockbox bootloader. The \fname{.hex}
file on your desktop is now a modified version of the original
\fname{.hex} file.
%
\item Turn on your \playerman{} and connect it to your computer via USB.
%
\item Copy or move the modified \fname{.hex} file directly to the root of
your \daps{} drive. Do not put it inside a directory on your \dap.
%
\item Disconnect the jukebox from USB. (Be sure to use Windows' ``safely remove
hardware'' option.)
\warn{Before proceeding further, make sure that your player has a full charge
or that it is connected to the power adaptor. Interrupting the next step
due to a power failure most likely will brick your \dap{}.}
%
\item Update your \daps{} firmware with the patched bootloader. To do this, turn
the jukebox on. Press and hold the
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect{} button }%
to enter the main menu, and navigate to \setting{General $\rightarrow$ Firmware
Upgrade}. Select \setting{Yes} when asked to confirm if you want to upgrade the
firmware. The \playerman{} will display a message indicating that the
firmware update
is in progress. Do \emph{not} interrupt this process. When the
firmware update is complete the player will turn itself off. (The update
firmware process usually takes a minute or so.)
You have now installed the Rockbox bootloader.
\item Copy \fname{.hex} to the root folder (the highest level) of your \dap{}
\end{enumerate}
\note{If you install the Rockbox bootloader but do not install the
Rockbox firmware the Rockbox bootloader will load the Iriver firmware when the
jukebox is turned on.
To load the \playerman{} firmware press and hold \ButtonRec{} before
powering up the \dap{} until the \playerman{} logo appears.
}
\note{The bootloader has a built-in ``bootloader USB mode''. This function
switches to USB mode when the \dap{} is connected to a computer upon
power-up. This way you can access the \daps{} hard disk without the need
to boot any firmware (which is also useful when your hard disk is
damaged). The screen will simply display the text ``bootloader USB mode''.
After you disconnect the \dap{} from USB the bootloader will
continue booting Rockbox. As in bootloader USB mode the firmware
itself has not been loaded this is also a simple way of updating Rockbox.
After the disconnect the bootloader will load the updated version of
Rockbox.
}

4
manual/getting_started/mrobe100_install.tex
View file

@ -1,10 +1,10 @@
\subsubsection{Installation}
\begin{enumerate}
\item Download
\opt{mrobe100}{\url{http://download.rockbox.org/bootloader/olympus/mrobe100/pp5020.mi4}}
{\url{http://download.rockbox.org/bootloader/olympus/mrobe100/pp5020.mi4}}
\item Connect your \playertype{} to the computer.
\item Rename the original \fname{pp5020.mi4} file to \fname{OF.mi4} in the \fname{System} directory on your \playertype{}.
\note{You should keep a safe backup of this file for use if you ever wish to switch back to the \playerman{} firmware.}
\warn{You should keep a safe backup of this file for use if you ever wish to switch back to the \playerman{} firmware.}
\note{If you cannot see the \fname{System} directory, you will need to make sure your operating system is configured to show hidden files and directories.}
\item Copy the \fname{pp5020.mi4} file you downloaded to the System directory on your \dap{}.

38
manual/getting_started/sansa_install.tex
View file

@ -1,32 +1,11 @@
% $Id$ %
\opt{e200}{\fixme{NOTE: These instructions will not work on the
``Rhapsody'' version of the E200 series (also known as E200R). Please
follow the instructions at
\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
\warn{If your \daps{} original firmware starts with a version number of 03.XX.XX, then do \emph{not} proceed with these install instructions.
If your \daps{} original firmware starts with 01.XX.XX, then you can
install Rockbox.}
In order to make your \playertype{} load and execute the Rockbox firmware you
have just installed, you will need to install the Rockbox
bootloader. Unless bugs are found in the bootloader code, or
significant new features are added, you will only have to perform this
step once.
These steps use the sansapatcher tool. Source code is available in the Rockbox
SVN repository (\url{http://svn.rockbox.org/viewvc.cgi/trunk/rbutil/sansapatcher/}).
\subsubsection{Bootloader installation from Windows}
\begin{enumerate}
\item Make sure you are logged into your computer as Administrator, or a
user with Administrator privileges and connect your \dap{}.
\item Download sansapatcher.exe from
\download{bootloader/sandisk-sansa/sansapatcher/win32/sansapatcher.exe}
and run it.
and run it whilst logged in with an administrator account.
\item If all has gone well, you should see some information displayed about
your \playertype{} and a message asking you if you wish to install the Rockbox
@ -34,9 +13,6 @@ bootloader. Press i followed by ENTER, and sansapatcher will now
install the bootloader. After a short time you should see the message
``[INFO] Bootloader installed successfully.'' Press ENTER again to exit
sansapatcher.
\item Disconnect your \dap{} in the usual way. The bootloader is now installed.
\end{enumerate}
\subsubsection{Bootloader installation from Mac OS X}
@ -54,11 +30,8 @@ and then double-click on the sansapatcher icon inside.
information displayed about your \dap{} and a message asking you if you
wish to install the Rockbox bootloader. Press i followed by ENTER, and
sansapatcher will now unmount your \dap{} and install the bootloader.
After a short time you should see the message ``[INFO] Bootloader installed successfully.'' Press ENTER again to exit sansapatcher and then quit the Terminal application.
\item Your \dap{} will now automatically reconnect itself to your Mac.
Wait for it to connect, and then eject and unplug it in the normal way.
After a short time you should see the message ``[INFO] Bootloader installed successfully.''
Press ENTER again to exit sansapatcher and then quit the Terminal application.
\end{enumerate}
\subsubsection{Bootloader installation from Linux}
@ -81,7 +54,7 @@ steps will assume you have saved it in your home directory.
./sansapatcher
\end{code}
\warn{You may need to be the root user in order for sansapatcher to have
\note{You need to be the root user in order for sansapatcher to have
sufficient permission to perform raw disk access to your \dap{}.}
\item If all has gone well, you should see some information displayed about
@ -89,7 +62,4 @@ your \playertype{} and a message asking you if you wish to install the Rockbox
bootloader. Press i followed by ENTER, and sansapatcher will now install the
bootloader. After a short time you should see the message ``[INFO] Bootloader
installed successfully.'' Press ENTER again to exit sansapatcher.
\item Disconnect your \dap{} in the usual way. The bootloader is now installed.
\end{enumerate}