summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/getting_started/archos_choice.tex44
-rw-r--r--manual/getting_started/iriver_install.tex13
-rw-r--r--manual/getting_started/main.tex81
3 files changed, 96 insertions, 42 deletions
diff --git a/manual/getting_started/archos_choice.tex b/manual/getting_started/archos_choice.tex
index 4ff2bac3bd..cbb1c4218b 100644
--- a/manual/getting_started/archos_choice.tex
+++ b/manual/getting_started/archos_choice.tex
@@ -1,36 +1,36 @@
1\section{Before installation} 1\section{Before installation}
2 2
3Before you install Rockbox, you will need to know what model of Archos 3Before you install Rockbox, you will need to know what model of Archos Jukebox
4Jukebox you own. Rockbox comes in different versions depending on the 4you own. Rockbox comes in different versions depending on the model of your
5model of your Jukebox. There are six different versions of the 5Jukebox. There are six different versions of the software. The table below
6software. The table below will help you to identify which version of 6will help you to identify which version of the software you need.
7the software you need.
8 7
9The model name is printed on the case. The hard drive size is listed on 8The model name is printed on the case. The hard drive size is listed on the
10the serial number sticker on the back of the unit. 9serial number sticker on the back of the unit.
11 10
12\begin{center} 11\begin{center}
13 \begin{tabular}{@{}cccc@{}}\toprule 12 \begin{tabular}{@{}cccc@{}}\toprule
14 \label{ref:Jukeboxtypetable} 13 \label{ref:Jukeboxtypetable}
15 \textbf{Picture} & \textbf{Disk size} & \textbf{Model Name} & \textbf{Version Name} \\\midrule 14 \textbf{Picture} & \textbf{Disk size} & \textbf{Model Name} & \textbf{Version Name} \\\midrule
16 \includegraphics[width=2cm]{getting_started/images/archos-studio-small.png} & 5GB, 6GB, 10GB, 20GB & Jukebox 5000, & player\\ 15 \includegraphics[width=2cm]{getting_started/images/archos-studio-small.png}
17 & & Jukebox 6000, & \\ 16 & 5GB, 6GB, 10GB, 20GB & Jukebox 5000, & player\\
18 & & Jukebox Studio 10, & \\ 17 & & Jukebox 6000, & \\
19 & & Jukebox Studio 20 & \\\midrule 18 & & Jukebox Studio 10, & \\
20 \includegraphics[width=2cm]{getting_started/images/archos-recorder-small.png} & 6GB, 10GB, 15GB, 20GB & Jukebox Recorder 6, & recorder\\ 19 & & Jukebox Studio 20 & \\\midrule
21 & & Jukebox Recorder 10, & \\ 20 \includegraphics[width=2cm]{getting_started/images/archos-recorder-small.png}
22 & & Jukebox Recorder 15, & \\ 21 & 6GB, 10GB, 15GB, 20GB & Jukebox Recorder 6, & recorder\\
23 & & Jukebox Recorder 20 & \\\midrule 22 & & Jukebox Recorder 10, & \\
23 & & Jukebox Recorder 15, & \\
24 & & Jukebox Recorder 20 & \\\midrule
24 \includegraphics[width=2cm]{getting_started/images/archos-recorderv2-small.png} 25 \includegraphics[width=2cm]{getting_started/images/archos-recorderv2-small.png}
25 & 20GB & Jukebox Recorder v2 & recorderv2\\\midrule 26 & 20GB & Jukebox Recorder v2 & recorderv2\\\midrule
26 \includegraphics[width=2cm]{getting_started/images/archos-recorderfm-small.png} 27 \includegraphics[width=2cm]{getting_started/images/archos-recorderfm-small.png}
27 & 20GB & Jukebox Recorder FM & fmrecorder \\\midrule 28 & 20GB & Jukebox Recorder FM & fmrecorder \\\midrule
28 \includegraphics[width=2cm]{getting_started/images/archos-ondiosp-small.png} 29 \includegraphics[width=2cm]{getting_started/images/archos-ondiosp-small.png}
29 & 128MB (flash) & Ondio 128 SP & ondiosp \\\midrule 30 & 128MB (flash) & Ondio 128 SP & ondiosp \\\midrule
30 \includegraphics[width=2cm]{getting_started/images/archos-ondiofm-small.png} 31 \includegraphics[width=2cm]{getting_started/images/archos-ondiofm-small.png}
31 &128MB (flash) & Ondio 128 FM & ondiofm \\\bottomrule 32 & 128MB (flash) & Ondio 128 FM & ondiofm \\\bottomrule
32 \end{tabular} 33 \end{tabular}
33\end{center} 34\end{center}
34Please note that Rockbox does not run on the Archos 35Please note that Rockbox does not run on the Archos Jukebox Multimedia or any
35Jukebox Multimedia or any Archos MP3 player products other than those 36Archos MP3 player products other than those mentioned here.
36mentioned here.
diff --git a/manual/getting_started/iriver_install.tex b/manual/getting_started/iriver_install.tex
index e9a74e8e3a..6b5c12c4f7 100644
--- a/manual/getting_started/iriver_install.tex
+++ b/manual/getting_started/iriver_install.tex
@@ -1,6 +1,13 @@
1\section{Preparing for Rockbox} 1\section{Preparing for Rockbox}
2There are two separate components of Rockbox that need to be installed in order to run Rockbox. 2There are two separate components of Rockbox that need to be installed in order
3to run Rockbox.
3\begin{enumerate} 4\begin{enumerate}
4\item The Rockbox bootloader. This is the component of Rockbox that is installed to the flash memory of your \playerman. The bootloader is the program that tells your \dap\ how to boot and load other components of Rockbox. 5\item The Rockbox bootloader. This is the component of Rockbox that is installed
5\item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely from flash memory, most of the Rockbox code is contained in the build that resides on your jukebox's hard drive. This makes it easy to update Rockbox. The build contain a file named \firmwarefilename\ and a directory called \fname{.rockbox} which are located in the root directory of your hard drive. 6 to the flash memory of your \playerman. The bootloader is the program that tells
7 your \dap\ how to boot and load other components of Rockbox.
8\item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely
9 from flash memory, most of the Rockbox code is contained in the build that
10 resides on your jukebox's hard drive. This makes it easy to update Rockbox. The
11 build contain a file named \firmwarefilename\ and a directory called
12 \fname{.rockbox} which are located in the root directory of your hard drive.
6\end{enumerate} 13\end{enumerate}
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 87a0ec07de..1c1a1f14d1 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -1,30 +1,61 @@
1\chapter{Getting started} 1\chapter{Getting started}
2\section{Welcome} 2\section{Welcome}
3This is the manual for Rockbox. Rockbox is an open source firmware replacement for a growing number of MP3 players. Rockbox aims to be considerably more functional and efficient than your device's stock firmware while remaining easy to use and customizable. Rockbox is written by users, for users. Not only is it free to use, it's also released under the GNU public license, which means that it will always remain free to both use and to change. 3This is the manual for Rockbox. Rockbox is an open source firmware replacement
4for a growing number of MP3 players. Rockbox aims to be considerably more
5functional and efficient than your device's stock firmware while remaining easy
6to use and customizable. Rockbox is written by users, for users. Not only is it
7free to use, it's also released under the GNU public license, which means that
8it will always remain free to both use and to change.
4 9
5Rockbox has been in development since 2001, and recieves new features, tweaks and fixes each day to provide you with the best possible experience on your MP3 player. A major goal of Rockbox is to be simple and easy to use, yet remain very customizable and configurable. We believe that you should never need to go through a series of menus for an action you perform frequently. We also believe that you should be able to configure almost anything about Rockbox you could want, pertaining to functionality. Another top priority of Rockbox is audio playback quality - Rockbox, for most models, includes a wider range of sound settings than that device's original firmware. A lot of work has been put into making Rockbox sound the best it can, and improvements are constantly being made. All models have access to a large number of plugins, including many games, applications, and graphical "demos". You can load different configurations quickly for different purposes (e.g. a large font for in your car, different sound settings for at home).Rockbox features a very wide range of languages, and all supported models also have the ability to talk to you - menus can be voiced and filenames spelled out or spoken. 10Rockbox has been in development since 2001, and recieves new features, tweaks
11and fixes each day to provide you with the best possible experience on your MP3
12player. A major goal of Rockbox is to be simple and easy to use, yet remain very
13customizable and configurable. We believe that you should never need to go
14through a series of menus for an action you perform frequently. We also believe
15that you should be able to configure almost anything about Rockbox you could
16want, pertaining to functionality. Another top priority of Rockbox is audio
17playback quality - Rockbox, for most models, includes a wider range of sound
18settings than that device's original firmware. A lot of work has been put into
19making Rockbox sound the best it can, and improvements are constantly being made.
20All models have access to a large number of plugins, including many games,
21applications, and graphical "demos". You can load different configurations
22quickly for different purposes (e.g. a large font for in your car, different
23sound settings for at home).Rockbox features a very wide range of languages, and
24all supported models also have the ability to talk to you - menus can be voiced
25and filenames spelled out or spoken.
6 26
7\section{Getting more help} 27\section{Getting more help}
8This manual is intended to be a comprehensive introduction to the Rockbox software. There is, however, more help available. The Rockbox website at \url{http://www.rockbox.org/}contains very extensive documentation and guides written by members of the Rockbox community and this should be your first port of call when looking for further help. 28This manual is intended to be a comprehensive introduction to the Rockbox
29software.
30 There is, however, more help available. The Rockbox website at
31\url{http://www.rockbox.org/} contains very extensive documentation and guides
32written by members of the Rockbox community and this should be your first port
33of call when looking for further help.
9 34
10\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}} 35\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}}
11\opt{h1xx,h300}{\input{getting_started/iriver_install}} 36\opt{h1xx,h300}{\input{getting_started/iriver_install}}
12 37
13\section{Downloading Rockbox} 38\section{Downloading Rockbox}
14The latest release of the Rockbox software will always be available from \url{http://www.rockbox.org/download/}. 39The latest release of the Rockbox software will always be available from
40\url{http://www.rockbox.org/download/}.
15\opt{MASCODEC}{ 41\opt{MASCODEC}{
16Windows users may wish to download the self{}-extracting Windows installer, which works for all Jukebox models, but those wishing to install manually or using a different operating system should choose the .zip archive containing the firmware for their model of the Jukebox. 42 Windows users may wish to download the self{}-extracting Windows installer,
43 which works for all Jukebox models, but those wishing to install manually or
44 using a different operating system should choose the .zip archive containing
45 the firmware for their model of the Jukebox.
17} 46}
18 47
19\section{Installing Rockbox} 48\section{Installing Rockbox}\label{sec:installing_rockbox}
20\opt{MASCODEC}{ 49\opt{MASCODEC}{
21Using the Windows self installing executable to install Rockbox is the easiest 50 Using the Windows self installing executable to install Rockbox is the easiest
22method of installing the software on your Jukebox. Simply follow the 51 method of installing the software on your Jukebox. Simply follow the
23on{}-screen instructions and select the appropriate drive letter and Jukebox 52 on{}-screen instructions and select the appropriate drive letter and Jukebox
24model when prompted. You can use ``Add / Remove Programs'' to uninstall the 53 model when prompted. You can use ``Add / Remove Programs'' to uninstall the
25software at a later date. 54 software at a later date.
55}
56\opt{SWCODEC}{
57 \fixme{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
26} 58}
27\textbf{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
28For non{}-Windows users and those wishing to install manually from the archive 59For non{}-Windows users and those wishing to install manually from the archive
29the procedure is still fairly simple. Connect your \playername\ to the 60the procedure is still fairly simple. Connect your \playername\ to the
30computer via USB as described in the manual that came with your \playername. On 61computer via USB as described in the manual that came with your \playername. On
@@ -33,15 +64,31 @@ Windows, the \playername\ drive will appear as a drive letter in your
33its contents to your \playername\ drive. You can do this using a program such 64its contents to your \playername\ drive. You can do this using a program such
34as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}. 65as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
35 66
36You will need to unpack all of the files in the archive onto your hard disk. If this has been done correctly, you will have a file called \fname{\firmwarefilename} in the main folder of your \playername\ drive, and also a folder called /\fname{.rockbox}, which contains a number of system files used by the software. 67You will need to unpack all of the files in the archive onto your hard disk. If
68 this has been done correctly, you will have a file called
69\fname{\firmwarefilename} in the main folder of your \playername\ drive, and
70also a folder called /\fname{.rockbox}, which contains a number of system files
71used by the software.
37 72
38\section{Enabling Speech Support (optional)} 73\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
39If you wish to use speech support you will also need a language file, available from \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. For the English language, the file is called \fname{english.voice}. When it has been downloaded, unpack this file and copy it into the \fname{lang} folder which is inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on by default. See page \pageref{ref:Voiceconfiguration} for details on voice settings. 74If you wish to use speech support you will also need a language file, available
75from \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. For the
76English language, the file is called \fname{english.voice}. When it has been
77downloaded, unpack this file and copy it into the \fname{lang} folder which is
78inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on
79by default. See page \pageref{ref:Voiceconfiguration} for details on voice
80settings.
40 81
41 82
42\section{Running Rockbox} 83\section{Running Rockbox}
43Remove your Jukebox from the computer's USB port. Unplug any connected power supply and turn the unit off. When you next turn the unit on, the Jukebox firmware will start to load, and then it will load Rockbox for you. When you see the Rockbox splash screen, Rockbox is loaded and ready for use. 84Remove your Jukebox from the computer's USB port. Unplug any connected power
85supply and turn the unit off. When you next turn the unit on, the Jukebox
86firmware will start to load, and then it will load Rockbox for you. When you see
87the Rockbox splash screen, Rockbox is loaded and ready for use.
44 88
45\section{Uninstalling Rockbox} 89\section{Uninstalling Rockbox}
46If you would like to go back to using the original \playername\ software, then 90If you would like to go back to using the original \playername\ software, then
47connect the \playername\ to your computer, and delete the \fname{\firmwarefilename} file. If you wish to clean up your disk, you may also wish to delete the \fname{.rockbox} folder and its contents. Turn the \playername\ off and on and the normal \playername\ software will load. 91connect the \playername\ to your computer, and delete the
92\fname{\firmwarefilename} file. If you wish to clean up your disk, you may also
93wish to delete the \fname{.rockbox} folder and its contents. Turn the
94\playername\ off and on and the normal \playername\ software will load.