summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Menes <rmenes@rockbox.org>2009-01-29 04:11:44 +0000
committerRobert Menes <rmenes@rockbox.org>2009-01-29 04:11:44 +0000
commitc5bffb1289ea0f2042d1b6523b29b46a41368bb5 (patch)
tree0707f1f187ca74b29ef1cc2162e6678c0080bb63
parent8f1d8be7a7572db951eae48745055f823cf52b61 (diff)
downloadrockbox-c5bffb1289ea0f2042d1b6523b29b46a41368bb5.tar.gz
rockbox-c5bffb1289ea0f2042d1b6523b29b46a41368bb5.zip
Some various pieces of manual work: Fixed installation instructions for the e200 and c200 under Mac OS X, added a warning about v2 firmwares to the Sansa install page, and the very beginnings of a Sansa Clip manual (which still needs a lot of work!) Also fixed up the blind descriptions for the Archos Player and Recorder, and some little typo fixes here and there.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19878 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/getting_started/sansa_install.tex22
-rw-r--r--manual/getting_started/sansav2_install.tex35
-rw-r--r--manual/platform/clip.tex24
-rw-r--r--manual/platform/keymap-clip.tex30
-rw-r--r--manual/rockbox_interface/main.tex65
5 files changed, 142 insertions, 34 deletions
diff --git a/manual/getting_started/sansa_install.tex b/manual/getting_started/sansa_install.tex
index 8b333e3ab2..5fc852096e 100644
--- a/manual/getting_started/sansa_install.tex
+++ b/manual/getting_started/sansa_install.tex
@@ -4,10 +4,14 @@
4follow the instructions at 4follow the instructions at
5\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}} 5\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
6 6
7\warn{If your \daps{} original firmware starts with a version number of 03.XX.XX, then do \emph{not} proceed with these install instructions.
8If your \daps{} original firmware starts with 01.XX.XX, then you can
9install Rockbox.}
10
7In order to make your \playertype{} load and execute the Rockbox firmware you 11In order to make your \playertype{} load and execute the Rockbox firmware you
8have just installed, you will need to install the Rockbox 12have just installed, you will need to install the Rockbox
9bootloader. Unless bugs are found in the bootloader code, or 13bootloader. Unless bugs are found in the bootloader code, or
10significant new feature are added, you will only have to perform this 14significant new features are added, you will only have to perform this
11step once. 15step once.
12 16
13These steps use the sansapatcher tool. Source code is available in the Rockbox 17These steps use the sansapatcher tool. Source code is available in the Rockbox
@@ -42,12 +46,6 @@ sansapatcher.
42\item Attach your \dap{} to your Mac and wait for its icon to appear in 46\item Attach your \dap{} to your Mac and wait for its icon to appear in
43Finder. 47Finder.
44 48
45\item\label{subsec:macos_umount} Open up Disk Utility
46(in Applications $\rightarrow$ Utilities) and click
47on the name of your \dap{} (e.g. Sansa \opt{e200}{e280}\opt{c200}{c250})
48in the list on the left pane. Then click on the ``unmount'' icon at the top.
49\warn{Do \emph{not} click on the ``eject'' icon.}
50
51\item Download and open sansa.dmg from 49\item Download and open sansa.dmg from
52\download{bootloader/sandisk-sansa/sansapatcher/macosx/sansapatcher.dmg} 50\download{bootloader/sandisk-sansa/sansapatcher/macosx/sansapatcher.dmg}
53and then double-click on the sansapatcher icon inside. 51and then double-click on the sansapatcher icon inside.
@@ -55,14 +53,8 @@ and then double-click on the sansapatcher icon inside.
55\item If all has gone well, you should see some 53\item If all has gone well, you should see some
56information displayed about your \dap{} and a message asking you if you 54information displayed about your \dap{} and a message asking you if you
57wish to install the Rockbox bootloader. Press i followed by ENTER, and 55wish to install the Rockbox bootloader. Press i followed by ENTER, and
58sansapatcher will now install the bootloader. After a short time you 56sansapatcher will now unmount your \dap{} and install the bootloader.
59should see the message ``[INFO] Bootloader installed successfully.'' Press 57After a short time you should see the message ``[INFO] Bootloader installed successfully.'' Press ENTER again to exit sansapatcher and then quit the Terminal application.
60ENTER again to exit sansapatcher and then quit the Terminal application.
61
62\item \warn{If you received a ``Resource busy'' error from
63sansapatcher, then this means you did not complete step
64\ref{subsec:macos_umount}. Go back to Disk Utility, unmount your
65\dap{} and then run sansapatcher again.}
66 58
67\item Your \dap{} will now automatically reconnect itself to your Mac. 59\item Your \dap{} will now automatically reconnect itself to your Mac.
68Wait for it to connect, and then eject and unplug it in the normal way. 60Wait for it to connect, and then eject and unplug it in the normal way.
diff --git a/manual/getting_started/sansav2_install.tex b/manual/getting_started/sansav2_install.tex
new file mode 100644
index 0000000000..9f2e25c64b
--- /dev/null
+++ b/manual/getting_started/sansav2_install.tex
@@ -0,0 +1,35 @@
1% $Id: %
2
3In order to make your \playertype{} load and execute the Rockbox
4firmware you have just installed, you will need to install the
5Rockbox bootloader. Unless bugs are found in the bootloader code, or
6significant new features are added, you will only have to perform this
7step once.
8
9These steps use the mkamsboot tool. Source code is available in the
10Rockbox SVN repository
11(\url{http://svn.rockbox.org/viewvc.cgi/trunk/rbutil/mkamsboot/}).
12
13\subsection{Bootloader installation from Windows}
14
15\begin{enumerate}
16
17% Will add when I have required install instructions %
18
19\end{enumerate}
20
21\subsection{Bootloader installation from Mac OS X}
22
23\begin{enumerate}
24
25% Same as above %
26
27\end{enumerate}
28
29\subsection{Bootloader installation from Linux}
30
31\begin{enumerate}
32
33% Lather rinse repeat %
34
35\end{enumerate} \ No newline at end of file
diff --git a/manual/platform/clip.tex b/manual/platform/clip.tex
new file mode 100644
index 0000000000..0f2192c926
--- /dev/null
+++ b/manual/platform/clip.tex
@@ -0,0 +1,24 @@
1% Id: %
2\def\UseOption{clip}
3\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
4\edef\UseOption{\UseOption,SANSA_CLIP_PAD}
5\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
6%\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE} %
7\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
8\edef\UseOption{\UseOption,sansa}
9
10\newcommand{\playerman}{Sansa}
11\newcommand{\playertype}{Clip}
12\newcommand{\playerlongtype}{\playertype}
13\newcommand{\genericimg}{128x64x1}
14\newcommand{\specimg}{Clip}
15%Used to name the player, e.g. ...to the \dap
16\newcommand{\dap}{player}
17%For use when referring to the player. E.g. the \daps\ capacity...
18\newcommand{\daps}{player's}
19\newcommand{firmwarefilename}{\fname{rockbox.sansa}}
20\newcommand{\screenshotsize}{3cm}
21\newcommand{\disk}{flash storage}
22
23% link external keymap file
24\input{platform/keymap-clip.tex} \ No newline at end of file
diff --git a/manual/platform/keymap-clip.tex b/manual/platform/keymap-clip.tex
new file mode 100644
index 0000000000..d9ea07d0d3
--- /dev/null
+++ b/manual/platform/keymap-clip.tex
@@ -0,0 +1,30 @@
1% $Id:
2
3\newcommand{\ButtonLeft}{\btnfnt{Left}}
4\newcommand{\ButtonRight}{\btnfnt{Right}}
5\newcommand{\ButtonHome}{\btnfnt{Home}}
6\newcommand{\ButtonUp}{\btnfnt{Play}}
7\newcommand{\ButtonDown}{\btnfnt{Submenu}}
8\newcommand{\ButtonSelect}{\btnfnt{Select}}
9\newcommand{\ButtonPower}{\btnfnt{Power}}
10\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
11\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
12\newcommand{\ButtonHold}{\btnfnt{Hold}}
13
14%Button actions, standard context
15
16%Button actions, wps context
17
18%Button actions, tree context
19
20%Button actions, YesNo context
21
22%Button actions, Setting context
23
24%Button actions, Virtual Keyboard Context
25
26%Button actions, Pitch Screen context
27
28%Button actions, Recording screen context
29
30%Button actions, FM radio context \ No newline at end of file
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index f99235b574..eb2599ddda 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -173,20 +173,21 @@ described in detail in the following paragraph.
173 } 173 }
174 % 174 %
175 \opt{ondio}{ 175 \opt{ondio}{
176 The main characteristic of the Ondio case is the dent on its lower right side 176 The main characteristic of the Ondio case is the indent on its lower right side,
177 which is the MMC slot. Holding the \dap{} with this slot in the described position 177 which is the MMC slot. Holding the \dap{} with this slot in the described position
178 you'll find the following: 178 you'll find the following:
179 179
180 On the curved top it has the headphone jack to the left, 180 On the curved top, from left to right, are the headphone jack,
181 the \ButtonOff{} button is in the middle% 181 the \ButtonOff{} button,%
182 \opt{recording}{ and the line in jack to the right}. 182 \opt{recording}{ and the line in jack}.
183 Apart from the already mentioned MMC slot you will find the USB connector on 183 Apart from the already mentioned MMC slot, you will find the USB connector on
184 the \daps{} right side. Placed on the upper side of the device right below 184 the \daps{} right side. Below the LCD, at approximately the center of the \dap{},
185 the flat display there is the main button pad of the \dap{}. A strong deepening 185 there is the main button pad of the \dap{}. The centre of the button pad dips inward
186 marks the center of it and helps to operate the directional keys from there. 186 and helps to operate the directional keys from there. Located on a two-way button
187 \ButtonLeft{} and \ButtonRight{} form some sort of a strip and divide \ButtonUp{} 187 strip are the \ButtonLeft{} and \ButtonRight{} keys, with \ButtonUp{} above it
188 and \ButtonDown{}. The raised button positioned in the lower left of this round 188 and \ButtonDown{} below it. The raised button positioned in the lower left of this
189 crosspad is labelled \ButtonMenu{}.} 189 round crosspad is labelled \ButtonMenu{}.
190 }
190 % 191 %
191 \opt{h10,h10_5gb}{ 192 \opt{h10,h10_5gb}{
192 Hold or lay the \dap{} so that the side with the scroll pad and 193 Hold or lay the \dap{} so that the side with the scroll pad and
@@ -284,7 +285,7 @@ described in detail in the following paragraph.
284 other end. Hold the \dap{} wih the thick end towards the top and the screen 285 other end. Hold the \dap{} wih the thick end towards the top and the screen
285 facing towards you. Half way up the front of the unit on the right hand side 286 facing towards you. Half way up the front of the unit on the right hand side
286 is a four way joystick which is the \ButtonUp{}, \ButtonDown{}, 287 is a four way joystick which is the \ButtonUp{}, \ButtonDown{},
287 \ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect. 288 \ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect{}.
288 289
289 On the right hand side of the \dap{} from top to bottom, first there is a two 290 On the right hand side of the \dap{} from top to bottom, first there is a two
290 way switch. the \ButtonPower{} button is activated by pushing this switch up, 291 way switch. the \ButtonPower{} button is activated by pushing this switch up,
@@ -345,15 +346,37 @@ described in detail in the following paragraph.
345 Immediately above the headphone socket is a lanyard loop and the microphone. 346 Immediately above the headphone socket is a lanyard loop and the microphone.
346 } 347 }
347 % 348 %
349 \opt{clip}{
350 Hold the \dap{} with the controls on the bottom and the screen on the top. The main
351 controls are a four-way pad with a button in the centre; pressing this centre button
352 functions as \ButtonSelect{}. Going clockwise from the top, the four-way pad contains
353 the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{} buttons.
354 Immediately above and to the right of the four-way pad is the \ButtonHome{} button.
355
356 On the left hand panel is a two way switch. Pressing this switch up acts as
357 \ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{}
358 switch. When the \ButtonHold{} switch is on, none of the other buttons have any
359 effect. Immediately above the switch is a mini-USB port to connect the \dap{} to
360 a computer.
361
362 On the right hand panel is a two-way button that acts as \ButtonVolDown{} when
363 pressed on the bottom, and \ButtonVolUp{} when pressed on the top. Immediately
364 above this button is the headphone jack.
365 }
366 %
348 \opt{player}{ 367 \opt{player}{
349 Holding the Jukebox in front of you there should be two buttons to 368 The main controls of this player are a four-way button on the right below
350 the left of the unit and a single multi-way circular button to their right. 369 the screen, and two round buttons to the left of it. Hold the \dap{} with
351 The buttons are as follows.% 370 these controls on the bottom and facing you.
371
352 On the left hand side, the higher of the two small buttons is the \ButtonOn{}, 372 On the left hand side, the higher of the two small buttons is the \ButtonOn{},
353 the lower of the two buttons is the \ButtonMenu{} button. The large circular 373 the lower of the two buttons is the \ButtonMenu{} button. The large circular
354 button on the right - push towards the top serves as \ButtonPlay{}, push towards 374 button on the right contains, clockwise from the top, the \ButtonPlay{},
355 the left is called \ButtonLeft{}, push towards the right \ButtonRight{} and push 375 the \ButtonRight{}, the \ButtonStop{}, and the \ButtonLeft{} buttons.
356 towards the bottom is labelled \ButtonStop{}. 376
377 On the top on the \dap{} is the headphone jack on the left and the Line-Out
378 jack on the right. On the bottom of the \dap{} is the Line-In jack on the left,
379 the DC-In jack on the right, and the USB connector in the centre.
357 } 380 }
358 % 381 %
359 \opt{recorder}{ 382 \opt{recorder}{
@@ -372,6 +395,10 @@ described in detail in the following paragraph.
372 below the \ButtonPlay{} button there is the \ButtonDown{} button placed. In the row 395 below the \ButtonPlay{} button there is the \ButtonDown{} button placed. In the row
373 of three rectangular buttons the following buttons can be found (from left to right): 396 of three rectangular buttons the following buttons can be found (from left to right):
374 \ButtonFOne{}, \ButtonFTwo{} and \ButtonFThree{}. 397 \ButtonFOne{}, \ButtonFTwo{} and \ButtonFThree{}.
398
399 On the top of the \dap{} is the headphone jack on the left and the Line-Out jack on
400 the right. On the bottom of the \dap{} is the Line-In jack on the left, the
401 DC-In jack on the right, and the USB connector in the centre.
375 } 402 }
376 \opt{recorderv2fm}{ 403 \opt{recorderv2fm}{
377 Holding the Jukebox in front of you, there should be three rectangular buttons 404 Holding the Jukebox in front of you, there should be three rectangular buttons
@@ -489,7 +516,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
489 \note{The iriver firmware does not shut down properly when you turn it off, 516 \note{The iriver firmware does not shut down properly when you turn it off,
490 it only goes to sleep. To get back into Rockbox when exiting from the 517 it only goes to sleep. To get back into Rockbox when exiting from the
491 iriver firmware, you will need to reset the player by \opt{h10}{inserting a 518 iriver firmware, you will need to reset the player by \opt{h10}{inserting a
492 pin in the reset hole}\opt{h10_5gb}{taking out battery}.} 519 pin in the reset hole}\opt{h10_5gb}{removing and reinserting the battery}.}
493 } 520 }
494 521
495 \opt{sansa} 522 \opt{sansa}