Remove unused card_detect(), and make card_detect_target() static inline in each...
[kugel-rb.git] / manual / rockbox_interface / main.tex
blob834a0390533cee6f3a8a48bc75eea8dcae73a85d
1 % $Id$ %
2 \chapter{\label{ref:rockbox_interface}Quick Start}
3 \section{Basic Overview}
4 \subsection{The \daps{} controls}
6 \begin{center}
7 % include the front image. Using \specimg makes this fairly easy,
8 % but requires to use the exact value of \specimg in the filename!
9 % The extension is selected in the preamble, so no further \ifpdfoutput
10 % is necessary.
11 \includegraphics[height=8cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-front}
12 \opt{m3}{% replace with HAVEREMOTEKEYMAP when the h100 file exists or change specimg
13 \end{center}
14 % spacing between the two pictures, could possibly be improved
15 \begin{center}
16 \includegraphics[height=5.6cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-remote}
18 \end{center}
20 Throughout this manual, the buttons on the \dap{} are labelled according to the
21 picture above. Whenever a button name is prefixed by ``Long'', a long press of
22 approximately one second should be performed on that button. The buttons are
23 described in detail in the following paragraph.
25 \blind{
26 Additional information for blind users is available on the Rockbox website at
27 \wikilink{BlindFAQ}.
30 \opt{h100}{
31 Hold or lay the \dap{} so that the side with the joystick and LCD is facing
32 towards you, and the curved side is at the top. The joystick functions as
33 the \ButtonUp{}, \ButtonRight{}, \ButtonLeft{}, and \ButtonDown{} buttons when
34 pressed in the appropriate direction. Pressing the joystick down functions as
35 \ButtonSelect{}.
36 On the right side of the \dap{} are the \ButtonOn{}, \ButtonOff{},
37 \ButtonMode{} buttons, and the \ButtonHold{} switch. When this switch is
38 switched towards the bottom of the \dap{}, hold is on, and none of the other
39 buttons have any effect.
41 On the left side is the \ButtonRec{} button. Above that is the internal microphone.
43 On the top panel of the \dap{}, from left to right, you can find the
44 following: headphone mini jack plug, remote port, Optical line-in, Optical Line-out.
46 On the bottom panel of the \dap{}, from left to right, you can find the
47 following: power jack, reset switch, and USB port. In the event that your
48 \dap{} hard locks, you can reset it by inserting a paper clip into the hole
49 where the reset switch is.}
51 \opt{h300}{
52 Hold or lay the \dap{} so that the side with the button pad and
53 LCD is facing towards you. The buttons on the button pad are as follows: top
54 left corner: \ButtonOn{}, bottom left corner: \ButtonOff{}, top right corner:
55 \ButtonRec, bottom right corner: \ButtonMode{}. In the center of the button pad
56 is a button labelled \ButtonSelect{}. Surrounding the \ButtonSelect{} button are
57 the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{}, and \ButtonRight{} buttons.
59 On the top panel of the \dap{}, from left to right, you can find the
60 following: headphone mini jack plug, remote port, Line-in, Line-out.
62 On the left hand side of the \dap{} is the internal microphone. Just underneath
63 this is a small hole, the reset switch. In the event that your \dap{} hard locks,
64 you can reset it by inserting a paper clip into the hole where the reset switch
65 is.
67 On the right hand side of the \dap{} is the \ButtonHold{} switch. When this is
68 switched towards the bottom of the \dap{}, hold is on, and none of the other
69 buttons have any effect.
71 On the bottom panel of the \dap{}, from left to right, you can find the
72 following: power jack and two USB ports. The USB port on the right is used
73 to connect your \dap{} to your computer. The USB port on the left is not
74 used in Rockbox.
77 \opt{ipod4g,ipodcolor,ipodvideo,ipodmini}{
78 The main controls on the \dap{} are a slightly indented scroll wheel
79 with a flat round button in the center. Hold the \dap{} with these controls
80 facing you.
82 The top of the player will have the following, from left to
83 right:
84 \opt{ipod4g,ipodcolor}{remote connector, headphone jack, \ButtonHold{}
85 switch.}
86 \opt{ipodvideo}{\ButtonHold{} switch, headphone jack.}
87 \opt{ipodmini}{\ButtonHold{} switch, remote connector, headphone jack.}
89 The dock connector that is used to connect your \dap{} to your computer is on
90 the bottom panel of the \dap{}.
92 The button in the middle of the wheel is called \ButtonSelect{}. You can
93 operate the wheel by pressing the top, bottom, left or right sections,
94 or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is
95 \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
96 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
97 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
98 counterclockwise. Note that the wheel is sensitive, so you will need to move
99 slowly at first and get a feel for how it works.
101 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
102 hold is on, and none of the other controls do anything. Be sure
103 \ButtonHold{} is off before trying to use your player.
106 \opt{ipod3g}{
107 The main controls on the \dap{} are a slightly indented touch wheel
108 with a flat round button in the center, and four buttons in a row above the
109 touch wheel. Hold the \dap{} with these controls
110 facing you.
112 The top of the player will have the following, from left to
113 right: remote connector, headphone jack, \ButtonHold{} switch.
115 The dock connector that is used to connect your \dap{} to your computer is on
116 the bottom panel of the \dap{}.
118 The button in the middle of the wheel is called \ButtonSelect{}. You can
119 operate the wheel by sliding your finger around it. The row of
120 buttons consists of, from left to right, the \ButtonLeft{},
121 \ButtonMenu{}, \ButtonPlay{}, and \ButtonRight{} buttons.
122 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
123 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
124 counterclockwise. Note that the wheel is sensitive, so you will need to move
125 slowly at first and get a feel for how it works.
127 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
128 hold is on, and none of the other controls do anything. Be sure
129 \ButtonHold{} is off before trying to use your player.
132 \opt{ipod1g2g}{
133 The main controls on the \dap{} are a slightly indented wheel
134 with a flat round button in the center, and four buttons surrounding
135 it. On the 1st generation iPod, this wheel physically turns. On the
136 2nd generation iPod, this wheel is touch-sensitive. Hold the \dap{} with these controls
137 facing you.
139 The top of the player will have the following, from left to
140 right: FireWire port, headphone jack, \ButtonHold{} switch.
142 The FireWire port is used to connect your \dap{} to the computer and
143 to charge its battery via a wall charger.
145 The button in the middle of the wheel is called \ButtonSelect{}. You can
146 operate the wheel by turning it, or sliding your finger around
147 it. The top is \ButtonMenu{}, the bottom is \ButtonPlay{}, the left
148 is \ButtonLeft{}, and the right is \ButtonRight{}.
149 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
150 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
151 counterclockwise. Note that the wheel is sensitive, so you will need to move
152 slowly at first and get a feel for how it works.
154 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
155 hold is on, and none of the other controls do anything. Be sure
156 \ButtonHold{} is off before trying to use your player.
159 \opt{ipodnano,ipodnano2g}{
160 The main controls on the \dap{} are a slightly indented wheel with a
161 flat round button in the center. Hold the \dap{} with these controls on the
162 top surface. There is a \ButtonHold{} switch at one end, and
163 headphone and dock connector at the other; be sure the end with the
164 switch is facing away from you.
166 The button in the middle of the wheel is called \ButtonSelect{}. You can
167 operate the wheel by pressing the top, bottom, left or right sections,
168 or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is
169 \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
170 When the manual says to \ButtonScrollFwd{}, it means to slide your finger
171 clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
172 counterclockwise. Note that the wheel is sensitive, so you will need to move
173 slowly at first and get a feel for how it works.
175 Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
176 hold is on, and none of the other controls do anything; be sure \ButtonHold{} is
177 off before trying to use your player.
180 \opt{ondio}{
181 The main characteristic of the Ondio case is the indent on its lower right side,
182 which is the MMC slot. Holding the \dap{} with this slot in the described position
183 you'll find the following:
185 On the curved top, from left to right, are the headphone jack,
186 the \ButtonOff{} button,%
187 \opt{recording}{ and the line in jack}.
188 Apart from the already mentioned MMC slot, you will find the USB connector on
189 the \daps{} right side. Below the LCD, at approximately the center of the \dap{},
190 there is the main button pad of the \dap{}. The centre of the button pad dips inward
191 and helps to operate the directional keys from there. Located on a two-way button
192 strip are the \ButtonLeft{} and \ButtonRight{} keys, with \ButtonUp{} above it
193 and \ButtonDown{} below it. The raised button positioned in the lower left of this
194 round crosspad is labelled \ButtonMenu{}.
197 \opt{h10,h10_5gb}{
198 Hold or lay the \dap{} so that the side with the scroll pad and
199 LCD is facing towards you. In the centre below the lcd is the scroll pad. It
200 is oriented vertically. Touching the top and bottom half of it acts as the
201 \ButtonScrollUp{} and \ButtonScrollDown{} buttons respectively. On the left
202 of the scroll pad is the \ButtonLeft{} button and on the right is the
203 \ButtonRight{} button.
205 There are three buttons on the right hand side of the \dap{}. From top to
206 bottom, they are: \ButtonRew{}, \ButtonPlay{} and \ButtonFF{}. On the left
207 hand side is the \ButtonPower{} button.
209 On the top panel of the \dap{}, from left to right, you can find the
210 following: \ButtonHold{} switch, \opt{h10}{reset pin hole, }remote port and
211 headphone mini jack plug.
213 On the bottom panel of the \dap{} is the data cable port.}
215 \opt{gigabeatf}{
216 \note{The following description is for the Gigabeat F, but can also apply for the
217 Gigabeat X. The Gigabeat F is slightly larger and more rectangular shaped, while the
218 Gigabeat X is smaller and has a slightly tapered back.}
220 Hold the \dap{} with the screen on top and the controls on the right hand side.
221 Below the screen is a cross-shaped touch sensitive pad which contains the
222 \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and \ButtonRight{} controls. On the
223 Gigabeat X, this pad will feel slightly raised up, while it will feel slightly
224 sunken in on the Gigabeat F. On the top of the unit, from left to right, are the
225 power socket, the \ButtonHold{} switch, and the headphone socket. The
226 \ButtonHold{} switch puts the \dap{} into hold mode when it is switched to the
227 right of the unit. The buttons will have no effect when this is the case.
229 Starting from the left hand side on the bottom of the unit, nearer to the front
230 than the back, is a recessed switch which
231 controls whether the battery is on or off. When this switch is to the left,
232 the battery is disconnected. This can be used for a hard reset of the unit,
233 or if the \dap{} is being placed in storage. Next to that is a connector for
234 the docking station and finally on the right hand side of the bottom of the
235 unit is a mini USB socket for connecting directly to USB.
237 Finally on the right hand side of the unit are some control buttons. Going from
238 the bottom of the unit to the top there is a small round \ButtonA{} buttton then a
239 rocker volume switch with of the \ButtonVolDown{} button below the \ButtonVolUp{}
240 button. Above that is are two more small round buttons, the \ButtonMenu{}
241 button and nearest to the top of the unit the \ButtonPower{} button, which is held
242 down to turn the \dap{} on or off. If you have a Gigabeat X, these buttons are small
243 metallic buttons that are place further up on the right hand side, and closer
244 together. The layout is still the same, however.}
246 \opt{gigabeats}{
247 Hold the \dap{} with the screen on top and the controls on the right hand side.
248 Directly below the bottom edge of the screen are two buttons, \ButtonBack{}
249 on the left and \ButtonMenu{} on the right. Below them is a cross-shaped pad
250 which contains the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{}, \ButtonRight{}
251 and \ButtonSelect{} controls.
252 On the top of the unit from left to right are the headphone socket and the
253 \ButtonHold{} switch. The \ButtonHold{} switch puts the \dap{} into
254 hold mode when it is switched to the right of the unit.
255 The buttons will have no effect when this is the case.
257 Starting from the left hand side on the bottom of the unit, nearer to the back
258 than the front, is a recessed switch which controls whether the battery is on
259 or off. When this switch is to the left, the battery is disconnected.
260 This can be used for a hard reset of the unit, or if the \dap{} is being placed
261 in storage. Next to that is a mini USB socket for connecting directly to USB,
262 and finally a custom connector, presumably for planned accessories which were
263 never released.
265 Finally on the right hand side of the unit are some control buttons and the power
266 connector. Going from the bottom of the unit to the top, there is the power
267 connector socket, followed by three small round buttons, the
268 \ButtonNext{} buttton, \ButtonPlay{} button, and \ButtonPrev{} button (from bottom
269 to top) then a rocker volume switch with of the \ButtonVolDown{} button below the
270 \ButtonVolUp{} button. Above that is one more small round button, the \ButtonPower{}
271 button, which is held down to turn the \dap{} on or off.}
273 \opt{mrobe100}{
274 Hold the \dap{} with the black front facing you such that the m:robe writing
275 is readable. Below the writing is the touch sensitive pad with the
276 \ButtonMenu{}, \ButtonPlay{}, \ButtonLeft{}, \ButtonRight{} and \ButtonDisplay
277 controls indicated by their symbols. The dotted center strip is devided in
278 three parts: \ButtonUp{}, \ButtonSelect{} and \ButtonDown. On the top of the
279 unit, on the right, is the \ButtonPower{} switch, which is held down to turn
280 the \dap{} on or off.
282 The \ButtonHold{} switch is located on the left of the \dap{}, below the
283 headphone socket. It puts the \dap{} into hold mode when it is switched to the
284 top of the unit. The buttons will have no effect when this is the case. On the
285 bottom of the unit, there is a connector for the docking station or the
286 proprietary USB connector for connecting directly to USB.}
288 \opt{x5,m5}{
289 The \dap{} is curved so that the end with the screen on it is thicker than the
290 other end. Hold the \dap{} wih the thick end towards the top and the screen
291 facing towards you. Half way up the front of the unit on the right hand side
292 is a four way joystick which is the \ButtonUp{}, \ButtonDown{},
293 \ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect{}.
295 On the right hand side of the \dap{} from top to bottom, first there is a two
296 way switch. the \ButtonPower{} button is activated by pushing this switch up,
297 and pushing this switch down until it clicks slightly will activate the
298 \ButtonHold{} button. When the switch is in this position, none of the other
299 keys will have an effect.
301 Below the switch is a lozenge shaped button which is the \ButtonRec{}
302 button, and below that the final button on this side of the unit, the
303 \ButtonPlay{} button. Just below this is a small hole which is difficult to
304 locate by touch which is the internal microphone. At the very bottom of
305 this side of the unit is the reset hole, which can be used to perform a hard
306 reset by inserting a paper clip.
308 On the bottom of the unit is the connector for the
309 \playerman{} subpack or dock. On the top of the unit is a charge
310 indicator light, which may feel a bit like a button, but is not.
312 From the top of the \dap{} on the left hand side is the headphone socket, then the
313 remote connector. Below this is a cover which protects the \opt{x5}{USB host
314 connector.}\opt{m5}{USB and charging connector}.}
316 \opt{e200,e200v2}{
317 Hold the \dap{} with the turning wheel at the front and bottom. On the bottom left
318 of the front of the \dap{} is a raised round button, the \ButtonPower{} button.
319 Above and to the left of this, on the outside of the turning wheel are four
320 buttons. These are the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and
321 \ButtonRight{} buttons. Inside the wheel is the \ButtonSelect{} button. Turning
322 the wheel to the right activates the \ButtonScrollFwd{} function, and to the
323 left, the \ButtonScrollBack{} function.
325 On the right of the unit is a slot for inserting flash cards. On the bottom is
326 the connector for the USB cable. On the left is the \ButtonRec{} button, and
327 on the top, there is the headphone socket to the right, and the \ButtonHold{}
328 switch. Moving this switch to the right activates hold mode in which none of the
329 other buttons have any effect. Just to the left of the \ButtonHold{} switch is a
330 small hole which contains the internal microphone.}
332 \opt{c200}{
333 Hold the \dap{} with the buttons on the right and the screen on the left. On
334 the right side of the unit, there is a series of four connected buttons that
335 form a square. The four sides of the square are the \ButtonUp{},
336 \ButtonDown{}, \ButtonLeft{} and \ButtonRight{} buttons, respectively. Inside
337 the square formed by these four buttons is the \ButtonSelect{} button. At the
338 bottom right corner of the square is a small separate button, the
339 \ButtonPower{} button.
341 Moving clockwise around the outside of the unit, on the top are the \ButtonVolUp{}
342 and \ButtonVolDown{} buttons, which control the volume of playback. The buttons can
343 be distinguished by a sunken triangle on the \ButtonVolDown{} button, and a
344 raised triangle on the \ButtonVolUp{} button. To the right of
345 the volume buttons on the top of the unit is the slot for inserting flash
346 memory cards. On the right side of the unit is the connector for the USB
347 cable. At center of the bottom of the \dap{} is the \ButtonRec{} button. To
348 the left of the \ButtonRec{} button is the \ButtonHold{} switch. Moving this
349 switch to the right activates hold mode, in which none of the other buttons
350 have any effect. On the lower left side of the unit is the headphone socket.
351 Immediately above the headphone socket is a lanyard loop and the microphone.
354 \opt{fuze}{
355 Hold the \dap{} with the controls on the bottom and the screen on the top. The main
356 controls are a scroll wheel with four clickable points and a button in the centre; pressing
357 this centre button functions as \ButtonSelect{}. Going clockwise from the top, the clickable
358 points on the wheel are the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{}
359 buttons. Turning the wheel clockwise is \ButtonScrollFwd{}, and turning it counter-clockwise
360 is \ButtonScrollBack{}. Immediately above and to the right of the wheel is the \ButtonHome{}
361 button.
363 On the lower left of the unit is a slot for inserting microSD cards. Immediately below that is
364 the opening for the microphone.
366 On the bottom of the unit is the connector for connecting a USB cable and the headphone jack.
367 On the lower right hand side of the unit is a two-way switch. Pressing this switch up acts as
368 \ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{} switch. When the
369 \ButtonHold{} switch is on, none of the other buttons have any effect.
372 \opt{clip}{
373 Hold the \dap{} with the controls on the bottom and the screen on the top. The main
374 controls are a four-way pad with a button in the centre; pressing this centre button
375 functions as \ButtonSelect{}. Going clockwise from the top, the four-way pad contains
376 the \ButtonUp{}, \ButtonRight{}, \ButtonDown{}, and \ButtonLeft{} buttons.
377 Immediately above and to the right of the four-way pad is the \ButtonHome{} button.
379 On the left hand panel is a two way switch. Pressing this switch up acts as
380 \ButtonPower{}, and clicking it down until it locks acts as the \ButtonHold{}
381 switch. When the \ButtonHold{} switch is on, none of the other buttons have any
382 effect. Immediately above the switch is a mini-USB port to connect the \dap{} to
383 a computer.
385 On the right hand panel is a two-way button that acts as \ButtonVolDown{} when
386 pressed on the bottom, and \ButtonVolUp{} when pressed on the top. Immediately
387 above this button is the headphone jack.
390 \opt{player}{
391 The main controls of this player are a four-way button on the right below
392 the screen, and two round buttons to the left of it. Hold the \dap{} with
393 these controls on the bottom and facing you.
395 On the left hand side, the higher of the two small buttons is the \ButtonOn{},
396 the lower of the two buttons is the \ButtonMenu{} button. The large circular
397 button on the right contains, clockwise from the top, the \ButtonPlay{},
398 the \ButtonRight{}, the \ButtonStop{}, and the \ButtonLeft{} buttons.
400 On the top on the \dap{} is the headphone jack on the left and the Line-Out
401 jack on the right. On the bottom of the \dap{} is the Line-In jack on the left,
402 the DC-In jack on the right, and the USB connector in the centre.
405 \opt{recorder}{
406 Holding the Jukebox in front of you, there should be three rectangular buttons
407 in a horizontal line towards the middle of the unit, and below this to the left
408 there is a circular four button array with the circular \ButtonPlay{} button
409 as a fifth button in the centre. These are the navigation controls. Below the
410 rectangular buttons and to the right of the circular buttons are two small round
411 buttons one above the other.
413 The \ButtonOn{} button is the topmost of the two buttons located below and to the
414 left of the navigation controls whereas the lower of these two is called \ButtonOff.
415 The small round button in the middle of the large circular button array is called
416 \ButtonPlay{} button. To the right of the \ButtonPlay{} button there is the
417 \ButtonRight{} button, left of it is the \ButtonLeft{}, above it \ButtonUp, and
418 below the \ButtonPlay{} button there is the \ButtonDown{} button placed. In the row
419 of three rectangular buttons the following buttons can be found (from left to right):
420 \ButtonFOne{}, \ButtonFTwo{} and \ButtonFThree{}.
422 On the top of the \dap{} is the headphone jack on the left and the Line-Out jack on
423 the right. On the bottom of the \dap{} is the Line-In jack on the left, the
424 DC-In jack on the right, and the USB connector in the centre.
426 \opt{recorderv2fm}{
427 Holding the Jukebox in front of you, there should be three rectangular buttons
428 in a horizontal line towards the middle of the unit, and below this centred on the
429 middle button there are four radial arc shaped buttons placed in a cross formation
430 with the circular play button as the centre of the cross. These are the navigation
431 controls. Below the cross and to the left are two other buttons.
433 The \ButtonOn{} button is the leftmost of the two buttons located below and to the
434 left of the navigation controls whereas the rightmost and little lower one of
435 these two is called \ButtonOff{}. The round button raised slightly higher than the
436 others in the centre of the navigation controls is the \ButtonPlay{} button. To
437 the right of the \ButtonPlay{} button there is the \ButtonRight{} button, left of
438 it is the \ButtonLeft{}, above it \ButtonUp{}, and below the \ButtonPlay{} button
439 there is the \ButtonDown{} button placed. In the row of three rectangular buttons
440 the following buttons can be found (from left to right): \ButtonFOne{}, \ButtonFTwo{}
441 and \ButtonFThree{}.
445 \subsection{Turning the \dap{} on and off}
446 To turn on and off your Rockbox enabled \dap{} use the following keys:
447 \begin{table}
448 \begin{btnmap}{}{}
449 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
450 \opt{IPOD_4G_PAD}{\ButtonMenu{} / \ButtonSelect}%
451 \opt{IPOD_3G_PAD}{\ButtonMenu{} / \ButtonPlay}%
452 \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
453 {Long \ButtonOn}%
454 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS}
455 {\ButtonPower}%
456 \opt{HAVEREMOTEKEYMAP}{&
457 \opt{IRIVER_RC_H100_PAD}{\ButtonRCOn}%
459 & Start Rockbox\\
460 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Long \ButtonOff}%
461 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonPlay}%
462 \opt{ONDIO_PAD,recorderv2fm}{Long \ButtonOff}%
463 \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
464 \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
465 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS}%
466 {Long \ButtonPower}%
467 \opt{HAVEREMOTEKEYMAP}{&
468 \opt{IRIVER_RC_H100_PAD}{Long \ButtonRCStop}%
470 & Shutdown Rockbox\\
471 \end{btnmap}
472 \end{table}
474 \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings.
476 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
477 ,SANSA_C200_PAD,IRIVER_H10_PAD,IPOD_4G_PAD,GIGABEAT_PAD}{%
478 If you have problems with your settings, such as accidentally having
479 set the colours to black on black, they can be reset at boot time. See
480 the Reset Settings in \reference{ref:manage_settings_menu} for details.
483 \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD,GIGABEAT_PAD,IPOD_4G_PAD,SANSA_E200_PAD%
484 ,SANSA_C200_PAD,IAUDIO_X5_PAD,IAUDIO_M5_PAD,IPOD_3G_PAD}{%
485 In the unlikely event of a software failure, hardware poweroff or reset can be
486 performed by holding down \opt{PLAYER_PAD}{\ButtonStop}\opt{RECORDER_PAD,ONDIO_PAD}
487 {\ButtonOff}\opt{GIGABEAT_PAD}{the battery switch}\opt{IPOD_4G_PAD}
488 {\ButtonMenu + \ButtonSelect}\opt{IPOD_3G_PAD}{\ButtonMenu + \ButtonPlay}
489 \opt{SANSA_E200_PAD,SANSA_C200_PAD,IAUDIO_X5_PAD,IAUDIO_M5_PAD}
490 {\ButtonPower} until the \dap{} shuts off or reboots.
492 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_M3_PAD,IRIVER_H10_PAD,MROBE100_PAD}{%
493 In the unlikely event of a software failure, a hardware reset can be
494 performed by inserting a paperclip gently into the Reset hole.
497 \nopt{gigabeatf,m3,m5,x5,archos}
499 \subsection{Starting the original firmware}
500 \label{ref:Dualboot}
501 \opt{ipod4g,ipodcolor,ipodvideo,ipodnano,ipodnano2g,ipodmini}
503 Rockbox has a dual-boot feature. To boot into the original firmware, shut
504 down the device as described above. Turn on the \ButtonHold{} switch
505 immediately after turning the player on. The Apple logo will
506 display for a few seconds as Rockbox loads the original firmware.
508 You can also load the original firmware by shutting down the device,
509 then clicking the \ButtonHold{} switch on and connecting the iPod
510 to your computer.
512 Regardless of which method you use to boot to the original firmware, you can
513 return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonSelect{}
514 simultaneously until the player hard resets.
517 \opt{ipod1g2g,ipod3g}
519 Rockbox has a dual-boot feature. To boot into the original firmware, shut
520 down the device as described above. Turn on the \ButtonHold{} switch
521 immediately after turning the player on. The Apple logo will
522 display for a few seconds as Rockbox loads the original firmware.
524 You can also load the original firmware by shutting down the device,
525 then clicking the \ButtonHold{} switch on and connecting the iPod
526 to your computer.
528 Regardless of which method you use to boot to the original firmware, you can
529 return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonPlay{}
530 simultaneously until the player hard resets.
533 \opt{h100,h300}
535 Rockbox has a dual-boot feature. To boot into the original firmware,
536 when the \dap{} is turned off, press and hold the \ButtonRec{} button,
537 and then press the \ButtonOn{} button.
540 \opt{h10,h10_5gb}
542 Rockbox has a dual-boot feature. It loads the original firmware from
543 the file \fname{/System/OF.mi4}. To boot into the original firmware,
544 press and hold the \ButtonLeft{} button while turning on the player.
545 \note{The iriver firmware does not shut down properly when you turn it off,
546 it only goes to sleep. To get back into Rockbox when exiting from the
547 iriver firmware, you will need to reset the player by \opt{h10}{inserting a
548 pin in the reset hole}\opt{h10_5gb}{removing and reinserting the battery}.}
551 \opt{sansa,sansaAMS}
553 Rockbox has a dual-boot feature. To boot into the original firmware,
554 press and hold the \ButtonLeft{} button while turning on the player.
557 \opt{sansaAMS}
559 The player will boot into the original firmware if it is powered
560 by a USB connection. This feature may be removed in the future when
561 Rockbox is able to handle USB transfers natively.
564 \opt{mrobe100}
566 Rockbox has a dual-boot feature. It loads the original firmware from
567 the file \fname{/System/OF.mi4}. To boot into the original firmware,
568 when the \dap{} is turned off, press the \ButtonPower{} button once and then
569 a second time when the m:robe bootlogo (the headphone) appears. Hold the
570 \ButtonPower{} button until you see the ``Loading original firmware...''
571 message on the screen.
574 \opt{gigabeats}
576 Rockbox has a dual-boot feature. To boot into the original firmware,
577 turn the \ButtonHold{} switch on just after turning on the \dap{}.
581 \subsection{Putting music on your \dap{}}
583 \note{Due to a bug in some OS X versions, the \dap{} can not be mounted, unless
584 the USB HID feature is disabled. See \reference{ref:USB_HID} for more
585 information.\newline
588 With the \dap{} connected to the computer as an MSC/UMS device (like a
589 USB Drive), music files can be put on the player via any standard file
590 transfer method that you would use to copy files between drives (e.g. Drag 'n' Drop).
591 The default directory structure that is assumed by some parts of Rockbox
592 \opt{albumart}{%
593 (album art searching, and missing-tag fallback in some WPSes) uses the
594 parent directory of a song as the Album name, and the parent directory of
595 that folder as the Artist name. While files may be organized however you
596 like, see \reference{ref:album_art} for the requirements for Album
597 Art to work properly, and WPSes may display information incorrectly if your
598 files are not properly tagged, and you have your music organized in a way
599 different than they assume when attempting to guess the Artist and Album
600 names from your filetree.
602 \nopt{albumart}{%
603 (missing-tag fallback in some WPSes) uses the parent directory of a song
604 as the Album name, and the parent directory of that folder as the Artist
605 name. While files may be organized however you like, WPSes may display
606 information incorrectly if your files are not properly tagged, and you have
607 your music organized in a way different than they assume when attempting to
608 guess the Artist and Album names from your filetree.
610 \opt{swcodec}{
611 See \reference{ref:Supportedaudioformats} for a list of supported audio
612 formats.
615 \subsection{The first contact}
617 After you have first started the \dap{}, you'll be presented by the
618 \setting{Main Menu}. From this menu you can reach every function of Rockbox,
619 for more information (see \reference{ref:main_menu}). To browse the files
620 on you \dap{}, select \setting{Files} (see \reference{ref:file_browser}), and to
621 browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
622 comments, etc.} of your audio files, select \setting{Database} (see
623 \reference{ref:database}).
625 \subsection{Basic controls}
626 When browsing files and moving through menus you usually get a list view
627 presented. The navigation in these lists are usually the same and should be
628 pretty intuitive.
629 In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
630 the selection. Use \ActionStdOk{} to select an item. When browsing the file
631 system selecting an audio file plays it. The view switches to the ``While
632 playing screen'', usually abbreviated as ``WPS'' (see \reference{ref:WPS}. The
633 dynamic playlist gets replaced with the contents of the current directory. This
634 way you can easily treat directories as playlists. The created dynamic playlist can
635 be extended or modified while playing. This is also known as
636 ``on-the-fly playlist''.
637 To go back to the \setting{File Browser} stop the playback with the
638 \ActionWpsStop{} button or return to the file browser while keeping playback
639 running using \ActionWpsBrowse{}.
640 In list views you can go back one step with \ActionTreeParentDirectory.
642 \subsection{Basic concepts}
643 \subsubsection{Playlists}
644 Rockbox is playlist oriented. This means that every time you play an audio file,
645 a so-called ``dynamic playlist'' is generated, unless you play a saved
646 playlist. You can modify the dynamic playlist while playing and also save
647 it to a file. If you do not want to use playlists you can simply play your
648 files directory based.
649 Playlists are covered in detail in \reference{ref:working_with_playlists}.
651 \subsubsection{Menu}
652 From the menu you can customise Rockbox. Rockbox itself is very customisable.
653 Also there are some special menus for quick access to frequently used
654 functions.
656 \subsubsection{Context Menu}
657 Some views, especially the file browser and the WPS have a context menu.
658 From the file browser this can be accessed with \ActionStdContext{}.
659 The contents of the context menu vary, depending on the situation it gets
660 called. The context menu itself presents you with some operations you can
661 perform with the currently highlighted file. In the file browser this is
662 the file (or directory) that is highlighted by the cursor. From the WPS this is
663 the currently playing file. Also there are some actions that do not apply
664 to the current file but refer to the screen from which the context menu
665 gets called. One example is the playback menu, which can be called using
666 the context menu from within the WPS.
668 \section{Customising Rockbox}
669 Rockbox' User Interface can be customised using ``Themes''. Themes usually
670 only affect the visual appearance, but an advanced user can create a theme
671 that also changes various other settings like file view, LCD settings and
672 all other settings that can be modified using \fname{.cfg} files. This topic
673 is discussed in more detail in \reference{ref:manage_settings}.
674 The Rockbox distribution comes with some themes that should look nice on
675 your \dap{}.
676 \opt{lcd_bitmap}{
677 \note{Some of the themes shipped with Rockbox need additional
678 fonts from the fonts package, so make sure you installed them.
679 Also, if you downloaded additional themes from the Internet make sure you
680 have the needed fonts installed as otherwise the theme may get displayed
681 garbled.}
684 \opt{usb_charging}
686 \section{Charging}
688 The \dap{} can be powered over USB without connecting to your
689 computer by holding \ActionStdUsbCharge{} while plugging in. This
690 allows you to continue using the \dap{} normally.
693 \input{rockbox_interface/browsing_and_playing.tex}