diff options
author | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2007-09-24 20:12:17 +0000 |
---|---|---|
committer | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2007-09-24 20:12:17 +0000 |
commit | 33e15591940413efa312e96ea4bd2f741d8f6115 (patch) | |
tree | 079f36e2de2b04f725e5009576ce83ba52df80f1 | |
parent | ff7b3c5e4eb7a0598cde2f5afa51e4fd444830dc (diff) | |
download | rockbox-33e15591940413efa312e96ea4bd2f741d8f6115.tar.gz rockbox-33e15591940413efa312e96ea4bd2f741d8f6115.zip |
Introduce Rockbox Utility to the manual as automated installation option. Only rather short description for now.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14843 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/getting_started/installation.tex | 231 |
1 files changed, 143 insertions, 88 deletions
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex index c9504169e1..70d7a1365e 100644 --- a/manual/getting_started/installation.tex +++ b/manual/getting_started/installation.tex | |||
@@ -9,6 +9,74 @@ | |||
9 | } | 9 | } |
10 | } | 10 | } |
11 | 11 | ||
12 | \section{Overview} | ||
13 | There are two ways of installing Rockbox: automated and manual. While the | ||
14 | manual way is older, more tested and proven to work correctly, the | ||
15 | automated installation is based on a nice graphical application that does | ||
16 | almost everything that's needed for you. It is still important that you have | ||
17 | an overview of the installation process to be able to select the correct | ||
18 | installation options. | ||
19 | |||
20 | \opt{MASCODEC}{Rockbox itself comes as a single package. There is no need | ||
21 | to install additional software for running Rockbox.} | ||
22 | \opt{SWCODEC} { | ||
23 | \opt{HAVE_RB_BL_ON_DISK}{There are three separate components, | ||
24 | two of which need to be installed in order to run Rockbox.} | ||
25 | \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components of Rockbox | ||
26 | that need to be installed in order to run Rockbox.} | ||
27 | |||
28 | \begin{description} | ||
29 | \opt{HAVE_RB_BL_ON_DISK}{ | ||
30 | \item[The \playerman{} boot loader.] | ||
31 | The \playerman{} boot loader is the program that tells your \dap{} how to boot | ||
32 | and load the remaining firmware from disk. It is also responsible for the | ||
33 | disk mode on your \dap{}. | ||
34 | |||
35 | This boot loader is stored in special flash memory in your \playerman{}. | ||
36 | It is already installed on your \dap{}, so it is never necessary to modify | ||
37 | this in order to install Rockbox.} | ||
38 | |||
39 | \item[The Rockbox boot loader.] \index{Boot loader} | ||
40 | \opt{HAVE_RB_BL_ON_DISK}{The Rockbox boot loader is loaded from disk by | ||
41 | the \playerman{} boot loader. It is responsible for loading the Rockbox | ||
42 | firmware and for providing the dual boot function. It directly replaces the | ||
43 | \playerman{} firmware on the \daps{} disk. | ||
44 | \opt{gigabeat}{\note{Dual boot does not currently work on the gigabeat.}}} | ||
45 | |||
46 | \opt{HAVE_RB_BL_IN_FLASH}{ | ||
47 | The boot loader is the program that tells your | ||
48 | \dap{} how to boot and load other components of Rockbox. This is the | ||
49 | component of Rockbox that is installed to the flash memory of your | ||
50 | \playerman.} | ||
51 | |||
52 | \item[The Rockbox firmware.] | ||
53 | \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs | ||
54 | entirely from flash memory,} | ||
55 | \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,} | ||
56 | most of the Rockbox code is contained in a | ||
57 | ``build'' that resides on your \daps{} drive. This makes it easy to | ||
58 | update Rockbox. The build consists of a directory called | ||
59 | \fname{.rockbox} containing all of Rockbox' files, which is located in the | ||
60 | root of your \daps{} drive. | ||
61 | |||
62 | \end{description} | ||
63 | } | ||
64 | |||
65 | \nopt{player} { | ||
66 | Apart from the required parts there are some addons you might be interested | ||
67 | in installing too. | ||
68 | \begin{description} | ||
69 | \item[Fonts.] Rockbox can load custom fonts. The fonts itself are | ||
70 | distributed as separate package and thus needs to be installed | ||
71 | separately. The fonts are not required to run Rockbox itself but | ||
72 | a lot of themes require the fonts package to be installed. | ||
73 | |||
74 | \item[Themes.] The view of Rockbox can be customized by themes. Depending | ||
75 | on your taste you might want to install additional themes to change | ||
76 | the look of Rockbox. | ||
77 | \end{description} | ||
78 | } | ||
79 | |||
12 | \section{Prerequisites}\label{sec:prerequisites} | 80 | \section{Prerequisites}\label{sec:prerequisites} |
13 | \index{Installation!Prerequisites} | 81 | \index{Installation!Prerequisites} |
14 | Before installing Rockbox you should make sure you meet the prerequisites. | 82 | Before installing Rockbox you should make sure you meet the prerequisites. |
@@ -17,19 +85,6 @@ already available on your computer but if not you need to get some additional | |||
17 | software. | 85 | software. |
18 | 86 | ||
19 | \begin{description} | 87 | \begin{description} |
20 | |||
21 | \item[ZIP utility.]\index{zip} | ||
22 | Rockbox is distributed as an archive using the | ||
23 | \fname{.zip} format. Thus you need a tool to handle that compressed | ||
24 | format. Usually your computer should have a tool installed that can | ||
25 | handle the \fname{.zip} file format. Windows XP has built-in support for | ||
26 | \fname{.zip} files and presents them to you as folders unless you have | ||
27 | installed a third party program that handles compressed files. For | ||
28 | other operating systems this may vary. If the \fname{.zip} file format | ||
29 | is not recognised on your computer you can find a program to handle them | ||
30 | at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which | ||
31 | can be downloaded and used free of charge. | ||
32 | |||
33 | \item[USB connection.] To transfer Rockbox to your \dap{} you need to | 88 | \item[USB connection.] To transfer Rockbox to your \dap{} you need to |
34 | connect it to your computer. To proceed you need to know where to access the | 89 | connect it to your computer. To proceed you need to know where to access the |
35 | \dap{}. On Windows this means you need to figure out the drive letter | 90 | \dap{}. On Windows this means you need to figure out the drive letter |
@@ -50,13 +105,25 @@ software. | |||
50 | \note{\index{Firewire}Firewire detection is not supported in Rockbox at | 105 | \note{\index{Firewire}Firewire detection is not supported in Rockbox at |
51 | the moment. Please use USB only.} | 106 | the moment. Please use USB only.} |
52 | } | 107 | } |
53 | 108 | \end{description} | |
109 | For manual installation and customization additional software is required. | ||
110 | \begin{description} | ||
111 | \item[ZIP utility.]\index{zip} | ||
112 | Rockbox is distributed as an archive using the | ||
113 | \fname{.zip} format. Thus you need a tool to handle that compressed | ||
114 | format. Usually your computer should have a tool installed that can | ||
115 | handle the \fname{.zip} file format. Windows XP has built-in support for | ||
116 | \fname{.zip} files and presents them to you as folders unless you have | ||
117 | installed a third party program that handles compressed files. For | ||
118 | other operating systems this may vary. If the \fname{.zip} file format | ||
119 | is not recognised on your computer you can find a program to handle them | ||
120 | at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which | ||
121 | can be downloaded and used free of charge. | ||
54 | \item[Text editor.] As you will see in the following chapters, Rockbox is | 122 | \item[Text editor.] As you will see in the following chapters, Rockbox is |
55 | highly configurable. In addition to saving configurations within Rockbox, | 123 | highly configurable. In addition to saving configurations within Rockbox, |
56 | Rockbox also allows you to create customised configuration files. If you | 124 | Rockbox also allows you to create customised configuration files. If you |
57 | would like to edit custom configuration files on your computer, you will | 125 | would like to edit custom configuration files on your computer, you will |
58 | need a text editor like Windows' ``Wordpad''. | 126 | need a text editor like Windows' ``Wordpad''. |
59 | |||
60 | \end{description} | 127 | \end{description} |
61 | 128 | ||
62 | \opt{ipod}{ | 129 | \opt{ipod}{ |
@@ -71,71 +138,45 @@ software. | |||
71 | } | 138 | } |
72 | } | 139 | } |
73 | 140 | ||
74 | \section{Installing Rockbox}\label{sec:installing_rockbox} | 141 | \section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation} |
75 | \index{Installation} | 142 | \subsection{Automated Installation} |
76 | \opt{MASCODEC}{ | 143 | To automatically install Rockbox download the official installer and |
77 | \subsection{Using the windows installer} | 144 | housekeeping tool \textsc{Rockbox Utility}. It allows you to |
78 | Using the Windows self installing executable to install Rockbox is the | 145 | \begin{itemize} |
79 | easiest method of installing the software on your \dap{}. Simply follow the | 146 | \item Automatically install all needed components for using Rockbox |
80 | on-screen instructions and select the appropriate drive letter and | 147 | (``Small Installation'') |
81 | \dap{}-model when prompted. You can use ``Add / Remove Programs'' to | 148 | \item Automatically install all suggested components (``Full Installation'') |
82 | uninstall the software at a later date. | 149 | \item Selectively install any of all available parts of Rockbox |
83 | 150 | \item Install additional themes interactively | |
84 | \subsection{Manual installation} | 151 | \item Install voice files and generate talk clips |
85 | For non{}-Windows users and those wishing to install manually from the | 152 | \item Uninstall all components you installed using Rockbox Utility |
86 | archive the procedure is still fairly simple. | 153 | \end{itemize} |
87 | } | 154 | Prebuild binaries for Windows, Linux and MacOS~X are |
88 | 155 | available from \download{rbutil/}. As Rockbox Utility is still under | |
89 | \opt{SWCODEC}{ | 156 | development more information including up-to-date download links can be |
90 | \subsection{Introduction} | 157 | found at \wikilink{RockboxUtilityQt}. |
91 | 158 | ||
92 | \opt{HAVE_RB_BL_ON_DISK}{There are three separate components of Rockbox, | 159 | \warn{Upon the first start of Rockbox Utility you \emph{need} to set at least |
93 | two of which need to be installed in order to run Rockbox.} | 160 | the correct player and mountpoint in the configuration dialog. Autodetection |
94 | 161 | can detect most player types. If autodetection failed or was unable to detect | |
95 | \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components of Rockbox | 162 | the mountpoint make sure to enter the correct values. The mountpoint indicates |
96 | that need to be installed in order to run Rockbox.} | 163 | the location of the \dap{} in your filesystem. On Windows, this is the drive |
97 | 164 | letter the \dap{} gets assigned, on other systems this is a path in the | |
98 | \begin{description} | 165 | filesystem.} |
99 | \opt{HAVE_RB_BL_ON_DISK}{ | 166 | \opt{ipodvideo}{\warn{Autodetection is unable to distinguish between the |
100 | \item[The \playerman{} boot loader.] | 167 | \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the |
101 | The \playerman{} boot loader is the program that tells your \dap{} how to boot | 168 | 30~GB model. This will usually work but you might want to check the |
102 | and load the remaining firmware from disk. It is also responsible for the | 169 | detected value, especially if you experience problems with Rockbox.}} |
103 | disk mode on your \dap{}. | 170 | |
104 | 171 | \note{Rockbox Utility currently lacks some guiding messages. Please have a | |
105 | This boot loader is stored in special flash memory in your \playerman{}. | 172 | look at the manual installation instructions if you're stuck |
106 | It is already installed on your \dap{}, so it is never necessary to modify | 173 | during installation.} |
107 | this in order to install Rockbox.} | 174 | |
108 | 175 | \subsection{Manual Installation} | |
109 | \item[The Rockbox boot loader.] \index{Boot loader} | 176 | |
110 | \opt{HAVE_RB_BL_ON_DISK}{The Rockbox boot loader is loaded from disk by | 177 | \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version} |
111 | the \playerman{} boot loader. It is responsible for loading the Rockbox | 178 | |
112 | firmware and for providing the dual boot function. It directly replaces the | 179 | There are three different types of firmware binaries from the Rockbox website: |
113 | \playerman{} firmware on the \daps{} disk. | ||
114 | \opt{gigabeat}{\note{Dual boot does not currently work on the gigabeat.}}} | ||
115 | |||
116 | \opt{HAVE_RB_BL_IN_FLASH}{ | ||
117 | The boot loader is the program that tells your | ||
118 | \dap{} how to boot and load other components of Rockbox. This is the | ||
119 | component of Rockbox that is installed to the flash memory of your | ||
120 | \playerman.} | ||
121 | |||
122 | \item[The Rockbox firmware.] | ||
123 | \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs | ||
124 | entirely from flash memory, } | ||
125 | \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware, } | ||
126 | most of the Rockbox code is contained in a | ||
127 | ``build'' that resides on your \daps{} drive. This makes it easy to | ||
128 | update Rockbox. The build consists of a directory called | ||
129 | \fname{.rockbox} containing all of Rockbox' files, which is located in the | ||
130 | root of your \daps{} drive. | ||
131 | |||
132 | \end{description} | ||
133 | |||
134 | } | ||
135 | |||
136 | \subsection{Choosing a Rockbox version}\label{sec:choosing_version} | ||
137 | |||
138 | There are three different types of firmware binaries from Rockbox website: | ||
139 | \label{Version} | 180 | \label{Version} |
140 | Release version, current build and daily build. You need to decide which one | 181 | Release version, current build and daily build. You need to decide which one |
141 | you want to install and get the version for your \dap{}. | 182 | you want to install and get the version for your \dap{}. |
@@ -187,7 +228,7 @@ project development, you can try development builds and help by reporting | |||
187 | bugs. Just be aware that these are development builds that are highly | 228 | bugs. Just be aware that these are development builds that are highly |
188 | functional, but not perfect! | 229 | functional, but not perfect! |
189 | 230 | ||
190 | \subsection{Installing the firmware}\label{sec:installing_firmware} | 231 | \subsubsection{Installing the firmware}\label{sec:installing_firmware} |
191 | 232 | ||
192 | \opt{sansa}{\warn{The following steps require you to change the setting in | 233 | \opt{sansa}{\warn{The following steps require you to change the setting in |
193 | \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the | 234 | \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the |
@@ -247,7 +288,7 @@ structure that Rockbox needs. | |||
247 | } | 288 | } |
248 | 289 | ||
249 | \opt{SWCODEC}{ | 290 | \opt{SWCODEC}{ |
250 | \subsection{Installing the boot loader} | 291 | \subsubsection{Installing the boot loader} |
251 | \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}} | 292 | \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}} |
252 | \opt{ipod}{\input{getting_started/ipod_install.tex}} | 293 | \opt{ipod}{\input{getting_started/ipod_install.tex}} |
253 | \opt{m5,x5}{\input{getting_started/iaudio_install.tex}} | 294 | \opt{m5,x5}{\input{getting_started/iaudio_install.tex}} |
@@ -256,7 +297,7 @@ structure that Rockbox needs. | |||
256 | \opt{sansa}{\input{getting_started/sansa_install.tex}} | 297 | \opt{sansa}{\input{getting_started/sansa_install.tex}} |
257 | } | 298 | } |
258 | 299 | ||
259 | \section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} | 300 | \subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support} |
260 | \index{Speech}\index{Installation!Optional Steps} | 301 | \index{Speech}\index{Installation!Optional Steps} |
261 | If you wish to use speech support you will also need a voice file, english ones | 302 | If you wish to use speech support you will also need a voice file, english ones |
262 | are available from \url{http://www.rockbox.org/daily.shtml}. Download the | 303 | are available from \url{http://www.rockbox.org/daily.shtml}. Download the |
@@ -266,15 +307,15 @@ your \dap{} and reboot. Voice menus are turned on by default. See | |||
266 | \reference{ref:Voiceconfiguration} for details on voice settings. | 307 | \reference{ref:Voiceconfiguration} for details on voice settings. |
267 | 308 | ||
268 | \section{Running Rockbox} | 309 | \section{Running Rockbox} |
269 | Remove your \dap{} from the computer's USB port.% | 310 | Remove your \dap{} from the computer's USB port. % |
270 | \nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When | 311 | \nopt{ipod,e200}{Unplug any connected power supply and turn the unit off. When |
271 | you next turn the unit on, Rockbox should load.}% | 312 | you next turn the unit on, Rockbox should load. }% |
272 | \opt{ipod}{Rebooting the Ipod by holding | 313 | \opt{ipod}{Rebooting the Ipod by holding |
273 | \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}% | 314 | \opt{IPOD_4G_PAD}{\ButtonMenu{}+\ButtonSelect{}}% |
274 | \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}} | 315 | \opt{IPOD_3G_PAD}{\ButtonMenu{}+\ButtonPlay{}} |
275 | for a couple of seconds until the \dap{} reboots. Now Rockbox should load. | 316 | for a couple of seconds until the \dap{} reboots. Now Rockbox should load. |
276 | }% | 317 | } % |
277 | \opt{e200}{Your e200 will automatically reboot and Rockbox should load}% | 318 | \opt{e200}{Your e200 will automatically reboot and Rockbox should load. }% |
278 | When you see the Rockbox splash screen, Rockbox is loaded and ready for | 319 | When you see the Rockbox splash screen, Rockbox is loaded and ready for |
279 | use. | 320 | use. |
280 | 321 | ||
@@ -289,15 +330,29 @@ use. | |||
289 | } | 330 | } |
290 | } | 331 | } |
291 | 332 | ||
292 | \section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build. | 333 | \section{Updating Rockbox} |
334 | Even if you don't use Rockbox Utility for updating Rockbox it's easy. | ||
335 | Download a Rockbox build. | ||
293 | (The latest release of the Rockbox software will always be available from | 336 | (The latest release of the Rockbox software will always be available from |
294 | \url{http://www.rockbox.org/download/}). Unzip the build to the root directory | 337 | \url{http://www.rockbox.org/download/}). Unzip the build to the root directory |
295 | of your \dap{} like you did in the installation step before. If your unzip | 338 | of your \dap{} like you did in the installation step before. If your unzip |
296 | program asks you whether to overwrite files, choose the ``Yes to all'' option. | 339 | program asks you whether to overwrite files, choose the ``Yes to all'' option. |
297 | The new build will be installed over your current build. | 340 | The new build will be installed over your current build. |
298 | 341 | ||
342 | \note{If you use Rockbox Utility be aware that it can not detect manually | ||
343 | installed components.} | ||
344 | |||
299 | \section{Uninstalling Rockbox}\index{Installation!uninstall} | 345 | \section{Uninstalling Rockbox}\index{Installation!uninstall} |
346 | \subsection{Automatic Uninstallation} | ||
347 | You can uninstall Rockbox automatically by using Rockbox Utility. If you | ||
348 | installed Rockbox manually you can still use Rockbox Utility for uninstallation | ||
349 | but won't be able to do this selectively. | ||
350 | |||
351 | \opt{h1xx,h300}{\note{Rockbox Utility can't uninstall the bootloader due to | ||
352 | the fact that it requires a flashing procedure. To uninstall the bootloader | ||
353 | completely follow the manual uninstallation instructions below.}} | ||
300 | 354 | ||
355 | \subsection{Manual Uninstallation} | ||
301 | \opt{archos}{ | 356 | \opt{archos}{ |
302 | If you would like to go back to using the original \playerman{} software, | 357 | If you would like to go back to using the original \playerman{} software, |
303 | connect the \dap{} to your computer, and delete the | 358 | connect the \dap{} to your computer, and delete the |