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

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.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19878 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Robert Menes 2009-01-29 04:11:44 +00:00
parent 8f1d8be7a7
commit c5bffb1289
5 changed files with 142 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
manual/getting_started/sansa_install.tex
View file

@ -4,10 +4,14 @@
follow the instructions at
\url{http://www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation}.}}
\warn{If your \daps{} original firmware starts with a version number of 03.XX.XX, then do \emph{not} proceed with these install instructions.
If your \daps{} original firmware starts with 01.XX.XX, then you can
install Rockbox.}
In order to make your \playertype{} load and execute the Rockbox firmware you
have just installed, you will need to install the Rockbox
bootloader. Unless bugs are found in the bootloader code, or
significant new feature are added, you will only have to perform this
significant new features are added, you will only have to perform this
step once.
These steps use the sansapatcher tool. Source code is available in the Rockbox
@ -42,12 +46,6 @@ sansapatcher.
\item Attach your \dap{} to your Mac and wait for its icon to appear in
Finder.
\item\label{subsec:macos_umount} Open up Disk Utility
(in Applications $\rightarrow$ Utilities) and click
on the name of your \dap{} (e.g. Sansa \opt{e200}{e280}\opt{c200}{c250})
in the list on the left pane. Then click on the ``unmount'' icon at the top.
\warn{Do \emph{not} click on the ``eject'' icon.}
\item Download and open sansa.dmg from
\download{bootloader/sandisk-sansa/sansapatcher/macosx/sansapatcher.dmg}
and then double-click on the sansapatcher icon inside.
@ -55,14 +53,8 @@ and then double-click on the sansapatcher icon inside.
\item If all has gone well, you should see some
information displayed about your \dap{} and a message asking you if you
wish to install the Rockbox bootloader. Press i followed by ENTER, and
sansapatcher will now install the bootloader. After a short time you
should see the message ``[INFO] Bootloader installed successfully.'' Press
ENTER again to exit sansapatcher and then quit the Terminal application.
\item \warn{If you received a ``Resource busy'' error from
sansapatcher, then this means you did not complete step
\ref{subsec:macos_umount}. Go back to Disk Utility, unmount your
\dap{} and then run sansapatcher again.}
sansapatcher will now unmount your \dap{} and install the bootloader.
After a short time you should see the message ``[INFO] Bootloader installed successfully.'' Press ENTER again to exit sansapatcher and then quit the Terminal application.
\item Your \dap{} will now automatically reconnect itself to your Mac.
Wait for it to connect, and then eject and unplug it in the normal way.

35
manual/getting_started/sansav2_install.tex Normal file
View file

@ -0,0 +1,35 @@
% $Id: %
In order to make your \playertype{} load and execute the Rockbox
firmware you have just installed, you will need to install the
Rockbox bootloader. Unless bugs are found in the bootloader code, or
significant new features are added, you will only have to perform this
step once.
These steps use the mkamsboot tool. Source code is available in the
Rockbox SVN repository
(\url{http://svn.rockbox.org/viewvc.cgi/trunk/rbutil/mkamsboot/}).
\subsection{Bootloader installation from Windows}
\begin{enumerate}
% Will add when I have required install instructions %
\end{enumerate}
\subsection{Bootloader installation from Mac OS X}
\begin{enumerate}
% Same as above %
\end{enumerate}
\subsection{Bootloader installation from Linux}
\begin{enumerate}
% Lather rinse repeat %
\end{enumerate}

24
manual/platform/clip.tex Normal file
View file

@ -0,0 +1,24 @@
% Id: %
\def\UseOption{clip}
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,SANSA_CLIP_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
%\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE} %
\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
\edef\UseOption{\UseOption,sansa}
\newcommand{\playerman}{Sansa}
\newcommand{\playertype}{Clip}
\newcommand{\playerlongtype}{\playertype}
\newcommand{\genericimg}{128x64x1}
\newcommand{\specimg}{Clip}
%Used to name the player, e.g. ...to the \dap
\newcommand{\dap}{player}
%For use when referring to the player. E.g. the \daps\ capacity...
\newcommand{\daps}{player's}
\newcommand{firmwarefilename}{\fname{rockbox.sansa}}
\newcommand{\screenshotsize}{3cm}
\newcommand{\disk}{flash storage}
% link external keymap file
\input{platform/keymap-clip.tex}

30
manual/platform/keymap-clip.tex Normal file
View file

@ -0,0 +1,30 @@
% $Id:
\newcommand{\ButtonLeft}{\btnfnt{Left}}
\newcommand{\ButtonRight}{\btnfnt{Right}}
\newcommand{\ButtonHome}{\btnfnt{Home}}
\newcommand{\ButtonUp}{\btnfnt{Play}}
\newcommand{\ButtonDown}{\btnfnt{Submenu}}
\newcommand{\ButtonSelect}{\btnfnt{Select}}
\newcommand{\ButtonPower}{\btnfnt{Power}}
\newcommand{\ButtonVolUp}{\btnfnt{Volume Up}}
\newcommand{\ButtonVolDown}{\btnfnt{Volume Down}}
\newcommand{\ButtonHold}{\btnfnt{Hold}}
%Button actions, standard context
%Button actions, wps context
%Button actions, tree context
%Button actions, YesNo context
%Button actions, Setting context
%Button actions, Virtual Keyboard Context
%Button actions, Pitch Screen context
%Button actions, Recording screen context
%Button actions, FM radio context

65
manual/rockbox_interface/main.tex
View file

@ -173,20 +173,21 @@ described in detail in the following paragraph.
}
%
\opt{ondio}{
The main characteristic of the Ondio case is the dent on its lower right side
The main characteristic of the Ondio case is the indent on its lower right side,
which is the MMC slot. Holding the \dap{} with this slot in the described position
you'll find the following:
On the curved top it has the headphone jack to the left,
the \ButtonOff{} button is in the middle%
\opt{recording}{ and the line in jack to the right}.
Apart from the already mentioned MMC slot you will find the USB connector on
the \daps{} right side. Placed on the upper side of the device right below
the flat display there is the main button pad of the \dap{}. A strong deepening
marks the center of it and helps to operate the directional keys from there.
\ButtonLeft{} and \ButtonRight{} form some sort of a strip and divide \ButtonUp{}
and \ButtonDown{}. The raised button positioned in the lower left of this round
crosspad is labelled \ButtonMenu{}.}
On the curved top, from left to right, are the headphone jack,
the \ButtonOff{} button,%
\opt{recording}{ and the line in jack}.
Apart from the already mentioned MMC slot, you will find the USB connector on
the \daps{} right side. Below the LCD, at approximately the center of the \dap{},
there is the main button pad of the \dap{}. The centre of the button pad dips inward
and helps to operate the directional keys from there. Located on a two-way button
strip are the \ButtonLeft{} and \ButtonRight{} keys, with \ButtonUp{} above it
and \ButtonDown{} below it. The raised button positioned in the lower left of this
round crosspad is labelled \ButtonMenu{}.
}
%
\opt{h10,h10_5gb}{
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.
other end. Hold the \dap{} wih the thick end towards the top and the screen
facing towards you. Half way up the front of the unit on the right hand side
is a four way joystick which is the \ButtonUp{}, \ButtonDown{},
\ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect.
\ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect{}.
On the right hand side of the \dap{} from top to bottom, first there is a two
way switch. the \ButtonPower{} button is activated by pushing this switch up,
@ -345,15 +346,37 @@ described in detail in the following paragraph.
Immediately above the headphone socket is a lanyard loop and the microphone.
}
%
\opt{clip}{
Hold the \dap{} with the controls on the bottom and the screen on the top. The main
controls are a four-way pad with a button in the centre; pressing this centre button
functions as \ButtonSelect{}. Going clockwise from the top, the four-way pad contains
the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{} buttons.
Immediately above and to the right of the four-way pad is the \ButtonHome{} button.
On the left hand panel is a two way switch. Pressing this switch up acts as
\ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{}
switch. When the \ButtonHold{} switch is on, none of the other buttons have any
effect. Immediately above the switch is a mini-USB port to connect the \dap{} to
a computer.
On the right hand panel is a two-way button that acts as \ButtonVolDown{} when
pressed on the bottom, and \ButtonVolUp{} when pressed on the top. Immediately
above this button is the headphone jack.
}
%
\opt{player}{
Holding the Jukebox in front of you there should be two buttons to
the left of the unit and a single multi-way circular button to their right.
The buttons are as follows.%
The main controls of this player are a four-way button on the right below
the screen, and two round buttons to the left of it. Hold the \dap{} with
these controls on the bottom and facing you.
On the left hand side, the higher of the two small buttons is the \ButtonOn{},
the lower of the two buttons is the \ButtonMenu{} button. The large circular
button on the right - push towards the top serves as \ButtonPlay{}, push towards
the left is called \ButtonLeft{}, push towards the right \ButtonRight{} and push
towards the bottom is labelled \ButtonStop{}.
button on the right contains, clockwise from the top, the \ButtonPlay{},
the \ButtonRight{}, the \ButtonStop{}, and the \ButtonLeft{} buttons.
On the top on the \dap{} is the headphone jack on the left and the Line-Out
jack on the right. On the bottom of the \dap{} is the Line-In jack on the left,
the DC-In jack on the right, and the USB connector in the centre.
}
%
\opt{recorder}{
@ -372,6 +395,10 @@ described in detail in the following paragraph.
below the \ButtonPlay{} button there is the \ButtonDown{} button placed. In the row
of three rectangular buttons the following buttons can be found (from left to right):
\ButtonFOne{}, \ButtonFTwo{} and \ButtonFThree{}.
On the top of the \dap{} is the headphone jack on the left and the Line-Out jack on
the right. On the bottom of the \dap{} is the Line-In jack on the left, the
DC-In jack on the right, and the USB connector in the centre.
}
\opt{recorderv2fm}{
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:
\note{The iriver firmware does not shut down properly when you turn it off,
it only goes to sleep. To get back into Rockbox when exiting from the
iriver firmware, you will need to reset the player by \opt{h10}{inserting a
pin in the reset hole}\opt{h10_5gb}{taking out battery}.}
pin in the reset hole}\opt{h10_5gb}{removing and reinserting the battery}.}
}
\opt{sansa}