1.2 Getting more help

This manual is intended to be a comprehensive introduction to the Rockbox rmware. There is, however, more help available. The Rockbox website at http://www.rockbox.org/ contains very extensive documentation and guides written by members of the Rockbox community and this should be your rst port of call when looking for further help. If you cannot nd the information you are searching for on the Rockbox website there are a number of support channels you should have a look at. You can try the Rockbox forums located at http://forums.rockbox.org/. Another option are the mailing lists which can be found at http://www.rockbox.org/mail/. From that page you can subscribe to the lists and browse the archives. For searching the list archives simply use the search eld that is located on the left side of the website. Also you can ask on IRC. The main channel
for Rockbox is #rockbox on irc://irc.freenode.net. A bunch of helpful developers and users are usually around. Just join and ask if someone knows the answer youll usually get an answer pretty quickly. More information including IRC logs can be found at http://www.rockbox.org/irc/. We also have a web client for joining the rockbox IRC channel so there is no need for you to install additional software to your computer. If you think you have found a bug please make sure it actually is a bug and is still present in the most recent version of rockbox. You should try to conrm that by using the above mentioned support channels rst. After that you can submit that issue to our tracker. Refer to section D (page 145) for details on how to use the tracker.
1.3 Naming conventions and marks
We have some conventions especially on naming that are intended to be consistent throughout this manual. Manufacturer and product names are formatted in accordance with the standard rules of English grammar, e.g. Iriver playback is currently unsupported. Manufacturer and model names are proper nouns, and thus are written beginning with a capital letter. This manual has some parts that are marked with icons on the margin to help you nding important parts or parts you could skip. The following icons are used: Note: This indicates a note. A note starts always with the text Note. For easier nding of notes we have put this an icon in the margin like here. Notes are used to mark information that could help you or indicate a possible weirdness in rockbox that would be explained. Warning: This is a warning. In contrast to notes mentioned above, a warning should be taken more seriously. While ignoring notes will not cause any serious damage ignoring warnings could cause serious damage. If you are new to rockbox you should really read the warnings before doing anything that is warned about. This icon marks a section that is intended especially for the blind and visually impaired. As they cannot read the manual in the same way sighted people do we have added some additional descriptions. If you are not blind or visually impaired you most likely can completely skip these blocks. To make this easier, there is an icon shown in the margin on the right. Links to the wiki are abbreviated by the name of the wiki page. Those names are still linked so you can simply follow them like any other link in this manual. If you want to access a wiki page manually go to Z http://www.rockbox.org/wiki/ and type the page name in the Go box at the top of the page. Links to wiki pages are also indicated by the symbol Z in front of the page name.

3.1.5 The rst contact

After you have rst started the player youll be presented by the M AIN M ENU. From this menu you can reach every function of Rockbox, for more information (see section 5.1 (page 38)). To browse the les on you player select F ILES (see section 4.1 (page 22)), and to browse in a view that is based on the meta-data1 of your audio les, select D ATABASE (see section 4.2 (page 26)).
ID3 Tags, Vorbis comments, etc.

3.1.6 Basic controls

When browsing les and moving through menus you usually get a list view presented. The navigation in these lists are usually the same and should be pretty intuitive. In the tree view use Scroll Down and Scroll Up to move around the selection. Use Select to select an item. When browsing the le system selecting an audio le plays it. The view switches to the While playing screen, usually abbreviated as WPS (see section 4.3 (page 28). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists. The created dynamic playlist can be extended or modied while playing. This is also known as on-the-y playlist. To go back to the F ILE B ROWSER stop the playback with the Long Play button or return to the le browser while keeping playback running using Cancel. In list views you can go back one step with Cancel.

3.1.7 Basic concepts

Playlists Rockbox is playlist oriented. This means that every time you play an audio le, a socalled dynamic playlist is generated, unless you play a saved playlist. You can modify the dynamic playlist while playing and also save it to a le. If you do not want to use playlists you can simply play your les directory based. Playlists are covered in detail in section 4.4 (page 33). Menu From the menu you can customise Rockbox. Rockbox itself is very customisable. Also there are some special menus for quick access to frequently used functions. Context Menu Some views, especially the le browser and the WPS have a context menu. From the le browser this can be accessed with Long Select. The contents of the context menu vary, depending on the situation it gets called. The context menu itself presents you with some operations you can perform with the currently highlighted le. In the le browser this is the le (or directory) that is highlighted by the cursor. From the WPS this is the currently playing le. Also there are some actions that do not apply to the current le but refer to the screen from which the context menu gets called. One example is the playback menu, which can be called using the context menu from within the WPS.

Long Play Long Select Power Long Cancel

4.1.2 Context Menu

Figure 4.2: The Context Menu
The C ONTEXT M ENU allows you to perform certain operations on les or directories. To access the C ONTEXT M ENU, position the selector over a le or directory and access the context menu with Long Select. Note: The C ONTEXT M ENU is a context sensitive menu. If the C ONTEXT M ENU is invoked on a le, it will display options available for les. If the C ONTEXT M ENU is invoked on a directory, it will display options for directories. The C ONTEXT M ENU contains the following options (unless otherwise noted, each option pertains both to les and directories): Playlist. Enters the P LAYLIST S UBMENU (see section 4.4.3 (page 35)).
Playlist Catalog. Enters the P LAYLIST C ATALOG S UBMENU (see section 4.4.2 (page 34)). Rename. This function lets the user modify the name of a le or directory. Cut. Copies the name of the currently selected le or directory to the clipboard and marks it to be cut. Copy. Copies the name of the currently selected le or directory to the clipboard and marks it to be copied. Paste. Only visible if a le or directory name is on the clipboard. When selected it will move or copy the clipboard to the current directory. Delete. Deletes the currently selected le. This option applies only to les, and not to directories. Rockbox will ask for conrmation before deleting a le. Press Select to conrm deletion or any other key to cancel. Delete Directory. Deletes the currently selected directory and all of the les and subdirectories it may contain. Deleted directories cannot be recovered. Use this feature with caution! Set As Backdrop. Set the selected bmp le as background image. The bitmaps need to meet the conditions explained in section 11.1.6 (page 125). Open with. Runs a viewer plugin on the le. Normally, when a le is selected in Rockbox, Rockbox automatically detects the le type and runs the appropriate plugin. The O PEN W ITH function can be used to override the default action and select a viewer by hand. For example, this function can be used to view a text le even if the le has a non-standard extension (i.e., the le has an extension of something other than.txt). See section 10.3 (page 103) for more details on viewers. Create Directory. Create a new directory in the current directory on the disk. Properties. Shows properties such as size and the time and date of the last modication for the selected le. If used on a directory, the number of les and subdirectories will be shown, as well as the total size. Set As Recording Directory. Save recordings in the selected directory. Add to Shortcuts. Adds a link to the selected item in the shortcuts.link le. If the le does not already exist it will be created in the root directory. Note that if you create a shortcut to a le, Rockbox will not open it upon selecting, but simply bring you to its location in the F ILE B ROWSER.

Like the context menu for the F ILE B ROWSER, the WPS C ONTEXT M ENU allows you quick access to some often used functions: Playlist The P LAYLIST submenu allows you to view, save, search and reshufe the current playlist. To change settings for the P LAYLIST V IEWER press Power while viewing the playlist to bring up the P LAYLIST V IEWER M ENU. Playlist Viewer Menu Show Icons. This toggles display of the icon for the currently selected playlist entry and the icon for moving a playlist entry Show Indicies. This toggles display of the line numbering for the playlist Track Display. This toggles between lename only and full path for playlist entries Save Current Playlist. Allows the current playlist to be saved as a.m3u playlist le Playlist catalog View catalog. This lists all playlists that are part of the Playlist catalog. You can load a new playlist directly from this list. Add to playlist. Adds the currently playing le to a playlist. Select the playlist you want the le to be added to and it will get appended to that playlist. Add to new playlist. Similar to the previous entry this will add the currently playing track to a playlist. You need to enter a name for the new playlist rst. Sound Settings This is a shortcut to the S OUND S ETTINGS M ENU, where you can congure volume, bass, treble, and other settings affecting the sound of your music. See section 6 (page 46) for more information.
C HAPTER 4. B ROWSING AND PLAYING Playback Settings
This is a shortcut to the P LAYBACK S ETTINGS M ENU, where you can congure shufe, repeat, party mode, study mode and other settings affecting the playback of your music. Rating The menu entry is only shown if G ATHER R UNTIME I NFORMATION is enabled. It allows the asignment of a personal rating value (0 10) to a track which can be displayed in the WPS and used in the Database browser. Press Select to increment the value. The value wraps at 10. Bookmarks This allows you to create a bookmark in the currently-playing track. Show Track Info
Figure 4.4: The track info viewer
This screen is accessible from the WPS screen, and provides a detailed view of all the identity information about the current track. This info is known as meta data and is stored in audio le formats to keep information on artist, album etc. To access this screen, press Play+Select. Open With. This O PEN W ITH function is the same as the O PEN W ITH function in the le browsers C ONTEXT M ENU. Delete Delete the currently playing le.
C HAPTER 4. B ROWSING AND PLAYING Pitch
The P ITCH S CREEN allows you to change the pitch and (at the same time) the playback speed of your player. The pitch value can be adjusted between 50% and 200%. 50% means half the normal playback speed and the pitch that is an octave lower than the normal pitch. 200% means double playback speed and the pitch that is an octave higher than the normal pitch. It is not possible to change the pitch without changing the playback speed and vice versa. Changing the pitch can be done in two modes: procentual and semitone. Initially (after the player is switched on), procentual mode is active. Key Power Scroll Up / Scroll Down Long Scroll Up / Long Scroll Down Next / Prev Play Cancel Action Toggle pitch changing mode Increase / Decrease pitch by 0.1% (in procentual mode) or a semitone (in semitone mode) Increase / Decrease pitch by 1% (in procentual mode) or a semitone (in semitone mode) Temporarily increase / decrease pitch by 2.0% Reset pitch to 100% Leave the Pitch Screen

4.4 Working with Playlists
4.4.1 Playlist terminology
Some common terms that are used in Rockbox when referring to playlists: Directory. A playlist! One of the keys to getting the most out of Rockbox is understanding that Rockbox always considers the song that it is playing to be part of a playlist, and in some situations, Rockbox will create a playlist automatically. For example, if you are playing the contents of a directory, Rockbox will automatically create a playlist containing all songs in it. This means that just about anything that is described in this chapter with respect to playlists also applies to directories. Dynamic playlist. A dynamic playlist is a playlist that is created On the y. Any time you insert or queue tracks using the P LAYLIST SUBMENU (see section 4.4.3 (page 35)), you are creating (or adding to) a dynamic playlist. Insert. In Rockbox, to I NSERT an item into a playlist means putting an item into a playlist and leaving it there, even after it is played. As you will see later in this chapter, Rockbox can I NSERT into a playlist in several places.
Queue. In Rockbox, to Q UEUE a song means to put the song into a playlist and then to remove the song from the playlist once it has been played. The only difference between I NSERT and Q UEUE is that the Q UEUE option removes the song from the playlist once it has been played, and the I NSERT option does not.

4.4.2 Creating playlists

Rockbox can create playlists in four different ways. By selecting (playing) a song from the File Browser Whenever a song is selected from the F ILE B ROWSER with Select, Rockbox will automatically create a playlist containing all of the songs in that directory and start playback with the selected song. Note: If you already have created a dynamic playlist, playing a new song will erase the current dynamic playlist and create a new one. If you want to add a song to the current playlist rather than erasing the current playlist, see the section below on how to add music to a playlist. By using Insert and Queue functions If playback is stopped, the I NSERT and Q UEUE functions can be used as described in 4.4.3 to create a new playlist instead of adding to an existing one. This will erase any dynamic playlist. By using the Playlist catalog The P LAYLIST CATALOG makes it possible to modify and create playlists that are not currently playing. To do this select P LAYLIST CATALOG in the C ONTEXT M ENU. There you will have two choices, A DD TO PLAYLIST adds the selected track or directory to an existing playlist and A DD TO A NEW PLAYLIST creates a new playlist containing the selected track or directory. Note: All playlists in the P LAYLIST CATALOG are stored by default in the /Playlists directory in the root of your players disk and playlists stored in other locations are not included in the catalog. It is however possible to move existing playlists there (see section 4.1.2 (page 23)). By using the Main Menu To create a playlist containing all music on your player, you can use the C REATE P LAYLIST command in the P LAYLIST O PTIONS menu found in the M AIN M ENU. The created playlist will be named root.m3u and saved in the root of your players disk.

To set the Start Point (A) press Power + Prev. Setting the End Point (B) is done accordingly using Power + Next. To reset the markers press Power + Play. Play Selected First This setting controls what happens when you select a le for playback while shufe mode is on. If the P LAY S ELECTED F IRST setting is Y ES, the le you selected will be played rst. If this setting is N O, a random le in the directory will be played rst. Fast-Forward/Rewind These settings control the speed and acceleration during fast forward and rewind. The setting FF/RW M IN S TEP controls the initial speed and FF/RW A CCEL controls the acceleration. Anti-Skip Buffer This setting allows you to control how much music is stored in the players memory whilst playing a song, acting as a buffer against shock or playback problems. The player transfers the selected amount of the forthcoming song into its memory at high speed whilst you are playing the song. It keeps a rolling buffer, which keeps feeding more of the forthcoming song into memory as it goes along. If the player is knocked, shaken or jogged heavily while Rockbox is trying to read the hard drive, Rockbox might not be able to read the drive. Rockbox will retry over and over again until it succeeds, but may eventually reach the end of the memory buffer. When that happens, Rockbox must stop playing and wait for more data from the disk, which causes your music to skip. The anti-skip setting tells Rockbox how much extra buffer memory to spare to handle this situation. This setting therefore allows you to reduce the chances of there being a gap or pause during playback of songs. The anti-skip buffer can be set to various values between 5 seconds and 10 minutes. Note: Having a large anti-skip buffer tends to use more power, and may reduce your battery life. It is recommended to always use the lowest possible setting that allows correct and continuous playback. Fade on Stop/Pause Enables and disables a fade effect when you pause or stop playing a song. If the Fade on Stop/Pause option is set to Y ES, your music will fade out when you stop or pause playback, and fade in when you resume playback. Party Mode Enables unstoppable music playback. When new songs are selected, they are queued at the end of the current dynamic playlist instead of being played immediately. Pausing and stopping playback is disabled as well as skipping songs and launching plugins. Crossfade This setting enables a cross-fader. At the end of a song, the song will fade out as the next song fades in, creating a smooth transition between songs. The crossfade setting is particularly effective when the player is set on shufe.

7.6.3 Disk

Options relating to the hard disk. Disk Spindown: Rockbox has a timer that makes it spin down the hard disk after it is idle for a certain amount of time. This setting controls the amount of time between the last user activity and the time that the disk spins down. This idle time is only affected by user activity, like navigating through the F ILE B ROWSER. When the hard disk spins up to ll the audio buffer, it automatically spins down afterwards. Directory Cache: Rockbox has the ability to cache the contents of your drive in RAM. The D IRECTORY C ACHE takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, but it speeds up navigation in the le browser by eliminating the slight pause between the time a navigation button is pressed and the time Rockbox responds. Turning this setting on activates the directory cache, and turning it off deactivates the directory cache. Note: The rst time you enable the directory cache, Rockbox will request a reboot of the player and upon restarting take a few minutes to scan the drive. After this, the directory cache will work in the background.

7.6.4 Time and Date

Time related menu options. Set Time/Date: Set current time and date. Time Format: Choose 12 or 24 hour clock.

7.6.5 Idle Poweroff

Rockbox can be congured to turn off power after the unit has been idle for a dened number of minutes. The player is idle when playback is stopped or paused. It is not idle while the USB or charger is connected , or while recording. Settings are either O FF or 1 to 10 minutes in 1 minute steps. Then 15,30,45 and 60 minutes are available.

7.6.6 Wake-Up Alarm

This option turns the player off and then starts it up again at the specied time. Use Scroll Up and Scroll Down to adjust the minutes setting, Next and Prev to adjust the hours. Select conrms the alarm and shuts the player down, and Cancel cancels setting an alarm. If the player is turned on again before the alarm occurs, the alarm will be cancelled. Using this option disables the S LEEP T IMER.
7.6.7 Alarm Wake up Screen
This option controls what the player does when it is woken up by the alarm.

C HAPTER 10. P LUGINS

10 Plugins
Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the le extension.rock. Most of them can be started from B ROWSE P LUGINS in the M AIN M ENU. Viewer plugins get started automatically by opening an associated le (i.e. text les, chip8 games), or from the O PEN WITH option on the C ONTEXT M ENU.

10.1 Games

See also the Chip-8 emulator in section 10.3.2 (page 105) and Rockboy in section 10.3.7 (page 109).

10.1.1 Blackjack

Figure 10.1: Blackjack
Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difcult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down. For the full set of rules to the game, and other facinating information visit http://www.blackjackinfo.com/blackjack-rules.php
C HAPTER 10. P LUGINS Key Play Select Cancel Power Cancel / Select / Scroll Up / Scroll Down Play Next Prev Select Power Action In menu Start new game Resume saved game Show high scores Quit In game Enter betting amount Hit (Draw new card) Stay (End hand) Double down Save game Return to menu or cancel

10.1.2 BrickMania

Figure 10.2: BrickMania
BrickMania is a clone of the classic game Breakout. The aim of the game is to destroy all the bricks by hitting them with the ball once or more. Sometimes a special item falls down when you destroy a brick. For a special item to take effect, you must catch it with the paddle. Look out for the bad ones.

10.1.21 Sokoban

Figure 10.18: Sokoban
The object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves. The boxes can only be pushed, never pulled, and only one can be pushed at a time. Sokoban may be used as a viewer for viewing saved solutions and playing external level sets with the.sok extension. Level sets should be in the standard Sokoban text format or RLE (Run Length Encoded). For more information about the level format, see http://sokobano.de/wiki/index.php?title=Level format
C HAPTER 10. P LUGINS Key Scroll Up, Scroll Down, Cancel, Select Power Play+Scroll Down Play+Select Play+Scroll Up Prev Next Play Scroll Up/Scroll Down Cancel/Select Power Action In game Move the sokoban up, down, left, or right Menu Back to previous level Restart level Go to next level Undo last movement Redo previously undone move Solution playback Pause/resume Increase/decrease playback speed Go backward/forward (while paused) Quit
Some places where can you can nd level sets: http://www.sourcecode.se/sokoban/levels.php http://sokobano.de/en/levels.php Note that some level sets may contain levels that are too large for this version of Sokoban and are unplayable as a result.

10.1.22 Solitaire

Figure 10.19: Klondike solitaire
This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though
the name may not be familiar, the game itself certainly is. This is due in no small part to Microsofts inclusion of the the game in every version of Windows. Though popular, the odds of winning are rather low, perhaps one in thirty hands. For the full set of rules to the game, and other facinating information visit http://www.solitairecentral.com/rules/klondike.html Key Scroll Up / Scroll Down / Cancel / Select Play Long Cancel Next Prev Long Select Power Action Move Cursor around.
Select cards, move cards, reveal hidden cards. If a card was selected unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 nal colour stacks. Put the card on top of the remains stack on one of the nal colour stacks. Show menu

10.1.23 Spacerocks

Figure 10.20: Spacerocks
Spacerocks is a clone of the old arcade game Asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a UFO will appear shoot this for extra points.
C HAPTER 10. P LUGINS Key Prev Scroll Up Cancel/ Select Scroll Down Play Power Action Shoot Thrust Turn left/right Teleport Pause game Quit

10.1.24 Star

Dithering (default: off) Prevent banding effects in gradients by blending of colours. (only available on Sansa e200, Sansa c200 and Gigabeat F/X) Show FPS (default: off) This option displays (once a second - if your video is fullscreen this means it will get overwritten by the video and appear to ash once per second) the average number of frames decoded per second, the total number of frames skipped (see the Skip Frames option), the current time (in 100Hz ticks) and the time the current frame is due to be displayed. Limit FPS (default: on) With this option disabled, mpegplayer will display the video as fast as it can. Useful for benchmarking. Skip frames (default: on) This option causes mpegplayer to attempt to maintain realtime playback by skipping the display of frames - but these frames are still decoded. Disabling this option can cause loss of A/V sync. See this page in the Rockbox wiki for information on how to encode your videos to the supported format. ZPluginMpegplayer

10.3.6 PPM viewer

Open a PPM le in the F ILE B ROWSER to view it. ppmviewer exits when any button is pressed. Note: Both ASCII PPM (P3) and raw PPM (P6) les are supported. For more information about PPM les, see http://netpbm.sourceforge.net/doc/ppm. html

10.3.7 Rockboy

Figure 10.36: Rockboy
Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game open a ROM le saved as.gb or.gbc in the le browser.
Default keys Key Scroll Up / Scroll Down / Cancel / Select Play Next Prev Power Action Direction keys
A button B button Start Open Rockboy menu
Rockboy menu Load Game. Loads a previously saved game. Save Game. Saves your current state. Options. Max Frameskip. Change frameskip setting to improve speed. Sound. Toggle sound on or off. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Screen Size. Chose whether the original aspect ratio should be kept when scaling the picture to the screen. Screen Rotate. Rotate the displayed picture by 90 percent.

hand, if enabled, is displayed along with the hour and minute hands. Digit display, if enabled, places 12, 3, 6, and 9 around the face of the clock in their respective positions. Digital mode An imitation of an LCD, this mode shows a Clock comprised of digital segments. The Date readout, if enabled, is displayed at the bottom, center. The Second readout, if in Text mode, is displayed at the top, center; if in Bar mode, is displayed as a progress bar at the top of the LCD; if in Invert mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed). The Counter, if displayed, is shown at the upper left. The Blinking Colon, if enabled, blinks the colon once every second. 12-hour mode, if enabled, will display the time in a 12-hour format. LCD mode Based on the Digital Mode, the LCD mode is another imitation of an LCD. The settings available in this mode are exactly the same as Digital Mode, but they are independent of Digital Mode. For example, you can have the Date Readout enabled in Digital Mode and disabled in LCD Mode. Fullscreen A Fullscreen clock is displayed. Show Border, if enabled, will draw a small box at every hour position (1 through 12). Invert Seconds, if enabled, will invert the LCD as the seconds pass. Second Hand, if enabled, will draw a second hand among the hour and minute hands. Binary mode This mode shows a Binary clock. The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line. Circle mode, if enabled, draws empty and full circles, instead of zeros and ones. For help on reading binary, please visit: http://en.wikipedia.org/wiki/Binary numeral system Plain mode This mode shows a plain clock in large text that takes up nearly the whole LCD.

10.4.5 Disk Tidy

Disk Tidy deletes junk les left behind by Windows, Linux or OS X after a USB connection. Select the OSs les you want to delete in the Files to Clean menu and select Start Cleaning to begin to process. The settings are stored in.rockbox/rocks/apps/disktidy.config, in a plain text le that is user-modiable to allow more entries to be added.

G.2 The GNU General Public License
Version 2, June 1991 Copyright c 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free softwareto make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundations software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each authors protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modied by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reect on the original authors reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyones free use or not licensed at all. The precise terms and conditions for copying, distribution and modication follow.
GNU G ENERAL P UBLIC L ICENSE T ERMS AND C ONDITIONS F OR C OPYING , D ISTRIBUTION AND M ODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The Program, below, refers to any such program or work, and a work based on the Program means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modications and/or translated into another language. (Hereinafter, translation is included without limitation in the term modication.) Each licensee is addressed as you. Activities other than copying, distribution and modication are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Programs source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modied les to carry prominent notices stating that you changed the les and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modied program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License.

N O WARRANTY

11. B ECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE , THERE IS NO WARRANTY FOR THE PROGRAM , TO THE EXTENT PERMITTED BY APPLICABLE LAW. E XCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND / OR OTHER PARTIES PROVIDE THE PROGRAM AS IS WITHOUT WARRANTY OF ANY KIND , EI THER EXPRESSED OR IMPLIED , INCLUDING , BUT NOT LIMITED TO , THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. T HE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. S HOULD THE PROGRAM PROVE DEFECTIVE , YOU ASSUME THE COST OF ALL NECESSARY SERVICING , REPAIR OR CORRECTION.
12. I N NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER , OR ANY OTHER PARTY WHO MAY MODIFY AND / OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE , BE LIABLE TO YOU FOR DAMAGES , INCLUDING ANY GENERAL , SPECIAL , INCIDENTAL OR CONSE QUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PRO GRAM ( INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING REN DERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS ), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
E ND OF T ERMS AND C ONDITIONS Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source le to most effectively convey the exclusion of warranty; and each le should have at least the copyright line and a pointer to where the full notice is found. <one line to give the programs name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Chapter 3. Quick Start

3 Quick Start

3.1 Basic Overview

3.1.1 The players controls
Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prexed by Long, a long press of approximately one second should be performed on that button. The buttons are described in detail in the following paragraph. Additional information for blind users is available on the Rockbox website at ZBlindFAQ. Hold or lay the player so that the side with the scroll pad and LCD is facing towards you. In the centre below the lcd is the scroll pad. It is oriented vertically. Touching the top and bottom half of it acts as the Scroll Up and Scroll Down buttons respectively. On the left of the scroll pad is the Cancel button and on the right is the Select button. There are three buttons on the right hand side of the player. From top to bottom, they are: Prev, Play and Next. On the left hand side is the Power button. On the top panel of the player, from left to right, you can nd the following: Hold switch, reset pin hole, remote port and headphone mini jack plug. On the bottom panel of the player is the data cable port.
3.1.2 Turning the player on and o
To turn on and o your Rockbox enabled player use the following keys: Key Power Long Power Action Start Rockbox Shutdown Rockbox
On shutdown, Rockbox automatically saves its settings. If you have problems with your settings, such as accidentally having set the colours to black on black, they can be reset at boot time. See the Reset Settings in section 12.3.3 (page 149) for details. In the unlikely event of a software failure, a hardware reset can be performed by inserting a paperclip gently into the Reset hole.
3.1.3 Starting the original rmware
Rockbox has a dual-boot feature. It loads the original rmware from the le /System/OF.mi4. To boot into the original rmware, press and hold the Cancel button while turning on the player. Note: The iriver rmware does not shut down properly when you turn it o, it only goes to sleep. To get back into Rockbox when exiting from the iriver rmware, you will need to reset the player by inserting a pin in the reset hole.

3.1.4 Putting music on your player
With the player connected to the computer as an MSC/UMS device (like a USB Drive), music les can be put on the player via any standard le transfer method that you would use to copy les between drives (e.g. Drag n Drop). The default directory structure that is assumed by some parts of Rockbox (album art searching, and missing-tag fallback in some WPSes) uses the parent directory of a song as the Album name, and the parent directory of that folder as the Artist name. While les may be organized however you like, see section C (page 165) for the requirements for Album Art to work properly, and WPSes may display information incorrectly if your les are not properly tagged, and you have your music organized in a way dierent than they assume when attempting to guess the Artist and Album names from your letree. See section A.2 (page 153) for a list of supported audio formats.

3.1.5 The rst contact

After you have rst started the player, youll be presented by the Main Menu. From this menu you can reach every function of Rockbox, for more information (see section 5.1 (page 38)). To browse the les on you player, select Files (see section 4.1 (page 22)), and
to browse in a view that is based on the meta-data1 of your audio les, select Database (see section 4.2 (page 26)).

3.1.6 Basic controls

When browsing les and moving through menus you usually get a list view presented. The navigation in these lists are usually the same and should be pretty intuitive. In the tree view use Scroll Down and Scroll Up to move around the selection. Use Select to select an item. When browsing the le system selecting an audio le plays it. The view switches to the While playing screen, usually abbreviated as WPS (see section 4.3 (page 28). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists. The created dynamic playlist can be extended or modied while playing. This is also known as on-the-y playlist. To go back to the File Browser stop the playback with the Long Play button or return to the le browser while keeping playback running using Cancel. In list views you can go back one step with Cancel.

3.1.7 Basic concepts

Playlists Rockbox is playlist oriented. This means that every time you play an audio le, a socalled dynamic playlist is generated, unless you play a saved playlist. You can modify the dynamic playlist while playing and also save it to a le. If you do not want to use playlists you can simply play your les directory based. Playlists are covered in detail in section 4.4 (page 33). Menu From the menu you can customise Rockbox. Rockbox itself is very customisable. Also there are some special menus for quick access to frequently used functions. Context Menu Some views, especially the le browser and the WPS have a context menu. From the le browser this can be accessed with Long Select. The contents of the context menu vary, depending on the situation it gets called. The context menu itself presents you with some operations you can perform with the currently highlighted le. In the le browser this is the le (or directory) that is highlighted by the cursor. From the WPS this is the currently playing le. Also there are some actions that do not apply to the current le but refer to the screen from which the context menu gets called. One example is the playback menu, which can be called using the context menu from within the WPS.

7.5 Anti-Skip Buer

This setting controls how early Rockbox starts relling the music buer from the hard drive when playing. A longer Anti-Skip Buer helps prevent skips in music playback if Rockbox has trouble reading from the disk. This can happen if the player is knocked, shaken or jogged heavily while Rockbox is trying to read the hard drive. The anti-skip buer can be set to various values between 5 seconds and 10 minutes. Note: Having a large anti-skip buer tends to use more power, and may reduce your battery life. It is recommended to always use the lowest possible setting that allows correct and continuous playback.

7.6 Fade on Stop/Pause

Enables and disables a fade eect when you pause or stop playing a song. If the Fade on Stop/Pause option is set to Yes, your music will fade out when you stop or pause playback, and fade in when you resume playback.

7.7 Party Mode

Enables unstoppable music playback. When new songs are selected, they are queued at the end of the current dynamic playlist instead of being played immediately. Pausing and stopping playback is disabled as well as skipping songs and launching plugins.

7.8 Crossfade

This setting enables a cross-fader. At the end of a song, the song will fade out as the next song fades in, creating a smooth transition between songs. The crossfade setting is particularly eective when the player is set on shue.
Chapter 7. Playback Settings Options for crossfade settings are:
Enable Crossfade If set to Off, crossfade is disabled. If set to Shuffle, crossfade is enabled when the shue feature is set to Yes, but disabled otherwise. If set to Track Skip Only, tracks will only crossfade when manually skipped. If set to Shuffle and Track Skip then crossfade will only be active when shue is set to Yes and the track is manually skipped. If set to Always, tracks will always crossfade into one another. Fade In Delay The fade in delay is the length of time between when the crossfade process begins and when the new track begins to fade in. Fade In Duration The length of time, in seconds, that it takes your music to fade in once the Fade In Delay has ended. Fade Out Delay The fade out delay is the length of time between when the crossfade process begins and when the old track begins to fade out. Fade Out Duration The length of time, in seconds, that it takes your music to fade out once the Fade Out Delay has ended. Fade Out Mode If set to Crossfade, one song will fade out and the next song will simultaneously fade in. If set to Mix, the ending song will continue to play as normal until its end, while the starting song will fade in from under it. Mix mode is not used for manual track skips, even if it is selected here. Note: The rules above apply except in the instance where Fade Out Delay plus Fade Out Duration is less then Fade In Delay (which would create a gap in the audio). In this case, the Fade In Delay is reduced to eliminate the gap. The graphic below illustrates how the dierent settings work in practice.

Clip Counter: Show the number of times the clip indicator went active during recording in front of the peak meters. Scale: Select whether the peak meter displays linear or logarithmic values. The human ear perceives loudness on a logarithmic scale. If the Scale setting is set to Logarithmic (dB) scale, the volume values are scaled logarithmically. The volume meters of digital audio devices usually are scaled this way. On the other hand, if you are interested in the power level that is applied to your headphones you should choose Linear display. This setting cannot be displayed in units like volts or watts because such units depend on your headphones. Minimum and maximum range: These two options dene the full value range that the peak meter displays. Recommended values for the Logarithmic (dB) setting are -40 dB for minimum and 0 dB for maximum. Recommended values for Linear display are 0 and 100%. Note that -40 dB is approximately 1% in linear value, but if you change the minimum setting in linear mode slightly and then change to the dB scale, there will be a large change. You can use these values for zooming into the peak meter. Default Codepage: A codepage describes the way extended characters that are not available within the ASCII character set are encoded. ID3v1 tags do not have a codepage encoding contained so Rockbox needs to know what encoding has been used when generating these tags. This should be ISO-8859-1 but to support languages outside Western Europe most applications use the setting of your operating system instead. If your operating system uses a dierent codepage and you are getting garbled extended characters you should adjust this settings. In most cases sticking to ISO-8859-1 would be sucient.

8.5 System

8.5.1 Start Screen
Set the screen that Rockbox will start in. Selecting Resume Playback will resume playback where it was when the player was shut o if there is a playlist to resume and will then end up in the WPS. Selecting Previous Screen will make Rockbox start in the screen it was when the player was shut o.

8.5.2 Battery

Options relating to the battery in the player. Battery Capacity: This setting can be used to tell Rockbox what capacity (in mAh) the battery being used has. The default is , which is the capacity value for the standard battery shipped with the player. Rockbox uses this value for runtime estimation, not battery percentage calculation. Changing this setting has no eect

Menus Main Menu. The main menu for game setup and access to other menus. New. Create a new game with your choice of board size and handicaps. Save. Save the current state of the game. It will be saved to "/sgf/gbn def.sgf" unless otherwise set. Save As. Save to a specied le. Game Info. View and modify the metadata of the current game. Playback Control. Control the playback of the current playlist and modify the volume of your player. Zoom Level. Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time you open this plugin. Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin. Any unsaved changes are saved to "/sgf/gbn def.sgf". Game Info. The menu for modifying game info (metadata) of the current game. This
information will be saved to the SGF le and can be viewed in almost all SGF readers. Basic Info. Shows a quick view of the basic game metadata, if any has been set (otherwise does nothing). This option does not allow editing. Time Limit. The time limit of the current game. Overtime. The overtime settings of the current game. Result. The result of the current game. This text must follow the format specied at http://www.red-bean.com/sgf/properties.html#RE to be read by other SGF readers. Some examples are B+R (Black wins by resignation), B+5.5 (Black wins by 5.5 points), W+T (White wins on Time). Handicap. The handicap of the current game. Komi. The komi of the current game (compensation to the white player for black having the rst move). Ruleset. The name of the ruleset in use for this game. The NZ and GOE rulesets include suicide as a legal move (for multi-stone suicide only); the rest do not. Black Player. The name of the black player. Black Rank. Blacks rank, in dan or kyu. Black Team. The name of blacks team, if any. White Player. The name of the white player. White Rank. Whites rank, in dan or kyu. White Team. The name of whites team, if any. Date. The date that this game took place. This text must follow the format specied at http://www.red-bean.com/sgf/properties.html#DT to be read by other SGF readers. Event. The name of the event which this game was a part of, if any. Place. The place that this game took place. Round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways. Show Child Variations? Enable this to mark child variations on the board if there are more than one. Note: variations which dont start with a move are not visible in this way. Disable Idle Powero ? Enable this if you do not want the player to turn o after a certain period of inactivity (depends on your global Rockbox settings). Idle Autosave Time. Set the amount of idle time to wait before automatically saving any unsaved changes. These autosaves go to the le "/sgf/gbn def.sgf" regardless of if you have loaded a game or used Save As to save the game before or not. Set to O to disable this functionality completely. Automatically Show Comments? If this is enabled and you navigate to a node containing game comments, they will automatically be displayed.

Some places where can you can nd level sets:
Chapter 11. Plugins http://www.sourcecode.se/sokoban/levels.php http://sokobano.de/en/levels.php
Note that some level sets may contain levels that are too large for this version of Sokoban and are unplayable as a result.

11.1.27 Solitaire

Figure 11.24: Klondike solitaire
This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though the name may not be familiar, the game itself certainly is. This is due in no small part to Microsofts inclusion of the the game in every version of Windows. Though popular, the odds of winning are rather low, perhaps one in thirty hands. For the full set of rules to the game, and other interesting information visit http: //www.solitairecentral.com/rules/klondike.html Key Scroll Up / Scroll Down / Cancel / Select Play Long Cancel Next Prev Long Select Power Action Move Cursor around.
Select cards, move cards, reveal hidden cards. If a card was selected unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 nal colour stacks. Put the card on top of the remains stack on one of the nal colour stacks. Show menu

11.1.28 Spacerocks

Figure 11.25: Spacerocks
Spacerocks is a clone of the old arcade game Asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a UFO will appear shoot this for extra points. Key Prev Scroll Up Cancel/ Select Scroll Down Play Power Action Shoot Thrust Turn left/right Teleport Pause game Quit

11.1.29 Star

Figure 11.26: Star game
This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator. Rules: Take all of the os to go to the next level. You can switch control between the lled circle, which can take os, and the lled square, which is used as a mobile
wall to allow your lled circle to get to places on the screen it could not otherwise reach. The block cannot take os. Key Cancel Select Scroll Up Scroll Down Prev Play+Scroll Down Play+Select Play+Scroll Up Power Action Move Left Move Right Move Up Move Down Switch between circle and square Previous level Reset level Next level Exit the game

11.1.30 Sudoku

11.2.11 Plasma

Figure 11.38: Plasma
Plasma is a demo displaying a 80s style retro plasma eect. Key Scroll Up / Scroll Down Play Power Action Adjust frequency Change colours Quit

11.2.12 Snow

Figure 11.39: Have you ever seen snow falling?
This demo replicates snow falling on your screen. If you love winter, you will love this demo. Or maybe not. Press Power to quit.

11.2.13 Stareld

Figure 11.40: Stareld
Stareld simulation (like the classic screensaver). Key Select / Cancel Scroll Up / Scroll Down Play Power Action Increase / decrease number of stars Increase / decrease speed Change colours Quit

11.2.14 VU meter

Figure 11.41: VU-Meter
This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above). From the settings menu the decay time for the meter (its memory), the meter type and the meter scale can be changed. Key Power Play Prev Scroll Up Scroll Down Action Save settings and quit Help Settings Raise Volume Lower Volume

11.3 Viewers

Viewers are plugins which are associated with specic le extensions. They cannot be run directly but are started by playing the associated le. Viewers are stored in the /.rockbox/rocks/viewers/ directory.

11.3.1 Shortcuts

The Shortcuts Plugin allows you to jump to places within the le browser without having to navigate there manually. The plugin works with.link les. A.link le is just a text le with every line containing the name of the le or the directory you want to quickly jump to. All names should be full absolute names, i.e. they should start with a /. Directory names should also end with a /.
Chapter 11. Plugins How to create.link les
You can use your favourite text editor to create a.link le on the PC an then copy the le to the player. Or you can use the context menu on either a le or a directory in the le browser tree, and use the Add to shortcuts menu option. This will append a line with the full name of the le or the directory to the shortcuts.link le in the root directory of the player. (The le will be created if it does not exist yet.) You can later rename the automatically created shortcuts.link le or move it to another directory if you wish. Subsequent calls of the context menu will create it again. How to use.link les, i.e. jump to desired places To use a.link le just play it from the le browser. This will show you a list with the entries in the le. Selecting one of them will then exit the plugin and leave you within the directory selected, or with the le selected in the le browser. You can then play the le or do with it whatever you want. The le will not be played automatically. If the.link le contains only one entry no list will be shown, you will directly jump to that location. The le shortcuts.link in the root directory is an exception. After playing it, the list will be shown even if the le contains just one entry. If the list you are seeing is from shortcuts.link in the root directory, you can delete the selected entry by pressing Power. Deleting entries from other.link les is not possible. Advanced Usage Placing the line #Display last path segments=n (where n is a number) in the beginning of a.link le will leave just the last n segments of the entries when they are shown. For example, if n is chosen to be 1, then the entry /MyMusic/collection/song.mp3 will be shown as song.mp3. This allows you to hide common path prexes. You can also provide a custom display name for each entry individually. To do so, append a tabulator character after the entrys path followed by your custom name. That name will then be used for showing the entry. For example:

Key Scroll Up / Scroll Down / Cancel / Select Play Long Play Next Prev Power
Action Move around in zoomed in image
Zoom in Zoom out Next png in directory Previous png in directory Show menu / Abort while decoding
The menu has the following entries. Quit. Quits the viewer and returns to the File Browser. Toggle Slideshow Mode. Enables or disables the slideshow mode. Change Slideshow Timeout. You can set the timeout for the slideshow between 1 second and 20 seconds.
Show Playback Menu. From the playback menu you can control the playback of the currently loaded playlist and change the volume of your player. Return. Returns you to the image

11.3.8 PPM viewer

Open a PPM le in the File Browser to view it. PPM viewer exits when any button is pressed. Note: Both ASCII PPM (P3) and raw PPM (P6) les are supported. For more information about PPM les, see http://netpbm.sourceforge.net/doc/ppm.html

11.3.9 Rockboy

Figure 11.42: Rockboy
Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM le saved as.gb or.gbc in the le browser.
Default keys Key Scroll Up / Scroll Down / Cancel / Select Play Next Prev Power Action Direction keys
A button B button Start Open Rockboy menu
Chapter 11. Plugins Rockboy menu Load Game. Loads a previously saved game. Save Game. Saves your current state.
Options. Max Frameskip. Change frameskip setting to improve speed. Sound. Toggle sound on or o. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Screen Size. Chose whether the original aspect ratio should be kept when scaling the picture to the screen. Screen Rotate. Rotate the displayed picture by 90 degrees. Set Palette. Pick one of a few predened colour palettes. Quit RockBoy. Quits the Rockboy plugin.

11.3.10 Search

This plugin can be used on playlists. It searches through the playlist that it opened on looking for any occurrences of the string entered by the user. The results of this search are saved to a new playlist, search results.m3u, within the same directory as the original playlist.

11.3.11 Sort

This plugin takes a le and sorts it in ascending alphabetical order. Case is ignored. This is useful for ordering playlists generated by the Create Playlist menu option (see section 5.10 (page 43)).

11.3.12 Text Viewer

This is a Viewer for text les with word wrap. Just open a.txt le to display it. The text viewer features controls to handle various styles of text formatting, has top-of-le and bottom-of-le buttons. You can view les without a.txt extension by using Open with from the Context Menu (see section 4.1.2 (page 23)).

11.4 Applications

11.4.1 Battery Benchmark
The Battery Benchmark plugin enables you to test your batterys performance whilst using your player normally. Results can be submitted to the ZBatteryRuntime wiki page. How it works Once loaded, Battery Benchmark runs in the background recording various information about your battery to memory. A new point is written to memory every minute.
Every time the disk is accessed for any reason (such as relling the audio buer, opening a directory or entering USB mode etc.) then the information in memory is written to disk. Once the memory becomes full (after many hours), then the data are written to disk anyway. This is done so that the data are not biased by excessive additional disk accesses. The le is written to the root directory of your player and is called battery bench.txt. The plugin will continue to log info until: Another plugin is loaded. The player is shut down. The battery is empty. Benchmarks can be resumed if you accidentally load a plugin, or turn o your player, so long as the log le battery bench.txt is not deleted. Information explained At the top of the battery bench.txt le is various information on how to use the plugin, followed by the data themselves. Time This column reports the total time of operation of the player. It is not the time that you started the plug-in. If you have your player on for 5 minutes and then start the plugin, it will start measuring from 5 minutes. Seconds The same as Time, except measured in seconds. Level The percent level of the battery estimated by Rockbox, and not the actual battery level. The actual battery level can be seen from the Voltage column Time Left This shows the time remaining until the battery is empty, again as estimated by Rockbox. Voltage The battery voltage in mV at the moment the measurement was taken. C This stands for Charger. An A in that column shows if the power adapter was attached to the unit at the time of the measurement. U USB powered. Only for targets that support this. A U will indicate if the unit was using the USB port for power at the time of the measurement. Usage The log le can be used to tell you how long the battery lasted (with some limitations, see below), but it is most useful for graphing discharge curves in order to improve Rockboxs estimation of battery level and time remaining. The battery log (battery bench.txt) is in CSV format (comma separated variables) and thus can be easily imported into a spreadsheet or similar program.
Chapter 11. Plugins Limitations
As Battery Benchmark needs to write the data held in memory to disk in order to save them, it is possible that should Rockbox shut down due to low battery then there will not be enough power remaining to write the data to disk. Therefore all measurements since the previous save will be lost.

12.4 Firmware Loading

12.4.1 Using ROLO (Rockbox Loader)
Rockbox is able to load and start another rmware le without rebooting. You just play a le with the extension.mi4. This can be used to test new rmware versions without deleting your current version.

Appendix A. File formats

A File formats

A.1 Supported le formats

Icon File Type Directory Audio le Cuesheet Playlist Rockbox rmware While Playing Screen Language File Text File Conguration File Font Plugin Chip8 game Image Video FM Presets Voice le Bookmark Link Extension none various (see A.2).cue.m3u,.m3u8.mi4.wps.lng.txt.cfg.fnt.rock.ch8.jpg.mpg,.mpeg,.mpv,.m2v.fmr.voice.bmark.link Action when selected Enter the directory Start playing the le and show the WPS View the cuesheet le Load the playlist and start playing the rst le Load the new rmware with ROLO Load the new WPS display conguration Load the language le Display the text le using the text viewer plugin Load the settings le Change the user interface font to this one Start the plugin Play the Chip8 game View the JPEG image Play the MPEG1/2 video Load the FM Presets (previous are discarded) Allow Rockbox to speak menus Display all bookmarks for an audio le Display list of target les and directories; selecting one jumps to the target. See section 11.3.1 (page 113). Open the colours le for editing. See section 12.1.4 (page 140). Show the conguration with the Rocklife plugin

Colours Game of Life

.colours.cells
A.2 Supported audio formats
Format Lossy codecs MPEG audio OGG/Vorbis Musepack Advanced Audio Coding Windows Media Audio ATSC A/52 ADX Speex Lossless codecs Waveform audio format Audio Interchange File Format Free Lossless Audio Apple Lossless Wavpack Shorten Monkeys Audio Other codecs Sound Interface Device MOD NES Sound Format SPC700 Atari SAP.sid.mod.nsf,.nsfe.spc.sap.wav.aif,.aiff.flac.m4a,.mp4.wv.shn.ape,.mac.mp1,.mpa,.mp2,.mp3.ogg,.oga.mpc.m4a,.m4b,.mp4.wma,.wmv,.asf.a52,.ac3.adx.spx Extension Notes
Some old oor 0 les may crash Rockbox.
Supports downmixing for playback of 5.1 streams in stereo.
Seeking not supported. Only -c1000 les decode enough to be useful.

Appendix B. WPS Tags

Appendix G. Changelog 2006-08-07: 2006-07-19: 2006-07-18: 2006-07-18: 2006-04-19: 2006-03-30: 2006-03-28: 2006-03-28: 2006-03-26: 2006-03-26: 2006-03-20: 2006-03-19: 2006-03-12: 2006-03-11: 2006-02-22: 2006-02-13: 2006-02-01: 2006-01-28: 2006-01-23: 2005-12-06: 2005-11-05: Initial version of mpegplayer plugin Rockpaint plugin SID codec Playlist catalog Rockbox is functional and plays audio on the iPod Mini 1G Rockbox is functional and plays audio on the iPod Mini 2G DOOM Sound on the iAudio X5 , X5L and X5V Experimental WAV playback plugin for Archos Recorder/Ondio Initial version of Tag Cache Bubbles, a bubble game Tetrox, a Tetris clone Xobox, a Xonix/Qix clone Pacbox, a pacman arcade machine emulator Chessbox chess game plugin iPod 5G audio playback AIFF codec support added Color bitmap support in the WPS (for color models) Brickmania game plugin Unicode support Jewels game plugin - a Bejeweled clone.

G.2.2 Enhancements

2008-08-06: Redesigned recording screen 2008-02-23: New default theme: cabbie 2.0 2008-01-04: All new greyscale library with improved performance 2007-08-08: Added support for grouping tags 2007-08-06: Organise the plugins into categories 2007-08-05: Voice le changes. Older voices no longer work, now all voice les are target-specic. 2007-08-03: Added support for the disc number tag 2007-04-04: WPS tokenizer: Rewritten WPS code 2007-03-20: rockbox.* le moved inside /.rockbox directory 2007-01-23: Settings are now saved to /.rockbox/cong.cfg and the hidden cong sector is not used anymore 2006-11-29: Playlists are saved with the extension.m3u8, extension.m3u is now read using the chosen codepage 2006-09-16: New scheduler. Audio playback is now prioritised over other tasks 2006-09-02: Enhanced statusbar in recording screen 2006-08-15: Support for displaying the path in the le browser 2006-02-07: Equalizer conguration for software codec platforms A 2006-02-06: The Rockbox manual is available in L TEXformat 2005-12-05: New wps added. Engineeer2, marquee, and DancePuDuo

G.2.3 Bug xes

Appendix H. Credits

H Credits

People that have contributed to the project, one way or another. Friends!

1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The Document, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as you. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A Modied Version of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modications and/or translated into another language. A Secondary Section is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Documents overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The Invariant Sections are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not t the above denition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The Cover Texts are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A Transparent copy of the Document means a machine-readable copy, represented in a format whose specication is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent le format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modication by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not Transparent is called Opaque. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modication. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The Title Page means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, Title Page means the text near the most prominent appearance of the works title, preceding the beginning of the body of the text.