summaryrefslogtreecommitdiffstats
path: root/manual/getting_started
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-03-31 12:49:45 +0000
committerMartin Arver <martin.arver@gmail.com>2006-03-31 12:49:45 +0000
commitd4a7bb67baa25c98c6bfec04aba8c76f5917dbf6 (patch)
tree04c30f6ed2805d4fcf799fce532db76f9ef03b28 /manual/getting_started
parent7e5c803d6c99507caa1c8f76700f95b38ac8f42d (diff)
downloadrockbox-d4a7bb67baa25c98c6bfec04aba8c76f5917dbf6.tar.gz
rockbox-d4a7bb67baa25c98c6bfec04aba8c76f5917dbf6.zip
code police
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9387 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/getting_started')
-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 @@
\section{Before installation}
-Before you install Rockbox, you will need to know what model of Archos
-Jukebox you own. Rockbox comes in different versions depending on the
-model of your Jukebox. There are six different versions of the
-software. The table below will help you to identify which version of
-the software you need.
+Before you install Rockbox, you will need to know what model of Archos Jukebox
+you own. Rockbox comes in different versions depending on the model of your
+Jukebox. There are six different versions of the software. The table below
+will help you to identify which version of the software you need.
-The model name is printed on the case. The hard drive size is listed on
-the serial number sticker on the back of the unit.
+The model name is printed on the case. The hard drive size is listed on the
+serial number sticker on the back of the unit.
\begin{center}
\begin{tabular}{@{}cccc@{}}\toprule
\label{ref:Jukeboxtypetable}
\textbf{Picture} & \textbf{Disk size} & \textbf{Model Name} & \textbf{Version Name} \\\midrule
- \includegraphics[width=2cm]{getting_started/images/archos-studio-small.png} & 5GB, 6GB, 10GB, 20GB & Jukebox 5000, & player\\
- & & Jukebox 6000, & \\
- & & Jukebox Studio 10, & \\
- & & Jukebox Studio 20 & \\\midrule
- \includegraphics[width=2cm]{getting_started/images/archos-recorder-small.png} & 6GB, 10GB, 15GB, 20GB & Jukebox Recorder 6, & recorder\\
- & & Jukebox Recorder 10, & \\
- & & Jukebox Recorder 15, & \\
- & & Jukebox Recorder 20 & \\\midrule
+ \includegraphics[width=2cm]{getting_started/images/archos-studio-small.png}
+ & 5GB, 6GB, 10GB, 20GB & Jukebox 5000, & player\\
+ & & Jukebox 6000, & \\
+ & & Jukebox Studio 10, & \\
+ & & Jukebox Studio 20 & \\\midrule
+ \includegraphics[width=2cm]{getting_started/images/archos-recorder-small.png}
+ & 6GB, 10GB, 15GB, 20GB & Jukebox Recorder 6, & recorder\\
+ & & Jukebox Recorder 10, & \\
+ & & Jukebox Recorder 15, & \\
+ & & Jukebox Recorder 20 & \\\midrule
\includegraphics[width=2cm]{getting_started/images/archos-recorderv2-small.png}
- & 20GB & Jukebox Recorder v2 & recorderv2\\\midrule
+ & 20GB & Jukebox Recorder v2 & recorderv2\\\midrule
\includegraphics[width=2cm]{getting_started/images/archos-recorderfm-small.png}
- & 20GB & Jukebox Recorder FM & fmrecorder \\\midrule
+ & 20GB & Jukebox Recorder FM & fmrecorder \\\midrule
\includegraphics[width=2cm]{getting_started/images/archos-ondiosp-small.png}
- & 128MB (flash) & Ondio 128 SP & ondiosp \\\midrule
+ & 128MB (flash) & Ondio 128 SP & ondiosp \\\midrule
\includegraphics[width=2cm]{getting_started/images/archos-ondiofm-small.png}
- &128MB (flash) & Ondio 128 FM & ondiofm \\\bottomrule
+ & 128MB (flash) & Ondio 128 FM & ondiofm \\\bottomrule
\end{tabular}
\end{center}
-Please note that Rockbox does not run on the Archos
-Jukebox Multimedia or any Archos MP3 player products other than those
-mentioned here.
+Please note that Rockbox does not run on the Archos Jukebox Multimedia or any
+Archos MP3 player products other than those mentioned 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 @@
\section{Preparing for Rockbox}
-There are two separate components of Rockbox that need to be installed in order to run Rockbox.
+There are two separate components of Rockbox that need to be installed in order
+to run Rockbox.
\begin{enumerate}
-\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.
-\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.
+\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.
+\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.
\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 @@
\chapter{Getting started}
\section{Welcome}
-This 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.
+This 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.
-Rockbox 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.
+Rockbox 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.
\section{Getting more help}
-This 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.
+This 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.
\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}}
\opt{h1xx,h300}{\input{getting_started/iriver_install}}
\section{Downloading Rockbox}
-The latest release of the Rockbox software will always be available from \url{http://www.rockbox.org/download/}.
+The latest release of the Rockbox software will always be available from
+\url{http://www.rockbox.org/download/}.
\opt{MASCODEC}{
-Windows 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.
+ Windows 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.
}
-\section{Installing Rockbox}
+\section{Installing Rockbox}\label{sec:installing_rockbox}
\opt{MASCODEC}{
-Using the Windows self installing executable to install Rockbox is the easiest
-method of installing the software on your Jukebox. Simply follow the
-on{}-screen instructions and select the appropriate drive letter and Jukebox
-model when prompted. You can use ``Add / Remove Programs'' to uninstall the
-software at a later date.
+ Using the Windows self installing executable to install Rockbox is the easiest
+ method of installing the software on your Jukebox. Simply follow the
+ on{}-screen instructions and select the appropriate drive letter and Jukebox
+ model when prompted. You can use ``Add / Remove Programs'' to uninstall the
+ software at a later date.
+}
+\opt{SWCODEC}{
+ \fixme{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
}
-\textbf{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
For non{}-Windows users and those wishing to install manually from the archive
the procedure is still fairly simple. Connect your \playername\ to the
computer 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
its contents to your \playername\ drive. You can do this using a program such
as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
-You 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.
+You 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.
-\section{Enabling Speech Support (optional)}
-If 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.
+\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
+If 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.
\section{Running Rockbox}
-Remove 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.
+Remove 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.
\section{Uninstalling Rockbox}
If you would like to go back to using the original \playername\ software, then
-connect 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.
+connect 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.