The threading model should be set from configure, not config.h.
[maemo-rb.git] / manual / rockbox_interface / main.tex
blobcf450acce985bdc3a622493d20f0cf5b1d7caeef
1 % $Id$ %
2 \chapter{\label{ref:rockbox_interface}Quick Start}
3 \section{Basic Overview}
4 \subsection{The \daps{} controls}
6 % include the front image. Using \specimg makes this fairly easy,
7 % but requires to use the exact value of \specimg in the filename!
8 % The extension is selected in the preamble, so no further \ifpdfoutput
9 % is necessary.
11 % The check looks for a png file -- we use png for the HTML manual, so that
12 % format needs to be present. It can also be used for the pdf manual, but
13 % usually we provide a pdf version of the file for that. Picking the correct
14 % one is done by LaTeX automatically, but for checking the filename we need to
15 % specify the extension.
16 \begin{center}
17 \IfFileExists{rockbox_interface/images/\specimg-front.png}
18 {\includegraphics[height=8cm,width=10cm,keepaspectratio=true]%
19 {rockbox_interface/images/\specimg-front}
21 {\color{red}{\textbf{WARNING!} Image not found}%
22 \typeout{Warning: missing front image}
24 \end{center}
25 \opt{HAVEREMOTEKEYMAP}{
26 % spacing between the two pictures, could possibly be improved
27 \begin{center}
28 \IfFileExists{rockbox_interface/images/\specimg-remote.png}
29 {\includegraphics[height=5.6cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-remote}
31 {\color{red}{\textbf{WARNING!} Image not found}%
32 \typeout{Warning: missing remote image}
34 \end{center}
37 Throughout this manual, the buttons on the \dap{} are labelled according to the
38 picture above.
39 \opt{touchscreen}{
40 The areas of the touchscreen in the 3$\times$3 grid mode are in turn referred as follows:
41 \begin{table}
42 \centering
43 \begin{tabular}{|c|c|c|}
44 \hline
45 \TouchTopLeft & \TouchTopMiddle & \TouchTopRight \\ [5ex]
46 \hline
47 \TouchMidLeft & \TouchCenter & \TouchMidRight \\ [5ex]
48 \hline
49 \TouchBottomLeft & \TouchBottomMiddle & \TouchBottomRight \\ [5ex]
50 \hline
51 \end{tabular}
52 \end{table}
54 Whenever a button name is prefixed by ``Long'', a long press of approximately
55 one second should be performed on that button. The buttons are described in
56 detail in the following paragraph.
57 \blind{%
58 Additional information for blind users is available on the Rockbox website at
59 \wikilink{BlindFAQ}.
62 \opt{iriverh100}{
63 Hold or lay the \dap{} so that the side with the joystick and LCD is facing
64 towards you, and the curved side is at the top. The joystick functions as
65 the \ButtonUp{}, \ButtonRight{}, \ButtonLeft{}, and \ButtonDown{} buttons when
66 pressed in the appropriate direction. Pressing the joystick down functions as
67 \ButtonSelect{}.
68 On the right side of the \dap{} are the \ButtonOn{}, \ButtonOff{},
69 \ButtonMode{} buttons, and the \ButtonHold{} switch. When this switch is
70 switched towards the bottom of the \dap{}, hold is on, and none of the other
71 buttons have any effect.
73 On the left side is the \ButtonRec{} button. Above that is the internal microphone.
75 On the top panel of the \dap{}, from left to right, you can find the
76 following: headphone mini jack plug, remote port, Optical line-in, Optical line-out.
78 On the bottom panel of the \dap{}, from left to right, you can find the
79 following: power jack, reset switch, and USB port. In the event that your
80 \dap{} hard locks, you can reset it by inserting a paper clip into the hole
81 where the reset switch is.}
83 \opt{iriverh300}{
84 Hold or lay the \dap{} so that the side with the button pad and
85 LCD is facing towards you. The buttons on the button pad are as follows: top
86 left corner: \ButtonOn{}, bottom left corner: \ButtonOff{}, top right corner:
87 \ButtonRec, bottom right corner: \ButtonMode{}. In the center of the button pad
88 is a button labelled \ButtonSelect{}. Surrounding the \ButtonSelect{} button are
89 the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{}, and \ButtonRight{} buttons.
91 On the top panel of the \dap{}, from left to right, you can find the
92 following: headphone mini jack plug, remote port, line-in, line-out.
94 On the left hand side of the \dap{} is the internal microphone. Just underneath
95 this is a small hole, the reset switch. In the event that your \dap{} hard locks,
96 you can reset it by inserting a paper clip into the hole where the reset switch
97 is.
99 On the right hand side of the \dap{} is the \ButtonHold{} switch. When this is
100 switched towards the bottom of the \dap{}, hold is on, and none of the other
101 buttons have any effect.
103 On the bottom panel of the \dap{}, from left to right, you can find the
104 following: power jack and two USB ports. The USB port on the right is used
105 to connect your \dap{} to your computer. The USB port on the left is not
106 used in Rockbox.
109 \opt{mpiohd200}{
110 Hold or lay the \dap{} so that the side with the LCD is facing towards you.
111 On the right hand side there is a rocker switch at the top which serves as
112 \ButtonRew{} and \ButtonFF{} when rocked up or down, respectively.
113 Pressing the rocker in functions as the \ButtonFunc{} button. Below the rocker
114 there are the \ButtonRec{} and \ButtonPlay{} buttons. At the bottom of the
115 right panel there is the \ButtonHold{} switch. When this is switched towards the
116 bottom of the \dap{}. hold is on, and none of the other buttons have any effect.
118 On the top panel of the \dap{} there is another rocker which serves as the
119 \ButtonVolDown{} and \ButtonVolUp{} buttons when pressed to the left or right,
120 respectively.
122 On the left hand side of the \dap{} there is a headphone mini jack plug at the top
123 and a small hole at the bottom, the reset switch. In the event that your \dap{}
124 hard locks, you can reset it by inserting a paper clip into the hole where the
125 reset switch is.
127 On the bottom panel of the \dap{}, from left to right, you can find the
128 following: power jack, line-in jack and USB port (under rubber cover).
131 \opt{ipod4g,ipodcolor,ipodvideo,ipodmini}{
132 The main controls on the \dap{} are a slightly indented scroll wheel
133 with a flat round button in the center. Hold the \dap{} with these controls
134 facing you.
136 The top of the player will have the following, from left to
137 right:
138 \opt{ipod4g,ipodcolor}{remote connector, headphone socket, \ButtonHold{}
139 switch.}
140 \opt{ipodvideo}{\ButtonHold{} switch, headphone socket.}
141 \opt{ipodmini}{\ButtonHold{} switch, remote connector, headphone socket.}
143 The dock connector that is used to connect your \dap{} to your computer is on
144 the bottom panel of the \dap{}.
146 The button in the middle of the wheel is called \ButtonSelect{}. You can
147 operate the wheel by pressing the top, bottom, left or right sections,
148 or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is
149 \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
150 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
151 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
152 counterclockwise. Note that the wheel is sensitive, so you will need to move
153 slowly at first and get a feel for how it works.
155 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
156 hold is on, and none of the other controls do anything. Be sure
157 \ButtonHold{} is off before trying to use your player.
160 \opt{ipod3g}{
161 The main controls on the \dap{} are a slightly indented touch wheel
162 with a flat round button in the center, and four buttons in a row above the
163 touch wheel. Hold the \dap{} with these controls
164 facing you.
166 The top of the player will have the following, from left to
167 right: remote connector, headphone socket, \ButtonHold{} switch.
169 The dock connector that is used to connect your \dap{} to your computer is on
170 the bottom panel of the \dap{}.
172 The button in the middle of the wheel is called \ButtonSelect{}. You can
173 operate the wheel by sliding your finger around it. The row of
174 buttons consists of, from left to right, the \ButtonLeft{},
175 \ButtonMenu{}, \ButtonPlay{}, and \ButtonRight{} buttons.
176 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
177 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
178 counterclockwise. Note that the wheel is sensitive, so you will need to move
179 slowly at first and get a feel for how it works.
181 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
182 hold is on, and none of the other controls do anything. Be sure
183 \ButtonHold{} is off before trying to use your player.
186 \opt{ipod1g2g}{
187 The main controls on the \dap{} are a slightly indented wheel
188 with a flat round button in the center, and four buttons surrounding
189 it. On the 1st generation iPod, this wheel physically turns. On the
190 2nd generation iPod, this wheel is touch-sensitive. Hold the \dap{} with these controls
191 facing you.
193 The top of the player will have the following, from left to
194 right: FireWire port, headphone socket, \ButtonHold{} switch.
196 The FireWire port is used to connect your \dap{} to the computer and
197 to charge its battery via a wall charger.
199 The button in the middle of the wheel is called \ButtonSelect{}. You can
200 operate the wheel by turning it, or sliding your finger around
201 it. The top is \ButtonMenu{}, the bottom is \ButtonPlay{}, the left
202 is \ButtonLeft{}, and the right is \ButtonRight{}.
203 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
204 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
205 counterclockwise. Note that the wheel is sensitive, so you will need to move
206 slowly at first and get a feel for how it works.
208 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
209 hold is on, and none of the other controls do anything. Be sure
210 \ButtonHold{} is off before trying to use your player.
213 \opt{ipodnano,ipodnano2g}{
214 The main controls on the \dap{} are a slightly indented wheel with a
215 flat round button in the center. Hold the \dap{} with these controls on the
216 top surface. There is a \ButtonHold{} switch at one end, and
217 headphone and dock connector at the other; be sure the end with the
218 switch is facing away from you.
220 The button in the middle of the wheel is called \ButtonSelect{}. You can
221 operate the wheel by pressing the top, bottom, left or right sections,
222 or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is
223 \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
224 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
225 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
226 counterclockwise. Note that the wheel is sensitive, so you will need to move
227 slowly at first and get a feel for how it works.
229 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
230 hold is on, and none of the other controls do anything; be sure \ButtonHold{} is
231 off before trying to use your player.
234 \opt{ondio}{
235 The main characteristic of the Ondio case is the indent on its lower right side,
236 which is the MMC slot. Holding the \dap{} with this slot in the described position
237 you'll find the following:
239 On the curved top, from left to right, are the headphone socket,
240 the \ButtonOff{} button,%
241 \opt{recording}{ and the line-in jack}.
242 Apart from the already mentioned MMC slot, you will find the USB connector on
243 the \daps{} right side. Below the LCD, at approximately the center of the \dap{},
244 there is the main button pad of the \dap{}. The centre of the button pad dips inward
245 and helps to operate the directional keys from there. Located on a two-way button
246 strip are the \ButtonLeft{} and \ButtonRight{} keys, with \ButtonUp{} above it
247 and \ButtonDown{} below it. The raised button positioned in the lower left of this
248 round crosspad is labelled \ButtonMenu{}.
251 \opt{iriverh10,iriverh10_5gb}{
252 Hold or lay the \dap{} so that the side with the scroll pad and
253 LCD is facing towards you. In the centre below the lcd is the scroll pad. It
254 is oriented vertically. Touching the top and bottom half of it acts as the
255 \ButtonScrollUp{} and \ButtonScrollDown{} buttons respectively. On the left
256 of the scroll pad is the \ButtonLeft{} button and on the right is the
257 \ButtonRight{} button.
259 There are three buttons on the right hand side of the \dap{}. From top to
260 bottom, they are: \ButtonRew{}, \ButtonPlay{} and \ButtonFF{}. On the left
261 hand side is the \ButtonPower{} button.
263 On the top panel of the \dap{}, from left to right, you can find the
264 following: \ButtonHold{} switch, \opt{iriverh10}{reset pin hole, }remote port
265 and headphone mini jack plug.
267 On the bottom panel of the \dap{} is the data cable port.}
269 \opt{gigabeatf}{
270 \note{The following description is for the Gigabeat F, but can also apply for the
271 Gigabeat X. The Gigabeat F is slightly larger and more rectangular shaped, while the
272 Gigabeat X is smaller and has a slightly tapered back.}
274 Hold the \dap{} with the screen on top and the controls on the right hand side.
275 Below the screen is a cross-shaped touch sensitive pad which contains the
276 \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and \ButtonRight{} controls. On the
277 Gigabeat X, this pad will feel slightly raised up, while it will feel slightly
278 sunken in on the Gigabeat F. On the top of the unit, from left to right, are the
279 power socket, the \ButtonHold{} switch, and the headphone socket. The
280 \ButtonHold{} switch puts the \dap{} into hold mode when it is switched to the
281 right of the unit. The buttons will have no effect when this is the case.
283 Starting from the left hand side on the bottom of the unit, nearer to the front
284 than the back, is a recessed switch which
285 controls whether the battery is on or off. When this switch is to the left,
286 the battery is disconnected. This can be used for a hard reset of the unit,
287 or if the \dap{} is being placed in storage. Next to that is a connector for
288 the docking station and finally on the right hand side of the bottom of the
289 unit is a mini USB socket for connecting directly to USB.
291 Finally on the right hand side of the unit are some control buttons. Going from
292 the bottom of the unit to the top there is a small round \ButtonA{} buttton then a
293 rocker volume switch with of the \ButtonVolDown{} button below the \ButtonVolUp{}
294 button. Above that is are two more small round buttons, the \ButtonMenu{}
295 button and nearest to the top of the unit the \ButtonPower{} button, which is held
296 down to turn the \dap{} on or off. If you have a Gigabeat X, these buttons are small
297 metallic buttons that are place further up on the right hand side, and closer
298 together. The layout is still the same, however.}
300 \opt{gigabeats}{
301 Hold the \dap{} with the screen on top and the controls on the right hand side.
302 Directly below the bottom edge of the screen are two buttons, \ButtonBack{}
303 on the left and \ButtonMenu{} on the right. Below them is a cross-shaped pad
304 which contains the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{}, \ButtonRight{}
305 and \ButtonSelect{} controls.
306 On the top of the unit from left to right are the headphone socket and the
307 \ButtonHold{} switch. The \ButtonHold{} switch puts the \dap{} into
308 hold mode when it is switched to the right of the unit.
309 The buttons will have no effect when this is the case.
311 Starting from the left hand side on the bottom of the unit, nearer to the back
312 than the front, is a recessed switch which controls whether the battery is on
313 or off. When this switch is to the left, the battery is disconnected.
314 This can be used for a hard reset of the unit, or if the \dap{} is being placed
315 in storage. Next to that is a mini USB socket for connecting directly to USB,
316 and finally a custom connector, presumably for planned accessories which were
317 never released.
319 Finally on the right hand side of the unit are some control buttons and the power
320 connector. Going from the bottom of the unit to the top, there is the power
321 connector socket, followed by three small round buttons, the
322 \ButtonNext{} buttton, \ButtonPlay{} button, and \ButtonPrev{} button (from bottom
323 to top) then a rocker volume switch with of the \ButtonVolDown{} button below the
324 \ButtonVolUp{} button. Above that is one more small round button, the \ButtonPower{}
325 button, which is held down to turn the \dap{} on or off.}
327 \opt{mrobe100}{
328 Hold the \dap{} with the black front facing you such that the m:robe writing
329 is readable. Below the writing is the touch sensitive pad with the
330 \ButtonMenu{}, \ButtonPlay{}, \ButtonLeft{}, \ButtonRight{} and \ButtonDisplay
331 controls indicated by their symbols. The dotted center strip is devided in
332 three parts: \ButtonUp{}, \ButtonSelect{} and \ButtonDown. On the top of the
333 unit, on the right, is the \ButtonPower{} switch, which is held down to turn
334 the \dap{} on or off.
336 The \ButtonHold{} switch is located on the left of the \dap{}, below the
337 headphone socket. It puts the \dap{} into hold mode when it is switched to the
338 top of the unit. The buttons will have no effect when this is the case. On the
339 bottom of the unit, there is a connector for the docking station or the
340 proprietary USB connector for connecting directly to USB.}
342 \opt{iaudiom5,iaudiox5}{
343 The \dap{} is curved so that the end with the screen on it is thicker than the
344 other end. Hold the \dap{} wih the thick end towards the top and the screen
345 facing towards you. Half way up the front of the unit on the right hand side
346 is a four way joystick which is the \ButtonUp{}, \ButtonDown{},
347 \ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect{}.
349 On the right hand side of the \dap{} from top to bottom, first there is a two
350 way switch. the \ButtonPower{} button is activated by pushing this switch up,
351 and pushing this switch down until it clicks slightly will activate the
352 \ButtonHold{} button. When the switch is in this position, none of the other
353 keys will have an effect.
355 Below the switch is a lozenge shaped button which is the \ButtonRec{}
356 button, and below that the final button on this side of the unit, the
357 \ButtonPlay{} button. Just below this is a small hole which is difficult to
358 locate by touch which is the internal microphone. At the very bottom of
359 this side of the unit is the reset hole, which can be used to perform a hard
360 reset by inserting a paper clip.
362 On the bottom of the unit is the connector for the
363 \playerman{} subpack or dock. On the top of the unit is a charge
364 indicator light, which may feel a bit like a button, but is not.
366 From the top of the \dap{} on the left hand side is the headphone socket, then the
367 remote connector. Below this is a cover which protects the \opt{iaudiox5}{USB
368 host connector.}\opt{iaudiom5}{USB and charging connector}.}
370 \opt{e200,e200v2}{
371 Hold the \dap{} with the turning wheel at the front and bottom. On the bottom left
372 of the front of the \dap{} is a raised round button, the \ButtonPower{} button.
373 Above and to the left of this, on the outside of the turning wheel are four
374 buttons. These are the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and
375 \ButtonRight{} buttons. Inside the wheel is the \ButtonSelect{} button. Turning
376 the wheel to the right activates the \ButtonScrollFwd{} function, and to the
377 left, the \ButtonScrollBack{} function.
379 On the right of the unit is a slot for inserting flash cards. On the bottom is
380 the connector for the USB cable. On the left is the \ButtonRec{} button, and
381 on the top, there is the headphone socket to the right, and the \ButtonHold{}
382 switch. Moving this switch to the right activates hold mode in which none of the
383 other buttons have any effect. Just to the left of the \ButtonHold{} switch is a
384 small hole which contains the internal microphone.}
386 \opt{c200,c200v2}{
387 Hold the \dap{} with the buttons on the right and the screen on the left. On
388 the right side of the unit, there is a series of four connected buttons that
389 form a square. The four sides of the square are the \ButtonUp{},
390 \ButtonDown{}, \ButtonLeft{} and \ButtonRight{} buttons, respectively. Inside
391 the square formed by these four buttons is the \ButtonSelect{} button. At the
392 bottom right corner of the square is a small separate button, the
393 \ButtonPower{} button.
395 Moving clockwise around the outside of the unit, on the top are the \ButtonVolUp{}
396 and \ButtonVolDown{} buttons, which control the volume of playback. The buttons can
397 be distinguished by a sunken triangle on the \ButtonVolDown{} button, and a
398 raised triangle on the \ButtonVolUp{} button. To the right of
399 the volume buttons on the top of the unit is the slot for inserting flash
400 memory cards. On the right side of the unit is the connector for the USB
401 cable. At center of the bottom of the \dap{} is the \ButtonRec{} button. To
402 the left of the \ButtonRec{} button is the \ButtonHold{} switch. Moving this
403 switch to the right activates hold mode, in which none of the other buttons
404 have any effect. On the lower left side of the unit is the headphone socket.
405 Immediately above the headphone socket is a lanyard loop and the microphone.
408 \opt{fuze,fuzev2}{
409 Hold the \dap{} with the controls on the bottom and the screen on the top. The main
410 controls are a scroll wheel with four clickable points and a button in the centre; pressing
411 this centre button functions as \ButtonSelect{}. Going clockwise from the top, the clickable
412 points on the wheel are the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{}
413 buttons. Turning the wheel clockwise is \ButtonScrollFwd{}, and turning it counter-clockwise
414 is \ButtonScrollBack{}. Immediately above and to the right of the wheel is the \ButtonHome{}
415 button.
417 On the lower left of the unit is a slot for inserting microSD cards. Immediately below that is
418 the opening for the microphone.
420 On the bottom of the unit is the connector for connecting a USB cable and the headphone socket.
421 On the lower right hand side of the unit is a two-way switch. Pressing this switch up acts as
422 \ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{} switch. When the
423 \ButtonHold{} switch is on, none of the other buttons have any effect.
426 \opt{clipplus,clipv1,clipv2}{
427 Hold the \dap{} with the controls on the bottom and the screen on the top. The main
428 controls are a four-way pad with a button in the centre; pressing this centre button
429 functions as \ButtonSelect{}. Going clockwise from the top, the four-way pad contains
430 the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{} buttons.
431 Immediately above and to the right of the four-way pad is the \ButtonHome{} button.
434 \opt{clipplus}{
435 The \ButtonPower{} button is on the top of the \dap{}, towards the right side.
437 At the bottom of the right side of the \dap{} is a slot for microSD cards.
438 Above this slot on the right side is the headphone socket.
440 On the left hand panel is a two-way button that acts as \ButtonVolDown{} when
441 pressed on the bottom, and \ButtonVolUp{} when pressed on the top. Immediately
442 above the switch is a mini-USB port to connect the \dap{} to a computer.
446 \opt{clipv1,clipv2}{
447 On the left hand panel is a two way switch. Pressing this switch up acts as
448 \ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{}
449 switch. When the \ButtonHold{} switch is on, none of the other buttons have any
450 effect. Immediately above the switch is a mini-USB port to connect the \dap{} to
451 a computer.
453 On the right hand panel is a two-way button that acts as \ButtonVolDown{} when
454 pressed on the bottom, and \ButtonVolUp{} when pressed on the top. Immediately
455 above this button is the headphone socket.
458 \opt{vibe500}{
459 Hold or lay the \dap{} so that the side with the controls and
460 LCD is facing towards you. Below the LCD is the touch sensitive pad with the \ButtonMenu{},
461 \ButtonPlay{}, \ButtonLeft{}, \ButtonRight{} controls and the scroll pad in the centre. The
462 scroll pad is oriented vertically between the \ButtonOK{} and \ButtonCancel{} buttons.
463 Sliding a finger up or down the scroll pad acts as \ButtonUp{} and \ButtonDown{} respectively.
464 Note that the scroll pad is sensitive, so you will need to move
465 slowly at first and get a feel for how it works.
467 There are two buttons on the right hand side of the \dap{}: \ButtonPower{} on the top and
468 \ButtonRec{} underneath. Under these buttons, from top to bottom you can find: USB connector,
469 power connector and the reset hole if you need to perform a hardware reset.
471 The \ButtonHold{} switch is located on the left hand side of the \dap{}. Note that when the
472 \ButtonHold{} switch is moved towards the top of the \dap{}, hold is turned on and all the
473 other controls are disabled. Be sure \ButtonHold{} is off before trying to use your player.
475 On the top on the \dap{} is the internal microphone on the left and the line-in socket on the
476 right, near the headphone socket.}
478 \opt{player}{
479 The main controls of this player are a four-way button on the right below
480 the screen, and two round buttons to the left of it. Hold the \dap{} with
481 these controls on the bottom and facing you.
483 On the left hand side, the higher of the two small buttons is the \ButtonOn{},
484 the lower of the two buttons is the \ButtonMenu{} button. The large circular
485 button on the right contains, clockwise from the top, the \ButtonPlay{},
486 the \ButtonRight{}, the \ButtonStop{}, and the \ButtonLeft{} buttons.
488 On the top on the \dap{} is the headphone socket on the left and the line-out
489 jack on the right. On the bottom of the \dap{} is the line-in jack on the left,
490 the DC-In jack on the right, and the USB connector in the centre.
493 \opt{recorder}{
494 Holding the Jukebox in front of you, there should be three rectangular buttons
495 in a horizontal line towards the middle of the unit, and below this to the left
496 there is a circular four button array with the circular \ButtonPlay{} button
497 as a fifth button in the centre. These are the navigation controls. Below the
498 rectangular buttons and to the right of the circular buttons are two small round
499 buttons one above the other.
501 The \ButtonOn{} button is the topmost of the two buttons located below and to the
502 left of the navigation controls whereas the lower of these two is called \ButtonOff.
503 The small round button in the middle of the large circular button array is called
504 \ButtonPlay{} button. To the right of the \ButtonPlay{} button there is the
505 \ButtonRight{} button, left of it is the \ButtonLeft{}, above it \ButtonUp, and
506 below the \ButtonPlay{} button there is the \ButtonDown{} button placed. In the row
507 of three rectangular buttons the following buttons can be found (from left to right):
508 \ButtonFOne{}, \ButtonFTwo{} and \ButtonFThree{}.
510 On the top of the \dap{} is the headphone socket on the left and the line-out jack on
511 the right. On the bottom of the \dap{} is the line-in jack on the left, the
512 DC-In jack on the right, and the USB connector in the centre.
514 \opt{recorderv2fm}{
515 Holding the Jukebox in front of you, there should be three rectangular buttons
516 in a horizontal line towards the middle of the unit, and below this centred on the
517 middle button there are four radial arc shaped buttons placed in a cross formation
518 with the circular play button as the centre of the cross. These are the navigation
519 controls. Below the cross and to the left are two other buttons.
521 The \ButtonOn{} button is the leftmost of the two buttons located below and to the
522 left of the navigation controls whereas the rightmost and little lower one of
523 these two is called \ButtonOff{}. The round button raised slightly higher than the
524 others in the centre of the navigation controls is the \ButtonPlay{} button. To
525 the right of the \ButtonPlay{} button there is the \ButtonRight{} button, left of
526 it is the \ButtonLeft{}, above it \ButtonUp{}, and below the \ButtonPlay{} button
527 there is the \ButtonDown{} button placed. In the row of three rectangular buttons
528 the following buttons can be found (from left to right): \ButtonFOne{}, \ButtonFTwo{}
529 and \ButtonFThree{}.
533 \subsection{Turning the \dap{} on and off}
534 \opt{cowond2}{Rockbox has a dual-boot feature with the original firmware being
535 the default.\\}
536 To turn on and off your Rockbox enabled \dap{} use the following keys:
537 \begin{btnmap}
538 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
539 \opt{MPIO_HD200_PAD,MPIO_HD300_PAD}{Long \ButtonPlay}%
540 \opt{IPOD_4G_PAD}{\ButtonMenu{} / \ButtonSelect}%
541 \opt{IPOD_3G_PAD}{\ButtonMenu{} / \ButtonPlay}%
542 \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
543 {Long \ButtonOn}%
544 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,ONDA_VX777_PAD%
545 ,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS,PBELL_VIBE500_PAD%
546 ,SANSA_FUZEPLUS_PAD%
547 }{\ButtonPower}%
548 \opt{COWON_D2_PAD} {\ButtonPower{}, then \ButtonHold}%
549 \opt{ONDA_VX777_PAD} {\ButtonPower{}}%
551 \opt{HAVEREMOTEKEYMAP}{
552 \opt{IRIVER_RC_H100_PAD}{\ButtonRCOn}%
553 \opt{IAUDIO_RC_PAD}{\ButtonRCPlay}
555 Start Rockbox
558 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Long \ButtonOff}%
559 \opt{MPIO_HD200_PAD,MPIO_HD300_PAD}{Long \ButtonPlay}%
560 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonPlay}%
561 \opt{ONDIO_PAD,recorderv2fm}{Long \ButtonOff}%
562 \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
563 \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
564 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD%
565 ,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS,COWON_D2_PAD%
566 ,PBELL_VIBE500_PAD,ONDA_VX777_PAD,SANSA_FUZEPLUS_PAD%
567 }{Long \ButtonPower}%
569 \opt{HAVEREMOTEKEYMAP}{
570 \opt{IRIVER_RC_H100_PAD}{Long \ButtonRCStop}%
571 \opt{IAUDIO_RC_PAD}{Long \ButtonRCPlay}
573 Shutdown Rockbox
575 \end{btnmap}
577 \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings.
579 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
580 ,SANSA_C200_PAD,IRIVER_H10_PAD,IPOD_4G_PAD,GIGABEAT_PAD}{%
581 If you have problems with your settings, such as accidentally having
582 set the colours to black on black, they can be reset at boot time. See
583 the Reset Settings in \reference{ref:manage_settings_menu} for details.
586 \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD,GIGABEAT_PAD,IPOD_4G_PAD,SANSA_E200_PAD%
587 ,SANSA_C200_PAD,IAUDIO_X5_PAD,IAUDIO_M5_PAD,IPOD_3G_PAD}{%
588 In the unlikely event of a software failure, hardware poweroff or reset can be
589 performed by holding down \opt{PLAYER_PAD}{\ButtonStop}\opt{RECORDER_PAD,ONDIO_PAD}
590 {\ButtonOff}\opt{GIGABEAT_PAD}{the battery switch}\opt{IPOD_4G_PAD}
591 {\ButtonMenu{} and \ButtonSelect{} simultaneously}%
592 \opt{IPOD_3G_PAD}{\ButtonMenu{} and \ButtonPlay{} simultaneously}%
593 \opt{SANSA_E200_PAD,SANSA_C200_PAD,IAUDIO_X5_PAD,IAUDIO_M5_PAD}
594 {\ButtonPower} until the \dap{} shuts off or reboots.
596 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_M3_PAD,IRIVER_H10_PAD,MROBE100_PAD
597 ,PBELL_VIBE500_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD}{%
598 In the unlikely event of a software failure, a hardware reset can be
599 performed by inserting a paperclip gently into the Reset hole.
602 \nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos}
604 \subsection{Starting the original firmware}
605 \label{ref:Dualboot}
606 \opt{ipod4g,ipodcolor,ipodvideo,ipodnano,ipodnano2g,ipodmini}
608 Rockbox has a dual-boot feature. To boot into the original firmware, shut
609 down the device as described above. Turn on the \ButtonHold{} switch
610 immediately after turning the player on. The Apple logo will
611 display for a few seconds as Rockbox loads the original firmware.
613 You can also load the original firmware by shutting down the device,
614 then clicking the \ButtonHold{} switch on and connecting the iPod
615 to your computer.
617 Regardless of which method you use to boot to the original firmware, you can
618 return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonSelect{}
619 simultaneously until the player hard resets.
622 \opt{ipod1g2g,ipod3g}
624 Rockbox has a dual-boot feature. To boot into the original firmware, shut
625 down the device as described above. Turn on the \ButtonHold{} switch
626 immediately after turning the player on. The Apple logo will
627 display for a few seconds as Rockbox loads the original firmware.
629 You can also load the original firmware by shutting down the device,
630 then clicking the \ButtonHold{} switch on and connecting the iPod
631 to your computer.
633 Regardless of which method you use to boot to the original firmware, you can
634 return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonPlay{}
635 simultaneously until the player hard resets.
638 \opt{iriverh100,iriverh300}
640 Rockbox has a dual-boot feature. To boot into the original firmware,
641 when the \dap{} is turned off, press and hold the \ButtonRec{} button,
642 and then press the \ButtonOn{} button.
644 \opt{fuzeplus}
646 Rockbox has a dual-boot feature. To boot into the original firmware,
647 when the \dap{} is turned off, press and hold the \ButtonVolDown{} button,
648 and then press and hold the \ButtonPower{} button while keeping the
649 \ButtonVolDown{} button pressed. After 5 to 10 seconds the original
650 firmware should boot.
652 It is also possible to connect your \dap{} to your computer using the
653 original firmware. To do so you may press and hold the \ButtonVolDown{}
654 button and connect your device to the computer while keeping the
655 \ButtonVolDown{} button pressed. After 5 to 10 seconds the original
656 firmware should boot into USB mode.
658 \opt{mpiohd200,mpiohd300}
660 Rockbox has a dual-boot feature. To boot into the original firmware,
661 when the \dap{} is turned off, press and hold the \ButtonRec{} button,
662 and then press the \ButtonPlay{} button. This will bring you to the
663 short menu where you can choose among: Boot Rockbox, Boot MPIO firmware
664 and Shutdown. Select the option you need with \ButtonRew{} and \ButtonFF{}
665 and confirm with long \ButtonPlay{}.
667 \opt{iriverh10,iriverh10_5gb}
669 Rockbox has a dual-boot feature. It loads the original firmware from
670 the file \fname{/System/OF.mi4}. To boot into the original firmware,
671 press and hold the \ButtonLeft{} button while turning on the player.
672 \note{The iriver firmware does not shut down properly when you turn it off,
673 it only goes to sleep. To get back into Rockbox when exiting from the
674 iriver firmware, you will need to reset the player by \opt{iriverh10}{%
675 inserting a pin in the reset hole}\opt{iriverh10_5gb}{removing and
676 reinserting the battery}.}
679 \opt{sansa,sansaAMS}
681 Rockbox has a dual-boot feature. To boot into the original firmware,
682 press and hold the \ButtonLeft{} button while turning on the player.
685 \opt{clipv2,fuzev2,clipplus}
687 \note{Rockbox does not boot into the original firmware when powered by
688 a USB connection. Older versions of Rockbox do not provide USB support.
689 If you have such a version installed you need to manually boot into the
690 original firmware for data transfer via USB.}
693 \opt{mrobe100}
695 Rockbox has a dual-boot feature. It loads the original firmware from
696 the file \fname{/System/OF.mi4}. To boot into the original firmware,
697 when the \dap{} is turned off, press the \ButtonPower{} button once and then
698 a second time when the m:robe bootlogo (the headphone) appears. Hold the
699 \ButtonPower{} button until you see the ``Loading original firmware...''
700 message on the screen.
703 \opt{gigabeats}
705 Rockbox has a dual-boot feature. To boot into the original firmware,
706 turn the \ButtonHold{} switch on just after turning on the \dap{}.
707 To return to Rockbox, shutdown the \dap{}, then turn the battery switch
708 on the bottom off then on again. Rockbox should now start.
711 \opt{cowond2}
713 Use \ButtonPower{} to boot the original \playerman{} firmware.
716 \opt{vibe500}
718 Rockbox has a dual-boot feature where it is possible to load the original firmware from
719 the file \fname{/System/OF.mi4}. To boot into the original firmware press and release
720 \ButtonPower{} and then immediately after the backlight turns on, press the \ButtonOK{}
721 button and keep it pressed until the original firmware starts.
724 \opt{ondavx777}
726 Rockbox has a dual-boot feature where it is possible to load the original firmware from
727 the file \fname{/SD/ccpmp.bin}. To boot into the original firmware press and release
728 \ButtonPower{} immediately after the Rockbox Logo appear on the screen.
732 \subsection{Putting music on your \dap{}}
734 \opt{usb_hid}{
735 \note{Due to a bug in some OS X versions, the \dap{} can not be mounted, unless
736 the USB HID feature is disabled. See \reference{ref:USB_HID} for more
737 information.\newline
741 With the \dap{} connected to the computer as an MSC/UMS device (like a
742 USB Drive), music files can be put on the player via any standard file
743 transfer method that you would use to copy files between drives (e.g. Drag-and-Drop).
744 Files may be placed wherever you like on the \dap{}, but it is strongly
745 suggested \emph{NOT} to put them in the \fname{/.rockbox} folder and instead
746 put them in any other folder, e.g. \fname{/}, \fname{/music} or \fname{/audio}.
747 The default directory structure that is assumed by some parts of Rockbox
748 \opt{albumart}{%
749 (album art searching, and missing-tag fallback in some WPSes) uses the
750 parent directory of a song as the Album name, and the parent directory of
751 that folder as the Artist name. WPSes may display information incorrectly if
752 your files are not properly tagged, and you have your music organized in a
753 way different than they assume when attempting to guess the Artist and Album
754 names from your filetree. See \reference{ref:album_art} for the requirements
755 for Album Art to work properly.
757 \nopt{albumart}{%
758 (missing-tag fallback in some WPSes) uses the parent directory of a song
759 as the Album name, and the parent directory of that folder as the Artist
760 name. WPSes may display
761 information incorrectly if your files are not properly tagged, and you have
762 your music organized in a way different than they assume when attempting to
763 guess the Artist and Album names from your filetree.
765 \opt{swcodec}{
766 See \reference{ref:Supportedaudioformats} for a list of supported audio
767 formats.
770 \subsection{The first contact}
772 After you have first started the \dap{}, you'll be presented by the
773 \setting{Main Menu}. From this menu you can reach every function of Rockbox,
774 for more information (see \reference{ref:main_menu}). To browse the files
775 on your \dap{}, select \setting{Files} (see \reference{ref:file_browser}), and to
776 browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
777 comments, etc.} of your audio files, select \setting{Database} (see
778 \reference{ref:database}).
780 \subsection{Basic controls}
781 When browsing files and moving through menus you usually get a list view
782 presented. The navigation in these lists are usually the same and should be
783 pretty intuitive.
784 In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
785 the selection. Use \ActionStdOk{} to select an item. \opt{wheel_acceleration}{
786 Note that the scroll speed is accelerating the faster you rotate the wheel.}
787 When browsing the file system selecting an audio file plays it. The view
788 switches to the ``While playing screen'', usually abbreviated as ``WPS'' (see
789 \reference{ref:WPS}. The dynamic playlist gets replaced with the contents of
790 the current directory. This way you can easily treat directories as playlists.
791 The created dynamic playlist can be extended or modified while playing. This is
792 also known as ``on-the-fly playlist''.
793 To go back to the \setting{File Browser} stop the playback with the
794 \ActionWpsStop{} button or return to the file browser while keeping playback
795 running using \ActionWpsBrowse{}.
796 In list views you can go back one step with \ActionTreeParentDirectory.
798 \subsection{Basic concepts}
799 \subsubsection{Playlists}
800 Rockbox is playlist oriented. This means that every time you play an audio file,
801 a so-called ``dynamic playlist'' is generated, unless you play a saved
802 playlist. You can modify the dynamic playlist while playing and also save
803 it to a file. If you do not want to use playlists you can simply play your
804 files directory based.
805 Playlists are covered in detail in \reference{ref:working_with_playlists}.
807 \subsubsection{Menu}
808 From the menu you can customise Rockbox. Rockbox itself is very customisable.
809 Also there are some special menus for quick access to frequently used
810 functions.
812 \subsubsection{Context Menu}
813 Some views, especially the file browser and the WPS have a context menu.
814 From the file browser this can be accessed with \ActionStdContext{}.
815 The contents of the context menu vary, depending on the situation it gets
816 called. The context menu itself presents you with some operations you can
817 perform with the currently highlighted file. In the file browser this is
818 the file (or directory) that is highlighted by the cursor. From the WPS this is
819 the currently playing file. Also there are some actions that do not apply
820 to the current file but refer to the screen from which the context menu
821 gets called. One example is the playback menu, which can be called using
822 the context menu from within the WPS.
824 \section{Customising Rockbox}
825 Rockbox' User Interface can be customised using ``Themes''. Themes usually
826 only affect the visual appearance, but an advanced user can create a theme
827 that also changes various other settings like file view, LCD settings and
828 all other settings that can be modified using \fname{.cfg} files. This topic
829 is discussed in more detail in \reference{ref:manage_settings}.
830 The Rockbox distribution comes with some themes that should look nice on
831 your \dap{}.
833 \opt{lcd_bitmap}{
834 \note{Some of the themes shipped with Rockbox need additional
835 fonts from the fonts package, so make sure you installed them.
836 Also, if you downloaded additional themes from the Internet make sure you
837 have the needed fonts installed as otherwise the theme may not display
838 properly.}
841 \nopt{ondio}{
842 \opt{usb_power}{
843 \section{USB Charging}
844 To charge your \dap{} over USB, hold any button while plugging it
845 in. This will prevent it from connecting to your computer and let you
846 continue to use it normally. Your \dap{} must already be in Rockbox for this
847 to function.
848 \nopt{fuzeplus}{
849 \note{Be aware that this button may still perform its normal function, so
850 it is recommended to use a button without harmful side effects, such as
851 \ActionStdUsbCharge{}.}
856 \opt{ondio}{
857 \section{USB Power}
859 To power your \dap{} over USB, hold \ActionStdUsbCharge{} while plugging it
860 in. This will prevent it from connecting to your computer and let you
861 continue to use it normally. Your \dap{} must already be in Rockbox for this
862 to function.
865 \input{rockbox_interface/browsing_and_playing.tex}