summaryrefslogtreecommitdiff
path: root/manual/getting_started/installation.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/getting_started/installation.tex')
-rw-r--r--manual/getting_started/installation.tex523
1 files changed, 317 insertions, 206 deletions
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 39e5e2ee9c..bfcc7ea4d3 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -1,37 +1,143 @@
1% $Id$ % 1% $Id$ %
2\chapter{Installation}\label{sec:installation} 2\chapter{Installation}\label{sec:installation}
3 3
4\opt{ipodnano}{ 4Installing Rockbox is generally a quick and easy procedure. However
5 \note{Rockbox presently runs only on the original Ipod Nano. Rockbox does 5before beginning there are a few things it is important to know.
6 \emph{not} run on the second, third, or fourth generation Ipod Nano. 6
7 For information on identifying which Ipod you own, see this page on 7\section{Before Starting}
8 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}. 8
9\opt{e200}{\fixme{NOTE: These instructions will not work on the
10``Rhapsody'' version of the E200 series (also known as E200R). Please
11follow the instructions at
12\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
13
14\opt{ipodnano,ipodvideo,e200,c200}{
15\begin{description}
16\item[Supported hardware versions.]
17 \opt{ipodnano}{
18 The \playertype{} is available in multiple versions, not
19 all of which run Rockbox. Rockbox presently runs only on
20 the original Ipod Nano. Rockbox does
21 \emph{not} run on the second, third, or fourth generation Ipod Nano.
22 For information on identifying which Ipod you own, see this page on
23 Apple's website: \url{http://www.info.apple.com/kbnum/n61688}.
9 } 24 }
25 \opt{ipodvideo}{
26 The \playertype{} is the 5th/5.5th generation \playerman{} only.
27 Rockbox does \emph{not} run on the newer, 6th/Classic generation Ipod.
28 For information on identifying which Ipod you own, see this page on Apple's
29 website: \url{http://www.info.apple.com/kbnum/n61688}.
30 }
31 \opt{e200,c200}{
32 The \playertype{} is available in multiple versions, not
33 all of which run Rockbox. Rockbox doesn't run on the
34 newer v2 models. They can be identified
35 by checking the Sandisk firmware version number under
36 Settings $\rightarrow$ Info. The v1
37 firmware is named 01.xx.xx, while the v2 firmware begins with 03.
38 }
39\end{description}
40}
41
42\opt{h300}{
43\begin{description}
44 \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will
45 \emph{permanently} lose the ability to playback files with DRM.
46\end{description}
10} 47}
11\opt{ipodvideo}{ 48
12 \note{Rockbox presently runs only on the 5th and 5.5th generation Ipod videos. 49\begin{description}
13 Rockbox does \emph{not} run on the newer, 6th/Classic generation Ipod. 50\item[USB connection.] To transfer Rockbox to your \dap{} you need to
14 For information on identifying which Ipod you own, see this page on Apple's 51 connect it to your computer. For manual installation/uninstallation, or
15 website: \url{http://www.info.apple.com/kbnum/n61688}. 52 should autodetection fail during automatic installation, you need to know
53 where to access the \dap{}. On Windows this means you need to know
54 the drive letter associated with the \dap{}. On Linux you need to know
55 the mount point of your \dap{}. On Mac OS X you need to know the volume
56 name of your \dap{}.
57
58 \opt{ipod}{
59 If you have Itunes installed and it is configured to open automatically
60 when your \dap{} is attached (the default behaviour),
61 then wait for it to open and then quit it. You
62 also need to ensure the ``Enable use as disk'' option is enabled for
63 your \dap{} in Itunes. Your \dap{} should then enter disk mode
64 automatically when connected to a
65 computer via USB. If your computer does not recognise your \dap{}, you may
66 need to enter disk mode manually. Disconnect your \dap{} from the
67 computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
68 \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
69 and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
70 \dap{} should enter disk mode and you can try reconnecting to the computer.
16 } 71 }
72 \opt{ipod3g,ipod4g,ipodcolor,ipodmini}{
73 \index{Firewire}Firewire detection is not supported in Rockbox at
74 the moment. Please use USB only.
75 }
76 \opt{x5}{
77 When instructed to connect/disconnect the USB cable, always use
78 the USB port through the subpack, not the side 'USB Host' port. The side port
79 is intended to be used for USB OTG connections only (digital cameras, memory
80 sticks, etc.).
81 }
82 \opt{sansa}{The following steps require you to change the setting in
83 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
84 original firmware.
85
86 \warn{Never extract files to your \dap{} while it is in recovery mode.}
87 }
88 \opt{h10,h10_5gb}{
89 The installation requires you to use UMS mode and so
90 may require use of the UMS trick, whereby it is possible to force a MTP
91 \playertype{} to start up in UMS mode as follows:
92 \begin{enumerate}
93 \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to
94 push the small reset button inside the hole between the Hold switch and
95 remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.}
96 \item Connect your \playertype{} to the computer using the data cable.
97 \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on.
98 \item Continue holding \ButtonRight{} until the USB Connected screen appears.
99 \item The \dap{} will now appear as a regular disk on your computer.
100 \end{enumerate}
101 \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally
102 power the player off so step 1 is no longer necessary.}
103 }
104 \opt{gigabeatf}{During installation, do not connect your \dap{}
105 using the cradle but plug the USB cable directly to the \dap{}.
106 }
107\end{description}
108
109\opt{ipod,sansa}{
110\begin{description}
111 \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox
112 requires you to have administrative (Windows) or root (Linux) rights.
113 Consequently when doing either the automatic or manual bootloader install,
114 please ensure that you are logged in with an administrator account or have root rights.
115\end{description}
17} 116}
18\opt{e200,c200}{ 117
19 \note{Rockbox doesn't function on the newer v2 models. They can be identified 118\opt{ipod}{
20 by checking the Sandisk firmware version number under 119\begin{description}
21 Settings $\rightarrow$ Info. The v1 120 \item[File system format.] Rockbox only works on Ipods formatted with
22 firmware is named 01.xx.xx, while the v2 firmware begins with 03.} 121 the FAT32 filesystem (i.e. Ipods initialised by Itunes
122 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
123 initialised by Itunes for the Mac). More information and instructions for
124 converting an Ipod to FAT32 can be found on the
125 \wikilink{IpodConversionToFAT32} wiki
126 page on the Rockbox website. Note that after conversion, you can still use
127 a FAT32 Ipod with a Mac.
128\end{description}
23} 129}
24 130
25\section{Overview} 131\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
26There are two ways of installing Rockbox: automated and manual. While the 132There are two ways to install Rockbox: automated and manual. The automated
27manual way is older, more tested and proven to work correctly, the 133way is the preferred method of installing Rockbox for the majority of
28automated installation is based on a nice graphical application that does 134people. Rockbox Utility is a graphical
29almost everything for you. It is still important that you have 135application that does almost everything for you.
30an overview of the installation process to be able to select the correct 136However, should you encounter a problem, then the manual way is
31installation options. 137still available to you.
32 138
33\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need 139\opt{MASCODEC}{Rockbox itself comes as a single package. There is no need
34 to install additional software for running Rockbox.} 140 to install additional software to run Rockbox.}
35\opt{swcodec} { 141\opt{swcodec} {
36 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components, 142 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
37 two of which need to be installed in order to run Rockbox:} 143 two of which need to be installed in order to run Rockbox:}
@@ -43,7 +149,7 @@ installation options.
43\item[The \playerman{} bootloader.] 149\item[The \playerman{} bootloader.]
44 The \playerman{} bootloader is the program that tells your \dap{} how to load 150 The \playerman{} bootloader is the program that tells your \dap{} how to load
45 and start the original firmware. It is also responsible for any emergency, 151 and start the original firmware. It is also responsible for any emergency,
46 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash 152 recovery, or disk modes on your \dap{}. This bootloader is stored in special flash
47 memory in your \playerman{} and comes factory-installed. It is not necessary 153 memory in your \playerman{} and comes factory-installed. It is not necessary
48 to modify this in order to install Rockbox.} 154 to modify this in order to install Rockbox.}
49 155
@@ -56,9 +162,10 @@ installation options.
56 162
57 \opt{HAVE_RB_BL_IN_FLASH}{ 163 \opt{HAVE_RB_BL_IN_FLASH}{
58 The bootloader is the program that tells your 164 The bootloader is the program that tells your
59 \dap{} how to load and start other components of Rockbox. This is the 165 \dap{} how to load and start other components of Rockbox and for providing
60 component of Rockbox that is installed to the flash memory of your 166 the dual boot function. This is the component of Rockbox that is installed
61 \playerman.} 167 to the flash memory of your \playerman.
168 \opt{iaudio}{\note{Dual boot does not currently work on the \playertype{}.}}}
62 169
63\item[The Rockbox firmware.] 170\item[The Rockbox firmware.]
64 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs 171 \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs
@@ -82,168 +189,125 @@ installation options.
82 separately. They are not required to run Rockbox itself but 189 separately. They are not required to run Rockbox itself but
83 a lot of themes require the fonts package to be installed. 190 a lot of themes require the fonts package to be installed.
84 191
85 \item[Themes.] The view of Rockbox can be customized by themes. Depending 192 \item[Themes.] The appearance of Rockbox can be customised by themes. Depending
86 on your taste you might want to install additional themes to change 193 on your taste you might want to install additional themes to change
87 the look of Rockbox. 194 the look of Rockbox.
88 \end{description} 195 \end{description}
89} 196}
90 197
91\section{Prerequisites}\label{sec:prerequisites}
92\index{Installation!Prerequisites}
93Before installing Rockbox you should make sure you meet the prerequisites.
94You may need some additional tools for installation. In most cases these will already be available on your computer, but if not, installing some additional
95software might be necessary.
96
97\begin{description}
98\item[USB connection.] To transfer Rockbox to your \dap{} you need to
99 connect it to your computer. For manual installation/uninstallation, or
100 should autodetection fail during automatic installation, you need to know
101 where to access the \dap{}. On Windows this means you need to figure out
102 the drive letter associated with the \dap{}. On Linux you need to know the
103 mount point of your \dap{}.
104
105 \opt{ipod}{
106 Your \dap{} should enter disk mode automatically when connected to a
107 computer via USB. If your computer does not recognise your \dap{}, you may
108 need to enter the disk mode manually. Disconnect your \dap{} from the
109 computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
110 \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
111 and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
112 \dap{} should enter disk mode and you can try reconnecting to the computer.
113 }
114
115 \opt{ipod3g,ipod4g,ipodcolor,ipodmini}{
116 \note{\index{Firewire}Firewire detection is not supported in Rockbox at
117 the moment. Please use USB only.}
118 }
119 \opt{x5}{
120 \note{When instructed to connect/disconnect the USB cable, always use
121 the USB port through the subpack, not the side 'USB Host' port! The side port
122 is intended to be used for USB OTG connections only (digital cameras, memory
123 sticks, etc)!}
124 }
125
126 \opt{sansa}{\warn{The following steps require you to change the setting in
127 \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the
128 original firmware. Never extract files to your \dap{} while it is in
129 recovery mode.}}
130 \opt{h10,h10_5gb}{\warn{The following steps require you to use UMS mode and so
131 may require use of the UMS trick as described in the bootloader installation
132 section.}}
133 \opt{gigabeatf}{\warn{During installation, do not connect your \dap{}
134 using the cradle but plug the USB cable directly to the \dap{}.}}
135\end{description}
136For manual installation and customization additional software is required.
137\begin{description}
138\item[ZIP utility.]\index{zip}
139 Rockbox is distributed as a compressed archive using the
140 \fname{.zip} format. Your computer will normally already have a means of
141 handling such archive files. Windows XP has built-in support for
142 \fname{.zip} files and presents them to you as directories unless you
143 have installed a third party program that handles compressed files. For
144 other operating systems this may vary. If the \fname{.zip} file format
145 is not recognised on your computer you can find a program to handle them
146 at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/}, both of
147 which can be downloaded and used free of charge.
148\item[Text editor.] As you will see in the following chapters, Rockbox is
149 highly configurable. In addition to saving configurations,
150 Rockbox also allows you to create customised configuration files. If you
151 would like to edit custom configuration files on your computer, you will
152 need a text editor like Windows' ``Wordpad''.
153\end{description}
154
155\opt{ipod}{
156 \note{In addition to the requirements described above, Rockbox only works on
157 Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by Itunes
158 for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
159 initialized by Itunes for the Mac). More information and instructions for
160 converting an Ipod to FAT32 can be found on the
161 \wikilink{IpodConversionToFAT32} wiki
162 page on the Rockbox website. Note that after conversion, you can still use
163 a FAT32 Ipod on a Mac.
164 }
165}
166
167\section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation}
168
169\opt{ipodvideo}{\warn{There are separate versions of Rockbox for the 30GB and
170 60GB/80GB models. You must ensure you download the correct version for your
171 \dap{}.}}
172
173\subsection{Automated Installation} 198\subsection{Automated Installation}
174 199
175\opt{mrobe100}
176
177To automatically install Rockbox, download the official installer and 200To automatically install Rockbox, download the official installer and
178housekeeping tool \caps{Rockbox Utility}. It allows you to: 201housekeeping tool \caps{Rockbox Utility}. It allows you to:
179\begin{itemize} 202\begin{itemize}
180\item Automatically install all needed components for using Rockbox 203\item Automatically install all needed components for using Rockbox
181 (``Small Installation'') 204 (``Minimal Installation'').
182\item Automatically install all suggested components (``Full Installation'') 205\item Automatically install all suggested components (``Complete Installation'').
183\item Selectively install optional components 206\item Selectively install optional components.
184\item Install additional themes 207\nopt{player}{\item Install additional fonts and themes.}
185\item Install voice files and generate talk clips 208\item Install voice files and generate talk clips.
186\item Uninstall all components you installed using Rockbox Utility 209\item Uninstall all components you installed using Rockbox Utility.
187\end{itemize} 210\end{itemize}
188Prebuilt binaries for Windows, Linux and MacOS~X are 211
189available at the \wikilink{RockboxUtility} wiki page. 212Prebuilt binaries for Windows, Linux and Mac OS X are
190\\* 213available at the \wikilink{RockboxUtility} wiki page.\\
191\warn{When first starting \caps{Rockbox Utility} run ``Autodetect'', 214
215When first starting \caps{Rockbox Utility} run ``Autodetect'',
192found in the configuration dialog (File $\rightarrow$ Configure). Autodetection 216found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
193can detect most player types. If autodetection fails or is unable to detect 217can detect most player types. If autodetection fails or is unable to detect
194the mountpoint, make sure to enter the correct values. The mountpoint indicates 218the mountpoint, make sure to enter the correct values. The mountpoint indicates
195the location of the \dap{} in your filesystem. On Windows, this is the drive 219the location of the \dap{} in your filesystem. On Windows, this is the drive
196letter the \dap{} gets assigned, on other systems this is a path in the 220letter the \dap{} gets assigned, on other systems this is a path in the
197filesystem.} 221filesystem.\\*
198 222
199\opt{ipodvideo} 223\opt{ipodvideo}
200 {\warn{Autodetection is unable to distinguish between the 224 {\note{Autodetection is unable to distinguish between the
201 \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the 225 \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
202 30~GB model. This will usually work but you might want to check the 226 30~GB model. This will usually work but you might want to check the
203 detected value, especially if you experience problems with Rockbox.} 227 detected value, especially if you experience problems with Rockbox.}
204} 228}
205 229
206\note{Rockbox Utility currently lacks some guiding messages. Please have a 230\opt{h100,h300}{
207 look at the manual installation instructions if you are stuck 231 Rockbox Utility will ask you for a compatible copy of the original
208 during installation.} 232 firmware. This is because for legal reasons we cannot distribute
209 233 the bootloader directly. Instead, we have to patch the Iriver firmware
210\subsection{Manual Installation} 234 with the Rockbox bootloader.
235
236 Download a supported version of the Iriver firmware for your
237 \playername{} from the Iriver website, links can be found on
238 \wikilink{IriverBoot}.
239
240 Supported Iriver firmware versions currently include
241 \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US,
242 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120;
243 H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}.
244 Likewise, the iHP110 and iHP115 use the same firmware, called
245 \fname{ihp\_100.hex}. Be sure to use the correct firmware file for
246 your player.}
247 \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
248 \note{The US \playername{} firmware is not supported and cannot be
249 patched to be used with the bootloader. If you wish to install Rockbox
250 on a US \playername{}, you must first install a non-US version of the
251 original firmware and then install one of the supported versions patched
252 with the Rockbox bootloader.
253 \warn{Installing non-US firmware on a US \playername{} will
254 permanently remove DRM support from the player.}}}
255
256 If the file that you downloaded is a \fname{.zip} file, use an unzip
257 utility like mentioned in the prerequisites section to extract
258 the \fname{.hex} from the \fname{.zip} file
259 to your desktop. Likewise, if the file that you downloaded is an
260 \fname{.exe} file, double-click on the \fname{.exe} file to extract
261 the \fname{.hex} file to your desktop.
262 When running Linux you should be able to extract \fname{.exe}
263 files using \fname{unzip}.
264}
211 265
212\subsubsection{Choosing a Rockbox version}\label{sec:choosing_version} 266\subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
213 267
214There are three different types of firmware binaries available from the 268There are three different versions of Rockbox available from the
215Rockbox website: 269Rockbox website:
216\label{Version} 270\label{Version}
217Release version, current build and daily build. You need to decide which one 271Release version, current build and archived daily build. You need to decide which one
218you want to install and get the appropriate version for your \dap{}. 272you want to install and get the appropriate version for your \dap{}. If you
273select either ``Minimal Installation'' or ``Complete Installation'' from the
274``Quick Start'' tab, then Rockbox Utility will automatically install the
275release version of Rockbox. Using the ``Installation'' tab will allow you
276to select which version you wish to install.
219 277
220\begin{description} 278\begin{description}
221 279
222\item[Release.] The release version is the latest stable release, free 280\item[Release.] The release version is the latest stable release, free
223 of known critical bugs. The current stable release of Rockbox is 281 of known critical bugs. For a manual install, the current stable release of Rockbox is
224 available at \url{http://www.rockbox.org/download/}. 282 available at \url{http://www.rockbox.org/download/}.
225 283
226\item[Current Build.] The current build is built at each source code change to 284\item[Current Build.] The current build is built at each source code change to
227 the Rockbox SVN repository and represents the current state of Rockbox 285 the Rockbox SVN repository and represents the current state of Rockbox
228 development. This means that the build could contain bugs but most of 286 development. This means that the build could contain bugs but most of
229 the time is safe to use. You can download the current build from 287 the time is safe to use. For a manual install, you can download the current build from
230 \url{http://build.rockbox.org/}. 288 \url{http://build.rockbox.org/}.
231 289
232\item[Archived Build.] In addition to the release version and the current build, 290\item[Archived Build.] In addition to the release version and the current build,
233 there is also an archive of daily builds available for download. These are 291 there is also an archive of daily builds available for download. These are
234 built once a day from the latest source code in the SVN repository. You can 292 built once a day from the latest source code in the SVN repository. For a manual install,
235 download archived builds from \url{http://www.rockbox.org/daily.shtml}. 293 you can download archived builds from \url{http://www.rockbox.org/daily.shtml}.
236 294
237\end{description} 295\end{description}
238 296
239\warn{Because current builds and daily builds are development versions which 297\note{Because current and archived builds are development versions that
240 change frequently, they may behave differently than described in this manual, 298 change frequently, they may behave differently than described in this manual,
241 or they may introduce new (and maybe annoying) bugs. If you do not want to 299 or they may introduce new (and potentially annoying) bugs. Unless you wish to
242 get undefined behaviour from your \dap{}, you should stick to the current 300 try the latest and greatest features at the price of possibly greater instability,
243 stable release if there is one for your \dap{}. If you want to help with 301 or you wish to help with development, you should stick with the release.\\*}
244 project development, you can try development builds and help by reporting bugs. 302
245 Just be aware that these are development builds that are highly functional 303Please now go to \reference{ref:finish_install} to complete the installation procedure.
246 but not perfect!} 304
305\subsection{Manual Installation}
306
307The manual installation method is still available to you, should you need or desire it
308by following the instructions below. If you have used Rockbox Utility
309to install Rockbox, then you do not need to follow the next section and can skip
310straight to \reference{ref:finish_install}
247 311
248\subsubsection{Installing the firmware}\label{sec:installing_firmware} 312\subsubsection{Installing the firmware}\label{sec:installing_firmware}
249 313
@@ -251,6 +315,9 @@ you want to install and get the appropriate version for your \dap{}.
251 315
252\item Download your chosen version of Rockbox from the links in the 316\item Download your chosen version of Rockbox from the links in the
253 previous section. 317 previous section.
318\opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and
31960GB/80GB models. You must ensure you download the correct version for your
320\dap{}.}}
254 321
255\item Connect your \dap{} to the computer via USB 322\item Connect your \dap{} to the computer via USB
256 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire} as described in 323 \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire} as described in
@@ -269,50 +336,18 @@ structure that Rockbox needs.}
269\end{enumerate} 336\end{enumerate}
270 337
271\opt{archos}{ 338\opt{archos}{
272 \note{ 339 If the contents of the \fname{.zip} file are extracted correctly, you will
273 If the contents of the \fname{.zip} file are extracted correctly, you will 340 have a file called \fname{\firmwarefilename} in the main directory of your
274 have a file called \fname{\firmwarefilename} in the main directory of your 341 \daps{} drive, and also a directory called \fname{.rockbox}, which contains a
275 \daps{} drive, and also a directory called \fname{.rockbox}, which contains a 342 number of other directories and system files needed by Rockbox.
276 number of other directories and system files needed by Rockbox. If you receive a
277 ``-1'' error when you start Rockbox, you have not extracted the contents of
278 the \fname{.zip} file to the proper location.
279 }
280} 343}
281 344
282% This has nothing to do with swcodec, just that these players need our own 345% This has nothing to do with swcodec, just that these players need our own
283% bootloader so we can decide where we want the main binary. 346% bootloader so we can decide where we want the main binary.
284\opt{swcodec}{ 347\opt{swcodec}{
285 \note{ 348 If the contents of the \fname{.zip} file are extracted correctly, you will
286 If the contents of the \fname{.zip} file are extracted correctly, you will 349 have a directory called \fname{.rockbox}, which contains all the files needed
287 have a directory called \fname{.rockbox}, which contains all the files needed 350 by Rockbox, in the main directory of your \daps{} drive.
288 by Rockbox, in the main directory of your \daps{} drive. If you receive a
289 ``-1'' error when you start Rockbox, you have not extracted the contents of
290 the \fname{.zip} file to the proper location.
291 }
292}
293
294\nopt{player}{
295 \subsubsection{Installing the fonts package}{\index{Installation!Fonts}\label{sec:installing_fonts}
296 Rockbox has a fonts package that is available at
297 \url{http://www.rockbox.org/daily.shtml} or from the \emph{extras} link in
298 the menu on the Rockbox website. The fonts package rarely changes and is
299 therefore not included in the firmware \fname{.zip} file. When installing
300 Rockbox for the first time, you should install the fonts package.
301
302 \begin{enumerate}
303
304 \item Download the fonts package from the link above.
305
306 \item Take the file that you downloaded above, and use the ``Extract
307 all'' command of your unzip program to extract the files in the
308 \fname{.zip} file onto your \dap{}. As with the firmware installation, the
309 entire contents of the fonts \fname{.zip} should be extracted directly to the
310 root of your \daps{} drive. Do not try to create a separate directory
311 on your \dap{} for the fonts! The \fname{.zip} already contains the
312 correct internal structure.
313
314 \end{enumerate}
315 }
316} 351}
317 352
318\opt{swcodec}{ 353\opt{swcodec}{
@@ -327,20 +362,71 @@ structure that Rockbox needs.}
327 \opt{gigabeats}{\input{getting_started/gigabeats_install.tex}} 362 \opt{gigabeats}{\input{getting_started/gigabeats_install.tex}}
328} 363}
329 364
365\subsection{Finishing the install}\label{ref:finish_install}
366
367\opt{gigabeatf}{
368 After installing you \emph{need} to power-cycle the
369 \dap{} by doing the following steps. Failure to do so may result in problems.
370 \begin{itemize}
371 \item Safely eject / unmount your \dap{} and unplug the USB cable.
372 \item Unplug any power adapter.
373 \item Hold the \ButtonPower{} button to turn off the \dap{}.
374 \item Slide the battery switch located on the bottom of the \dap{} from
375 `on' to `off'.
376 \item Slide the battery switch back from `off' to `on'.
377 \end{itemize}
378}
379
380\opt{m5,x5}{
381 After installing you \emph{need} to power-cycle the
382 \dap{} by doing the following steps.
383 \begin{itemize}
384 \item Safely eject / unmount your \dap{} and unplug the USB cable.
385 \item Hold the \ButtonPower{} button to turn off the \dap{}.
386 \item Insert the charger. The Rockbox bootloader will automatically be flashed.
387 \end{itemize}
388}
389
390\opt{h10,h10_5gb,ipod,mrobe100,sansa,archos}{
391 Safely eject / unmount the USB drive, unplug the cable and restart.
392}
393
394\opt{h100,h300}{
395 \begin{itemize}
396 \item Safely eject / unmount your \dap{}.
397
398 \item \warn{Before proceeding further, make sure that your player has a full charge
399 or that it is connected to the power adaptor. Interrupting the next step
400 due to a power failure most likely will brick your \dap{}.}
401 Update your \daps{} firmware with the patched bootloader. To do this, turn
402 the jukebox on. Press and hold the \ButtonSelect{} button to enter the main menu,
403 and navigate to \setting{General $\rightarrow$ Firmware Upgrade}. Select
404 \setting{Yes} when asked to confirm if you want to upgrade the
405 firmware. The \playerman{} will display a message indicating that the
406 firmware update is in progress. Do \emph{not} interrupt this process. When the
407 firmware update is complete the player will turn itself off. (The update
408 firmware process usually takes a minute or so.). You are now ready to go.
409\end{itemize}
410}
411
412
330\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} 413\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
331\index{Speech}\index{Installation!Optional Steps} 414\index{Speech}\index{Installation!Optional Steps}
332If you wish to use speech support you will also need a voice file, English ones 415If you wish to use speech support you will also need a voice file. Voice files
333are available from \url{http://www.rockbox.org/daily.shtml}. Download the 416allow Rockbox to speak the user interface to you. Rockbox Utility can install
334``voice'' package for your player and unzip it directly to the root of your \dap. 417an English voice file, or you can download it from \url{http://www.rockbox.org/daily.shtml}
335You should now find an \fname{english.voice} in the \fname{/.rockbox/langs} 418and unzip it to the root of your \dap{}.
336directory on your \dap{}. Voice menus are enabled by default and will come 419Rockbox Utility can also aid you in the creation of voice files with different voices
420or in other languages if you have a suitable speech engine installed on your computer.
421Voice menus are enabled by default and will come
337into effect after a reboot. See \reference{ref:Voiceconfiguration} for details 422into effect after a reboot. See \reference{ref:Voiceconfiguration} for details
338on voice settings. 423on voice settings.
424Rockbox Utility can also aid in the production of talk files, which allow Rockbox
425to speak file and folder names.
339 426
340\section{Running Rockbox} 427\section{Running Rockbox}
341Remove your \dap{} from the computer's USB port. %
342\nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When 428\nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When
343you next turn the unit on, Rockbox should load. }% 429you next turn the unit on, Rockbox should load.}%
344\opt{ipod}{Hard resetting the Ipod by holding 430\opt{ipod}{Hard resetting the Ipod by holding
345 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}% 431 \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}%
346 \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}} 432 \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}}
@@ -354,22 +440,24 @@ use.
354 \note{ 440 \note{
355 If you have loaded music onto your \dap{} using Itunes, 441 If you have loaded music onto your \dap{} using Itunes,
356 you will not be able to see your music properly in the \setting{File Browser}. 442 you will not be able to see your music properly in the \setting{File Browser}.
357 This is because Itunes changes your files' names and hides them in 443 This is because Itunes changes your files' names and hides them in
358 directories in the \fname{Ipod\_Control} directory. Files placed on your 444 directories in the \fname{Ipod\_Control} directory. Files placed on your
359 \dap{} using Itunes can be viewed by initializing and using Rockbox's database. 445 \dap{} using Itunes can be viewed by initialising and using Rockbox's database.
360 See \reference{ref:database} for more information. 446 See \reference{ref:database} for more information.
361 } 447 }
362} 448}
363 449
364\section{Updating Rockbox} 450\section{Updating Rockbox}
365Updating Rockbox is easy even if you do not use the Rockbox Utility. 451Rockbox can be easily updated with Rockbox Utility.
366Download a Rockbox build. 452You can also update Rockbox manually - download a Rockbox build
367(The latest release of the Rockbox software will always be available from 453as detailed above, and unzip the build to the root directory
368\url{http://www.rockbox.org/download/}). Unzip the build to the root directory 454of your \dap{} as in the manual installation stage. If your unzip
369of your \dap{} like you did in the installation stage. If your unzip
370program asks you whether to overwrite files, choose the ``Yes to all'' option. 455program asks you whether to overwrite files, choose the ``Yes to all'' option.
371The new build will be installed over your current build. 456The new build will be installed over your current build.
372 457
458The bootloader only changes rarely, and should not normally
459need to be updated.
460
373\note{If you use Rockbox Utility be aware that it cannot detect manually 461\note{If you use Rockbox Utility be aware that it cannot detect manually
374 installed components.} 462 installed components.}
375 463
@@ -438,27 +526,50 @@ completely follow the manual uninstallation instructions below.}}
438} 526}
439 527
440\opt{h100,h300}{ 528\opt{h100,h300}{
441 \note{
442 If you want to remove the Rockbox bootloader, simply flash an unpatched 529 If you want to remove the Rockbox bootloader, simply flash an unpatched
443 \playerman{} firmware. Be aware that doing so will also remove the bootloader 530 \playerman{} firmware. Be aware that doing so will also remove the bootloader
444 USB mode. As that mode can come in quite handy (especially when 531 USB mode. As that mode can come in quite handy (especially if you experience
445 having disk errors) it is recommended to keep the bootloader. It also 532 disk errors) it is recommended to keep the bootloader. It also
446 gives you the possibility of trying Rockbox anytime later by simply 533 gives you the possibility of trying Rockbox anytime later by simply
447 installing the distribution files. 534 installing the distribution files.
448 \opt{h100}{ 535 \opt{h100}{
449 The Rockbox bootloader will automatically start the original firmware if 536 The Rockbox bootloader will automatically start the original firmware if
450 the \fname{.rockbox} directory has been deleted. 537 the \fname{.rockbox} directory has been deleted.
451 }% 538 }
452 \opt{h300}{% 539 \opt{h300}{
453 Although if you retain the Rockbox bootloader, you will need to hold the 540 Although if you retain the Rockbox bootloader, you will need to hold the
454 \ButtonRec{} button each time you want to start the original firmware. 541 \ButtonRec{} button each time you want to start the original firmware.
455 } 542 }
456 }
457} 543}
458 544
459If you wish to clean up your disk, you may also wish to delete the 545If you wish to clean up your disk, you may also wish to delete the
460\fname{.rockbox} directory and its contents. 546\fname{.rockbox} directory and its contents.
461\nopt{m5,x5}{Turn the \playerman{} off. 547\nopt{m5,x5}{Turn the \playerman{} off.
462 Turn the \dap{} back on and the original \playerman{} software will load. 548 Turn the \dap{} back on and the original \playerman{} software will load.}
463}
464 549
550\section{Troubleshooting}
551\begin{description}
552 \item[``-1 error'']
553 If you receive a ``-1 error'' from the bootloader, then
554 the bootloader cannot find the Rockbox firmware. This is usually a result of
555 not extracting the contents of the \fname{.zip} file to the proper location,
556 and should not happen when Rockbox has been installed with Rockbox Utility.
557
558 To fix this, either install Rockbox with the Rockbox Utility which will take care
559 of this for you, or recheck the Manual Install section to see where the files
560 need to be located.
561
562\opt{sansa,ipod}{
563 \item[Bootloader install problems]
564 If you have trouble installing the bootloader,
565 please ensure that you are either logged in as an administrator (Windows), or
566 you have root rights (Linux)}
567
568\opt{h100,h300}{
569 \item[Immediately loading original firmware.]
570 If the original firmware is immediately
571 loaded without the Rockbox bootloader appearing first, then the Rockbox bootloader
572 has not been correctly installed. The original firmware update will only perform
573 the update if the filename is correct, including case. Make sure that the patched
574 Iriver firmware is called \fname{.hex}.}
575\end{description} \ No newline at end of file