Rockbox Documentation Index
Rockbox Manuals
- Rockbox Manuals for all supported DAPs, updated daily. This page has PDF and HTML versions of the Rockbox Manual for every supported platform. It should be the first place to look for usage documentation and installation instructions.
General Information
Welcome
- WhyRockbox - What is Rockbox and why should you use it?
- ScreenShots - Screenshots of Rockbox in action
- The GNU General Public License - The terms under which Rockbox may be distributed
- TargetStatus - The current status of Rockbox development on various players
- ProjectGlossary - Catch up with the Rockbox project lingo
- DeviceChart - Device comparison table
- FeatureComparison - Rockbox vs. Out-of-the-box
- BuyersGuide - Want to buy a Rockbox compatible device?
- IdentifyPlayer - Not sure what player you have?
- DonatedMoney - Where the millions go
- WhyHaveAds - Why are there advertisements on the frontpage?
- RockboxMerchandise - The Rockbox-branded pocket-protector collection.
- NoDo - A list of features that we will not implement
- Known issues
- The Noble People Behind Rockbox
More Stuff
- RockboxUtility - A program designed to ease the installation of Rockbox and extras
- RockboxExtras - Extras not included with the regular download
- UserForums - A list of Rockbox-related forums
- UsefulTools - A collection of tools for Rockbox as well as general digital music management
- MajorChanges - List of major changes to Rockbox
- ReleaseNotes25 - Release notes for v2.5 (Archos only)
- FeatureRequests - How to get a feature into Rockbox
- ReportingBugs - How to report bugs
- FlySpray - General information on the FlySpray system
- FlySprayHowto - How to use FlySpray
- RockboxManual - Interested in helping out with the manual?
- HardwareProjects - A collection of interesting hardware projects
- ExternalRelatedPages - A list of external related pages
- WebStatistics - A Wiki statistics page that would be cool if it was kept up to date
- DownloadMirrors
FAQs
- Frequently Asked Questions
- Frequently Asked Questions for Blind and Visually Impaired Rockbox users
- Frequently Asked Questions about the Sansa port
- Frequently Asked Questions about the iriver port
- Frequently Asked Questions about the iPod port
- Frequently Asked Questions about Rockbox for Archos players
Meetups, DevCons, GTs
- DevCon2008
- RockboxNYC
- DevConWest2007
- DevCon2007
- DevCon2006
- DevconNotes - DevCon 2006 Notes
- TowerOfRockbox
User Interface
- PluginIndex - Where to find information on all plugins
- ViewerPlugin - Information on viewer plugins
- PluginMpegplayer - Information on the MPEG video player plugin
- PluginJpeg - Information on the JPEG plugin
- PluginRockboy - Information on the Rockboy (Gameboy emulator) plugin
- WpsGallery - The Rockbox WPS/Theme gallery
- CustomWPS - How to design your own custom While Playing Screen
- SimpleGuideToWPSMaking - A simple guide to making your own WPS
- AlbumArt - Information on using Album Art
- ThemeGuidelines - Guidelines for submitting themes
- SubmitWPS - Instructions on how to submit your WPS for inclusion with the regular build
- FutureWPSFeatures - Planned features
- WpsRequestList - Idea page for the WPS
- DefaultWPS - Submissions for the Default Theme Contest
- CreateFonts - How to create fonts for use with Rockbox
- FontFormat - The Rockbox font format
- UserConvertedFonts - Gallery of user-converted fonts
- UnicodeGuide - The Unicode info page
- UnicodeFonts - The status of Unicode support with various fonts
- LangFiles - Details on the .lang file type
- IconSets - The Icon Sets gallery
- CustomIcons - How to create custom icons for Rockbox
- DataBase - Details on the Rockbox Database
- FmPresets - FM Presets for various regions
- VoiceFiles - Index of pre-built voice files
- VoiceHowto - How to make your player speak
- VoiceBuilding - How to make your own voices
- LoadableKeyboardLayouts - Information on custom keyboard layouts
- CustomConfigFile - Details of the Rockbox configuration file type
- LastFMLog - Info on last.fm logging capabilities
- GaplessPlayback - About Gapless playback
- GaplessHowTo - How to create gapless sound files
- VolumeTriggeredRecording
- RoLo - Information on the Rockbox Loader
- ScreenDump - How to take a bitmap image of your screen
- SoundCodecs - Details on the codecs supported by Rockbox
- ShuffleExplained - Basic description of how shuffle works in Rockbox
For Developers
Getting Started & Compiling
- NewPort - How to start a port to a new player
- PortingHowTo - The basics of porting
- DevelopmentGuide - First-time guide to Rockbox development
- CrossCompiler - Building the cross compiler (Linux/Cygwin)
- HowToCompile - Detailed instructions on compiling
- WorkingWithPatches - How to work with patches
- HowToWriteCodecs - How to write Rockbox codecs
- HowtoWritePlugins - How to write Rockbox plugins
- HowtoVerifyPlugins - How to verify plugins
- UsingCygwinAndTortoiseSVN - How to use TortoiseSVN and Cygwin together
- UsingSVN - How to use SVN
- ObjdumpGuide - How to use objdump to disassemble firmware.
- SimpleGuideToCompiling - The simplified guide to compiling (Windows)
- VMwareDevelopmentPlatform - How to use a VMware virtual image to compile Rockbox (Windows)
- CygwinDevelopment - Easy guide to setting up a Cygwin Rockbox development environment (Windows)
- CygwinInstallWithScreenShots - ... with step-by-step screenshots.
- CoLinuxDevelopmentPlatform - How to use CoLinux to compile Rockbox
- DevelopmentTools - A collection of various development tools
- BuildServer - How to add your powerful machine to the server build farm
- UiSimulator - What it is and how to build/use it (Unix/Linux/Cygwin/MacOS)
About the Code
- RockboxArchitecture - The internal architecture of Rockbox
- SourceLayout - The source code layout of Rockbox
- SourceProfiling - How to profile Rockbox
- WhyNoMalloc - Why does Rockbox have no malloc()?
- RockboxMemoryLayout - Memory layout under Rockbox
- UseMemoryGuard - How to use the memory guard ("Catch mem accesses") debugging feature
- ListWidget - How to use the List Widget
- RockboxKernel - Description of the Rockbox Kernel
- RockboxPCMPlayback - Part of an attempt to document the software codec playback code
- RockboxUsbHandling - USB handling in Rockbox
- UsingTheMenuAPI - How to use the Menu API
- GraphicsAPI - Graphics API documentation
- WpsTokenizer - Details on the WPS tokenizer
- DynamicCPUFrequency - Dynamic CPU Frequency in Rockbox
- TargetTree - The Target Tree structure
- LangFiles - Details on the .lang file type
Benchmarks and test results
- BatteryRuntime - Rockbox battery runtime testing
- CodecPerformanceComparison - Sound codec performance compared side-by-side
- UsbPerformance - Details on the performance of the Rockbox USB Stack
- LcdFrameRate - LCD frame rates for various players
- DiskSpeed - Rockbox disk driver speed measurements
Hardware Information
- Photographs of various Archos Internals
- HardwareSchematics - Hardware schematics for various players
- PortPinAssignments - Port pin assignments for various players
- GigabeatPortPins - Port pin assignments for the Toshiba Gigabeat F & X
- GigabeatSPortPins - Port pin assigments for the Toshiba Gigabeat S
- DataSheets
- DatasheetErrata
- ArmInstructions
- AustriaMicrosystems
- AustriaMicrosystemsAS3514
- ColdFire
- TelechipsInfo
- TexasInstrumentsTMS320
- SigmaTelSTMP3xxx
- PortalPlayer
- CalmRISC16
- PhilipsPNX0101
- PhilipsSAA7750
- MotorolaDSP56k
People
- KnowledgeMap - The Who-Knows-What List
- WhoDoesWhat - The Who-Does-What List
- RockboxTesting - Find people with specific players to help you test
Projects & Discussions
- SummerOfCode - Description and page index
- ReleasePlanning - Page for release planning discussion
- ReleaseTodo - Page for things to do before a proper release can be done
- PortalPlayerUsb - Details on the current status of the Rockbox USB Stack for PortalPlayer
- SoftwareCodecPlayback - Plan to rework playback
- ViewPorts - Plan to change how the WPS screen displays information
- ViewPortsDesign - ... and the design.
- ViewDrawing - New theme design proposal piggy-backing on ViewPorts
- CompiledSkinProposal - A proposal to have compiled skins for Rockbox
- MenuLayoutDiscussion - Discussion about the menu layout and possible improvements to it
- RockboxDictionary - An incomplete project to design a Rockbox dictionary
- TouchpadInterface
- UsbOnTheGoSupport
- TextToSpeech
- FontSystemProposal
- MultiFontSupport - A discussion on how multi-font support can be implemented
- NonLatinLanguages - Supporting Rockbox over non-latin languages
- GitVersionControl - Git Version Control system, and how it might be useful for Rockbox
- RockboxArchitectureImprovements
- VKeyboardDesignProposal
- MultiScreenVKeyboard
- AudioAPIEnhancement
- AudioHardwareAPIProposal
- RockboxUtility - The Qt version of Rockbox Utility
- DeviceDetection - Info on RBUtil device detection
- DeviceEnableRegistersPP502x - Information regarding the Device Enable registers on PP502X targets
- HardwareProjects - Various hardware projects
- RockboxOrgEmail - Want a fancy @rockbox.org email address?
- SimpleFirmwareCrack - A small program to help with firmware cracking
- SoundCodecs - Details on the codecs supported by Rockbox
- CodecPerformanceComparison - Sound codec performance compared side-by-side
- ConsoleEmulators - List of console emulators that might help porting to Rockbox
- ThemeRepository - Discussing the adoption of themes.rockbox.org
- UseDisplayName - "Using display names allows you to browse files using the id3 tags embedded into most mp3 files"
- MasLimitations - MAS MPEG audio decoders seems to not correctly decode all valid MPEG version/layer/bitrate combinations.
- AllKeysConfigurable - People want to be able to personalize everything but it would be a nightmare to support. Discuss.
- CustomMenus - People want to be able to personalize everything but it would be a nightmare to support. Discuss.
- BrowseByAlphabet - A proposal for browsing by the first letter of the filename
- DocumentViewer - The beginning of a plugin for viewing Wikipedia articles or converting HTML, PDF files for Rockbox
- ButtonAssignments - A work page to assist in making the keymaps, and hence the code, more generic.
- LocalizablePlugins - A proposal to implement localizable plugins.
External Pages (Mods, Disassemblies, Repairs, etc)
- Uwe Freese's 8MB RAM mod for Recorders
- Uwe Freese's RTC alarm mod for v1 recorders
- James Stewart's Jukebox 6000 Bass and Volume improvement
- Another page describing hard drive update
- Steve Russell's PIC-based remote control
- Chris Halsall's MMJB20 page with disassembly instructions useful for FM and V2 owners
- Archos Atmel remote control by Matthias Klumpp
- Rockbox plugins by Bluechip
- VWCDPIC Adapter - Remote control Archos from Volkswagen radio (see Developer's Area for schematic/firmware)
- Eric Woudenberg's excellent description on how to repair the DC socket on the V1 Recorder.
- Rockbox as a Sony Unilink Car Cd Changer emulator
- A mailing list for French-speaking Rockbox users especially targeted to help blind people but open to everyone
- An Italian mailing list for Rockbox users especially to help blind people
- An excellent diagnostic chart for the most common hardware faults on the Archos jukebox models
- The iPod Nano 2G dissection pictures
- iriver h3x0 Dissassembly Video
The Rockbox Museum (Outdated stuff, Useless pages, Committed proposals, etc)
- RockBox - You are here?
- WikiManual - The old wiki manual
- DocBoxObsolete - The even older manual
- KeymapOndio - Keymap for Rockbox 2.3. Unsure if this is relevent to 2.5.
- WikiRestore - Page for the effort to recover the wiki from "The Incident"
- MissingAttachments - An attempt to find the missing attachments lost in the wiki hack
- MenuSettingsRecoding - Late 2006 effort to recode the menu settings
- ButtonActionIdea - Explanation of the Button Actions Idea, committed in 2006.
- BookmarkUseCases - A collection of use-cases for bookmarks from late 2006.
- ColdfireEmulatorDevelopment - This topic describes the development effort to extend the existing Coldfire Emulator to support CF5249 in 2004.
- SettingsRecode - Recoding the settings menus in early 2007
- MetadataOnBuffer - Restructuring playback in late 2007
- MetadataOnBufferTesting
- BufferingAPIProposal - Superceded by MetadataOnBuffer.
- UsbSoftwareStack - Plan to develop a USB software stack. Superceded by PortalPlayerUsb.
- ReleaseAnnouncement30 - If Rockbox v3.0 is ever released this page will be useful
- SortingPluginsProposal - Proposal to sort the plugins from 2007
- NewForumProposal - Forum reorganization proposal from 2006
- CodecTesting - Pushed to CodecPerformanceComparison
- BrokenSed - Broken sed caused build problems
- IaudioBoot - Info moved to iAudio port page
- IaudioBootKr - Out of date Korean translation
- IriverFAQKr - Out of date Korean translation
- IriverInstall - Old iriver installation instructions
- IriverInstallKr - Out of date Korean translation
- IriverH10InstallationBeta
- IriverPlaylistInstructions
- IriverTeam
- IriverTesting
- IriverRamLoad
- IriverNavigation
- IpodInstallation
- IpodInstallationKr
- IpodInstallationBeta
- IpodInstallationFromLinux
- IpodInstallationFromMacOSX
- IpodMacOSInstaller
- IpodRestoration
- SansaE200Install
- SansaE200InstallBeta
- SansaE200RBootloaderPatching
- PowerConsumption - iriver H300 power consumption table
- ChangeLog25 - Change log for 2.4 -> 2.5
- RockBox251 - Unsupported build for the Archos models
- EncoderDiscussionMP3 - Discussion of MP3 Encoding/Decoding
- VideoCodecs - The beginning of video support
- RockboxUtilityOld
- RockboxUtilityQt
- RockboxUserInterfaceProposal - User Interface Discussion Feb 2006
- RuntimeDatabase - Planning a runtime database to store all runtime info
- RockboxAudioAPIProposal - Discussion about a proposed "new" internal audio API
- WPSTokenbasedHandling - Outdated idea for a token based WPS handling
- PastedImagesForFourms - GodEater tries to save some fourm (sp) storage space
- ForumChanges - GodEater is a weird dude
- RockboxGraphicalUIDesign - Someone trying to change the boot & USB graphics in 2005
- FlySprayLinks - No longer needed because of links on the left panel
- RootMenu - Discussion of main menu design
- FixingWaves - Rockbox ruins wav files - out of date
- SoapSealofApproval
- DesktopTools - Deprecated by RockboxUtility
- OldPluginIndex - The old plugins
- TagDatabase - Precursor to DataBase
- CuesheetSupport - Committed
- IpodExperimental - Unsupported iPod builds, way out of date
- GUIProposal - This seems cute and funny now
- RockboxDevelopment - The old DevelopmentGuide
- SimpleGuideToCompilingKr - Someone didn't finish their homework
- RockboxFlash - A totally empty page!
- RockboxThemes - For the iRiver H100 Only - Deprecated
- ThingsTodo
- HarddiskInfo - Replaced by HardDriveReplacement
- RockboxShots
- IpodTips - Merged with iPod FAQ
- NonArchos - When the categories were Archos and Non-Archos
- OtherTargets - Merged with TargetStatus
- MenuRework - Duplicate page
- IriverH100FAQ & IriverH10FAQ & IriverH300FAQ - All merged into iriverFAQ
- ManualHowTo - Merged with GeneralFAQ
- OpenOffice
- SourceForge
- MediaCoder
- MisticRiver
- SanDisk
- SoC - Simple terminology - added to ProjectGlossary
- NiMH - Simple terminology - added to ProjectGlossary
- LiIon - Simple terminology - added to ProjectGlossary
- FlashMemory - Simple terminology - added to ProjectGlossary
- MultiMediaCard - Simple terminology - added to ProjectGlossary
- FileFormatMI4 - Simple terminology - added to ProjectGlossary
- RealLife?
- FmTunerProject - Getting the FM Radio to work on the iriver H10 - the tuner is supported on H10
CategoryFrontpage: Documentation index - Looking for something? [Documentation]
r194 - 11 May 2008 - 20:26:17 - MarcGuay
| Edit | View raw | Attach | Ref-By | History: r194 < r193 < r192 < r191 < r190 | More | Refresh cache |
|
Copyright © 1999-2008 by the contributing authors.
|