forked from len0rd/rockbox
General cleanup and some minor rewriting. Fixed a fixme in the ipod installation instructions and clarified uninstallation instructions for ipod and H300. Added some whitespace in the .tex file.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10921 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo
parent
8ccedc98da
commit
1f08551d12
2 changed files with 205 additions and 131 deletions
|
|
@ -1,46 +1,61 @@
|
||||||
% $Id$ %
|
% $Id$ %
|
||||||
\chapter{Installation}\label{sec:installation}
|
\chapter{Installation}\label{sec:installation}
|
||||||
|
|
||||||
\section{Prerequisites}\label{sec:prerequisites}
|
\section{Prerequisites}\label{sec:prerequisites}
|
||||||
|
|
||||||
Before installing Rockbox you should make sure you meet the prerequisites.
|
Before installing Rockbox you should make sure you meet the prerequisites.
|
||||||
Also you may need some tools for installation. In most cases these will be
|
Also you may need some tools for installation. In most cases these will be
|
||||||
already available on your computer but if not you need to get some additional
|
already available on your computer but if not you need to get some additional
|
||||||
software.
|
software.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[ZIP utility.]
|
|
||||||
Rockbox is distributed as an archive using the \fname{.zip} format. Thus you
|
\item[ZIP utility.] Rockbox is distributed as an archive using the
|
||||||
need a tool to handle that compressed format. Usually your
|
\fname{.zip} format. Thus you need a tool to handle that compressed
|
||||||
computer should have a tool installed that can handle the \fname{.zip} file
|
format. Usually your computer should have a tool installed that can
|
||||||
format.
|
handle the \fname{.zip} file format. Windows XP has builtin support for
|
||||||
Windows XP has builtin support for \fname{.zip} files and presents them to
|
\fname{.zip} files and presents them to you as folders unless you have
|
||||||
you as folders unless you have installed a third party program that handles
|
installed a third party program that handles compressed files. For
|
||||||
compressed files. For other operating systems this may vary. If the
|
other operating systems this may vary. If the \fname{.zip} file format
|
||||||
\fname{.zip} file format isn't recognized on your computer you can find a
|
is not recognized on your computer you can find a program to handle them
|
||||||
program to handle them at \url{http://www.info-zip.org/} or
|
at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which
|
||||||
\url{http://sevenzip.sf.net/} which can downloaded and used free of
|
can be downloaded and used free of charge.
|
||||||
charge.
|
|
||||||
\item[USB connection.]
|
\item[USB connection.] To transfer Rockbox to your \dap{} you need to
|
||||||
To transfer Rockbox to your \dap{} you need to connect it to your computer.
|
connect it to your computer. To proceed you need to know where to access the
|
||||||
To proceed you need to know where to access the \dap{}. On Windows this
|
\dap{}. On Windows this means you need to figure out the drive letter
|
||||||
means you need to figure out the drive letter the device got associated
|
associated with the device. On Linux you need to know the mount point of
|
||||||
with. On Linux you need to know the mount point of your \dap{}.
|
your \dap{}.
|
||||||
\opt{ipod}{A connection means you need to be able accessing your \dap{}
|
|
||||||
as hard disk meaning you need to use the so-called ``disk-mode''.
|
\opt{ipod}
|
||||||
\fixme{add a note on how to enter the disk mode}
|
{
|
||||||
}
|
\note
|
||||||
\item[Text editor.]
|
{
|
||||||
If you want to create customized configuration files you'll need a text
|
Your \dap{} should enter disk mode automatically when connected to a
|
||||||
editor like Windows' ``Wordpad''. Of course you can simply save
|
computer via USB. If your computer does not recognize your \dap{}, you
|
||||||
configurations on the \dap{} for which you don't need an editor at all.
|
may need to enter the disk mode manually. Disconnect your \dap{}
|
||||||
Modifying configurations from your computer is a more advanced feature
|
from the computer. Reset the \dap{} by pressing and holding the
|
||||||
which you probably won't need.
|
\ButtonMenu{} and \ButtonSelect{} buttons simultaneously. As soon as the
|
||||||
|
\dap{} resets, press and hold the \ButtonMenu{} and \ButtonPlay{} buttons
|
||||||
|
simultaneously. Your \dap{} should enter disk mode, and you can try
|
||||||
|
reconnecting to the computer.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
\item[Text editor.] As you will see in the following chapters, Rockbox is
|
||||||
|
highly configurable. In addition to saving configurations within Rockbox,
|
||||||
|
Rockbox also allows you to create customized 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}
|
\end{description}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\section{Installing Rockbox}\label{sec:installing_rockbox}
|
\section{Installing Rockbox}\label{sec:installing_rockbox}
|
||||||
\opt{MASCODEC}{
|
|
||||||
\subsection{Using the windows installer}
|
\opt{MASCODEC}
|
||||||
|
{
|
||||||
|
\subsection{Using the windows installer}
|
||||||
Using the Windows self installing executable to install Rockbox is the
|
Using the Windows self installing executable to install Rockbox is the
|
||||||
easiest method of installing the software on your \dap{}. Simply follow the
|
easiest method of installing the software on your \dap{}. Simply follow the
|
||||||
on-screen instructions and select the appropriate drive letter and
|
on-screen instructions and select the appropriate drive letter and
|
||||||
|
|
@ -50,89 +65,110 @@ software.
|
||||||
\subsection{Manual installation}
|
\subsection{Manual installation}
|
||||||
For non{}-Windows users and those wishing to install manually from the archive
|
For non{}-Windows users and those wishing to install manually from the archive
|
||||||
the procedure is still fairly simple.
|
the procedure is still fairly simple.
|
||||||
}
|
}
|
||||||
\opt{SWCODEC}{
|
|
||||||
|
\opt{SWCODEC}
|
||||||
|
{
|
||||||
\subsection{Introduction}
|
\subsection{Introduction}
|
||||||
|
|
||||||
There are two separate components of Rockbox that need to be installed in
|
There are two separate components of Rockbox that need to be installed in
|
||||||
order to run Rockbox.
|
order to run Rockbox.
|
||||||
\begin{enumerate}
|
|
||||||
\item The Rockbox bootloader. This is the component of Rockbox that is
|
\begin{description}
|
||||||
installed to the flash memory of your \playerman. The bootloader is the
|
|
||||||
program that tells your \dap{} how to boot and load other components of
|
\item[The Rockbox bootloader.] The bootloader is the program that tells your
|
||||||
Rockbox.
|
\dap{} how to boot and load other components of Rockbox. This is the
|
||||||
\item The Rockbox firmware. Unlike the \playerman\ firmware which runs
|
component of Rockbox that is installed to the flash memory of your
|
||||||
entirely from flash memory, most of the Rockbox code is contained in the
|
\playerman.
|
||||||
build that resides on your \daps{} hard drive. This makes it easy to update
|
|
||||||
Rockbox. The build consist of a file named \firmwarefilename\ and a
|
\item[The Rockbox firmware.] Unlike the \playerman\ firmware, which runs
|
||||||
directory called \fname{.rockbox} which are located in the root directory
|
entirely from flash memory, most of the Rockbox code is contained in a
|
||||||
of your hard drive.
|
``build'' that resides on your \daps{} hard drive. This makes it easy to
|
||||||
\end{enumerate}
|
update Rockbox. The build consists of a file named \firmwarefilename\ and a
|
||||||
|
directory called \fname{.rockbox}, both of which are located in the root
|
||||||
|
directory of your hard drive.
|
||||||
|
|
||||||
|
\end{description}
|
||||||
|
|
||||||
% Installing the bootloader
|
\subsection{Installing the bootloader}
|
||||||
\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
|
\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
|
||||||
\opt{ipod4g,ipod3g,ipodcolor,ipodnano,ipodmini,ipodvideo}
|
\opt{ipod}{\input{getting_started/ipod_install.tex}}
|
||||||
{\input{getting_started/ipod_install.tex}}
|
\opt{x5}{\input{getting_started/iaudio_install.tex}}
|
||||||
\opt{x5}{\input{getting_started/iaudio_install.tex}}
|
|
||||||
|
|
||||||
\subsection{Installing the firmware}
|
\subsection{Installing the firmware}
|
||||||
|
After installing the bootloader, the installation becomes fairly easy.
|
||||||
After installing the bootloader, the installation becomes fairly easy.}
|
}
|
||||||
There are three different types of firmware binaries from Rockbox website:
|
|
||||||
Current Version, Daily Build and Bleeding Edge.
|
There are three different types of firmware binaries from Rockbox website:
|
||||||
You need to decide which one you want to install and get the version for
|
current version, daily build and CVS build. You need to decide which one you
|
||||||
your \dap{}.
|
want to install and get the version for your \dap{}.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\item[Current Version.] The current version is the latest stable version
|
|
||||||
developed by the Rockbox Team. It's free of known critical bugs. It is
|
\item[Current Version.] The current version is the latest stable release, free
|
||||||
available from \url{http://www.rockbox.org/download/}. The current version
|
of known critical bugs. The current stable release of Rockbox, version 2.5,
|
||||||
includes everything meaning you won't need to download the fonts package
|
is available at \url{http://www.rockbox.org/download/}.
|
||||||
separately.
|
\opt{SWCODEC}{
|
||||||
\opt{SWCODEC}{\note{currently there hasn't been any stable release for
|
\note{The current stable release is available only for Archos jukeboxes.
|
||||||
\playername{}!}}
|
There has not yet been a stable release for the \playername{}. Until
|
||||||
|
there is a stable release for \playername{}, use a daily build or CVS build.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
\item[Daily Build.] The Daily Build is a development version of Rockbox. It
|
\item[Daily Build.] The daily build is a development version of Rockbox. It
|
||||||
supports all new features and patches developed since last stable version. It
|
contains features and patches developed since last stable version. It
|
||||||
may also contain bugs! This version is generated automatically every day
|
may also contain bugs! This daily build is generated automatically every day
|
||||||
and can be found at \url{http://www.rockbox.org/daily.shtml}.
|
and can be found at \url{http://www.rockbox.org/daily.shtml}.
|
||||||
The daily builds don't include the fonts (as they change rarely).
|
|
||||||
When installing Rockbox for the first time you should install the fonts
|
|
||||||
package.
|
|
||||||
|
|
||||||
\item[Bleeding Edge.] Bleeding edge builds are the same as the Daily build,
|
\item[CVS Build (formerly, ``Bleeding Edge Build.'')] CVS stands for
|
||||||
but built from the latest development on each commit to the CVS repository.
|
``Concurrent Versions System.'' CVS is the system that Rockbox
|
||||||
These builds are for people who want to test the code that developers just
|
developers use to keep track of changes to the Rockbox source code. CVS
|
||||||
checked in.
|
builds are made automatically every time there is a change to the
|
||||||
|
Rockbox source. These builds are for people who want to test the code
|
||||||
|
that developers just checked in.
|
||||||
|
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
\nopt{player}{
|
||||||
|
\note{
|
||||||
|
Rockbox has a fonts package that is available at
|
||||||
|
\url{http://www.rockbox.org/daily.shtml}. While the daily builds and CVS
|
||||||
|
builds change frequently, the fonts package rarely changes. Thus, the
|
||||||
|
fonts package is not included in the daily builds and CVS builds. (The
|
||||||
|
stable release, on the other hand, does not change, so fonts are
|
||||||
|
include with the stable release.) When installing Rockbox for the
|
||||||
|
first time, you should install the fonts package.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
If you don't want to get undefined behaviour from your \dap\ you should
|
Because daily builds and CVS builds are development versions which change
|
||||||
really stick to the Current Version. Development versions may have lots of
|
frequently, they may behave differently than described in this manual, or
|
||||||
changes so they may behave completely different than described in this manual,
|
they may introduce new (and maybe annoying) bugs. If you do not want to get
|
||||||
introduce new (and maybe annoying) bugs and similar. If you want to help the
|
undefined behaviour from your \dap\ you should really stick to the current
|
||||||
project development you can try development builds and help by reporting bugs,
|
stable release, if there is one for your \dap{}. If you want to help the
|
||||||
feature requests and so so. But be aware that using a development build may
|
project development, you can try development builds and help by reporting
|
||||||
eat also some more time.
|
bugs. Just be aware that these are development builds that are highly
|
||||||
|
functional, but not perfect!
|
||||||
|
|
||||||
After downloading the Rockbox package connect your \dap{} to the
|
After downloading the Rockbox package connect your \dap{} to the computer via
|
||||||
computer via USB as described in the manual that came with your \dap{}.
|
USB as described in the manual that came with your \dap{}. Take the file that
|
||||||
Take the file that you downloaded above, and unpack
|
you downloaded above, and extract its contents to your \daps{} drive.
|
||||||
its contents to your \playerman{}'s drive.
|
|
||||||
|
|
||||||
You will need to unpack all of the files in the archive onto your hard disk.
|
Use the ``Extract all'' command of your unzip program to extract the files in
|
||||||
If this has been done correctly, you will have a file called
|
the \fname{.zip} file onto your \dap{}. Note that the entire contents of the
|
||||||
\fname{\firmwarefilename} in the main folder of your \daps{} drive, and
|
\fname{/zip} file should be extracted directly to the root of your \daps{}
|
||||||
also a folder called /\fname{.rockbox}, which contains a number of system
|
drive. Do not try to create a separate directory or folder on your \dap{} for
|
||||||
files needed by Rockbox.
|
the Rockbox files! The \fname{.zip} file already contains the internal
|
||||||
|
directory structure that Rockbox needs.
|
||||||
|
|
||||||
\nopt{player}{
|
\note{
|
||||||
\note{If this is the first time you are installing Rockbox, you should also
|
If the contents of the \fname{.zip} file are extracted correctly, you will
|
||||||
download the ``Fonts'' package available on the Daily Builds page.}
|
have a file called \fname{\firmwarefilename} in the main folder of your
|
||||||
}%
|
\daps{} drive, and also a folder called /\fname{.rockbox}, which contains a
|
||||||
|
number of other folders and system files needed by Rockbox. If you receive a
|
||||||
\note{Please note that the firmware folder starts with a leading dot. You may
|
``-1'' error when you start Rockbox, you have not extracted the contents of
|
||||||
experience problems when trying to create such folders when using Windows.
|
the \fname{.zip} file to the proper location.
|
||||||
Directly unzipping to your \daps{} drive works flawlessly; it is only Windows'
|
}
|
||||||
Explorer that is limited in handling such files.}
|
|
||||||
|
|
||||||
\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
|
\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
|
||||||
If you wish to use speech support you will also need a language file, available
|
If you wish to use speech support you will also need a language file, available
|
||||||
|
|
@ -148,45 +184,83 @@ and turn the unit off. When you next turn the unit on, Rockbox should load. When
|
||||||
you see the Rockbox splash screen, Rockbox is loaded and ready for use.
|
you see the Rockbox splash screen, Rockbox is loaded and ready for use.
|
||||||
|
|
||||||
\opt{ipod}{
|
\opt{ipod}{
|
||||||
\note{Rockbox starts in the \setting{File Browser}. If you have loaded music
|
\note{
|
||||||
onto your player using Itunes, you will not be able to see your music because
|
Rockbox starts in the \setting{File Browser}. If you have loaded music onto
|
||||||
Itunes changes your files' names and hides them in directories in the
|
your player using Itunes, you will not be able to see your music because
|
||||||
\fname{Ipod\_Control} folder. You can view files placed on your \dap{} by Itunes
|
Itunes changes your files' names and hides them in directories in the
|
||||||
by initializing and using Rockbox's Tag Cache. See \reference{ref:tagcache} for
|
\fname{Ipod\_Control} folder. You can view files placed on your \dap{} by
|
||||||
more information.}
|
Itunes by initializing and using Rockbox's Tag Cache. See
|
||||||
}
|
\reference{ref:tagcache} for more information.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
\section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build.
|
\section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build.
|
||||||
(The latest release of the Rockbox software will always be available from
|
(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
|
\url{http://www.rockbox.org/download/}). Unzip the build to the root directory
|
||||||
of your \dap{} like you did in the installation step before. If your unzip
|
of your \dap{} like you did in the installation step before. If your unzip
|
||||||
program asks you whether to overwrite files, choose the ``Yes to all'' option.
|
program asks you whether to overwrite files, choose the ``Yes to all'' option.
|
||||||
The new build will be installed over your current build replacing that.
|
The new build will be installed over your current build.
|
||||||
|
|
||||||
\note{Settings are stored on an otherwise-unused sector of your hard disk, not
|
\note{
|
||||||
in any of the files contained in the Rockbox build. Therefore, generally
|
Settings are stored on an otherwise-unused sector of your hard disk, not in
|
||||||
speaking, installing a new build does \emph{not} reset Rockbox to its default
|
any of the files contained in the Rockbox build. Therefore, generally
|
||||||
settings. Be aware, however, that from time to time, a change is made to the
|
speaking, installing a new build does \emph{not} reset Rockbox to its default
|
||||||
Rockbox source code that \emph{does} cause settings to be reset to their
|
settings. Be aware, however, that from time to time, a change is made to the
|
||||||
defaults when a Rockbox build is updated. Thus it is recommended to save your
|
Rockbox source code that \emph{does} cause settings to be reset to their
|
||||||
settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg
|
defaults when a Rockbox build is updated. Thus it is recommended to save your
|
||||||
file} function before updating your Rockbox build so that you can easily restore
|
settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg
|
||||||
the settings if necessary. For additional information on how to save, load, and
|
file} function before updating your Rockbox build so that you can easily
|
||||||
reset Rockbox's settings, see \reference{ref:SystemOptions}.}
|
restore the settings if necessary. For additional information on how to save,
|
||||||
|
load, and reset Rockbox's settings, see \reference{ref:SystemOptions}.
|
||||||
|
}
|
||||||
|
|
||||||
\section{Uninstalling Rockbox}
|
\section{Uninstalling Rockbox}
|
||||||
If you would like to go back to using the original \playerman\ software, then
|
|
||||||
connect the \playerman\ to your computer, and delete the
|
|
||||||
\fname{\firmwarefilename} file. If you wish to clean up your disk, you may also
|
|
||||||
wish to delete the \fname{.rockbox} folder and its contents. Turn the
|
|
||||||
\playerman\ off and on and the original \playerman\ software will load.
|
|
||||||
|
|
||||||
\opt{h1xx,h300}{\note{There's no need to remove the installed boot loader. If you
|
If you would like to go back to using the original \playerman{} software, then
|
||||||
want to remove it simply flash an unpatched \playerman{} firmware.
|
connect the \playerman{} to your computer, and delete the
|
||||||
Be aware that doing so will also remove the bootloader USB mode. As that
|
\fname{\firmwarefilename} file.
|
||||||
mode can come in quite handy (especially when having 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.}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
\optv{ipod}{
|
||||||
|
Next, open a command window (Windows) or a terminal window (Mac or Linux).
|
||||||
|
Navigate to the folder you created when you downloaded the
|
||||||
|
\fname{ipodpatcher} program you used to install the Rockbox bootloader.
|
||||||
|
Type the following command:
|
||||||
|
|
||||||
|
\begin{code}
|
||||||
|
ipodpatcher -r \emph{N} bootpartition.bin
|
||||||
|
\end{code}
|
||||||
|
|
||||||
|
Remember that \emph{N} is the number that you found when you installed
|
||||||
|
Rockbox on your \playerman{}.
|
||||||
|
}
|
||||||
|
|
||||||
|
If you wish to clean up your disk, you may also wish to delete the
|
||||||
|
\fname{.rockbox} folder and its contents. Turn the \playerman{} off.
|
||||||
|
|
||||||
|
\opt{h300}{Press and hold the \ButtonRec{} button.}
|
||||||
|
|
||||||
|
Turn the \dap{} back on and the original \playerman{} software will load.
|
||||||
|
|
||||||
|
\opt{h1xx}{
|
||||||
|
\note{
|
||||||
|
There's no need to remove the installed bootloader. If you want to remove it
|
||||||
|
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 gives you the possibility of trying Rockbox anytime
|
||||||
|
later by simply installing the distribution files.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
\opt{h300}{
|
||||||
|
\note{
|
||||||
|
There's no need to remove the installed bootloader, although you 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 want to remove it
|
||||||
|
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), you may wish to keep the bootloader.
|
||||||
|
It also gives you the possibility of trying Rockbox anytime later by simply
|
||||||
|
installing a new build.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
% $Id$ %
|
% $Id$ %
|
||||||
\subsection{Installing the bootloader}
|
|
||||||
\warn{These instructions are preliminary and may contain errors!
|
\warn{These instructions are preliminary and may contain errors!
|
||||||
Please check the wiki for up-to-date and improved installation instructions!
|
Please check the wiki for up-to-date and improved installation instructions!
|
||||||
If you find errors you're of course welcomed to report them so we can fix it
|
If you find errors you're of course welcomed to report them so we can fix it
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue