summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/getting_started/ipod_install.tex98
1 files changed, 56 insertions, 42 deletions
diff --git a/manual/getting_started/ipod_install.tex b/manual/getting_started/ipod_install.tex
index 71fed85283..9f1e273b00 100644
--- a/manual/getting_started/ipod_install.tex
+++ b/manual/getting_started/ipod_install.tex
@@ -13,18 +13,18 @@ your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
13is currently no Rockbox port available. Do not attempt to install the 13is currently no Rockbox port available. Do not attempt to install the
14bootloader on a 2nd generation Nano}} 14bootloader on a 2nd generation Nano}}
15 15
16In order to make your iPod load and execute the Rockbox firmware you have just 16In order to make your Ipod load and execute the Rockbox firmware you have just
17installed, you will need to install the Rockbox bootloader. Unless bugs are 17installed, you will need to install the Rockbox bootloader. Unless bugs are
18found in the bootloader code, or significant new feature are added, you will 18found in the bootloader code, or significant new feature are added, you will
19only have to perform this step once. 19only have to perform this step once.
20 20
21The following instructions refer to the ``installation folder.'' For Windows 21The following instructions refer to the ``installation folder.'' For Windows
22users, the "installation folder" is assumed to be a folder in the root (top- 22users, the ``installation folder'' is a folder in the root (top-level) of the C:
23level) of the C: drive called \fname{rockbox} (you will obviously need to 23drive called \fname{\textbackslash{}rockbox} (you will obviously need to create
24create this folder yourself). For Mac OS X and Linux users, the ``installation 24this folder yourself). For Mac OS X and Linux users, the ``installation
25folder'' is assumed to be the Desktop folder. But you can use any folder 25folder'' is assumed to be the Desktop folder. Note that the bootloader
26you wish. Note that these files should be saved onto your computer's hard disk, 26installation files should be saved onto your computer's hard disk, \emph{not} on
27\emph{not} on your Ipod. 27your Ipod.
28 28
29\begin{enumerate} 29\begin{enumerate}
30 30
@@ -46,86 +46,93 @@ you wish. Note that these files should be saved onto your computer's hard disk,
46 \item Next, open a command prompt (Windows) or terminal window (Mac OSX and Linux). 46 \item Next, open a command prompt (Windows) or terminal window (Mac OSX and Linux).
47 47
48 Windows users will perform this and the following steps from the Windows 48 Windows users will perform this and the following steps from the Windows
49 command prompt. Start a command prompt and navigate to the installation 49 command prompt. To start a command prompt, click \fname{start}, and then
50 directory. 50 click \fname{Run...}. Type ``cmd'' and press \fname{Enter}. Navigate
51 to the installation directory by typing the following command:
51 52
53 \begin{code}
54 cd \textbackslash{}rockbox
55 \end{code}
56
52 Mac OS X and Linux/Unix users will perform these steps from the Terminal. 57 Mac OS X and Linux/Unix users will perform these steps from the Terminal.
53 Start a new terminal window and navigate to the Desktop folder (type cd 58 Start a new terminal window and navigate to the Desktop folder (type cd
54 Desktop into the terminal and press enter). You then need to ensure that the 59 Desktop into the terminal and press enter). You then need to ensure that the
55 ipodpatcher program is ``executable'' by typing the command chmod +x 60 ipodpatcher program is ``executable'' by typing the command chmod +x
56 ipodpatcher and then pressing enter. 61 ipodpatcher and then pressing \fname{Enter}.
57 62
58 \item Connect your ipod to your computer. 63 \item Connect your Ipod to your computer.
59 64
60 If you haven't already done so, you should now plug your iPod into your 65 If you haven't already done so, you should now plug your Ipod into your
61 computer (via either the USB or Firewire cable). 66 computer (via either the USB or Firewire cable).
62 67
63 \fixme{Notes about closing itunes, enabling the ``show ipod as disk'' option 68 \fixme{Notes about closing itunes, enabling the ``show ipod as disk'' option
64 in ipod, anything else?} 69 in ipod, anything else?}
65 70
66 \item Find your ipod with ipodpatcher (Windows users only) 71 \item Find your Ipod with ipodpatcher (Windows users only)
67 72
68 Windows users: Type the following command to search for ipods attached to 73 Windows users: Type the following command to search for Ipods attached to
69 your computer: 74 your computer:
70 \begin{code} 75 \begin{code}
71 ipodpatcher --scan 76 ipodpatcher --scan
72 \end{code} 77 \end{code}
73 78
74 When ipodpatcher finds your ipod, remember the number it displays - this 79 When ipodpatcher finds your Ipod, remember the number it displays after the
75 will be the number you use to access your ipod in the following steps. 80 words ``disk device''- this will be the number you use to access your Ipod
81 in the following steps. So, for example, if ipodpatcher displays ``disk
82 device 1'' you will use the number 1 in the commands described below.
76 83
77 \note{Windows users require administrator rights for running ipodpatcher. 84 \note{Windows users require administrator rights for running ipodpatcher.
78 Either re-login as administrator, or open a command prompt running under an 85 Either re-login as administrator, or open a command prompt running under an
79 administrator account by using one of the "Run as" features of Windows XP.} 86 administrator account by using one of the "Run as" features of Windows XP.}
80 87
81 \item Find your ipod (Mac OS X users only) 88 \item Find your Ipod (Mac OS X users only)
82 89
83 Attach your iPod to your Mac (using either USB or Firewire) and wait for 90 Attach your Ipod to your Mac (using either USB or Firewire) and wait for
84 iTunes to open. When iTunes opens, close it down. In your Terminal window, 91 iTunes to open. When iTunes opens, close it down. In your Terminal window,
85 type the command mount and press enter. This will list all the disks (and 92 type the command mount and press enter. This will list all the disks (and
86 other devices) that are "mounted" on your computer. The last drive in the 93 other devices) that are "mounted" on your computer. The last drive in the
87 list should be your iPod. For example: 94 list should be your Ipod. For example:
88 \begin{code} 95 \begin{code}
89 /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid) 96 /dev/disk1s2 on /Volumes/DAVE_S IPOD 1 (local, nodev, nosuid)
90 \end{code} 97 \end{code}
91 98
92 In order to install the ipod bootloader, you need to "unmount" this disk 99 In order to install the ipod bootloader, you need to ``unmount'' this disk
93 using the following command: 100 using the following command:
94 \begin{code} 101 \begin{code}
95 diskutil unmount /dev/disk1s2 102 diskutil unmount /dev/disk1s2
96 \end{code} 103 \end{code}
97 104
98 replacing ``/dev/disk1s2'' with the device name Mac OS has assigned to your 105 replacing ``/dev/disk1s2'' with the device name Mac OS has assigned to your
99 ipod. This may take a few seconds, after which Mac OS will say ``Volume 106 Ipod. This may take a few seconds, after which Mac OS will say ``Volume
100 /dev/disk1s2 unmounted.'' ``/dev/disk1s2'' refers to the second partition on 107 /dev/disk1s2 unmounted.'' ``/dev/disk1s2'' refers to the second partition on
101 /dev/disk1 - remember ``/dev/disk1'' for the next step. 108 /dev/disk1 - remember ``/dev/disk1'' for the next step.
102 109
103 It's possible that itunes will try to be ``helpful'' and remount your ipod 110 It's possible that itunes will try to be ``helpful'' and remount your Ipod
104 after you modify it with ipodpatcher. If this happens, you need to unmount 111 after you modify it with ipodpatcher. If this happens, you need to unmount
105 it again using the above command. 112 it again using the above command.
106 113
107 \item Create a backup of your ipod's firmware partition 114 \item Create a backup of your Ipod's firmware partition
108 115
109 Type the following command, replacing "[device]" with the number (for 116 Type the following command, replacing ``N'' with the number (for
110 Windows users) or the device name (Mac OS X and Unix users) assigned to 117 Windows users) or the device name (Mac OS X and Unix users) assigned to
111 your ipod that you found in the previous step: 118 your Ipod that you identified in the previous step:
112 \begin{code} 119 \begin{code}
113 ipodpatcher [device] -r bootpartition.bin (Windows) 120 ipodpatcher N -r bootpartition.bin (Windows)
114 \end{code} 121 \end{code}
115 or 122 or
116 \begin{code} 123 \begin{code}
117 ./ipodpatcher [device] -r bootpartition.bin (Mac OS X/Unix) 124 ./ipodpatcher N -r bootpartition.bin (Mac OS X/Unix)
118 \end{code} 125 \end{code}
119 126
120 This should create a file in the current folder called bootpartition.bin 127 This should create a file in the current folder called
121 (approximately 40MB for the iPod 3G, 4G and Color/Photo, 80MB for the Nano 128 \fname{bootpartition.bin} (approximately 40MB for the iPod 3G, 4G and
122 1st gen and 30GB Video, and 112MB for the 60GB Video) containing a copy of 129 Color/Photo, 80MB for the Nano 1st gen and 30GB Video, and 112MB for the
123 the ``firmware partition'' from your iPod. 130 60GB Video) containing a copy of the ``firmware partition'' from your Ipod.
124 131
125 If it ever becomes necessary (i.e. your ipod refuses to start), you can 132 If it ever becomes necessary (for example, if your Ipod refuses to start),
126 restore this backup to your ipod using the command ipodpatcher [device] -w 133 you can restore this backup to your Ipod using the command ipodpatcher N -w
127 bootpartition.bin (Windows) or ./ipodpatcher [device] -w bootpartition.bin 134 bootpartition.bin (Windows) or ./ipodpatcher N -w bootpartition.bin (Mac OS
128 (Mac OS X/Unix). 135 X/Unix).
129 136
130 \opt{ipodmini}{ 137 \opt{ipodmini}{
131 \note{Ipod Mini 2g users need to replace ``1g'' with ``2g'' in the 138 \note{Ipod Mini 2g users need to replace ``1g'' with ``2g'' in the
@@ -135,20 +142,27 @@ you wish. Note that these files should be saved onto your computer's hard disk,
135 \item Install the bootloader. 142 \item Install the bootloader.
136 Windows users should now type: 143 Windows users should now type:
137 \begin{code} 144 \begin{code}
138 ipodpatcher [device] -a \bootloaderfile 145 ipodpatcher N -a \bootloaderfile
139 \end{code} 146 \end{code}
140 % 147 %
141 148
142 and Mac OS X/Unix users should type: 149 and Mac OS X/Unix users should type:
143 150
144 \begin{code} 151 \begin{code}
145 ./ipodpatcher [device] -a \bootloaderfile 152 ./ipodpatcher N -a \bootloaderfile
146 \end{code} 153 \end{code}
147 154
148 Replace [device] with the number (Windows users) or device name (Mac OS X/Unix 155 Replace N with the number (Windows users) or device name (Mac OS X/Unix
149 users) you've been using to access your ipod. 156 users) you've been using to access your Ipod.
157
158 You can now disconnect your Ipod from your computer in the normal way. This
159 should cause your Ipod to reboot and start Rockbox.
150 160
151 You can now disconnect your ipod from your computer in the normal way. This 161 \note{If your Ipod displays the message ``Error: -1,'' you have either
152 should cause your iPod to reboot and start Rockbox. 162 neglected to install a Rockbox build as described in the preceding section,
163 or you have extracted the contents of the \fname{.zip} file to some
164 directory other than the the root directory of your Ipod. To fix this
165 error, following the directions in the preceding section for downloading and
166 installing a Daily Build.}
153 167
154\end{enumerate} 168\end{enumerate}