merge 19488 back from the 3.1 branch
[kugel-rb.git] / manual / getting_started / ipod_install.tex
blobf53263b9aba46b3668d7643d552a9896e9e40512
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{}. If you have
21 configured iTunes to open automatically when your \dap{} is attached
22 (the default behaviour), then wait for it to open and then quit it. You
23 also need to ensure the ``Enable use as disk'' option is enabled for
24 your \dap{} in iTunes.
26 \item Download ipodpatcher.exe from
27 \download{bootloader/ipod/ipodpatcher/win32/ipodpatcher.exe}
28 and run it.
30 \item If all has gone well, you should see some information displayed about
31 your \dap{} and a message asking you if you wish to install the Rockbox
32 bootloader. Press i followed by ENTER, and ipodpatcher will now
33 install the bootloader. After a short time you should see the message
34 ``[INFO] Bootloader installed successfully.'' Press ENTER again to exit
35 ipodpatcher.
37 \item \note{If ipodpatcher fails to install the bootloader for you, please
38 be certain that you do indeed have a supported iPod model. If you do, run
39 ipodpatcher once more and try again. If you don't, then do not attempt to
40 install again.}
42 \item Make sure that you have correctly extracted a build of Rockbox so that
43 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
44 in the root of your \daps{} drive and that you have also installed the fonts
45 package -- see \reference{sec:installing_fonts} for more information.
47 \item Disconnect your \dap{} in the usual way. The bootloader is now installed.
49 \end{enumerate}
51 \subsubsection{Bootloader installation from Mac OS X}
53 \begin{enumerate}
55 \item Attach your \dap{} to your Mac and wait for its icon to appear in
56 Finder. If you have configured iTunes to open automatically when your
57 \dap{} is attached (the default behaviour), then wait for it to open and
58 then quit it. You also need to ensure the ``Enable use as disk'' option
59 is enabled for your \dap{} in iTunes.
61 \item Download and open ipodpatcher.dmg from
62 \download{bootloader/ipod/ipodpatcher/macosx/ipodpatcher.dmg}
63 and then double-click on the ipodpatcher icon inside. You can also
64 drag the ipodpatcher icon to a location on your hard drive and launch
65 it from the Terminal.
67 \item If all has gone well, you should see some
68 information displayed about your \dap{} and a message asking you if you
69 wish to install the Rockbox bootloader. Press i followed by ENTER, and
70 ipodpatcher will now install the bootloader. After a short time you
71 should see the message ``[INFO] Bootloader installed successfully.'' Press
72 ENTER again to exit ipodpatcher and then quit the Terminal application.
74 \item \note{If ipodpatcher fails to install the bootloader for you, please
75 be certain that you do indeed have a supported iPod model. If you do, run
76 ipodpatcher once more and try again. If you don't, then do not attempt to
77 install again.}
80 \item Your \dap{} will now automatically reconnect itself to your Mac.
81 Wait for it to connect, and then eject and unplug it in the normal way.
82 \note{You should unplug your ipod immediately after ejecting it to
83 prevent Rockbox immediately rebooting your \dap{} into disk mode when it
84 detects that your \dap{} is attached to a computer. }
86 \item Make sure that you have correctly extracted a build of Rockbox so that
87 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
88 in the root of your \daps{} drive and that you have also installed the fonts
89 package -- see \reference{sec:installing_fonts} for more information.
91 \end{enumerate}
93 \subsubsection{Bootloader installation from Linux}
95 \begin{enumerate}
97 \item Download ipodpatcher from
98 \download{bootloader/ipod/ipodpatcher/linux32x86/ipodpatcher} (32-bit x86
99 binary) or \download{bootloader/ipod/ipodpatcher/linux64amd64/ipodpatcher}
100 (64-bit amd64 binary). You can save this anywhere you wish, but the next
101 steps will assume you have saved it in your home directory.
103 \item Attach your \dap{} to your computer.
105 \item Open up a terminal window and type the following commands:
107 \begin{code}
108 cd $HOME
109 chmod +x ipodpatcher
110 ./ipodpatcher
111 \end{code}
113 \warn{You may need to be the root user in order for ipodpatcher to have
114 sufficient permission to perform raw disk access to your \dap{}.}
116 \item If all has gone well, you should see some information displayed about
117 your \dap{} and a message asking you if you wish to install the Rockbox
118 bootloader. Press i followed by ENTER, and ipodpatcher will now install the
119 bootloader. After a short time you should see the message ``[INFO] Bootloader
120 installed successfully.'' Press ENTER again to exit ipodpatcher.
122 \item Make sure that you have correctly extracted a build of Rockbox so that
123 you have a \fname{/.rockbox}, which contains all the files needed by Rockbox
124 in the root of your \daps{} drive and that you have also installed the fonts
125 package -- see \reference{sec:installing_fonts} for more information.
127 \item Disconnect your \dap{} in the usual way. The bootloader is now installed.
129 \end{enumerate}