2 \chapter{Installation
}\label{sec:installation
}
5 \note{Rockbox presently runs only on the original Ipod Nano. Rockbox does
6 \emph{not
} run on the second, third, or fourth generation Ipod Nano.
7 For information on identifying which Ipod you own, see this page on
8 Apple's website:
\url{http://www.info.apple.com/kbnum/n61688
}.
12 \note{Rockbox presently runs only on the
5th and
5.5th generation Ipod videos.
13 Rockbox does
\emph{not
} run on the newer,
6th/Classic generation Ipod.
14 For information on identifying which Ipod you own, see this page on Apple's
15 website:
\url{http://www.info.apple.com/kbnum/n61688
}.
19 \note{Rockbox doesn't function on the newer v2 models. They can be identified
20 by checking the Sandisk firmware version number under
21 Settings $
\rightarrow$ Info. The v1
22 firmware is named
01.xx.xx, while the v2 firmware begins with
03.
}
26 There are two ways of installing Rockbox: automated and manual. While the
27 manual way is older, more tested and proven to work correctly, the
28 automated installation is based on a nice graphical application that does
29 almost everything for you. It is still important that you have
30 an overview of the installation process to be able to select the correct
33 \opt{MASCODEC
}{Rockbox itself comes as a single package. There is no need
34 to install additional software for running Rockbox.
}
36 \opt{HAVE_RB_BL_ON_DISK
}{There are three separate components,
37 two of which need to be installed in order to run Rockbox:
}
38 \opt{HAVE_RB_BL_IN_FLASH
}{There are two separate components
39 which need to be installed in order to run Rockbox:
}
42 \opt{HAVE_RB_BL_ON_DISK
}{
43 \item[The
\playerman{} bootloader.
]
44 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,
46 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
48 to modify this in order to install Rockbox.
}
50 \item[The Rockbox bootloader.
] \index{Bootloader
}
51 \opt{HAVE_RB_BL_ON_DISK
}{The Rockbox bootloader is loaded from disk by
52 the
\playerman{} bootloader. It is responsible for loading the Rockbox
53 firmware and for providing the dual boot function. It directly replaces the
54 \playerman{} firmware in the
\daps{} boot sequence.
55 \opt{gigabeatf
}{\note{Dual boot does not currently work on the Gigabeat.
}}}
57 \opt{HAVE_RB_BL_IN_FLASH
}{
58 The bootloader is the program that tells your
59 \dap{} how to load and start other components of Rockbox. This is the
60 component of Rockbox that is installed to the flash memory of your
63 \item[The Rockbox firmware.
]
64 \opt{HAVE_RB_BL_IN_FLASH
}{Unlike the
\playerman{} firmware, which runs
65 entirely from flash memory,
}
66 \opt{HAVE_RB_BL_ON_DISK
}{Similar to the
\playerman{} firmware,
}
67 most of the Rockbox code is contained in a
68 ``build'' that resides on your
\daps{} drive. This makes it easy to
69 update Rockbox. The build consists of a directory called
70 \fname{.rockbox
} which contains all of the Rockbox files, and is
71 located in the root of your
\daps{} drive.
77 Apart from the required parts there are some addons you might be interested
80 \item[Fonts.
] Rockbox can load custom fonts. The fonts are
81 distributed as a separate package and thus need to be installed
82 separately. They are not required to run Rockbox itself but
83 a lot of themes require the fonts package to be installed.
85 \item[Themes.
] The view of Rockbox can be customized by themes. Depending
86 on your taste you might want to install additional themes to change
91 \section{Prerequisites
}\label{sec:prerequisites
}
92 \index{Installation!Prerequisites
}
93 Before installing Rockbox you should make sure you meet the prerequisites.
94 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
95 software might be necessary.
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{}.
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.
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.
}
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
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
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
133 \opt{gigabeatf
}{\warn{During installation, do not connect your
\dap{}
134 using the cradle but plug the USB cable directly to the
\dap{}.
}}
136 For manual installation and customization additional software is required.
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''.
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.
167 \section{Installing Rockbox
}\label{sec:installing_rockbox
}\index{Installation
}
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
173 \subsection{Automated Installation
}
177 To automatically install Rockbox, download the official installer and
178 housekeeping tool
\caps{Rockbox Utility
}. It allows you to:
180 \item Automatically install all needed components for using Rockbox
181 (``Small Installation'')
182 \item Automatically install all suggested components (``Full Installation'')
183 \item Selectively install optional components
184 \item Install additional themes
185 \item Install voice files and generate talk clips
186 \item Uninstall all components you installed using Rockbox Utility
188 Prebuilt binaries for Windows, Linux and MacOS~X are
189 available at the
\wikilink{RockboxUtility
} wiki page.
191 \warn{When first starting
\caps{Rockbox Utility
} run ``Autodetect'',
192 found in the configuration dialog (File $
\rightarrow$ Configure). Autodetection
193 can detect most player types. If autodetection fails or is unable to detect
194 the mountpoint, make sure to enter the correct values. The mountpoint indicates
195 the location of the
\dap{} in your filesystem. On Windows, this is the drive
196 letter the
\dap{} gets assigned, on other systems this is a path in the
200 {\warn{Autodetection is unable to distinguish between the
201 \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
203 detected value, especially if you experience problems with Rockbox.
}
206 \note{Rockbox Utility currently lacks some guiding messages. Please have a
207 look at the manual installation instructions if you are stuck
208 during installation.
}
210 \subsection{Manual Installation
}
212 \subsubsection{Choosing a Rockbox version
}\label{sec:choosing_version
}
214 There are three different types of firmware binaries available from the
217 Release version, current build and daily build. You need to decide which one
218 you want to install and get the appropriate version for your
\dap{}.
223 \opt{release30
}{The release version is the latest stable release, free
224 of known critical bugs. The current stable release of Rockbox, version
225 3.0, is available at
\url{http://www.rockbox.org/download/
}.
228 There has not yet been a stable release for the
\playername{}. Until
229 there is one, use a current build.
232 \item[Current Build.
] The current build is built at each source code change to
233 the Rockbox SVN repository and represents the current state of Rockbox
234 development. This means that the build could contain bugs but most of
235 the time is safe to use. You can download the current build from
236 \url{http://build.rockbox.org/
}.
238 \item[Archived Build.
] In addition to the release version and the current build,
239 there is also an archive of daily builds available for download. These are
240 built once a day from the latest source code in the SVN repository. You can
241 download archived builds from
\url{http://www.rockbox.org/daily.shtml
}.
245 \warn{Because current builds and daily builds are development versions which
246 change frequently, they may behave differently than described in this manual,
247 or they may introduce new (and maybe annoying) bugs. If you do not want to
248 get undefined behaviour from your
\dap{}, you should stick to the current
249 stable release if there is one for your
\dap{}. If you want to help with
250 project development, you can try development builds and help by reporting bugs.
251 Just be aware that these are development builds that are highly functional
254 \subsubsection{Installing the firmware
}\label{sec:installing_firmware
}
258 \item Download your chosen version of Rockbox from the links in the
261 \item Connect your
\dap{} to the computer via USB
262 \opt{ipod3g,ipod4g,ipodmini,ipodcolor
}{ or Firewire
} as described in
263 the manual that came with your
\dap{}.
265 \item Take the
\fname{.zip
} file that you downloaded and use
266 the ``Extract all'' command of your unzip program to extract
267 the files onto your
\dap{}.
269 \note{The entire contents of the
\fname{.zip
} file should be extracted
270 directly to the root of your
\daps{} drive. Do not try to
271 create a separate directory on your
\dap{} for the Rockbox
272 files! The
\fname{.zip
} file already contains the internal
273 structure that Rockbox needs.
}
279 If the contents of the
\fname{.zip
} file are extracted correctly, you will
280 have a file called
\fname{\firmwarefilename} in the main directory of your
281 \daps{} drive, and also a directory called
\fname{.rockbox
}, which contains a
282 number of other directories and system files needed by Rockbox. If you receive a
283 ``-
1'' error when you start Rockbox, you have not extracted the contents of
284 the
\fname{.zip
} file to the proper location.
288 % This has nothing to do with swcodec, just that these players need our own
289 % bootloader so we can decide where we want the main binary.
292 If the contents of the
\fname{.zip
} file are extracted correctly, you will
293 have a directory called
\fname{.rockbox
}, which contains all the files needed
294 by Rockbox, in the main directory of your
\daps{} drive. If you receive a
295 ``-
1'' error when you start Rockbox, you have not extracted the contents of
296 the
\fname{.zip
} file to the proper location.
301 \subsubsection{Installing the fonts package
}{\index{Installation!Fonts
}\label{sec:installing_fonts
}
302 Rockbox has a fonts package that is available at
303 \url{http://www.rockbox.org/daily.shtml
} or from the
\emph{extras
} link in
304 the menu on the Rockbox website. The fonts package rarely changes and is
305 therefore not included in the firmware
\fname{.zip
} file. When installing
306 Rockbox for the first time, you should install the fonts package.
310 \item Download the fonts package from the link above.
312 \item Take the file that you downloaded above, and use the ``Extract
313 all'' command of your unzip program to extract the files in the
314 \fname{.zip
} file onto your
\dap{}. As with the firmware installation, the
315 entire contents of the fonts
\fname{.zip
} should be extracted directly to the
316 root of your
\daps{} drive. Do not try to create a separate directory
317 on your
\dap{} for the fonts! The
\fname{.zip
} already contains the
318 correct internal structure.
325 \subsubsection{Installing the bootloader
}
326 \opt{h100,h300
}{\input{getting_started/iriver_install.tex
}}
327 \opt{ipod
}{\input{getting_started/ipod_install.tex
}}
328 \opt{m5,x5
}{\input{getting_started/iaudio_install.tex
}}
329 \opt{h10,h10_5gb
}{\input{getting_started/h10_install.tex
}}
330 \opt{gigabeatf
}{\input{getting_started/gigabeat_install.tex
}}
331 \opt{sansa
}{\input{getting_started/sansa_install.tex
}}
332 \opt{mrobe100
}{\input{getting_started/mrobe100_install.tex
}}
333 \opt{gigabeats
}{\input{getting_started/gigabeats_install.tex
}}
336 \subsection{Enabling Speech Support (optional)
}\label{sec:enabling_speech_support
}
337 \index{Speech
}\index{Installation!Optional Steps
}
338 If you wish to use speech support you will also need a voice file, English ones
339 are available from
\url{http://www.rockbox.org/daily.shtml
}. Download the
340 ``voice'' package for your player and unzip it directly to the root of your
\dap.
341 You should now find an
\fname{english.voice
} in the
\fname{/.rockbox/langs
}
342 directory on your
\dap{}. Voice menus are enabled by default and will come
343 into effect after a reboot. See
\reference{ref:Voiceconfiguration
} for details
346 \section{Running Rockbox
}
347 Remove your
\dap{} from the computer's USB port.
%
348 \nopt{ipod,e200
}{Unplug any connected power supply and turn the unit off. When
349 you next turn the unit on, Rockbox should load.
}%
350 \opt{ipod
}{Hard resetting the Ipod by holding
351 \opt{IPOD_4G_PAD
}{\ButtonMenu{}+
\ButtonSelect{}}%
352 \opt{IPOD_3G_PAD
}{\ButtonMenu{}+
\ButtonPlay{}}
353 for a couple of seconds until the
\dap{} resets. Now Rockbox should load.
355 \opt{e200
}{Your e200 will automatically reboot and Rockbox should load.
}%
356 When you see the Rockbox splash screen, Rockbox is loaded and ready for
361 If you have loaded music onto your
\dap{} using Itunes,
362 you will not be able to see your music properly in the
\setting{File Browser
}.
363 This is because Itunes changes your files' names and hides them in
364 directories in the
\fname{Ipod
\_Control} directory. Files placed on your
365 \dap{} using Itunes can be viewed by initializing and using Rockbox's database.
366 See
\reference{ref:database
} for more information.
370 \section{Updating Rockbox
}
371 Updating Rockbox is easy even if you do not use the Rockbox Utility.
372 Download a Rockbox build.
373 (The latest release of the Rockbox software will always be available from
374 \url{http://www.rockbox.org/download/
}). Unzip the build to the root directory
375 of your
\dap{} like you did in the installation stage. If your unzip
376 program asks you whether to overwrite files, choose the ``Yes to all'' option.
377 The new build will be installed over your current build.
379 \note{If you use Rockbox Utility be aware that it cannot detect manually
380 installed components.
}
382 \section{Uninstalling Rockbox
}\index{Installation!uninstall
}
384 \nopt{gigabeatf,m5,x5,archos,mrobe100
}{
385 \note{The Rockbox bootloader allows you to choose between Rockbox and
386 the original firmware. (See
\reference{ref:Dualboot
} for more information.)
}
389 \subsection{Automatic Uninstallation
}
390 You can uninstall Rockbox automatically by using Rockbox Utility. If you
391 installed Rockbox manually you can still use Rockbox Utility for uninstallation
392 but will not be able to do this selectively.
394 \opt{h100,h300
}{\note{Rockbox Utility cannot uninstall the bootloader due to
395 the fact that it requires a flashing procedure. To uninstall the bootloader
396 completely follow the manual uninstallation instructions below.
}}
398 \subsection{Manual Uninstallation
}
401 If you would like to go back to using the original
\playerman{} software,
402 connect the
\dap{} to your computer, and delete the
403 \fname{\firmwarefilename} file.
407 If you would like to go back to using the original
\playerman{} software,
408 connect the
\dap{} to your computer, and delete the
409 \opt{h10
}{\fname{H10
\_20GC.mi4
}}\opt{h10_5gb
}{\fname{H10.mi4
}} file and rename
410 \fname{OF.mi4
} to
\opt{h10
}{\fname{H10
\_20GC.mi4
}}\opt{h10_5gb
}{\fname{H10.mi4
}}
411 in the
\fname{System
} directory on your
\playertype{}. As in the installation,
412 it may be necessary to first put your device into UMS mode.
416 If you would like to go back to using the original
\playerman{} software,
417 connect the
\dap{} to your computer, and delete the
418 \fname{pp5020.mi4
} file and rename
419 \fname{OF.mi4
} to
\fname{pp5020.mi4
}
420 in the
\fname{System
} directory on your
\playertype{}.
424 If you would like to go back to using the original
\playerman{} software,
425 connect the
\dap{} to your computer, and follow the instructions to install
426 the bootloader, but when prompted by sansapatcher, enter
\texttt{u
} for uninstall,
427 instead of
\texttt{i
} for install. As in the installation, it may be necessary to
428 first put your device into MSC mode.
432 To uninstall Rockbox and go back to using just the original Ipod software, connect
433 the
\dap{} to your computer and follow the instructions to install
434 the bootloader but, when prompted by ipodpatcher, enter
\texttt{u
} for uninstall
435 instead of
\texttt{i
} for install.
439 If you would like to go back to using the original
\playerman{} software,
440 connect the
\dap{} to your computer, download the original
\playername{}
441 firmware from the
\playerman{} website, and copy it to the
\fname{FIRMWARE
}
442 directory on your
\playername{}. Turn off the
\dap{}, remove the USB cable
443 and insert the charger. The original firmware will automatically be flashed.
448 If you want to remove the Rockbox bootloader, simply flash an unpatched
449 \playerman{} firmware. Be aware that doing so will also remove the bootloader
450 USB mode. As that mode can come in quite handy (especially when
451 having disk errors) it is recommended to keep the bootloader. It also
452 gives you the possibility of trying Rockbox anytime later by simply
453 installing the distribution files.
455 The Rockbox bootloader will automatically start the original firmware if
456 the
\fname{.rockbox
} directory has been deleted.
459 Although if you retain the Rockbox bootloader, you will need to hold the
460 \ButtonRec{} button each time you want to start the original firmware.
465 If you wish to clean up your disk, you may also wish to delete the
466 \fname{.rockbox
} directory and its contents.
467 \nopt{m5,x5
}{Turn the
\playerman{} off.
468 Turn the
\dap{} back on and the original
\playerman{} software will load.