summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorMichael DiFebbo <medifebbo@rockbox.org>2006-07-31 16:39:35 +0000
committerMichael DiFebbo <medifebbo@rockbox.org>2006-07-31 16:39:35 +0000
commit2bf4f520fb258ec101da1f466adcb5571730c01c (patch)
tree5f1813af568ecf273ed5c5d07839f883bedbd8da /manual
parent8a7b9161ab0c11f9415f8c7b743b9c4de95ada4c (diff)
downloadrockbox-2bf4f520fb258ec101da1f466adcb5571730c01c.tar.gz
rockbox-2bf4f520fb258ec101da1f466adcb5571730c01c.zip
Updates to installation section: added url for daily builds page, added note about downloading the fonts package. Expanded the 'update Rockbox' section to provide more detail and address the common misconception that updating a build is supposed to return settings to default. Rearranged order of sections (it makes more sense to have section on updating Rockbox *before* the section on uninstalling Rockbox). Added a note that ipod users who loaded tunes with itunes should use the Tag Cache.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10386 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/getting_started/main.tex138
1 files changed, 79 insertions, 59 deletions
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 87d508e554..a03c2d810a 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -6,7 +6,7 @@ for a growing number of MP3 players. Rockbox aims to be considerably more
6functional and efficient than your device's stock firmware while remaining easy 6functional and efficient than your device's stock firmware while remaining easy
7to use and customizable. Rockbox is written by users, for users. Not only is it 7to use and customizable. Rockbox is written by users, for users. Not only is it
8free to use, it's also released under the GNU public license, which means that 8free to use, it's also released under the GNU public license, which means that
9it will always remain free to both use and to change. 9it will always remain free both to use and to change.
10 10
11Rockbox has been in development since 2001, and recieves new features, tweaks 11Rockbox has been in development since 2001, and recieves new features, tweaks
12and fixes each day to provide you with the best possible experience on your MP3 12and fixes each day to provide you with the best possible experience on your MP3
@@ -81,58 +81,87 @@ are used:
81} 81}
82\opt{SWCODEC}{ 82\opt{SWCODEC}{
83\subsection{Introduction} 83\subsection{Introduction}
84There are two separate components of Rockbox that need to be installed in order 84 There are two separate components of Rockbox that need to be installed in order
85to run Rockbox. 85 to run Rockbox.
86\begin{enumerate} 86 \begin{enumerate}
87\item The Rockbox bootloader. This is the component of Rockbox that is installed 87 \item The Rockbox bootloader. This is the component of Rockbox that is installed
88 to the flash memory of your \playerman. The bootloader is the program that tells 88 to the flash memory of your \playerman. The bootloader is the program that tells
89 your \dap\ how to boot and load other components of Rockbox. 89 your \dap\ how to boot and load other components of Rockbox.
90\item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely 90 \item The Rockbox firmware. Unlike the \playerman\ firmware, which runs entirely
91 from flash memory, most of the Rockbox code is contained in the build that 91 from flash memory, most of the Rockbox code is contained in the build that
92 resides on your jukebox's hard drive. This makes it easy to update Rockbox. The 92 resides on your jukebox's hard drive. This makes it easy to update Rockbox. The
93 build contain a file named \firmwarefilename\ and a directory called 93 build contain a file named \firmwarefilename\ and a directory called
94 \fname{.rockbox} which are located in the root directory of your hard drive. 94 \fname{.rockbox} which are located in the root directory of your hard drive.
95\end{enumerate} 95 \end{enumerate}
96\opt{h1xx,h300}{\input{getting_started/iriver_install.tex}} 96 \opt{h1xx,h300}{\input{getting_started/iriver_install.tex}}
97\opt{ipod4g,ipodcolor,ipodnano,ipodmini,ipodvideo} 97 \opt{ipod4g,ipodcolor,ipodnano,ipodmini,ipodvideo}
98 {\input{getting_started/ipod_install.tex}} 98 {\input{getting_started/ipod_install.tex}}
99\opt{x5}{\input{getting_started/iaudio_install.tex}} 99 \opt{x5}{\input{getting_started/iaudio_install.tex}}
100 100
101 \subsection{Installing the firmware} 101 \subsection{Installing the firmware}
102 After installing the bootloader the installation becomes fairly easy. 102
103 After installing the bootloader, the installation becomes fairly easy.}
104
105 Go to \url{http://www.rockbox.org/daily.shtml} and download the latest
106 Rockbox daily build for the \playername{}. Connect your \playername\ to the
107 computer via USB as described in the manual that came with your \playername{}.
108 On Windows, the \playername\ drive will appear as a drive letter in your
109 ``My Computer'' folder. Take the file that you downloaded above, and unpack
110 its contents to your \playername\ drive. You can do this using a program
111 such as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
112
113 \note{If this is the first time you are installing Rockbox, you should also
114 download the ``Fonts'' package avaible on the Daily Builds page.}
115
116 You will need to unpack all of the files in the archive onto your hard disk.
117 If this has been done correctly, you will have a file called
118 \fname{\firmwarefilename} in the main folder of your \playername\ drive, and
119 also a folder called /\fname{.rockbox}, which contains a number of system
120 files used by the software.
121
122 \note{Please note that the firmware folder starts with a leading dot. You may
123 experience problems when trying to create such folders when using Windows.
124 Directly unzipping to your \daps drive works flawlessly; it is only Windows'
125 Explorer that is limited in handling such files.}
126
127\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
128If you wish to use speech support you will also need a language file, available
129from \wikilink{VoiceFiles}. For the English language, the file is called
130\fname{english.voice}. When it has been downloaded, unpack this file and copy it
131into the \fname{lang} folder which is inside the /\fname{.rockbox} folder on
132your Jukebox. Voice menus are turned on by default. See
133\rockref{ref:Voiceconfiguration} for details on voice settings.
134
135\section{Running Rockbox}
136Remove your \dap from the computer's USB port. Unplug any connected power supply
137and turn the unit off. When you next turn the unit on, Rockbox should load. When
138you see the Rockbox splash screen, Rockbox is loaded and ready for use.
139
140\opt{ipod}{
141\note{Rockbox starts in the \setting{File Browser}. If you have loaded music
142onto your player using Itunes, you will not be able to see your music because
143Itunes changes your files' names and hides them in directories in the
144\fname{Ipod\_Control} folder. You can view files placed on your \dap{} by Itunes
145by initializing and using Rockbox's Tag Cache. See \rockref{ref:tagcache} for
146more information.}
103} 147}
104 148
105Connect your \playername\ to the computer via USB as described in the 149\section{Updating Rockbox} Updating Rockbox is easy. Download a Rockbox build.
106manual that came with your \playername. On Windows, the \playername\ drive 150(The latest release of the Rockbox software will always be available from
107will appear as a drive letter in your ``My Computer'' folder. Take the file 151\url{http://www.rockbox.org/download/}.) Unzip the build to the root directory
108that you downloaded above, and unpack its contents to your \playername\ drive. 152of your \dap. If your unzip program asks you whether to overwrite files, choose
109You can do this using a program such as \url{http://www.info-zip.org/} or 153the ``Yes to all'' option. The new build will be installed over your current build.
110\url{http://www.winzip.org/}. 154
111 155\note{Settings are stored on an otherwise-unused sector of your hard disk, not
112You will need to unpack all of the files in the archive onto your hard disk. If 156in any of the files contained in the Rockbox build. Therefore, generally
113this has been done correctly, you will have a file called 157speaking, installing a new build does \emph{not} reset Rockbox to its default
114\fname{\firmwarefilename} in the main folder of your \playername\ drive, and 158settings. Be aware, however, that from time to time, a change is made to the
115also a folder called /\fname{.rockbox}, which contains a number of system files 159Rockbox source code that \emph{does} cause settings to be reset to their
116used by the software. 160defaults when a Rockbox build is updated. Thus, it is a good idea to save your
117\note{Please note that the firmware folder starts with a leading dot. You may 161settings using the \setting{Manage Settings} $\rightarrow$ \setting{Write .cfg
118experience problems when trying to create such folders when using Windows. 162file} function before updating your Rockbox build so that you can easily restore
119Directly unzipping to your \dap's drive works flawlessly; it is only Windows' 163the settings if necessary. For additional information on how to save, load, and
120Explorer that is limited in handling such files.} 164reset Rockbox's settings, see \rockref{ref:SystemOptions}.}
121
122\section{Enabling Speech Support (optional)}\label{sec:enabling_speech_support}
123If you wish to use speech support you will also need a language file, available
124from \wikilink{VoiceFiles}. For the
125English language, the file is called \fname{english.voice}. When it has been
126downloaded, unpack this file and copy it into the \fname{lang} folder which is
127inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on
128by default. See \rockref{ref:Voiceconfiguration} for details on voice
129settings.
130
131\section{Running Rockbox}
132Remove your Jukebox from the computer's USB port. Unplug any connected power
133supply and turn the unit off. When you next turn the unit on, the Jukebox
134firmware will start to load, and then it will load Rockbox for you. When you see
135the Rockbox splash screen, Rockbox is loaded and ready for use.
136 165
137\section{Uninstalling Rockbox} 166\section{Uninstalling Rockbox}
138If you would like to go back to using the original \playername\ software, then 167If you would like to go back to using the original \playername\ software, then
@@ -141,12 +170,3 @@ connect the \playername\ to your computer, and delete the
141wish to delete the \fname{.rockbox} folder and its contents. Turn the 170wish to delete the \fname{.rockbox} folder and its contents. Turn the
142\playername\ off and on and the normal \playername\ software will load. 171\playername\ off and on and the normal \playername\ software will load.
143 172
144\section{Updating Rockbox}
145The latest release of the Rockbox software will always be available from
146\url{http://www.rockbox.org/download/}.
147\opt{MASCODEC}{
148 Windows users may wish to download the self-extracting Windows installer,
149 which works for all Jukebox models, but those wishing to install manually or
150 using a different operating system should choose the .zip archive containing
151 the firmware for their model of the Jukebox.
152}