summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2007-01-02 20:50:03 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2007-01-02 20:50:03 +0000
commit40afbd2a6574e25077d099f1f01371a4b72c8b33 (patch)
tree03faff0ed41705c1d4b303daed9a720af7a17293 /manual
parent8bde9475b5b6d61a8e5e4a548c50ea161eb663ac (diff)
downloadrockbox-40afbd2a6574e25077d099f1f01371a4b72c8b33.tar.gz
rockbox-40afbd2a6574e25077d099f1f01371a4b72c8b33.tar.bz2
rockbox-40afbd2a6574e25077d099f1f01371a4b72c8b33.zip
Some more tweaks to the ipod installation:
- introduce \download for easier linking to the download server - fix some empty lines - add a link on how to identify mini 1g/2g (FS#6372) - change the ipodpatcher links from wiki to download server - add first version of the file header to the preamble that should get added to all LaTeX sources later git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11886 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rwxr-xr-xmanual/getting_started/ipod_install.tex69
-rw-r--r--manual/preamble.tex27
2 files changed, 58 insertions, 38 deletions
diff --git a/manual/getting_started/ipod_install.tex b/manual/getting_started/ipod_install.tex
index e3f5e5b0f6..3db63aced8 100755
--- a/manual/getting_started/ipod_install.tex
+++ b/manual/getting_started/ipod_install.tex
@@ -1,5 +1,12 @@
% $Id$ %
+\opt{ipodvideo}{\newcommand{\bootloaderfile}{bootloader-ipodvideo.ipod}}%
+\opt{ipodmini}{\newcommand{\bootloaderfile}{bootloader-ipodmini1g.ipod}}%
+\opt{ipodnano}{\newcommand{\bootloaderfile}{bootloader-ipodnano.ipod}}%
+\opt{ipodcolor}{\newcommand{\bootloaderfile}{bootloader-ipodcolor.ipod}}%
+\opt{ipod4g}{\newcommand{\bootloaderfile}{bootloader-ipod4g.ipod}}%
+\opt{ipod3g}{\newcommand{\bootloaderfile}{bootloader-ipod3g.ipod}}%
+%
\opt{ipodnano}{\warn{If your Nano has a stainless steel back and plastic front
it is a 1st generation and is compatible with Rockbox. If, on the other hand,
your Nano has a one-piece aluminum body it is a 2nd generation Nano and there
@@ -23,19 +30,18 @@ you wish. Note that these files should be saved onto your computer's hard disk,
\item First, download the \fname{ipodpatcher} tool to your installation
folder. You can download the \fname{ipodpatcher} tool for your operating
- system at
- \url{http://www.rockbox.org/twiki/bin/view/Main/IpodInstallationBeta}.
+ system at \download{bootloader/ipod}.
\item Next, download the following file to the installation folder:
- \opt{ipodvideo}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipodvideo.ipod}}
- \opt{ipodnano}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipodnano.ipod}}
- \opt{ipodmini}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipodmini1g.ipod}
- or \url{http://download.rockbox.org/bootloader/ipod/bootloader-ipodmini2g.ipod}
- depending on which generation your \dap{} is. \fixme{Describe how to identify 1/2G}}
- \opt{ipodcolor}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipodcolor.ipod}}
- \opt{ipod4g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipod4g.ipod}}
- \opt{ipod3g}{\url{http://download.rockbox.org/bootloader/ipod/bootloader-ipod3g.ipod}}
+ \download{bootloader/ipod/\bootloaderfile}
+ \opt{ipodmini}{%
+ or \download{bootloader/ipod/bootloader-ipodmini2g.ipod}
+ depending on which generation your \dap{} is.
+ The following page describes the differences between the two
+ generations of the \dap{}:
+ \url{http://docs.info.apple.com/article.html?artnum=300850}.
+ }
\item Next, open a command prompt (Windows) or terminal window (Mac OSX and Linux).
@@ -106,9 +112,7 @@ you wish. Note that these files should be saved onto your computer's hard disk,
\begin{code}
ipodpatcher [device] -r bootpartition.bin (Windows)
\end{code}
-
or
-
\begin{code}
./ipodpatcher [device] -r bootpartition.bin (Mac OS X/Unix)
\end{code}
@@ -122,38 +126,27 @@ you wish. Note that these files should be saved onto your computer's hard disk,
restore this backup to your ipod using the command ipodpatcher [device] -w
bootpartition.bin (Windows) or ./ipodpatcher [device] -w bootpartition.bin
(Mac OS X/Unix).
-
- \item Install the bootloader.
+ \opt{ipodmini}{
+ \note{Ipod Mini 2g users need to replace ``1g'' with ``2g'' in the
+ following commands.}
+ }
+
+ \item Install the bootloader.
Windows users should now type:
- \begin{code}
- \opt{ipodvideo}{ipodpatcher [device] -a bootloader-ipodvideo.ipod}
- \opt{ipodnano}{ipodpatcher [device] -a bootloader-ipodnano.ipod}
- \opt{ipodmini}{ipodpatcher [device] -a bootloader-ipodmini1g.ipod}
- \opt{ipodcolor}{ipodpatcher [device] -a bootloader-ipodcolor.ipod}
- \opt{ipod4g}{ipodpatcher [device] -a bootloader-ipod4g.ipod}
- \opt{ipod3g}{ipodpatcher [device] -a bootloader-ipod3g.ipod}
- \end{code}
-
+ \begin{code}
+ ipodpatcher [device] -a \bootloaderfile
+ \end{code}
+ %
and Mac OS X/Unix users should type:
- \begin{code}
- \opt{ipodvideo}{./ipodpatcher [device] -a bootloader-ipodvideo.ipod}
- \opt{ipodnano}{./ipodpatcher [device] -a bootloader-ipodnano.ipod}
- \opt{ipodmini}{./ipodpatcher [device] -a bootloader-ipodmini1g.ipod}
- \opt{ipodcolor}{./ipodpatcher [device] -a bootloader-ipodcolor.ipod}
- \opt{ipod4g}{./ipodpatcher [device] -a bootloader-ipod4g.ipod}
- \opt{ipod3g}{./ipodpatcher [device] -a bootloader-ipod3g.ipod}
- \end{code}
-
+ \begin{code}
+ ./ipodpatcher [device] -a \bootloaderfile
+ \end{code}
+
Replace [device] with the number (Windows users) or device name (Mac OS X/Unix
users) you've been using to access your ipod.
- \opt{ipodmini}{
- \note{Ipod Mini 2g users should replace ``1g'' with ``2g'' in the above
- commands.}
- }
-
You can now disconnect your ipod from your computer in the normal way. This
should cause your iPod to reboot and start Rockbox.
-\end{enumerate} \ No newline at end of file
+\end{enumerate}
diff --git a/manual/preamble.tex b/manual/preamble.tex
index af9fba904c..999bcbf2f9 100644
--- a/manual/preamble.tex
+++ b/manual/preamble.tex
@@ -1,3 +1,24 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% __________ __ ___.
+% Open \______ \ ____ ____ | | _\_ |__ _______ ___
+% Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
+% Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
+% Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
+% \/ \/ \/ \/ \/
+% - M A N U A L -
+%
+% $Id$
+%
+% Copyright (C) 2006 The Rockbox Manual Team
+%
+% All files in this archive are subject to the GNU Free Documentation License
+% See the file COPYING-MANUAL in the source tree docs/ folder for full license
+% agreement.
+%
+% Contributors are listed in the file docs/CREDITS-MANUAL
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\documentclass[a4paper,11pt]{scrreprt}
\usepackage[latin1]{inputenc}
\usepackage{palatino}
@@ -223,6 +244,12 @@
\newcommand{\config}[1]{\texttt{#1}}
+% set link to download server
+% Usage: \download{bootloader/bootloader-ipodnano.ipod}
+% gets expanded to
+% "http://download.rockbox.org/bootloader/bootloader-ipodnano.ipod"
+\newcommand{\download}[1]{\url{http://download.rockbox.org/#1}}
+
% set link to the wiki.
% Usage: \wikilink{WebHome}
% with "WebHome" being the wiki page name