summaryrefslogtreecommitdiffstats
path: root/manual/getting_started
diff options
context:
space:
mode:
Diffstat (limited to 'manual/getting_started')
-rw-r--r--manual/getting_started/installation.tex189
-rw-r--r--manual/getting_started/iriver_install.tex69
-rw-r--r--manual/getting_started/main.tex132
3 files changed, 258 insertions, 132 deletions
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
new file mode 100644
index 0000000000..ccb5f21110
--- /dev/null
+++ b/manual/getting_started/installation.tex
@@ -0,0 +1,189 @@
+% $Id$ %
+\chapter{Installation}\label{sec:installation}
+\section{Prerequisites}\label{sec: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
+already available on your computer but if not you need to get some additional
+software.
+
+\begin{description}
+\item[zip Utility.]
+ Rockbox is distributed as an archive using the ``zip'' format. Thus you
+ need a tool to handle that compressed format. Usually your
+ computer should have a tool installed that can handle the zip file format.
+ Windows XP has builtin support for zip files and presents them to you
+ as folders unless you have installed a third party program that handles
+ compressed files. For other operating systems this may vary. If the zip file
+ format isn't recognized on your computer you can find a program to
+ handle them at \url{http://www.info-zip.org/} or
+ \url{http://sevenzip.sf.net/} which can downloaded and used free of
+ charge.
+\item[USB connection.]
+ To transfer Rockbox to your \dap{} you need to connect it to your computer.
+ To proceed you need to know where to access the \dap{}. On windows this
+ means you need to figure out the drive letter the device got associated
+ with. On Linux you need to know the mount point of 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''.
+ \fixme{add a note on how to enter the disk mode}
+ }
+\item[Text Editor.]
+ If you want to create customized configuration files you'll need a text
+ editor like Windows' ``Wordpad''. Of course you can simply save
+ configurations on the \dap{} for which you don't need an editor at all.
+ Modifying configurations from your computer is a more advanced feature
+ which you probably won't need.
+\end{description}
+
+
+
+\section{Installing Rockbox}\label{sec:installing_rockbox}
+\opt{MASCODEC}{
+ \subsection{Using the windows installer}
+ Using the Windows self installing executable to install Rockbox is the easiest
+ method of installing the software on your Jukebox. Simply follow the
+ on-screen instructions and select the appropriate drive letter and Jukebox
+ model when prompted. You can use ``Add / Remove Programs'' to uninstall the
+ software at a later date.
+
+ \subsection{Manual installation}
+ For non{}-Windows users and those wishing to install manually from the archive
+ the procedure is still fairly simple.
+}
+\opt{SWCODEC}{
+\subsection{Introduction}
+ There are two separate components of Rockbox that need to be installed in order
+ to run Rockbox.
+ \begin{enumerate}
+ \item The Rockbox bootloader. This is the component of Rockbox that is 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 Rockbox.
+ \item The Rockbox firmware. Unlike the \playerman\ firmware which runs entirely
+ from flash memory most of the Rockbox code is contained in the build that
+ resides on your \daps{} hard drive. This makes it easy to update Rockbox. The
+ build contain a file named \firmwarefilename\ and a directory called
+ \fname{.rockbox} which are located in the root directory of your hard drive.
+ \end{enumerate}
+
+% Installing the bootloader
+\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
+\opt{ipod4g,ipodcolor,ipodnano,ipodmini,ipodvideo}
+ {\input{getting_started/ipod_install.tex}}
+\opt{x5}{\input{getting_started/iaudio_install.tex}}
+
+ \subsection{Installing the firmware}
+
+ 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.
+ You need to decide which one you want to install and get the version for
+ your \dap{}.
+
+\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
+ available from \url{http://www.rockbox.org/download/}. The current version
+ includes everything meaning you won't need to download the fonts package
+ separately.
+ \opt{SWCODEC}{\note{currently there hasn't been any stable release for
+ \playerman{} \playername{}!}}
+
+\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
+ may also contain bugs! This version is generated automatically every day
+ 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,
+ but built from the latest development on each commit to the CVS repository.
+ These builds are for people who want to test the code that developers just
+ checked in.
+\end{description}
+
+If you don't want to get undefined behaviour from your \dap\ you should
+really stick to the Current Version. Development versions may have lots of
+changes so they may behave completely different than described in this manual,
+introduce new (and maybe annoying) bugs and similar. If you want to help the
+project development you can try development builds and help by reporting bugs,
+feature requests and so so. But be aware that using a development build may
+eat also some more time.
+
+After downloading the Rockbox package connect your \dap{} to the
+computer via USB as described in the manual that came with your \dap{}.
+Take the file that you downloaded above, and unpack
+its contents to your \playerman{}'s drive.
+
+You will need to unpack all of the files in the archive onto your hard disk.
+If this has been done correctly, you will 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 system
+files needed by Rockbox.
+
+\nopt{player}{
+ \note{If this is the first time you are installing Rockbox, you should also
+ download the ``Fonts'' package available on the Daily Builds page.}
+}%
+
+\note{Please note that the firmware folder starts with a leading dot. You may
+ experience problems when trying to create such folders when using Windows.
+ 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}
+If you wish to use speech support you will also need a language file, available
+from \wikilink{VoiceFiles}. For the English language, the file is called
+\fname{english.voice}. When it has been downloaded, unpack this file and copy it
+into the \fname{lang} folder which is inside the \fname{/.rockbox} folder on
+your Jukebox. Voice menus are turned on by default. See
+\reference{ref:Voiceconfiguration} for details on voice settings.
+
+\section{Running Rockbox}
+Remove your \dap{} from the computer's USB port. Unplug any connected power supply
+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.
+
+\opt{ipod}{
+\note{Rockbox starts in the \setting{File Browser}. If you have loaded music
+onto your player using Itunes, you will not be able to see your music because
+Itunes changes your files' names and hides them in directories in the
+\fname{Ipod\_Control} folder. You can view files placed on your \dap{} by 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.
+(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 step before. 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 replacing that.
+
+\note{Settings are stored on an otherwise-unused sector of your hard disk, not
+in any of the files contained in the Rockbox build. Therefore, generally
+speaking, installing a new build does \emph{not} reset Rockbox to its default
+settings. Be aware, however, that from time to time, a change is made to the
+Rockbox source code that \emph{does} cause settings to be reset to their
+defaults when a Rockbox build is updated. Thus it is recommended to save your
+settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg
+file} function before updating your Rockbox build so that you can easily 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}
+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
+ 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.}
+}
+
diff --git a/manual/getting_started/iriver_install.tex b/manual/getting_started/iriver_install.tex
index 46406fce2c..1b0e0a7db0 100644
--- a/manual/getting_started/iriver_install.tex
+++ b/manual/getting_started/iriver_install.tex
@@ -8,9 +8,10 @@
how to download and patch the Iriver firmware with the Rockbox bootloader
and install it on your jukebox.
+
\begin{enumerate}
\item Download a supported version of the Iriver firmware for your
- \playername\ from the Iriver website or from
+ \playername{} from the Iriver website or from
\wikilink{ManualRockboxInstall}.
Supported Iriver firmware versions currently include
\opt{IRIVER_H100_PAD}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
@@ -24,13 +25,15 @@
patched to be used with the bootloader. If you wish to install Rockbox
on a US \playername\, you must use an international firmware, which will
permanently remove DRM support from the player.}
- }
+ }%
If the file that you downloaded is a \fname{.zip} file, use an unzip
- utility such as \fname{InfoZip}, \fname{7zip}, \fname{WinRAR}, or
- \fname{WinZip} to extract the \fname{.hex} from the \fname{.zip} file
+ 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
+ \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.
@@ -42,39 +45,55 @@
\item Go to your desktop and double-click on whichever version of the firmware
patcher you downloaded in the prior step.
%
- \item In the firmware patcher dialog box, click on the BROWSE button and navigate
+ \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.
%
- \item Click 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 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 to the ROOT directory of
+ \item Copy or move the modified \fname{.hex} file to the root folder of
your jukebox.
%
\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.}
+ \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 \playerman{} s firmware with the patched bootloader. To do this, turn
- the jukebox on. Press and hold the
- \opt{IRIVER_H100_PAD}{\ButtonSelect{} button }%
- \opt{IRIVER_H300_PAD}{\ButtonSelect{} button }%
+ \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 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.
+ 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.
+\end{enumerate}
-\opt{h1xx}{\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.}}
+\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.
+ }
-\end{enumerate}
+\note{The bootloader has a builtin ``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{} harddisk without the need
+ to boot any firmware (which is also useful when your harddisk 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 hasn't been loaded this is also a simple way of updating Rockbox.
+ After the disconnect the bootloader will load the updated version of
+ Rockbox.
+}
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index e588d21cb4..e5a6c82aa4 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -27,11 +27,33 @@ and filenames spelled out or spoken.
\section{Getting more help}
This manual is intended to be a comprehensive introduction to the Rockbox
-software. There is, however, more help available. The Rockbox website at
+firmware. There is, however, more help available. The Rockbox website at
\url{http://www.rockbox.org/} contains very extensive documentation and guides
written by members of the Rockbox community and this should be your first port
of call when looking for further help.
+If you can't find the informations you're searching for on the Rockbox
+website there are a number of support channels you should have a look at.
+You can try the Rockbox forums located at \url{http://forums.rockbox.org/}.
+Another option are the mailing lists which can be found at
+\url{http://www.rockbox.org/mail/}. From that page you can subscribe to the
+lists and browse the archives. For searching the list archives simply use
+the search field that is located on the left side of the web site.
+Also you can ask on IRC. The main channel for rockbox is \texttt{\#rockbox}
+on \url{irc://irc.freenode.net}. A bunch of helpful developers and users
+are usually around. Just join and ask -- if someone knows the answer you'll
+usually get an answer pretty quickly. More information including IRC logs
+can be found at \url{http://www.rockbox.org/irc/}. We also have a web client
+for joining the rockbox IRC channel so there is no need for you
+to install additional software to your computer.
+
+If you think you found a bug please make sure it actually is a bug and is
+still present in the most recent version of rockbox. You should try to
+confirm that by using the above mentioned support channels first. After that
+you can submit that issue to our tracker. Refer to \reference{sec:feedback}
+for details on how to use the tracker.
+
+
\section{Naming conventions and marks}
We have some conventions especially on naming that are intended to be
consistent throughout this manual.
@@ -59,116 +81,12 @@ are used:
}
\blind{This icon marks a section that are intended especially for the blind
and visually impaired. As they can't
- read the manual in the same way seeing people can do we've added some
+ read the manual in the same way sighted people can do we've added some
additional descriptions. If you aren't blind or visually impaired you most
likely can completely skip these blocks. To make this easier, there is an
icon shown in the margin like here.
}
}{}% end ifpdfoutput
-\section{Installing Rockbox}\label{sec:installing_rockbox}
-\opt{MASCODEC}{
- \subsection{Using the windows installer}
- Using the Windows self installing executable to install Rockbox is the easiest
- method of installing the software on your Jukebox. Simply follow the
- on-screen instructions and select the appropriate drive letter and Jukebox
- model when prompted. You can use ``Add / Remove Programs'' to uninstall the
- software at a later date.
-
- \subsection{Manual installation}
- For non{}-Windows users and those wishing to install manually from the archive
- the procedure is still fairly simple.
-}
-\opt{SWCODEC}{
-\subsection{Introduction}
- There are two separate components of Rockbox that need to be installed in order
- to run Rockbox.
- \begin{enumerate}
- \item The Rockbox bootloader. This is the component of Rockbox that is 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 Rockbox.
- \item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely
- from flash memory, most of the Rockbox code is contained in the build that
- resides on your jukebox's hard drive. This makes it easy to update Rockbox. The
- build contain a file named \firmwarefilename\ and a directory called
- \fname{.rockbox} which are located in the root directory of your hard drive.
- \end{enumerate}
- \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
- \opt{ipod4g,ipodcolor,ipodnano,ipodmini,ipodvideo}
- {\input{getting_started/ipod_install.tex}}
- \opt{x5}{\input{getting_started/iaudio_install.tex}}
-
- \subsection{Installing the firmware}
-
- After installing the bootloader, the installation becomes fairly easy.}
-
- Go to \url{http://www.rockbox.org/daily.shtml} and download the latest
- Rockbox daily build for the \playertype{}. Connect your \playerman\ to the
- computer via USB as described in the manual that came with your \playerman{}.
- On Windows, the \playerman\ drive will appear as a drive letter in your
- ``My Computer'' folder. Take the file that you downloaded above, and unpack
- its contents to your \playerman\ drive. You can do this using a program
- such as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
-
- \nopt{player}{
- \note{If this is the first time you are installing Rockbox, you should also
- download the ``Fonts'' package available on the Daily Builds page.}
- }
-
- You will need to unpack all of the files in the archive onto your hard disk.
- If this has been done correctly, you will have a file called
- \fname{\firmwarefilename} in the main folder of your \playerman\ drive, and
- also a folder called /\fname{.rockbox}, which contains a number of system
- files used by the software.
-
- \note{Please note that the firmware folder starts with a leading dot. You may
- experience problems when trying to create such folders when using Windows.
- 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}
-If you wish to use speech support you will also need a language file, available
-from \wikilink{VoiceFiles}. For the English language, the file is called
-\fname{english.voice}. When it has been downloaded, unpack this file and copy it
-into the \fname{lang} folder which is inside the \fname{/.rockbox} folder on
-your Jukebox. Voice menus are turned on by default. See
-\reference{ref:Voiceconfiguration} for details on voice settings.
-
-\section{Running Rockbox}
-Remove your \dap from the computer's USB port. Unplug any connected power supply
-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.
-
-\opt{ipod}{
-\note{Rockbox starts in the \setting{File Browser}. If you have loaded music
-onto your player using Itunes, you will not be able to see your music because
-Itunes changes your files' names and hides them in directories in the
-\fname{Ipod\_Control} folder. You can view files placed on your \dap{} by 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.
-(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. 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.
-
-\note{Settings are stored on an otherwise-unused sector of your hard disk, not
-in any of the files contained in the Rockbox build. Therefore, generally
-speaking, installing a new build does \emph{not} reset Rockbox to its default
-settings. Be aware, however, that from time to time, a change is made to the
-Rockbox source code that \emph{does} cause settings to be reset to their
-defaults when a Rockbox build is updated. Thus, it is a good idea to save your
-settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg
-file} function before updating your Rockbox build so that you can easily 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}
-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 normal \playerman\ software will load.
+\input{getting_started/installation.tex} \ No newline at end of file