Index: manual/platform/recorder.tex =================================================================== --- manual/platform/recorder.tex (revision 20635) +++ manual/platform/recorder.tex (working copy) @@ -11,7 +11,6 @@ \newcommand{\playertype}{Recorder} \newcommand{\playerlongtype}{Recorder 6, 10, 15 and 20} \newcommand{\genericimg}{112x64x1} - \newcommand{\specimg}{recorder} %Used to name the player, e.g. ...to the \dap \newcommand{\dap}{player} Index: manual/getting_started/installation.tex =================================================================== --- manual/getting_started/installation.tex (revision 20635) +++ manual/getting_started/installation.tex (working copy) @@ -11,13 +11,12 @@ follow the instructions at \url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}} +\begin{description} \opt{ipodnano,ipodvideo,e200,c200}{ -\begin{description} -\item[Supported hardware versions.] - \opt{ipodnano}{ - The \playertype{} is available in multiple versions, not - all of which run Rockbox. Rockbox presently runs only on - the original Ipod Nano. Rockbox does +\item[Supported hardware versions.] + \opt{ipodnano}{ + The \playertype{} is available in multiple versions, not all of which run + Rockbox. Rockbox presently runs only on the original Ipod Nano. Rockbox does \emph{not} run on the second, third, or fourth generation Ipod Nano. For information on identifying which Ipod you own, see this page on Apple's website: \url{http://www.info.apple.com/kbnum/n61688}. @@ -29,25 +28,20 @@ website: \url{http://www.info.apple.com/kbnum/n61688}. } \opt{e200,c200}{ - The \playertype{} is available in multiple versions, not - all of which run Rockbox. Rockbox doesn't run on the - newer v2 models. They can be identified - by checking the Sandisk firmware version number under - Settings $\rightarrow$ Info. The v1 - firmware is named 01.xx.xx, while the v2 firmware begins with 03. + The \playertype{} is available in multiple versions, not all of which run + Rockbox. Rockbox doesn't run on the newer v2 models. They can be identified + by checking the Sandisk firmware version under + \setting{Settings $\rightarrow$ Info.} + The v1 firmware is named 01.xx.xx, while the v2 firmware begins with 03. } -\end{description} } \opt{h300}{ -\begin{description} - \item[DRM capability.] If your \dap{} has a US firmware, then by installing Rockbox you will - \emph{permanently} lose the ability to playback files with DRM. -\end{description} + \item[DRM capability.] If your \dap{} has a US firmware, then by installing + Rockbox you will \emph{permanently} lose the ability to play files with DRM. } \nopt{gigabeats}{ -\begin{description} \nopt{ipod1g2g}{ \item[USB connection.] @@ -55,23 +49,21 @@ \opt{ipod1g2g}{ \item[Firewire connection.] } - To transfer Rockbox to your \dap{} you need to - connect it to your computer. For manual installation/uninstallation, or - should autodetection fail during automatic installation, you need to know - where to access the \dap{}. On Windows this means you need to know - the drive letter associated with the \dap{}. On Linux you need to know - the mount point of your \dap{}. On Mac OS X you need to know the volume - name of your \dap{}. + To transfer Rockbox to your \dap{} you need to connect it to your computer. + For manual installation/uninstallation, or should autodetection fail during + automatic installation, you need to know where to access the \dap{}. On + Windows this means you need to know the drive letter associated with the + \dap{}. On Linux you need to know the mount point of your \dap{}. On + Mac OS X you need to know the volume name of your \dap{}. \opt{ipod}{ - If you have Itunes installed and it is configured to open automatically - when your \dap{} is attached (the default behaviour), - then wait for it to open and then quit it. You - also need to ensure the ``Enable use as disk'' option is enabled for - your \dap{} in Itunes. Your \dap{} should then enter disk mode - automatically when connected to a computer via \nopt{ipod1g2g}{USB.}\opt{ipod1g2g}{Firewire.} - If your computer does not recognise your \dap{}, you may - need to enter disk mode manually. Disconnect your \dap{} from the + If you have Itunes installed and it is configured to open automatically when + your \dap{} is attached (the default behaviour), then wait for it to open + and then quit it. You also need to ensure the ``Enable use as disk'' option + is enabled for your \dap{} in Itunes. Your \dap{} should then enter disk + mode automatically when connected to a computer via \nopt{ipod1g2g}{USB.} + \opt{ipod1g2g}{Firewire.} If your computer does not recognise your \dap{}, + you may need to enter disk mode manually. Disconnect your \dap{} from the computer. Hard reset the \dap{} by pressing and holding the \ButtonMenu{} and \ButtonSelect{} buttons simultaneously. As soon as the \dap{} resets, press and hold the \ButtonSelect{} and \ButtonPlay{} buttons simultaneously. Your @@ -82,10 +74,9 @@ the moment. Please use USB only. } \opt{x5}{ - When instructed to connect/disconnect the USB cable, always use - the USB port through the subpack, not the side 'USB Host' port. The side port - is intended to be used for USB OTG connections only (digital cameras, memory - sticks, etc.). + When instructed to connect/disconnect the USB cable, always use the USB port + through the subpack, not the side 'USB Host' port. The side port is intended + to be used for USB OTG connections only (digital cameras, memory sticks, etc.). } \opt{sansa}{The following steps require you to change the setting in \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the @@ -94,65 +85,59 @@ \warn{Never extract files to your \dap{} while it is in recovery mode.} } \opt{h10,h10_5gb}{ - The installation requires you to use UMS mode and so - may require use of the UMS trick, whereby it is possible to force a MTP - \playertype{} to start up in UMS mode as follows: - \begin{enumerate} - \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to - push the small reset button inside the hole between the Hold switch and - remote control connector.}\opt{h10_5gb}{removing the battery and putting it back in again.} - \item Connect your \playertype{} to the computer using the data cable. - \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on. - \item Continue holding \ButtonRight{} until the USB Connected screen appears. - \item The \dap{} will now appear as a regular disk on your computer. - \end{enumerate} - \note{Once Rockbox has been installed, when you shut down your \dap{} from Rockbox it will totally - power the player off so step 1 is no longer necessary.} + The installation requires you to use UMS mode and so may require use of the + UMS trick, whereby it is possible to force a MTP \playertype{} to start up + in UMS mode as follows: + \begin{enumerate} + \item Ensure the \dap{} is fully powered off by \opt{h10}{using a pin to + push the small reset button inside the hole between the Hold switch and + remote control connector.}\opt{h10_5gb}{removing the battery and putting + it back in again.} + \item Connect your \playertype{} to the computer using the data cable. + \item Hold \ButtonRight{} and push \ButtonPower{} to turn the \dap{} on. + \item Continue holding \ButtonRight{} until the USB Connected screen appears. + \item The \dap{} will now appear as a regular disk on your computer. + \end{enumerate} + \note{Once Rockbox has been installed, when you shut down your \dap{} from + Rockbox it will totally power the player off so step 1 is no longer necessary.} } \opt{gigabeatf}{During installation, do not connect your \dap{} - using the cradle but plug the USB cable directly to the \dap{}. + using the cradle but plug the USB cable directly to the \dap{}. } -\end{description} } -\opt{ipod,sansa}{ -\begin{description} - \item[Administrator/Root rights.] Installing the bootloader portion of Rockbox - requires you to have administrative (Windows) or root (Linux) rights. - Consequently when doing either the automatic or manual bootloader install, - please ensure that you are logged in with an administrator account or have root rights. -\end{description} +\opt{ipod,sansa}{ + \item[Administrator/Root rights.] Installing the Rockbox bootloader requires + you to have administrative (Windows) or root (Linux) rights. Consequently when + doing either the automatic or manual bootloader install, please ensure that + you are logged in with an administrator account or have root rights. } \opt{ipod}{ -\begin{description} - \item[File system format.] Rockbox only works on Ipods formatted with - the FAT32 filesystem (i.e. Ipods initialised by Itunes - for Windows). It does not work with the HFS+ filesystem (i.e. Ipods - initialised by Itunes for the Mac). More information and instructions for - converting an Ipod to FAT32 can be found on the - \wikilink{IpodConversionToFAT32} wiki - page on the Rockbox website. Note that after conversion, you can still use - a FAT32 Ipod with a Mac. -\end{description} + \item[File system format.] Rockbox only works on Ipods formatted with the + FAT32 filesystem (i.e. Ipods initialised by Itunes for Windows). It does not + work with the HFS+ filesystem (i.e. Ipods initialised by Itunes for the Mac). + More information and instructions for converting an Ipod to FAT32 can be found + on the \wikilink{IpodConversionToFAT32} wiki page on the Rockbox website. Note + that after conversion, you can still use a FAT32 Ipod with a Mac. } +\end{description} \section{Installing Rockbox}\label{sec:installing_rockbox}\index{Installation} -There are two ways to install Rockbox: automated and manual. The automated -way is the preferred method of installing Rockbox for the majority of -people. Rockbox Utility is a graphical application that does almost everything -for you. However, should you encounter a problem, then the manual way is -still available to you.\\ +There are two ways to install Rockbox: automated and manual. The automated way +is the preferred method of installing Rockbox for the majority of people. +Rockbox Utility is a graphical application that does almost everything for you. +However, should you encounter a problem, then the manual way is still available +to you.\\ \opt{gigabeats}{\note{The automated install is not yet available for the \playertype{}. For now you can use the manual method to install Rockbox. - Please still read the section on the automatic install as it explains - various important aspects of Rockbox, such as the different versions - available.\\}} + Please still read the section on the automatic install as it explains various + important aspects of Rockbox, such as the different versions available.\\}} \opt{MASCODEC}{Rockbox itself comes as a single package. There is no need to install additional software to run Rockbox.} -\opt{swcodec} { +\opt{swcodec}{ \opt{HAVE_RB_BL_ON_DISK}{There are three separate components, two of which need to be installed in order to run Rockbox:} \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components @@ -163,9 +148,9 @@ \item[The \playerman{} bootloader.] The \playerman{} bootloader is the program that tells your \dap{} how to load and start the original firmware. It is also responsible for any emergency, - recovery, or disk modes on your \dap{}. This bootloader is stored in special flash - memory in your \playerman{} and comes factory-installed. It is not necessary - to modify this in order to install Rockbox.} + recovery, or disk modes on your \dap{}. This bootloader is stored in special + flash memory in your \playerman{} and comes factory-installed. It is not + necessary to modify this in order to install Rockbox.} \item[The Rockbox bootloader.] \index{Bootloader} \opt{HAVE_RB_BL_ON_DISK}{The Rockbox bootloader is loaded from disk by @@ -185,28 +170,26 @@ \opt{HAVE_RB_BL_IN_FLASH}{Unlike the \playerman{} firmware, which runs entirely from flash memory,} \opt{HAVE_RB_BL_ON_DISK}{Similar to the \playerman{} firmware,} - most of the Rockbox code is contained in a - ``build'' that resides on your \daps{} drive. This makes it easy to - update Rockbox. The build consists of a directory called - \fname{.rockbox} which contains all of the Rockbox files, and is - located in the root of your \daps{} drive. + most of the Rockbox code is contained in a ``build'' that resides on your + \daps{} drive. This makes it easy to update Rockbox. The build consists of a + directory called \fname{.rockbox} which contains all of the Rockbox files, and + is located in the root of your \daps{} drive. \end{description} } \nopt{player} { - Apart from the required parts there are some addons you might be interested - in installing. - \begin{description} - \item[Fonts.] Rockbox can load custom fonts. The fonts are - distributed as a separate package and thus need to be installed - separately. They are not required to run Rockbox itself but - a lot of themes require the fonts package to be installed. - - \item[Themes.] The appearance of Rockbox can be customised by themes. Depending - on your taste you might want to install additional themes to change - the look of Rockbox. - \end{description} + Apart from the required parts there are some addons you might be interested + in installing. + \begin{description} + \item[Fonts.] Rockbox can load custom fonts. The fonts are + distributed as a separate package and thus need to be installed + separately. They are not required to run Rockbox itself but + a lot of themes require the fonts package to be installed. + \item[Themes.] The appearance of Rockbox can be customised by themes. + Depending on your taste you might want to install additional themes to + change the look of Rockbox. + \end{description} } \subsection{Automated Installation} @@ -215,7 +198,7 @@ housekeeping tool \caps{Rockbox Utility}. It allows you to: \begin{itemize} \item Automatically install all needed components for using Rockbox - (``Minimal Installation''). + (``Minimal Installation''). \item Automatically install all suggested components (``Complete Installation''). \item Selectively install optional components. \nopt{player}{\item Install additional fonts and themes.} @@ -226,19 +209,18 @@ Prebuilt binaries for Windows, Linux and Mac OS X are available at the \wikilink{RockboxUtility} wiki page.\\ -When first starting \caps{Rockbox Utility} run ``Autodetect'', -found in the configuration dialog (File $\rightarrow$ Configure). Autodetection -can detect most player types. If autodetection fails or is unable to detect -the mountpoint, make sure to enter the correct values. The mountpoint indicates -the location of the \dap{} in your filesystem. On Windows, this is the drive -letter the \dap{} gets assigned, on other systems this is a path in the -filesystem.\\* +When first starting \caps{Rockbox Utility} run ``Autodetect'', found in the +configuration dialog (File $\rightarrow$ Configure). Autodetection can detect +most player types. If autodetection fails or is unable to detect the mountpoint, +make sure to enter the correct values. The mountpoint indicates the location of +the \dap{} in your filesystem. On Windows, this is the drive letter the \dap{} +gets assigned, on other systems this is a path in the filesystem.\\* -\opt{ipodvideo} - {\note{Autodetection is unable to distinguish between the - \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the - 30~GB model. This will usually work but you might want to check the - detected value, especially if you experience problems with Rockbox.} +\opt{ipodvideo}{ + \note{Autodetection is unable to distinguish between the + \playerman{} 30~GB and 60~GB / 80~GB models and defaults to the + 30~GB model. This will usually work but you might want to check the + detected value, especially if you experience problems with Rockbox.} } \opt{h100,h300}{ @@ -247,18 +229,16 @@ the bootloader directly. Instead, we have to patch the Iriver firmware with the Rockbox bootloader. - Download a supported version of the Iriver firmware for your - \playername{} from the Iriver website, links can be found on - \wikilink{IriverBoot}. + Download a supported version of the Iriver firmware for your \playername{} + from the Iriver website, links can be found on \wikilink{IriverBoot}. Supported Iriver firmware versions currently include - \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US, - 1.66EU and 1.66K. Note that the H140 uses the same firmware as the H120; - H120 and H140 owners should use the firmware called \fname{ihp\_120.hex}. - Likewise, the iHP110 and iHP115 use the same firmware, called - \fname{ihp\_100.hex}. Be sure to use the correct firmware file for - your player.} - \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU. + \opt{h100}{1.63US, 1.63EU, 1.63K, 1.65US, 1.65EU, 1.65K, 1.66US, 1.66EU and + 1.66K. Note that the H140 uses the same firmware as the H120; H120 and H140 + owners should use the firmware called \fname{ihp\_120.hex}. Likewise, the + iHP110 and iHP115 use the same firmware, called \fname{ihp\_100.hex}. + Be sure to use the correct firmware file for your player.} + \opt{h300}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU. \note{The US \playername{} firmware is not supported and cannot be patched to be used with the bootloader. If you wish to install Rockbox on a US \playername{}, you must first install a non-US version of the @@ -267,14 +247,12 @@ \warn{Installing non-US firmware on a US \playername{} will permanently remove DRM support from the player.}}} - If the file that you downloaded is a \fname{.zip} file, use an unzip - utility like mentioned in the prerequisites section to extract - the \fname{.hex} from the \fname{.zip} file - to your desktop. Likewise, if the file that you downloaded is an - \fname{.exe} file, double-click on the \fname{.exe} file to extract - the \fname{.hex} file to your desktop. - When running Linux you should be able to extract \fname{.exe} - files using \fname{unzip}. + If the file that you downloaded is a \fname{.zip} file, use an unzip utility + like mentioned in the prerequisites section to extract the \fname{.hex} from + the \fname{.zip} file to your desktop. Likewise, if the file that you + downloaded is an \fname{.exe} file, double-click on the \fname{.exe} file to + extract the \fname{.hex} file to your desktop. When running Linux you should + be able to extract \fname{.exe} files using \fname{unzip}. } \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version} @@ -282,44 +260,45 @@ There are three different versions of Rockbox available from the Rockbox website: \label{Version} -Release version, current build and archived daily build. You need to decide which one -you want to install and get the appropriate version for your \dap{}. If you -select either ``Minimal Installation'' or ``Complete Installation'' from the -``Quick Start'' tab, then Rockbox Utility will automatically install the +Release version, current build and archived daily build. You need to decide +which one you want to install and get the appropriate version for your \dap{}. +If you select either ``Minimal Installation'' or ``Complete Installation'' from +the ``Quick Start'' tab, then Rockbox Utility will automatically install the release version of Rockbox. Using the ``Installation'' tab will allow you to select which version you wish to install. \begin{description} -\item[Release.] The release version is the latest stable release, free - of known critical bugs. For a manual install, the current stable release of Rockbox is - available at \url{http://www.rockbox.org/download/}. +\item[Release.] The release version is the latest stable release, free of known + critical bugs. For a manual install, the current stable release of Rockbox is + available at \url{http://www.rockbox.org/download/}. \item[Current Build.] The current build is built at each source code change to the Rockbox SVN repository and represents the current state of Rockbox - development. This means that the build could contain bugs but most of - the time is safe to use. For a manual install, you can download the current build from + development. This means that the build could contain bugs but most of the time + is safe to use. For a manual install, you can download the current build from \url{http://build.rockbox.org/}. \item[Archived Build.] In addition to the release version and the current build, there is also an archive of daily builds available for download. These are - built once a day from the latest source code in the SVN repository. For a manual install, - you can download archived builds from \url{http://www.rockbox.org/daily.shtml}. + built once a day from the latest source code in the SVN repository. For a + manual install, you can download archived builds from + \url{http://www.rockbox.org/daily.shtml}. \end{description} -\note{Because current and archived builds are development versions that - change frequently, they may behave differently than described in this manual, - or they may introduce new (and potentially annoying) bugs. Unless you wish to - try the latest and greatest features at the price of possibly greater instability, - or you wish to help with development, you should stick with the release.\\*} +\note{Because current and archived builds are development versions that change +frequently, they may behave differently than described in this manual, or they +may introduce new (and potentially annoying) bugs. Unless you wish to try the +latest and greatest features at the price of possibly greater instability, +or you wish to help with development, you should stick with the release.\\*} Please now go to \reference{ref:finish_install} to complete the installation procedure. \subsection{Manual Installation} -The manual installation method is still available to you, should you need or desire it -by following the instructions below. If you have used Rockbox Utility +The manual installation method is still available to you, should you need or +desire it by following the instructions below. If you have used Rockbox Utility to install Rockbox, then you do not need to follow the next section and can skip straight to \reference{ref:finish_install} @@ -329,17 +308,16 @@ \subsubsection{Installing the firmware}\label{sec:installing_firmware} -\opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader -USB mode, you will see two visible partitions - the 150MB firmware -partition (containing at least a file called \fname{nk.bin}) and -the main data partition. Rockbox \emph{must} be installed onto the main -data partiton.}} +\opt{gigabeats}{\note{When your \dap{} is in the Rockbox USB or bootloader USB + mode, you will see two visible partitions - the 150MB firmware partition + (containing at least a file called \fname{nk.bin}) and the main data + partition. Rockbox \emph{must} be installed onto the main data partiton.}} \begin{enumerate} \item Download your chosen version of Rockbox from the links in the previous section. \opt{ipodvideo}{\note{There are separate versions of Rockbox for the 30GB and -60GB/80GB models. You must ensure you download the correct version for your + 60GB/80GB models. You must ensure you download the correct version for your \dap{}.}} \item Connect your \dap{} to the computer via USB @@ -537,7 +515,7 @@ \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}} file and rename \fname{OF.mi4} to \opt{h10}{\fname{H10\_20GC.mi4}}\opt{h10_5gb}{\fname{H10.mi4}} in the \fname{System} directory on your \playertype{}. As in the installation, - it may be necessary to first put your device into UMS mode. + it may be necessary to first put your \dap{} into UMS mode. } \opt{mrobe100}{ @@ -557,9 +535,9 @@ } \optv{ipod}{ - To uninstall Rockbox and go back to using just the original Ipod software, connect - the \dap{} to your computer and follow the instructions to install - the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall + If you would like to go back to using the original \playerman{} software, + connect the \dap{} to your computer and follow the instructions to install + the bootloader but, when prompted by ipodpatcher, enter \texttt{u} for uninstall, instead of \texttt{i} for install. } Index: manual/getting_started/main.tex =================================================================== --- manual/getting_started/main.tex (revision 20635) +++ manual/getting_started/main.tex (working copy) @@ -21,9 +21,9 @@ 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. +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 @@ -82,12 +82,11 @@ warned about. \\ } -\blind{This icon marks a section that is intended especially for the blind - and visually impaired. As they cannot - read the manual in the same way sighted people do we have added some - additional descriptions. If you are not blind or visually impaired you most - likely can completely skip these blocks. To make this easier, there is an - icon shown in the margin on the right. +\blind{This icon marks a section that is intended especially for the blind and + visually impaired. As they cannot read the manual in the same way sighted + people do we have added some additional descriptions. If you are not blind or + visually impaired you most likely can completely skip these blocks. To make + this easier, there is an icon shown in the margin on the right. \\ } }{}% end ifpdfoutput