Rockbox open source high quality audio player as a Music Player Daemon
mpris
rockbox
mpd
libadwaita
audio
rust
zig
deno
Various improvements to the installation chapter, most of which are related to English spelling and grammar. Based on FS#8715.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@17826 a1c6a512-1295-4272-9138-f99709370657
+88
-84
+88
-84
manual/getting_started/installation.tex
+88
-84
manual/getting_started/installation.tex
···
26
26
There are two ways of installing Rockbox: automated and manual. While the
27
27
manual way is older, more tested and proven to work correctly, the
28
28
automated installation is based on a nice graphical application that does
29
-
almost everything that is needed for you. It is still important that you have
29
+
almost everything for you. It is still important that you have
30
30
an overview of the installation process to be able to select the correct
31
31
installation options.
32
32
···
42
42
\opt{HAVE_RB_BL_ON_DISK}{
43
43
\item[The \playerman{} bootloader.]
44
44
The \playerman{} bootloader is the program that tells your \dap{} how to boot
45
-
and load the remaining firmware from disk. It is also responsible for the
45
+
and load the firmware from disk. It is also responsible for the
46
46
disk mode on your \dap{}.
47
47
48
48
This bootloader is stored in special flash memory in your \playerman{}.
···
53
53
\opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by
54
54
the \playerman{} bootloader. It is responsible for loading the Rockbox
55
55
firmware and for providing the dual boot function. It directly replaces the
56
-
\playerman{} firmware on the \daps{} disk.
57
-
\opt{gigabeatf}{\note{Dual boot does not currently work on the gigabeat.}}}
56
+
\playerman{} firmware in the \daps{} boot sequence.
57
+
\opt{gigabeatf}{\note{Dual boot does not currently work on the Gigabeat.}}}
58
58
59
59
\opt{HAVE_RB_BL_IN_FLASH}{
60
60
The bootloader is the program that tells your
···
69
69
most of the Rockbox code is contained in a
70
70
``build'' that resides on your \daps{} drive. This makes it easy to
71
71
update Rockbox. The build consists of a directory called
72
-
\fname{.rockbox} containing all of Rockbox' files, which is located in the
73
-
root of your \daps{} drive.
72
+
\fname{.rockbox} which contains all of the Rockbox files, and is
73
+
located in the root of your \daps{} drive.
74
74
75
75
\end{description}
76
76
}
···
79
79
Apart from the required parts there are some addons you might be interested
80
80
in installing too.
81
81
\begin{description}
82
-
\item[Fonts.] Rockbox can load custom fonts. The fonts itself are
82
+
\item[Fonts.] Rockbox can load custom fonts. The fonts are
83
83
distributed as separate package and thus needs to be installed
84
-
separately. The fonts are not required to run Rockbox itself but
84
+
separately. They are not required to run Rockbox itself but
85
85
a lot of themes require the fonts package to be installed.
86
86
87
87
\item[Themes.] The view of Rockbox can be customized by themes. Depending
···
93
93
\section{Prerequisites}\label{sec:prerequisites}
94
94
\index{Installation!Prerequisites}
95
95
Before installing Rockbox you should make sure you meet the prerequisites.
96
-
Also you may need some tools for installation. In most cases these will be
96
+
You may need some additional tools for installation. In most cases these will be
97
97
already available on your computer but if not you need to get some additional
98
98
software.
99
99
100
100
\begin{description}
101
101
\item[USB connection.] To transfer Rockbox to your \dap{} you need to
102
-
connect it to your computer. To proceed you need to know where to access the
103
-
\dap{}. On Windows this means you need to figure out the drive letter
104
-
associated with the device. On Linux you need to know the mount point of
105
-
your \dap{}.
102
+
connect it to your computer. For manual installation/uninstallation, or
103
+
should autodetection fail during automatic installation, you need to know
104
+
where to access the \dap{}. On Windows this means you need to figure out
105
+
the drive letter associated with the \dap{}. On Linux you need to know the
106
+
mount point of your \dap{}.
106
107
107
108
\opt{ipod}{
108
109
Your \dap{} should enter disk mode automatically when connected to a
···
111
112
computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and
112
113
\ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press
113
114
and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your
114
-
\dap{} should enter disk mode, and you can try reconnecting to the computer.
115
+
\dap{} should enter disk mode and you can try reconnecting to the computer.
115
116
}
116
117
117
118
\opt{ipod3g,ipod4g,ipodcolor,ipodmini}{
···
138
139
For manual installation and customization additional software is required.
139
140
\begin{description}
140
141
\item[ZIP utility.]\index{zip}
141
-
Rockbox is distributed as an archive using the
142
-
\fname{.zip} format. Thus you need a tool to handle that compressed
143
-
format. Usually your computer should have a tool installed that can
144
-
handle the \fname{.zip} file format. Windows XP has built-in support for
142
+
Rockbox is distributed as a compressed archive using the
143
+
\fname{.zip} format, so you'll need a tool which can open it.
144
+
Usually your computer will have a tool already installed that can
145
+
do this. Windows XP has built-in support for
145
146
\fname{.zip} files and presents them to you as directories unless you have
146
147
installed a third party program that handles compressed files. For
147
148
other operating systems this may vary. If the \fname{.zip} file format
148
149
is not recognised on your computer you can find a program to handle them
149
-
at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/} which
150
-
can be downloaded and used free of charge.
150
+
at \url{http://www.info-zip.org/} or \url{http://sevenzip.sf.net/}, both of
151
+
which can be downloaded and used free of charge.
151
152
\item[Text editor.] As you will see in the following chapters, Rockbox is
152
-
highly configurable. In addition to saving configurations within Rockbox,
153
+
highly configurable. In addition to saving configurations,
153
154
Rockbox also allows you to create customised configuration files. If you
154
155
would like to edit custom configuration files on your computer, you will
155
156
need a text editor like Windows' ``Wordpad''.
···
157
158
158
159
\opt{ipod}{
159
160
\note{In addition to the requirements described above, Rockbox only works on
160
-
Ipods formatted with the FAT32 filesystem (i.e., Ipods initialized by iTunes
161
+
Ipods formatted with the FAT32 filesystem (i.e. Ipods initialized by iTunes
161
162
for Windows). It does not work with the HFS+ filesystem (i.e. Ipods
162
163
initialized by iTunes for the Mac). More information and instructions for
163
164
converting an Ipod to FAT32 can be found on the
···
178
179
\opt{mrobe100}{\fixme{NOTE: The m:robe 100 is only supported in rbutil version
179
180
1.05 or greater which may not be available on the download site yet.}}
180
181
181
-
To automatically install Rockbox download the official installer and
182
+
To automatically install Rockbox, download the official installer and
182
183
housekeeping tool \textsc{Rockbox Utility}. It allows you to
183
184
\begin{itemize}
184
185
\item Automatically install all needed components for using Rockbox
185
186
(``Small Installation'')
186
187
\item Automatically install all suggested components (``Full Installation'')
187
-
\item Selectively install any of all available parts of Rockbox
188
-
\item Install additional themes interactively
188
+
\item Selectively install optional components
189
+
\item Install additional themes
189
190
\item Install voice files and generate talk clips
190
191
\item Uninstall all components you installed using Rockbox Utility
191
192
\end{itemize}
192
193
Prebuilt binaries for Windows, Linux and MacOS~X are
193
-
available from \download{rbutil/}. As Rockbox Utility is still under
194
-
development more information including up-to-date download links can be
195
-
found at \wikilink{RockboxUtility}.
196
-
197
-
\warn{Upon the first start of Rockbox Utility you \emph{need} to set at least
198
-
the correct player and mountpoint in the configuration dialog. Autodetection
199
-
can detect most player types. If autodetection failed or was unable to detect
200
-
the mountpoint make sure to enter the correct values. The mountpoint indicates
194
+
available at the \wikilink{RockboxUtility} wiki page.
195
+
\\*
196
+
\warn{When first starting \textsc{Rockbox Utility} run ``Autodetect'',
197
+
found in the configuration dialog (File $\rightarrow$ Configure). Autodetection
198
+
can detect most player types. If autodetection fails or is unable to detect
199
+
the mountpoint, make sure to enter the correct values. The mountpoint indicates
201
200
the location of the \dap{} in your filesystem. On Windows, this is the drive
202
201
letter the \dap{} gets assigned, on other systems this is a path in the
203
202
filesystem.}
204
-
\opt{ipodvideo}{\warn{Autodetection is unable to distinguish between the
205
-
\playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
206
-
30~GB model. This will usually work but you might want to check the
207
-
detected value, especially if you experience problems with Rockbox.}}
203
+
204
+
\opt{ipodvideo}
205
+
{\warn{Autodetection is unable to distinguish between the
206
+
\playerman{} 30~GB and 60~GB / 80~GB models and defaults to the
207
+
30~GB model. This will usually work but you might want to check the
208
+
detected value, especially if you experience problems with Rockbox.}
209
+
}
208
210
209
211
\note{Rockbox Utility currently lacks some guiding messages. Please have a
210
212
look at the manual installation instructions if you are stuck
···
214
216
215
217
\subsubsection{Choosing a Rockbox version}\label{sec:choosing_version}
216
218
217
-
There are three different types of firmware binaries from the Rockbox website:
219
+
There are three different types of firmware binaries available from the
220
+
Rockbox website:
218
221
\label{Version}
219
222
Release version, current build and daily build. You need to decide which one
220
-
you want to install and get the version for your \dap{}.
223
+
you want to install and get the appropriate version for your \dap{}.
221
224
222
225
\begin{description}
223
226
···
228
231
}
229
232
\opt{swcodec}{
230
233
There has not yet been a stable release for the \playername{}. Until
231
-
there is a stable release for \playername{}, use a current build.
234
+
there is one, use a current build.
232
235
}
233
236
234
237
\item[Current Build.] The current build is built at each source code change to
235
-
the Rockbox SVN repository, and represent the current state of Rockbox
236
-
development. This means that the build could contain bugs, but is most of
237
-
the time safe to use. You can download the current build from
238
+
the Rockbox SVN repository and represents the current state of Rockbox
239
+
development. This means that the build could contain bugs but most of
240
+
the time is safe to use. You can download the current build from
238
241
\url{http://build.rockbox.org/}.
239
242
240
243
\item[Archived Build.] In addition to the release version and the current build,
···
244
247
245
248
\end{description}
246
249
247
-
248
-
Because current builds and daily builds are development versions which change
249
-
frequently, they may behave differently than described in this manual, or
250
-
they may introduce new (and maybe annoying) bugs. If you do not want to get
251
-
undefined behaviour from your \dap{} you should really stick to the current
252
-
stable release, if there is one for your \dap{}. If you want to help the
253
-
project development, you can try development builds and help by reporting
254
-
bugs. Just be aware that these are development builds that are highly
255
-
functional, but not perfect!
250
+
\warn{Because current builds and daily builds are development versions which
251
+
change frequently, they may behave differently than described in this manual,
252
+
or they may introduce new (and maybe annoying) bugs. If you do not want to
253
+
get undefined behaviour from your \dap{}, you should stick to the current
254
+
stable release if there is one for your \dap{}. If you want to help with
255
+
project development, you can try development builds and help by reporting bugs.
256
+
Just be aware that these are development builds that are highly functional
257
+
but not perfect!}
256
258
257
259
\subsubsection{Installing the firmware}\label{sec:installing_firmware}
258
260
···
265
267
\opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire} as described in
266
268
the manual that came with your \dap{}.
267
269
268
-
\item Take the file that you downloaded above, and use the ``Extract
269
-
all'' command of your unzip program to extract the files in the
270
-
\fname{.zip} file onto your \dap{}.
270
+
\item Take the \fname{.zip} file that you downloaded and use
271
+
the ``Extract all'' command of your unzip program to extract
272
+
the files onto your \dap{}.
271
273
272
-
Note that the entire contents of the \fname{.zip} file should be
273
-
extracted directly to the root of your \daps{} drive. Do not try to
274
+
\note{The entire contents of the \fname{.zip} file should be extracted
275
+
directly to the root of your \daps{} drive. Do not try to
274
276
create a separate directory on your \dap{} for the Rockbox
275
277
files! The \fname{.zip} file already contains the internal
276
-
structure that Rockbox needs.
278
+
structure that Rockbox needs.}
277
279
278
280
\end{enumerate}
279
281
···
281
283
\note{
282
284
If the contents of the \fname{.zip} file are extracted correctly, you will
283
285
have a file called \fname{\firmwarefilename} in the main directory of your
284
-
\daps{} drive, and also a directory called \fname{/.rockbox}, which contains a
286
+
\daps{} drive, and also a directory called \fname{.rockbox}, which contains a
285
287
number of other directories and system files needed by Rockbox. If you receive a
286
288
``-1'' error when you start Rockbox, you have not extracted the contents of
287
289
the \fname{.zip} file to the proper location.
···
293
295
\opt{swcodec}{
294
296
\note{
295
297
If the contents of the \fname{.zip} file are extracted correctly, you will
296
-
have a directory called \fname{/.rockbox}, which contains all the files needed
298
+
have a directory called \fname{.rockbox}, which contains all the files needed
297
299
by Rockbox, in the main directory of your \daps{} drive. If you receive a
298
300
``-1'' error when you start Rockbox, you have not extracted the contents of
299
301
the \fname{.zip} file to the proper location.
···
305
307
Rockbox has a fonts package that is available at
306
308
\url{http://www.rockbox.org/daily.shtml} or from the \emph{extras} link in
307
309
the menu on the Rockbox website. While the current builds and
308
-
daily builds change frequently, the fonts package rarely changes. Thus,
309
-
the fonts package is not included in these builds. (The release version, on
310
-
the other hand, does not change, so fonts are included when you download a
311
-
release). When installing Rockbox for the first time, you should install
312
-
the fonts package.
310
+
daily builds change frequently, the fonts package rarely changes and is
311
+
therefore not included in these builds. When installing Rockbox for the first
312
+
time, you should install the fonts package. The release version, on the other hand,
313
+
does not change, so fonts are included with it.
313
314
314
315
\begin{enumerate}
315
316
···
341
342
342
343
\subsection{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
343
344
\index{Speech}\index{Installation!Optional Steps}
344
-
If you wish to use speech support you will also need a voice file, english ones
345
+
If you wish to use speech support you will also need a voice file, English ones
345
346
are available from \url{http://www.rockbox.org/daily.shtml}. Download the
346
347
``voice'' package for your player and unzip it directly to the root of your \dap.
347
348
You should now find an \fname{english.voice} in the \fname{/.rockbox/langs}
···
364
365
365
366
\opt{ipod}{
366
367
\note{
367
-
Rockbox starts in the \setting{File Browser}. If you have loaded music onto
368
-
your player using Itunes, you will not be able to see your music because
369
-
Itunes changes your files' names and hides them in directories in the
370
-
\fname{Ipod\_Control} directory. You can view files placed on your \dap{} by
371
-
Itunes by initializing and using Rockbox's database. See
372
-
\reference{ref:database} for more information.
368
+
If you have loaded music onto your \dap{} using Itunes,
369
+
you will not be able to see your music properly in the \setting{File Browser}.
370
+
This is because Itunes changes your files' names and hides them in
371
+
directories in the \fname{Ipod\_Control} directory. Files placed on your
372
+
\dap{} using Itunes can be viewed by initializing and using Rockbox's database.
373
+
See \reference{ref:database} for more information.
373
374
}
374
375
}
375
376
···
378
379
Download a Rockbox build.
379
380
(The latest release of the Rockbox software will always be available from
380
381
\url{http://www.rockbox.org/download/}). Unzip the build to the root directory
381
-
of your \dap{} like you did in the installation step before. If your unzip
382
+
of your \dap{} like you did in the installation stage. If your unzip
382
383
program asks you whether to overwrite files, choose the ``Yes to all'' option.
383
384
The new build will be installed over your current build.
384
385
385
-
\note{If you use Rockbox Utility be aware that it can not detect manually
386
+
\note{If you use Rockbox Utility be aware that it cannot detect manually
386
387
installed components.}
387
388
388
389
\section{Uninstalling Rockbox}\index{Installation!uninstall}
390
+
391
+
\nopt{gigabeatf,m5,x5,archos,mrobe100}{
392
+
\note{The Rockbox bootloader allows you to choose between Rockbox and
393
+
the original firmware. (See \reference{ref:Dualboot} for more information.)}
394
+
}
395
+
389
396
\subsection{Automatic Uninstallation}
390
397
You can uninstall Rockbox automatically by using Rockbox Utility. If you
391
398
installed Rockbox manually you can still use Rockbox Utility for uninstallation
···
396
403
completely follow the manual uninstallation instructions below.}}
397
404
398
405
\subsection{Manual Uninstallation}
406
+
399
407
\opt{archos}{
400
408
If you would like to go back to using the original \playerman{} software,
401
409
connect the \dap{} to your computer, and delete the
402
410
\fname{\firmwarefilename} file.
403
411
}
404
-
\nopt{gigabeatf,m5,x5,archos,mrobe100}
405
-
{
406
-
\note{The Rockbox bootloader can start the original firmware on your \dap.
407
-
(See \reference{ref:Dualboot} for more information.)}}
408
412
409
413
\opt{h10,h10_5gb}{
410
414
If you would like to go back to using the original \playerman{} software,
···
426
430
\opt{e200}{
427
431
If you would like to go back to using the original \playerman{} software,
428
432
connect the \dap{} to your computer, and follow the instructions to install
429
-
the bootloader, but when prompted by sansapatcher, enter 'u' for uninstall,
430
-
instead of 'i' for install. As in the installation, it may be necessary to
433
+
the bootloader, but when prompted by sansapatcher, enter \texttt{u} for uninstall,
434
+
instead of \texttt{i} for install. As in the installation, it may be necessary to
431
435
first put your device into UMS mode.
432
436
}
433
437
434
438
\optv{ipod}{
435
-
If you would like to go back to using the original \playerman{} software,
436
-
connect the \dap{} to your computer, and follow the instructions to install
437
-
the bootloader, but when prompted by ipodpatcher, enter 'u' for uninstall,
438
-
instead of 'i' for install.
439
+
To uninstall Rockbox and go back to using just the original Ipod software, connect
440
+
the \dap{} to your computer and follow the instructions to install
441
+
the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall
442
+
instead of \texttt{i} for install.
439
443
}
440
444
441
445
\opt{m5,x5}{