summaryrefslogtreecommitdiff
path: root/manual/getting_started
diff options
context:
space:
mode:
Diffstat (limited to 'manual/getting_started')
-rw-r--r--manual/getting_started/main.tex67
1 files changed, 13 insertions, 54 deletions
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 2f3476f74c..ffe42eefcf 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -1,66 +1,29 @@
1\chapter{Getting started} 1\chapter{Getting started}
2\section{Welcome} 2\section{Welcome}
3This is the manual for Rockbox. Rockbox is a replacement firmware for the 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.
4Jukebox Studio, Recorder and Ondio players made by Archos, the H120/140
5players from iRiver and the Apple iPod Nano etc. It is a complete rewrite of
6the software used to make the DAP play and record music, and contains many
7features and enhancements not available in the original firmware supplied by
8the manufacturer. Among the things that Rockbox has to offer are the
9following:
10 4
11\begin{itemize} 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.
12\item Faster loading than the \playername\ firmware
13\item Uninterrupted playing of MP3 files {--} skipping is very rare
14\item More control over how your music is played
15\item Built in viewers for several common file types
16\item Sophisticated plugin system that allows the Jukebox to run games,
17a calendar, a clock, and many other applications.
18\item Totally removable. (Removal of Rockbox before returning the
19Jukebox for repair under warranty is advised.)
20\item Optional voice user interface for complete control without looking
21at the screen
22\end{itemize}
23Rockbox is a complete from scratch rewrite of the \playername\ software and
24uses no fragments of the original firmware. Not only is it free to
25use, it's also released under the GNU public license,
26which means that it will always remain free to both use and to change.
27
28\opt{Ondio}{Although Rockbox also runs on the Archos Ondio series of
29flash based MP3 players, this is a recent development, which is not covered
30fully in this manual. Most of this manual will, however, apply equally to
31Rockbox on the Ondio Jukeboxes. For more details on the Ondio port, please
32see the web page:
33\url{http://www.rockbox.org/twiki/bin/view/Main/ArchosOndio}.}
34 6
35\section{Getting more help} 7\section{Getting more help}
36 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.
37This manual is intended to be a comprehensive introduction to the Rockbox
38software. There is, however, more help available. The Rockbox website at
39\url{http://www.rockbox.org/}contains very extensive documentation and guides
40written by members of the Rockbox community and this should be your first port
41of call when looking for further help.
42 9
43\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}} 10\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}}
44 11
45
46\section{Downloading Rockbox} 12\section{Downloading Rockbox}
47 13The latest release of the Rockbox software will always be available from \url{http://www.rockbox.org/download/}.
48The latest release of the Rockbox software will always be available from 14\opt{MASCODEC}{
49\url{http://www.rockbox.org/download/}. 15Windows 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.
50 Windows users may wish to download the self{}-extracting Windows 16}
51installer, which works for all Jukebox models, but those wishing to
52install manually or using a different operating system should choose
53the .zip archive containing the firmware for their model of the
54Jukebox.
55 17
56\section{Installing Rockbox} 18\section{Installing Rockbox}
57 19\opt{MASCODEC}{
58Using the Windows self installing executable to install Rockbox is the easiest 20Using the Windows self installing executable to install Rockbox is the easiest
59method of installing the software on your Jukebox. Simply follow the 21method of installing the software on your Jukebox. Simply follow the
60on{}-screen instructions and select the appropriate drive letter and Jukebox 22on{}-screen instructions and select the appropriate drive letter and Jukebox
61model when prompted. You can use ``Add / Remove Programs'' to uninstall the 23model when prompted. You can use ``Add / Remove Programs'' to uninstall the
62software at a later date. 24software at a later date.
63 25}
26\textbf{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
64For non{}-Windows users and those wishing to install manually from the archive 27For non{}-Windows users and those wishing to install manually from the archive
65the procedure is still fairly simple. Connect your \playername\ to the 28the procedure is still fairly simple. Connect your \playername\ to the
66computer via USB as described in the manual that came with your \playername. On 29computer via USB as described in the manual that came with your \playername. On
@@ -69,19 +32,15 @@ Windows, the \playername\ drive will appear as a drive letter in your
69its contents to your \playername\ drive. You can do this using a program such 32its contents to your \playername\ drive. You can do this using a program such
70as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}. 33as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
71 34
72You 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 \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} 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. 35You 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.
73 36
74\section{Enabling Speech Support (optional)} 37\section{Enabling Speech Support (optional)}
75 38If 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.
76If 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.
77 39
78 40
79\section{Running Rockbox} 41\section{Running Rockbox}
80
81Remove 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. 42Remove 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.
82 43
83\section{Uninstalling Rockbox} 44\section{Uninstalling Rockbox}
84
85If you would like to go back to using the original \playername\ software, then 45If you would like to go back to using the original \playername\ software, then
86connect the \playername\ to your computer, and delete the \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} file. 46connect 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.
87If 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.