Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

manual: Fix broken ipod manual generation

Browse source 
Split apart ipod6g installation instructions from the rest.  For unknown
reasons the \opt and \nopt tests were causing the \code blocks to go wonky

Change-Id: I99b96cd17bd817e18b3487a92b66e966e39397d6
This commit is contained in:
Solomon Peachy 2020-03-29 10:06:12 -04:00
parent 2ce000272d
commit f86f7883f5
3 changed files with 71 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
manual/getting_started/installation.tex
View file

@ -512,7 +512,11 @@ structure that Rockbox needs.\\}
\subsubsection{Installing the bootloader} \subsubsection{Installing the bootloader}
\opt{iriverh100,iriverh300}{\input{getting_started/iriver_install.tex}} \opt{iriverh100,iriverh300}{\input{getting_started/iriver_install.tex}}
\opt{mpiohd200,mpiohd300}{\input{getting_started/mpio_install.tex}} \opt{mpiohd200,mpiohd300}{\input{getting_started/mpio_install.tex}}
\opt{ipod}{\input{getting_started/ipod_install.tex}} \opt{ipod}{
\nopt{ipod6g} {
\input{getting_started/ipod_install.tex}}
\opt{ipod6g} {
\input{getting_started/ipod6g_install.tex}} }
\opt{iaudio}{\input{getting_started/iaudio_install.tex}} \opt{iaudio}{\input{getting_started/iaudio_install.tex}}
\opt{iriverh10,iriverh10_5gb}{\input{getting_started/h10_install.tex}} \opt{iriverh10,iriverh10_5gb}{\input{getting_started/h10_install.tex}}
\opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}} \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}}

66
manual/getting_started/ipod6g_install.tex Normal file
View file

@ -0,0 +1,66 @@
\subsubsection{Bootloader installation from Windows}
Manual installation under Windows is not supported. Please use \caps{Rockbox
Utility} for bootloader and Rockbox installation.
\subsubsection{Bootloader installation from Mac OS X}
\warn{Please make sure that your iPod is formatted using FAT32
(a.k.a. WinPod) before attempting to install the bootloader!
Installation will not work on HFS/HFS+ iPods (a.k.a. MacPods).}
\begin{enumerate}
\item Download the bootloader in .ipod format from
\url{https://files.freemyipod.org/~user890104/bootloader-ipodclassic-v1_0/bootloader-ipod6g.ipod}
\item Download mks5lboot for your operating system from
\url{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html\#download_stable}
\item You need to have package libusb installed using Homebrew (brew install
libusb) or MacPorts (port install libusb) in order to run mks5lboot.
\item Start mks5lboot from a terminal with the following command-line:
mks5lboot --dfuscan -l It should scan for DFU devices every second.
\item It is important to stop iTunes (dock icon -> Quit) and iTunesHelper
(using Activity monitor, find the process and select Quit or Force
quit if it keeps restarting) BEFORE continuing to the next
step. Otherwise iTunes will put your iPod in wrong mode, and you will
not be able to proceed with the installation.
\item Put your iPod in DFU mode.
\item When the device is detected, press CTRL+C to terminate the scan
process, and proceed to the next step.
\item Start mks5lboot from a terminal with the following command-line:
mks5lboot --bl-inst path/to/bootloader-ipod6g.ipod, providing the
correct path to bootloader-ipod6g.ipod that you downloaded earlier.
\item When the installation is complete, you should have Rockbox up and
running!
\end{enumerate}
\subsubsection{Bootloader installation from Linux}
\begin{enumerate}
\item Connect your iPod in normal mode (iTunes/file transfer).
\item Download \wikilink{RockboxUtility} for your operating system.
\item When \caps{Rockbox Utility} opens, select the checkbox named Show disabled targets, and point the installer to your iPod's mount point.
\item On the installation screen make sure that Rockbox is selected and Bootloader is not selected. You can install themes or the game files if you want.
\item Start the Rockbox installation.
\item Download the \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic-v1_0/bootloader-ipod6g.ipod}{bootloader in .ipod format}.
\item Download \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#download_stable}{mks5lboot} for your operating system. Alternatively, you can \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#build_mks5lboot}{build it} from the source code.
\item You need to have package libusb-1.0.0 installed in order to run mks5lboot.
\item To make sure the installer is marked as executable, start the following command in the terminal: chmod +x mks5lboot.
\item Start mks5lboot from a terminal with the following command-line: ./mks5lboot --dfuscan -l. It should scan for DFU devices every second.
\item Put your iPod in \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#dfu}{DFU mode}.
\item When the device is detected, press CTRL+C to terminate the scan process, and proceed to the next step.
\item Start mks5lboot from a terminal with the following command-line: ./mks5lboot --bl-inst path/to/bootloader-ipod6g.ipod, providing the correct path to bootloader-ipod6g.ipod that you downloaded earlier.
\item When the installation is complete, you should have Rockbox up and running!
\end{enumerate}

73
manual/getting_started/ipod_install.tex
View file

@ -1,7 +1,3 @@
% $Id$ %
\nopt{ipod6g}{
\subsubsection{Bootloader installation from Windows} \subsubsection{Bootloader installation from Windows}
\begin{enumerate} \begin{enumerate}
@ -87,73 +83,4 @@ bootloader. Press i followed by ENTER, and ipodpatcher will now install the
bootloader. After a short time you should see the message ``[INFO] Bootloader bootloader. After a short time you should see the message ``[INFO] Bootloader
installed successfully.'' Press ENTER again to exit ipodpatcher. installed successfully.'' Press ENTER again to exit ipodpatcher.
\end{enumerate}}
\opt{ipod6g}{
\subsubsection{Bootloader installation from Windows}
Manual installation under Windows is not supported. Please use \caps{Rockbox
Utility} for bootloader and Rockbox installation.
\subsubsection{Bootloader installation from Mac OS X}
\warn{Please make sure that your iPod is formatted using FAT32
(a.k.a. WinPod) before attempting to install the bootloader!
Installation will not work on HFS/HFS+ iPods (a.k.a. MacPods).}
\begin{enumerate}
\item Download the bootloader in .ipod format from
\url{https://files.freemyipod.org/~user890104/bootloader-ipodclassic-v1_0/bootloader-ipod6g.ipod}
\item Download mks5lboot for your operating system from
\url{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html\#download_stable}
\item You need to have package libusb installed using Homebrew (brew install
libusb) or MacPorts (port install libusb) in order to run mks5lboot.
\item Start mks5lboot from a terminal with the following command-line:
mks5lboot --dfuscan -l It should scan for DFU devices every second.
\item It is important to stop iTunes (dock icon -> Quit) and iTunesHelper
(using Activity monitor, find the process and select Quit or Force
quit if it keeps restarting) BEFORE continuing to the next
step. Otherwise iTunes will put your iPod in wrong mode, and you will
not be able to proceed with the installation.
\item Put your iPod in DFU mode.
\item When the device is detected, press CTRL+C to terminate the scan
process, and proceed to the next step.
\item Start mks5lboot from a terminal with the following command-line:
mks5lboot --bl-inst path/to/bootloader-ipod6g.ipod, providing the
correct path to bootloader-ipod6g.ipod that you downloaded earlier.
\item When the installation is complete, you should have Rockbox up and
running!
\end{enumerate} \end{enumerate}
\subsubsection{Bootloader installation from Linux}
\begin{enumerate}
\item Connect your iPod in normal mode (iTunes/file transfer).
\item Download \wikilink{RockboxUtility} for your operating system.
\item When \caps{Rockbox Utility} opens, select the checkbox named Show disabled targets, and point the installer to your iPod's mount point.
\item On the installation screen make sure that Rockbox is selected and Bootloader is not selected. You can install themes or the game files if you want.
\item Start the Rockbox installation.
\item Download the \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic-v1_0/bootloader-ipod6g.ipod}{bootloader in .ipod format}.
\item Download \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#download_stable}{mks5lboot} for your operating system. Alternatively, you can \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#build_mks5lboot}{build it} from the source code.
\item You need to have package libusb-1.0.0 installed in order to run mks5lboot.
\item To make sure the installer is marked as executable, start the following command in the terminal: chmod +x mks5lboot.
\item Start mks5lboot from a terminal with the following command-line: ./mks5lboot --dfuscan -l. It should scan for DFU devices every second.
\item Put your iPod in \href{https://files.freemyipod.org/~user890104/bootloader-ipodclassic.html#dfu}{DFU mode}.
\item When the device is detected, press CTRL+C to terminate the scan process, and proceed to the next step.
\item Start mks5lboot from a terminal with the following command-line: ./mks5lboot --bl-inst path/to/bootloader-ipod6g.ipod, providing the correct path to bootloader-ipod6g.ipod that you downloaded earlier.
\item When the installation is complete, you should have Rockbox up and running!
\end{enumerate}
}