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