update manual with recent changes to mpegplayer
[Rockbox.git] / manual / getting_started / ipod_install.tex
blob5a019b540339403f84613e8e70bdaf902ea35234
1 % $Id$ %
3 \opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front
4 it is a 1st generation and is compatible with Rockbox. If, on the other hand,
5 your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
6 is currently no Rockbox port available. Do not attempt to install the
7 bootloader on a 2nd generation Nano}}
9 In order to make your \dap{} load and execute the Rockbox firmware you
10 have just installed, you will need to install the Rockbox
11 bootloader. Unless bugs are found in the bootloader code, or
12 significant new feature are added, you will only have to perform this
13 step once.
15 \subsubsection{Bootloader installation from Windows}
17 \begin{enumerate}
19 \item Make sure you are logged into your computer as Administrator, or a
20 user with Administrator privileges and connect your \dap{}.
22 \item Download ipodpatcher.exe from
23 \download{bootloader/ipod/ipodpatcher/win32/ipodpatcher.exe}
24 and run it.
26 \item If all has gone well, you should see some information displayed about
27 your ipod and a message asking you if you wish to install the Rockbox
28 bootloader. Press i followed by ENTER, and ipodpatcher will now
29 install the bootloader. After a short time you should see the message
30 ``[INFO] Bootloader installed successfully.'' Press ENTER again to exit
31 ipodpatcher.
33 \item Make sure that you have correctly extracted a build of Rockbox so that
34 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
35 in the root of your \daps{} drive and that you have also installed the fonts
36 package -- see \reference{sec:installing_fonts} for more information.
38 \item Disconnect your \dap{} in the usual way. The bootloader is now installed.
40 \end{enumerate}
42 \subsubsection{Bootloader installation from Mac OS X}
44 \begin{enumerate}
46 \item Attach your \dap{} to your Mac and wait for its icon to appear in
47 Finder. If you have configured itunes to open automatically when your
48 \dap{} is attached (the default behaviour), then wait for it to open and
49 then quit it. You also need to ensure the ``Enable use as disk'' option
50 is enabled for your \dap{} in itunes.
52 \item\label{subsec:macos_umount} Open up Disk Utility
53 (in Applications $\rightarrow$ Utilities) and click
54 on the name of your \dap{} (e.g. DAVES IPOD) in the list on the left
55 pane. Then click on the ``unmount'' icon at the top. \warn{Do \emph{not}
56 click on the ``eject'' icon.}
58 \item Download and open ipodpatcher.dmg from
59 \download{bootloader/ipod/ipodpatcher/macosx/ipodpatcher.dmg}
60 and then double-click on the ipodpatcher icon inside.
62 \item If all has gone well, you should see some
63 information displayed about your \dap{} and a message asking you if you
64 wish to install the Rockbox bootloader. Press i followed by ENTER, and
65 ipodpatcher will now install the bootloader. After a short time you
66 should see the message ``[INFO] Bootloader installed successfully.'' Press
67 ENTER again to exit ipodpatcher and then quit the Terminal application.
69 \item \warn{If you received a ``Resource busy'' error from
70 ipodpatcher, then this means you didn't complete step
71 \ref{subsec:macos_umount}. Go back to Disk Utility, unmount your
72 \dap{} and then run ipodpatcher again.}
74 \item Your \dap{} will now automatically reconnect itself to your Mac.
75 Wait for it to connect, and then eject and unplug it in the normal way.
76 \note{You should unplug your ipod immediately after ejecting it to
77 prevent Rockbox immediately rebooting your \dap{} into disk mode when it
78 detects that your \dap{} is attached to a computer. }
80 \item Make sure that you have correctly extracted a build of Rockbox so that
81 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
82 in the root of your \daps{} drive and that you have also installed the fonts
83 package -- see \reference{sec:installing_fonts} for more information.
85 \end{enumerate}
87 \subsubsection{Bootloader installation from Linux}
89 \begin{enumerate}
91 \item Download ipodpatcher from
92 \download{bootloader/ipod/ipodpatcher/linux32x86/ipodpatcher} (32-bit x86
93 binary) or \download{bootloader/ipod/ipodpatcher/linux64amd64/ipodpatcher}
94 (64-bit amd64 binary). You can save this anywhere you wish, but the next
95 steps will assume you've saved it in your home directory.
97 \item Attach your \dap{} to your computer.
99 \item Open up a terminal window and type the following commands:
101 \begin{code}
102 cd $HOME
103 chmod +x ipodpatcher
104 ./ipodpatcher
105 \end{code}
107 \warn{You may need to be the root user in order for ipodpatcher to have
108 sufficient permission to perform raw disk access to your \dap{}.}
110 \item If all has gone well, you should see some information displayed about
111 your ipod and a message asking you if you wish to install the Rockbox
112 bootloader. Press i followed by ENTER, and ipodpatcher will now install the
113 bootloader. After a short time you should see the message ``[INFO] Bootloader
114 installed successfully.'' Press ENTER again to exit ipodpatcher.
116 \item Make sure that you have correctly extracted a build of Rockbox so that
117 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
118 in the root of your \daps{} drive and that you have also installed the fonts
119 package -- see \reference{sec:installing_fonts} for more information.
121 \item Disconnect your \dap{} in the usual way. The bootloader is now installed.
123 \end{enumerate}