summaryrefslogtreecommitdiff
path: root/manual/getting_started/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/getting_started/main.tex')
-rw-r--r--manual/getting_started/main.tex112
1 files changed, 112 insertions, 0 deletions
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
new file mode 100644
index 0000000000..276f2a87a1
--- /dev/null
+++ b/manual/getting_started/main.tex
@@ -0,0 +1,112 @@
1\chapter{Getting started}
2\newpage
3\section{Welcome}
4This is the manual for Rockbox. Rockbox is a replacement firmware for the
5Jukebox Studio, Recorder and Ondio players made by Archos, the H120/140
6players from iRiver and the Apple iPod Nano etc. It is a complete rewrite of
7the software used to make the PDA play and record music, and contains many
8features and enhancements not available in the original firmware supplied by
9the manufacturer. Among the things that Rockbox has to offer are the
10following:
11
12\begin{itemize}
13\item Faster loading than the \playername firmware
14\item Uninterrupted playing of MP3 files {--} skipping is very rare
15\item More control over how your music is played
16\item Built in viewers for several common file types
17\item Sophisticated plugin system that allows the Jukebox to run games,
18a calendar, a clock, and many other applications.
19\item Totally removable. (Removal of Rockbox before returning the
20Jukebox for repair under warranty is advised.)
21\item Optional voice user interface for complete control without looking
22at the screen
23\end{itemize}
24Rockbox is a complete from scratch rewrite of the \playername software and
25uses no fragments of the original firmware. Not only is it free to
26use, it's also released under the GNU public license,
27which means that it will always remain free to both use and to change.
28
29\opt{OndioSP,OndioFM}{Although Rockbox also runs on the Archos Ondio series of
30flash based MP3 players, this is a recent development, which is not covered
31fully in this manual. Most of this manual will, however, apply equally to
32Rockbox on the Ondio Jukeboxes. For more details on the Ondio port, please
33see the web page:
34\url{http://www.rockbox.org/twiki/bin/view/Main/ArchosOndio}.}
35
36\section{Getting more help}
37
38This manual is intended to be a comprehensive introduction to the Rockbox
39software. There is, however, more help available. The Rockbox website at
40\url{http://www.rockbox.org/}contains very extensive documentation and guides
41written by members of the Rockbox community and this should be your first port
42of call when looking for further help.
43
44\opt{Archos}{\input{chapter1/archos_choice}}
45
46
47\section{Downloading Rockbox}
48
49The latest release of the Rockbox software will always be available from
50\url{http://www.rockbox.org/download/}.
51 Windows users may wish to download the self{}-extracting Windows
52installer, which works for all Jukebox models, but those wishing to
53install manually or using a different operating system should choose
54the .zip archive containing the firmware for their model of the
55Jukebox.
56
57\section{Installing Rockbox}
58
59Using the Windows self installing executable to install Rockbox is the easiest
60method of installing the software on your Jukebox. Simply follow the
61on{}-screen instructions and select the appropriate drive letter and Jukebox
62model when prompted. You can use ``Add / Remove Programs'' to uninstall the
63software at a later date.
64
65For non{}-Windows users and those wishing to install manually from the archive
66the procedure is still fairly simple. Connect your \playername to the computer
67via USB as described in the manual that came with your \playername. On Windows,
68the \playername drive will appear as a drive letter in your ``My Computer''
69folder. Take the file that you downloaded above, and unpack its contents to
70your \playername drive. You can do this using a program such as
71\url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
72
73You will need to unpack all of the files in the archive onto your hard
74disk. If this has been done correctly, you will have a file called
75\opt{PS}{\fname{archos.mod}}
76\opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}}
77\opt{H120,H340}{\fname{rockbox.iriver}}
78in the main folder of your \playername drive, and also a folder called
79/\fname{.rockbox}, which contains a number of system files used by the
80software.
81
82\section{Enabling Speech Support (optional)}
83
84If you wish to use speech support you will also need a language file,
85available from
86\url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}.
87 For the English language, the file is called \fname{english.voice}.
88When it has been downloaded, unpack this file and copy it into the
89\fname{lang} folder which is inside the /\fname{.rockbox} folder on
90your Jukebox. Voice menus are turned on by default. See page
91\pageref{ref:Voiceconfiguration} for details on voice settings.
92
93
94\section{Running Rockbox}
95
96Remove your Jukebox from the computer's USB port.
97Unplug any connected power supply and turn the unit off. When you next
98turn the unit on, the Jukebox firmware will start to load, and then it
99will load Rockbox for you. When you see the Rockbox splash screen,
100Rockbox is loaded and ready for use.
101
102\section{Uninstalling Rockbox}
103
104If you would like to go back to using the
105original \playername software, then connect the \playername up to your computer,
106and delete the
107\opt{PS}{\fname{archos.mod}}
108\opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}}
109\opt{H120,H340}{\fname{rockbox.iriver}}
110If you wish to clean up your disk, you may also wish to delete the
111\fname{.rockbox} folder and its contents. Turn the \playername off and on and
112the normal \playername software will load.