summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/getting_started/installation.tex340
1 files changed, 169 insertions, 171 deletions
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index b33134ca6c..8fd97105cb 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -8,138 +8,134 @@ Also you may need some tools for installation. In most cases these will be
8already available on your computer but if not you need to get some additional 8already available on your computer but if not you need to get some additional
9software. 9software.
10 10
11 \begin{description} 11\begin{description}
12 12
13 \item[ZIP utility.] Rockbox is distributed as an archive using the 13\item[ZIP utility.] Rockbox is distributed as an archive using the
14 \fname{.zip} format. Thus you need a tool to handle that compressed 14 \fname{.zip} format. Thus you need a tool to handle that compressed
15 format. Usually your computer should have a tool installed that can 15 format. Usually your computer should have a tool installed that can
16 handle the \fname{.zip} file format. Windows XP has builtin support for 16 handle the \fname{.zip} file format. Windows XP has builtin support for
17 \fname{.zip} files and presents them to you as folders unless you have 17 \fname{.zip} files and presents them to you as folders unless you have
18 installed a third party program that handles compressed files. For 18 installed a third party program that handles compressed files. For
19 other operating systems this may vary. If the \fname{.zip} file format 19 other operating systems this may vary. If the \fname{.zip} file format
20 is not recognized on your computer you can find a program to handle them 20 is not recognized on your computer you can find a program to handle them
21 at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which 21 at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which
22 can be downloaded and used free of charge. 22 can be downloaded and used free of charge.
23 23
24 \item[USB connection.] To transfer Rockbox to your \dap{} you need to 24\item[USB connection.] To transfer Rockbox to your \dap{} you need to
25 connect it to your computer. To proceed you need to know where to access the 25 connect it to your computer. To proceed you need to know where to access the
26 \dap{}. On Windows this means you need to figure out the drive letter 26 \dap{}. On Windows this means you need to figure out the drive letter
27 associated with the device. On Linux you need to know the mount point of 27 associated with the device. On Linux you need to know the mount point of
28 your \dap{}. 28 your \dap{}.
29 29
30 \opt{ipod} 30 \opt{ipod}{
31 { 31 \note{Your \dap{} should enter disk mode automatically when connected to a
32 \note 32 computer via USB. If your computer does not recognize your \dap{}, you
33 { 33 may need to enter the disk mode manually. Disconnect your \dap{} from the
34 Your \dap{} should enter disk mode automatically when connected to a 34 computer. Reset the \dap{} by pressing and holding the \ButtonMenu{} and
35 computer via USB. If your computer does not recognize your \dap{}, you 35 \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets,
36 may need to enter the disk mode manually. Disconnect your \dap{} 36 press and hold the \ButtonMenu{} and \ButtonPlay{} buttons
37 from the computer. Reset the \dap{} by pressing and holding the 37 simultaneously. Your \dap{} should enter disk mode, and you can try
38 \ButtonMenu{} and \ButtonSelect{} buttons simultaneously. As soon as the 38 reconnecting to the computer.
39 \dap{} resets, press and hold the \ButtonMenu{} and \ButtonPlay{} buttons
40 simultaneously. Your \dap{} should enter disk mode, and you can try
41 reconnecting to the computer.
42 }
43 } 39 }
40 }
44 41
45 \item[Text editor.] As you will see in the following chapters, Rockbox is 42\item[Text editor.] As you will see in the following chapters, Rockbox is
46 highly configurable. In addition to saving configurations within Rockbox, 43 highly configurable. In addition to saving configurations within Rockbox,
47 Rockbox also allows you to create customized configuration files. If you 44 Rockbox also allows you to create customized configuration files. If you
48 would like to edit custom configuration files on your computer, you will 45 would like to edit custom configuration files on your computer, you will
49 need a text editor like Windows' ``Wordpad''. 46 need a text editor like Windows' ``Wordpad''.
50 47
51\end{description} 48\end{description}
52 49
53 50
54\section{Installing Rockbox}\label{sec:installing_rockbox} 51\section{Installing Rockbox}\label{sec:installing_rockbox}
55 52
56\opt{MASCODEC} 53\opt{MASCODEC}{
57 { 54 \subsection{Using the windows installer}
58 \subsection{Using the windows installer}
59 Using the Windows self installing executable to install Rockbox is the 55 Using the Windows self installing executable to install Rockbox is the
60 easiest method of installing the software on your \dap{}. Simply follow the 56 easiest method of installing the software on your \dap{}. Simply follow the
61 on-screen instructions and select the appropriate drive letter and 57 on-screen instructions and select the appropriate drive letter and
62 \dap{}-model when prompted. You can use ``Add / Remove Programs'' to 58 \dap{}-model when prompted. You can use ``Add / Remove Programs'' to
63 uninstall the software at a later date. 59 uninstall the software at a later date.
64 60
65 \subsection{Manual installation} 61 \subsection{Manual installation}
66 For non{}-Windows users and those wishing to install manually from the archive 62 For non{}-Windows users and those wishing to install manually from the
67 the procedure is still fairly simple. 63 archive the procedure is still fairly simple.
68 } 64}
69 65
70\opt{SWCODEC} 66\opt{SWCODEC}{
71 {
72 \subsection{Introduction} 67 \subsection{Introduction}
73 68
74 There are two separate components of Rockbox that need to be installed in 69 There are two separate components of Rockbox that need to be installed in
75 order to run Rockbox. 70 order to run Rockbox.
76 71
77 \begin{description} 72 \begin{description}
73
74 \item[The Rockbox bootloader.] The bootloader is the program that tells your
75 \dap{} how to boot and load other components of Rockbox. This is the
76 component of Rockbox that is installed to the flash memory of your
77 \playerman.
78 78
79 \item[The Rockbox bootloader.] The bootloader is the program that tells your 79 \item[The Rockbox firmware.] Unlike the \playerman\ firmware, which runs
80 \dap{} how to boot and load other components of Rockbox. This is the 80 entirely from flash memory, most of the Rockbox code is contained in a
81 component of Rockbox that is installed to the flash memory of your 81 ``build'' that resides on your \daps{} hard drive. This makes it easy to
82 \playerman. 82 update Rockbox. The build consists of a file named \firmwarefilename\ and a
83 83 directory called \fname{.rockbox}, both of which are located in the root
84 \item[The Rockbox firmware.] Unlike the \playerman\ firmware, which runs 84 directory of your hard drive.
85 entirely from flash memory, most of the Rockbox code is contained in a
86 ``build'' that resides on your \daps{} hard drive. This makes it easy to
87 update Rockbox. The build consists of a file named \firmwarefilename\ and a
88 directory called \fname{.rockbox}, both of which are located in the root
89 directory of your hard drive.
90 85
91 \end{description} 86 \end{description}
92 87
93 \subsection{Installing the bootloader} 88 \subsection{Installing the bootloader}
94 \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}} 89 \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
95 \opt{ipod}{\input{getting_started/ipod_install.tex}} 90 \opt{ipod}{\input{getting_started/ipod_install.tex}}
96 \opt{x5}{\input{getting_started/iaudio_install.tex}} 91 \opt{x5}{\input{getting_started/iaudio_install.tex}}
97 92
98 \subsection{Installing the firmware} 93 \subsection{Installing the firmware}
99 After installing the bootloader, the installation becomes fairly easy. 94 After installing the bootloader, the installation becomes fairly easy.
100 } 95}
101 96
102There are three different types of firmware binaries from Rockbox website: 97There are three different types of firmware binaries from Rockbox website:
103current version, daily build and CVS build. You need to decide which one you 98current version, daily build and CVS build. You need to decide which one
104want to install and get the version for your \dap{}. 99you want to install and get the version for your \dap{}.
105 100
106\begin{description} 101\begin{description}
107 102
108 \item[Current Version.] The current version is the latest stable release, free 103\item[Current Version.] The current version is the latest stable release, free
109 of known critical bugs. The current stable release of Rockbox, version 2.5, 104 of known critical bugs. The current stable release of Rockbox, version 2.5,
110 is available at \url{http://www.rockbox.org/download/}. 105 is available at \url{http://www.rockbox.org/download/}.
111 \opt{SWCODEC}{ 106 \opt{SWCODEC}{
112 \note{The current stable release is available only for Archos jukeboxes. 107 \note{The current stable release is available only for Archos jukeboxes.
113 There has not yet been a stable release for the \playername{}. Until 108 There has not yet been a stable release for the \playername{}. Until
114 there is a stable release for \playername{}, use a daily build or CVS build. 109 there is a stable release for \playername{}, use a daily build or CVS
115 } 110 build.
116 } 111 }
112 }
117 113
118 \item[Daily Build.] The daily build is a development version of Rockbox. It 114\item[Daily Build.] The daily build is a development version of Rockbox. It
119 contains features and patches developed since last stable version. It 115 contains features and patches developed since last stable version. It
120 may also contain bugs! This daily build is generated automatically every day 116 may also contain bugs! This daily build is generated automatically every day
121 and can be found at \url{http://www.rockbox.org/daily.shtml}. 117 and can be found at \url{http://www.rockbox.org/daily.shtml}.
118
119\item[CVS Build (formerly, ``Bleeding Edge Build.'')] CVS stands for
120 ``Concurrent Versions System.'' CVS is the system that Rockbox
121 developers use to keep track of changes to the Rockbox source code. CVS
122 builds are made automatically every time there is a change to the
123 Rockbox source. These builds are for people who want to test the code
124 that developers just checked in.
122 125
123 \item[CVS Build (formerly, ``Bleeding Edge Build.'')] CVS stands for
124 ``Concurrent Versions System.'' CVS is the system that Rockbox
125 developers use to keep track of changes to the Rockbox source code. CVS
126 builds are made automatically every time there is a change to the
127 Rockbox source. These builds are for people who want to test the code
128 that developers just checked in.
129
130\end{description} 126\end{description}
131 127
132 \nopt{player}{ 128\nopt{player}{
133 \note{ 129 \note{
134 Rockbox has a fonts package that is available at 130 Rockbox has a fonts package that is available at
135 \url{http://www.rockbox.org/daily.shtml}. While the daily builds and CVS 131 \url{http://www.rockbox.org/daily.shtml}. While the daily builds and CVS
136 builds change frequently, the fonts package rarely changes. Thus, the 132 builds change frequently, the fonts package rarely changes. Thus, the
137 fonts package is not included in the daily builds and CVS builds. (The 133 fonts package is not included in the daily builds and CVS builds. (The
138 stable release, on the other hand, does not change, so fonts are 134 stable release, on the other hand, does not change, so fonts are
139 include with the stable release.) When installing Rockbox for the 135 include with the stable release.) When installing Rockbox for the
140 first time, you should install the fonts package. 136 first time, you should install the fonts package.
141 } 137 }
142 } 138}
143 139
144Because daily builds and CVS builds are development versions which change 140Because daily builds and CVS builds are development versions which change
145frequently, they may behave differently than described in this manual, or 141frequently, they may behave differently than described in this manual, or
@@ -147,7 +143,7 @@ they may introduce new (and maybe annoying) bugs. If you do not want to get
147undefined behaviour from your \dap\ you should really stick to the current 143undefined behaviour from your \dap\ you should really stick to the current
148stable release, if there is one for your \dap{}. If you want to help the 144stable release, if there is one for your \dap{}. If you want to help the
149project development, you can try development builds and help by reporting 145project development, you can try development builds and help by reporting
150bugs. Just be aware that these are development builds that are highly 146bugs. Just be aware that these are development builds that are highly
151functional, but not perfect! 147functional, but not perfect!
152 148
153After downloading the Rockbox package connect your \dap{} to the computer via 149After downloading the Rockbox package connect your \dap{} to the computer via
@@ -161,38 +157,39 @@ drive. Do not try to create a separate directory or folder on your \dap{} for
161the Rockbox files! The \fname{.zip} file already contains the internal 157the Rockbox files! The \fname{.zip} file already contains the internal
162directory structure that Rockbox needs. 158directory structure that Rockbox needs.
163 159
164 \note{ 160\note{
165 If the contents of the \fname{.zip} file are extracted correctly, you will 161 If the contents of the \fname{.zip} file are extracted correctly, you will
166 have a file called \fname{\firmwarefilename} in the main folder of your 162 have a file called \fname{\firmwarefilename} in the main folder of your
167 \daps{} drive, and also a folder called /\fname{.rockbox}, which contains a 163 \daps{} drive, and also a folder called /\fname{.rockbox}, which contains a
168 number of other folders and system files needed by Rockbox. If you receive a 164 number of other folders and system files needed by Rockbox. If you receive a
169 ``-1'' error when you start Rockbox, you have not extracted the contents of 165 ``-1'' error when you start Rockbox, you have not extracted the contents of
170 the \fname{.zip} file to the proper location. 166 the \fname{.zip} file to the proper location.
171 } 167}
172 168
173\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} 169\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
174If you wish to use speech support you will also need a language file, available 170If you wish to use speech support you will also need a language file, available
175from \wikilink{VoiceFiles}. For the English language, the file is called 171from \wikilink{VoiceFiles}. For the English language, the file is called
176\fname{english.voice}. When it has been downloaded, unpack this file and copy it 172\fname{english.voice}. When it has been downloaded, unpack this file and copy
177into the \fname{lang} folder which is inside the \fname{/.rockbox} folder on 173it into the \fname{lang} folder which is inside the \fname{/.rockbox} folder on
178your \dap{}. Voice menus are turned on by default. See 174your \dap{}. Voice menus are turned on by default. See
179\reference{ref:Voiceconfiguration} for details on voice settings. 175\reference{ref:Voiceconfiguration} for details on voice settings.
180 176
181\section{Running Rockbox} 177\section{Running Rockbox}
182Remove your \dap{} from the computer's USB port. Unplug any connected power supply 178Remove your \dap{} from the computer's USB port. Unplug any connected power
183and turn the unit off. When you next turn the unit on, Rockbox should load. When 179supply and turn the unit off. When you next turn the unit on, Rockbox should
184you see the Rockbox splash screen, Rockbox is loaded and ready for use. 180load. When you see the Rockbox splash screen, Rockbox is loaded and ready for
181use.
185 182
186\opt{ipod}{ 183\opt{ipod}{
187 \note{ 184 \note{
188 Rockbox starts in the \setting{File Browser}. If you have loaded music onto 185 Rockbox starts in the \setting{File Browser}. If you have loaded music onto
189 your player using Itunes, you will not be able to see your music because 186 your player using Itunes, you will not be able to see your music because
190 Itunes changes your files' names and hides them in directories in the 187 Itunes changes your files' names and hides them in directories in the
191 \fname{Ipod\_Control} folder. You can view files placed on your \dap{} by 188 \fname{Ipod\_Control} folder. You can view files placed on your \dap{} by
192 Itunes by initializing and using Rockbox's Tag Cache. See 189 Itunes by initializing and using Rockbox's Tag Cache. See
193 \reference{ref:tagcache} for more information. 190 \reference{ref:tagcache} for more information.
194 } 191 }
195 } 192}
196 193
197\section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build. 194\section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build.
198(The latest release of the Rockbox software will always be available from 195(The latest release of the Rockbox software will always be available from
@@ -202,17 +199,18 @@ program asks you whether to overwrite files, choose the ``Yes to all'' option.
202The new build will be installed over your current build. 199The new build will be installed over your current build.
203 200
204\note{ 201\note{
205 Settings are stored on an otherwise-unused sector of your hard disk, not in 202 Settings are stored on an otherwise-unused sector of your hard disk, not in
206 any of the files contained in the Rockbox build. Therefore, generally 203 any of the files contained in the Rockbox build. Therefore, generally
207 speaking, installing a new build does \emph{not} reset Rockbox to its default 204 speaking, installing a new build does \emph{not} reset Rockbox to its default
208 settings. Be aware, however, that from time to time, a change is made to the 205 settings. Be aware, however, that from time to time, a change is made to the
209 Rockbox source code that \emph{does} cause settings to be reset to their 206 Rockbox source code that \emph{does} cause settings to be reset to their
210 defaults when a Rockbox build is updated. Thus it is recommended to save your 207 defaults when a Rockbox build is updated. Thus it is recommended to save your
211 settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg 208 settings using the \setting{Manage Settings} $\rightarrow$
212 file} function before updating your Rockbox build so that you can easily 209 \setting{Write .cfg file} function before updating your Rockbox build so that
213 restore the settings if necessary. For additional information on how to save, 210 you can easily restore the settings if necessary. For additional information
214 load, and reset Rockbox's settings, see \reference{ref:SystemOptions}. 211 on how to save, load, and reset Rockbox's settings, see
215 } 212 \reference{ref:SystemOptions}.
213}
216 214
217\section{Uninstalling Rockbox} 215\section{Uninstalling Rockbox}
218 216
@@ -220,20 +218,20 @@ If you would like to go back to using the original \playerman{} software, then
220connect the \playerman{} to your computer, and delete the 218connect the \playerman{} to your computer, and delete the
221\fname{\firmwarefilename} file. 219\fname{\firmwarefilename} file.
222 220
223 \optv{ipod}{ 221\optv{ipod}{
224 Next, open a command window (Windows) or a terminal window (Mac or Linux). 222 Next, open a command window (Windows) or a terminal window (Mac or Linux).
225 Navigate to the folder you created when you downloaded the 223 Navigate to the folder you created when you downloaded the
226 \fname{ipodpatcher} program you used to install the Rockbox bootloader. 224 \fname{ipodpatcher} program you used to install the Rockbox bootloader.
227 Type the following command: 225 Type the following command:
228 226
229 \begin{code} 227 \begin{code}
230 ipodpatcher -w \emph{N} bootpartition.bin 228 ipodpatcher -w \emph{N} bootpartition.bin
231 \end{code} 229 \end{code}
232 230
233 Remember that \emph{N} is the number that you found when you installed 231 Remember that \emph{N} is the number that you found when you installed
234 Rockbox on your \playerman{}. 232 Rockbox on your \playerman{}.
235 } 233}
236 234
237If you wish to clean up your disk, you may also wish to delete the 235If you wish to clean up your disk, you may also wish to delete the
238\fname{.rockbox} folder and its contents. Turn the \playerman{} off. 236\fname{.rockbox} folder and its contents. Turn the \playerman{} off.
239 237
@@ -242,25 +240,25 @@ If you wish to clean up your disk, you may also wish to delete the
242Turn the \dap{} back on and the original \playerman{} software will load. 240Turn the \dap{} back on and the original \playerman{} software will load.
243 241
244\opt{h1xx}{ 242\opt{h1xx}{
245 \note{ 243 \note{
246 There's no need to remove the installed bootloader. If you want to remove it 244 There's no need to remove the installed bootloader. If you want to remove
247 simply flash an unpatched \playerman{} firmware. Be aware that doing so will 245 it, simply flash an unpatched \playerman{} firmware. Be aware that doing so
248 also remove the bootloader USB mode. As that mode can come in quite handy 246 will also remove the bootloader USB mode. As that mode can come in quite
249 (especially when having disk errors) it is recommended to keep the 247 handy (especially when having disk errors) it is recommended to keep the
250 bootloader. It also gives you the possibility of trying Rockbox anytime 248 bootloader. It also gives you the possibility of trying Rockbox anytime
251 later by simply installing the distribution files. 249 later by simply installing the distribution files.
252 } 250 }
253 } 251}
254 252
255\opt{h300}{ 253\opt{h300}{
256 \note{ 254 \note{
257 There's no need to remove the installed bootloader, although you if you 255 There's no need to remove the installed bootloader, although you if you
258 retain the Rockbox bootloader, you will need to hold the \ButtonRec{} button 256 retain the Rockbox bootloader, you will need to hold the \ButtonRec{}
259 each time you want to start the original firmware. If you want to remove it 257 button each time you want to start the original firmware. If you want to
260 simply flash an unpatched \playerman{} firmware. Be aware that doing so will 258 remove it simply flash an unpatched \playerman{} firmware. Be aware that
261 also remove the bootloader USB mode. As that mode can come in quite handy 259 doing so will also remove the bootloader USB mode. As that mode can come in
262 (especially when having disk errors), you may wish to keep the bootloader. 260 quite handy (especially when having disk errors), you may wish to keep the
263 It also gives you the possibility of trying Rockbox anytime later by simply 261 bootloader. It also gives you the possibility of trying Rockbox anytime
264 installing a new build. 262 later by simply installing a new build.
265 } 263 }
266 } 264}