Rockbox manual in LaTeX initial commit. New option 'manual' added to configure. Some platforms (eg recorderv2, fmrecorder) produce the same manual target, so either can be selected from the configure script.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@8596 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Christi Scarborough 2006-02-06 07:25:25 +00:00
parent 4eca52941c
commit d68d7c0ecf
48 changed files with 7111 additions and 5 deletions

287
manual/LaTeX.Rules Normal file
View file

@ -0,0 +1,287 @@
#
# Makefile for the automation of LaTeX document processing
#
# Usage: make [target]
# The following targets are understood:
# dvi generate dvi output (latex default target)
# pdf generate pdf output (pdflatex default target)
# ps generate postscript
# clean erase all intermediate files
# realclean erase all but the source files
#
# To do:
# -recursively process \include{} and \input{} commands for .tex
# dependancies
# -do the same for \bibliography{} commands
# -add metapost processing
#
#
# Document information (provided by top-level Makefile)
#
# LATEX
# The name of the latex compiler to use. If the program name is,
# specifically, "pdflatex" then the .pdf will be the default target
# rather than the .dvi. Note that at present there is no way to ask
# for one or the other without switching the contents of this
# variable.
#
# DOCUMENT
# (required) The root name for all files.
#
# GRAPHIC_FILES
# Any graphic files the document depends on, for example any .eps or
# .pdf files included with \includegraphics{}. The output is rebuilt
# if any of these files change but otherwise they play no role in the
# build process.
#
# XFIG_FILES
# Thes Makefile rules allow your LaTeX document to include xfig .fig
# files directly. Each .fig file is converted to a graphic format
# suitable for inclusion by the LaTeX processor, for example
# postscript or pdf. This is accomplished by processing the .fig
# file with fig2dev and producing two output files: a graphics
# version of the .fig file and a LaTeX source file containing the
# commands needed to import that graphics file. In your own LaTeX
# document, you will need to include this .tex source file. For
# example, if you have an xfig file called diagram.fig, you should
# set "XFIG_FILES = diagram.fig" in your Makefile and place the
# command "\include{diagram.fig}" in your LaTeX document where you
# would like the image placed. When your document is processed, the
# xfig file will be converted to a, for example, postscript file
# called diagram.fig.ps and a LaTeX source file called
# diagram.fig.tex. The \include{} command in your LaTeX source reads
# in the .fig.tex file (the .tex extension is assumed by the command)
# which in turn contains the commands to import the graphics file.
#
# As an added bonus, any text objects in the xfig document that have
# their "special" flag set will be removed from the document before
# it is converted to a graphics format. Their contents are added to
# the LaTeX source file along with the commands needed to overlay
# them in the correct places on the figure. In this way, you can use
# LaTeX to typset the text of your xfig figure. This has the
# advantage of having the text rendered in the same font as the rest
# of your document and also allows you to make use of all of LaTeX's
# typsetting facilities. Note that in your xfig document you should
# set the pen colour of the "special" text to "Default" in order to
# prevent \color commands from being issued, otherwise you will need
# to include the LaTeX package "color".
#
# If you get error messages about "unknown graphics format" related
# to the .fig.ps or .fig.pdf intermediate graphics file then you must
# issue the \DeclareGraphicsRule{.fig.ps}{eps}{.fig.ps}{} command or
# the \DeclareGraphicsRule{.fig.pdf}{pdf}{.fig.pdf}{} command in your
# document's preamble. See the grfguide.ps graphics package
# documentation for more information.
#
# BIB_FILES
# $(DOCUMENT).tex will be automatically searched for all .bib files
# specified via \bibliography{} commands. Use this variable to
# override the automatic search and manually specify the .bib files.
# Reasons for wanting to override the automatics: (i) scanning a
# large document can be time-consuming and can be skipped by entering
# the info yourself (ii) the algorithm may be broken for your
# document.
#
# BSTINPUTS
# BIBINPUTS
# The contents of these variables override the system default search
# paths for bibtex. If you are using a custom bibliographic style,
# you may need to set BSTINPUTS to the directory in which the .bst
# file resides. If your .bib databases cannot be found, then you
# will need to set BIBINPUTS to a colon-separated list of the
# directories in which they reside.
#
# DVIPS_FLAGS
# Flags to pass to dvips. It might be necessary to include the -K
# flag if you are having trouble getting mpage to handle documents
# that contain EPS figures generated by certain applications.
#
###############################################################################
#
# Preamble
#
###############################################################################
DVI_FILE := $(DOCUMENT).dvi
PDF_FILE := $(DOCUMENT).pdf
PS_FILE := $(DOCUMENT).ps
AUX_FILE := $(DOCUMENT).aux
LOF_FILE := $(shell ls $(DOCUMENT).lof 2>/dev/null)
LOT_FILE := $(shell ls $(DOCUMENT).lot 2>/dev/null)
TOC_FILE := $(shell ls $(DOCUMENT).toc 2>/dev/null)
IDX_FILE := $(shell ls $(DOCUMENT).idx 2>/dev/null)
END_FILE := $(shell ls $(DOCUMENT).end 2>/dev/null)
TEX_FILES := $(DOCUMENT).tex
OTHER_FILES := $(DOCUMENT).blg $(DOCUMENT).log $(DOCUMENT).out
# grab the contents of \bibliograph{} commands
ifeq ($(BIB_FILES),)
BIB_FILES := $(shell for source in $(TEX_FILES) ; do sed -e '{' -e 'y/,/ /' -e 's?.*\\bibliography[{]\(.*\)[}].*?\1?' -e 't' -e 'd' -e '}' <$$source ; done)
BIB_FILES := $(BIB_FILES:%=%.bib)
endif
ifneq ($(BIB_FILES),)
BBL_FILE := $(DOCUMENT).bbl
endif
ifneq ($(IDX_FILE),)
IND_FILE := $(DOCUMENT).ind
endif
# construct the names of auxiliary files related to xfig documents
XFIG_AUX = $(strip $(XFIG_FILES:%.fig=%.fig.aux))
XFIG_GFX = $(strip $(XFIG_FILES:%.fig=%.fig.pdf) $(XFIG_FILES:%.fig=%.fig.ps))
XFIG_TEX = $(strip $(XFIG_FILES:%.fig=%.fig.tex))
# latex will be run over and over and over again until the following files
# stop changing.
MONITOR_FILES := $(strip $(AUX_FILE) $(TOC_FILE) $(LOF_FILE) $(LOT_FILE) $(BBL_FILE) $(IND_FILE) $(END_FILE))
# the following files must be present or processing will fail
SOURCE_FILES := $(TEX_FILES) $(BIB_FILES) $(GRAPHIC_FILES) $(XFIG_FILES)
###############################################################################
#
# Targets
#
###############################################################################
.PHONY : dvi pdf ps clean realclean check_for_sources
.SECONDARY : $(MONITOR_FILES) $(XFIG_AUX) $(XFIG_GFX) $(XFIG_TEX)
ifeq (,$(LATEX))
LATEX := latex
endif
ifeq ($(notdir $(LATEX)),pdflatex)
pdf : $(PDF_FILE)
else
dvi : $(DVI_FILE)
endif
ps : $(PS_FILE)
clean :
-rm -f $(MONITOR_FILES)
-rm -f $(MONITOR_FILES:%=%.old)
-rm -f $(OTHER_FILES)
-rm -f $(XFIG_AUX)
-rm -f $(XFIG_GFX)
-rm -f $(XFIG_TEX)
realclean : clean
-rm -f $(DVI_FILE)
-rm -f $(PDF_FILE)
-rm -f $(PS_FILE)
###############################################################################
#
# Macros
#
###############################################################################
###############################################################################
#
# Dependancies and Generation Rules
#
###############################################################################
#
# Check for the existance of all required source files
#
check_for_sources :
@FOUNDALL=1 ; for source in $(SOURCE_FILES) ; do [ -f "$$source" ] || { echo "Error: cannot find source file: $$source" ; FOUNDALL=0 ; } ; done ; [ $$FOUNDALL == 1 ]
#
# Generate a postscript file from a .dvi file
#
%.ps : %.dvi
dvips $(DVIPS_FLAGS) -o $@ $*
#
# Generate the .dvi (or .pdf) file by running LaTeX (or PDFLaTeX) until the
# auxiliary files listed in MONITOR_FILES stop changing. Rather than just
# looping, make is re-run which allows any files that depend on the
# particular auxiliary files that changed to be updated as well.
#
define run-latex
@function saveold () { for file ; do [ -f $${file} ] && cp -fp $${file} $${file}.old ; done ; true ; } ; \
function restoreold () { for file ; do [ -f $${file}.old ] && mv -f $${file}.old $${file} ; done ; true ; } ; \
function deleteold () { for file ; do rm -f $${file}.old ; done ; true ; } ; \
function makeobsolete () { touch -r $$(ls *.old | tail -n 1) $${1} ; true ; } ; \
function nochange () { for file ; do [ ! -f $${1} ] || cmp $${1} $${1}.old >/dev/null || return ; done ; true ; } ; \
saveold $(MONITOR_FILES) ; \
if $(LATEX) $* ; then \
if nochange $(MONITOR_FILES) ; then \
echo "$(MAKE): LaTeX auxiliary files did not change (processing is complete)" ; \
restoreold $(MONITOR_FILES) ; \
else \
echo "$(MAKE): LaTeX auxiliary files changed (further processing is required)" ; \
echo "please wait..." ; sleep 2 ; \
makeobsolete $@ ; \
deleteold $(MONITOR_FILES) ; \
$(MAKE) --no-print-directory $@ ; \
fi ; \
else \
echo ; \
false ; \
fi
endef
$(DVI_FILE) : %.dvi : $(TEX_FILES) $(MONITOR_FILES) $(GRAPHIC_FILES) $(XFIG_TEX)
$(run-latex)
$(PDF_FILE) : %.pdf : $(TEX_FILES) $(MONITOR_FILES) $(GRAPHIC_FILES) $(XFIG_TEX)
$(run-latex)
#
# Generate a .bbl file from the .aux file.
#
%.bbl : %.aux $(BIB_FILES)
BSTINPUTS="$(BSTINPUTS)" BIBINPUTS="$(BIBINPUTS)" bibtex $*
#
# Generate a .ind file from the .idx file.
#
%.ind : %.idx
makeindex $<
#
# Generate a .aux or .idx file if it doesn't already exist. The existance
# of these files is a prerequisite for the main document processing loop
# above so that's what we're doing here. Note, however, that all .fig.tex
# files must be present in order for this first pass to succeed
#
%.aux %.idx : $(XFIG_TEX)
$(LATEX) $*
#
# Distill xfig .fig files into .fig.tex and either .fig.pdf or .fig.ps
# compoents
#
ifeq ($(notdir $(LATEX)),pdflatex)
%.fig.tex : %.fig %.fig.pdf
fig2dev -L pstex_t -p $*.fig.pdf <$< >$@
else
%.fig.tex : %.fig %.fig.ps
fig2dev -L pstex_t -p $*.fig.ps <$< >$@
endif
%.fig.pdf : %.fig
pushd $(dir $<) ; fig2dev -L pstex <$(nodir $<) | ps2pdf - - >$(nodir $@) ; popd
%.fig.ps : %.fig
pushd $(dir $<) ; fig2dev -L pstex <$(notdir $<) >$(notdir $@) ; popd

17
manual/Makefile Normal file
View file

@ -0,0 +1,17 @@
.PHONY: all buildmanual clean
all: rockbox-build.tex
rockbox-build.tex: rockbox.tex
@if [ "$(OBJDIR)" = "" ]; then echo Run make in you build diriectory!; false; fi
@mkdir -p $(OBJDIR)
@cp -R * $(OBJDIR)
@echo "\newcommand{\platform}{${ARCHOS}}" > $(OBJDIR)/rockbox-build.tex
@echo "\newcommand{\buildversion}{$(VERSION)}" >> $(OBJDIR)/rockbox-build.tex
@echo "\input{rockbox.tex}" >> $(OBJDIR)/rockbox-build.tex
@mv $(OBJDIR)/Makefile.pdflatex $(OBJDIR)/Makefile
make -C $(OBJDIR)
clean:
@if [ "$(OBJDIR)" == "" ]; then echo Run make in you build diriectory!; false; fi
@rm -rf $(OBJDIR)/manual $(OBJDIR)/*.pdf

10
manual/Makefile.pdflatex Normal file
View file

@ -0,0 +1,10 @@
DOCUMENT := rockbox-build
LATEX := pdflatex
include LaTeX.Rules
GRAPHIC_FILES:=`find . -name \*.jpg \*.jpeg`
.PHONY: all cleaner buildmanual output
buildmanual: rockbox-build.tex
@cp $(OBJDIR)/rockbox-build.pdf $(OBJDIR)/../rockbox-$(ARCHOS)-$(VERSION).pdf

View file

@ -0,0 +1,947 @@
\appendix
\chapter{The appendix}
\section{Feature comparison chart}
\begin{tabular}[c]{|p{10.382cm}|p{2.799cm}|p{2.411cm}|}
\hline
{\centering\bfseries\itshape
FEATURE
\par}
&
{\centering\bfseries\itshape
ROCKBOX
\par}
&
{\centering\bfseries\itshape
ARCHOS
\par}
\\\hline
\endhead
ID3v1 and ID3v2 support
&
Yes
&
ID3v1
\\\hline
Background noise during playback
&
No
&
Yes
\\\hline
Mid{}-track resume
&
Yes
&
No
\\\hline
Mid{}-playlist resume
&
Yes
&
No
\\\hline
Resumed playlist order
&
Yes
&
No
\\\hline
Battery lifetime
&
Longer
&
Long
\\\hline
Battery time indicator
&
Yes
&
No
\\\hline
Customizable font (Recorder)
&
Yes
&
No
\\\hline
Customizable screen info when playing songs
&
Yes
&
No
\\\hline
USB attach/detach without reboot
&
Yes
&
No
\\\hline
Can load another firmware without rebooting
&
Yes
&
No
\\\hline
Playlist load speed, songs/sec
&
3000 {}- 4000
&
15 {}- 20
\\\hline
Max number of songs in a playlist
&
20 000
&
999
\\\hline
Supports bad path prefixes in playlists
&
Yes
&
Yes
\\\hline
Open source/development process
&
Yes
&
No
\\\hline
Corrects reported bugs
&
Yes
&
No
\\\hline
Automatic Volume Control (Recorder)
&
Yes
&
No
\\\hline
Pitch control (Recorder)
&
Yes
&
No
\\\hline
Text File Reader
&
Yes
&
Yes
\\\hline
Games (Recorder)
&
8
&
No
\\\hline
Games (Player)
&
2
&
No
\\\hline
File Delete \& Rename
&
Yes
&
Yes
\\\hline
Playlist Building
&
Yes
&
Yes
\\\hline
Recording (Recorder)
&
Yes
&
Yes
\\\hline
Generates XING VBR header when recording
&
Yes
&
Yes
\\\hline
High Resolution Volume Control
&
Yes
&
No
\\\hline
Deep discharge option (Recorder)
&
Yes
&
No
\\\hline
Customizable backlight timeout
&
Yes
&
Yes
\\\hline
Backlight{}-on when charging option
&
Yes
&
No
\\\hline
Queue function
&
Yes
&
Yes
\\\hline
Supports the XING header
&
Yes
&
Yes
\\\hline
Supports the VBRI header
&
Partly
&
Yes
\\\hline
Max number of files in a directory
&
10 000
&
999
\\\hline
Adjustable scroll speed
&
Yes
&
No
\\\hline
Screensaver style demos (Recorder)
&
Yes
&
No
\\\hline
Variable step / accelerating ffwd and rwd
&
Yes
&
No
\\\hline
Visual Progress Bar
&
Yes
&
No
\\\hline
Select/Load configurations
&
Yes
&
No
\\\hline
Sleep timer
&
Yes
&
No
\\\hline
Easy User Interface
&
Yes
&
No
\\\hline
Remote Control Controllable
&
Yes
&
Yes
\\\hline
ISO8859{}-1 font support (Player)
&
Yes
&
No
\\\hline
Queue songs to play next
&
Yes
&
Yes
\\\hline
Bookmark positions in songs
&
Yes
&
No
\\\hline
Number of available languages
&
24
&
3
\\\hline
Accurate VBR bitrate display
&
Yes
&
No
\\\hline
FM Tuner support (FM Recorder)
&
Yes
&
Yes
\\\hline
FF/FR with sound
&
No
&
Yes
\\\hline
Pre{}-Recording (Recorders)
&
Yes
&
Yes
\\\hline
Video Playback with sound (Recorders)
&
Yes
&
No
\\\hline
Boot Time from Flash (in seconds)
&
4
&
12
\\\hline
Speaking Menus Support
&
Yes
&
No
\\\hline
\end{tabular}
\section{Supported file formats}
\begin{center}\begin{tabular}{|p{0.46100003cm}|p{3.296cm}|p{12.339cm}|}
\hline
&
{\centering\bfseries\itshape
FILE TYPE
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.37cm,height=0.423cm]{images/rockbox-manual-img80.png}
&
Directory
&
The browser enters that directory
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.45cm,height=0.385cm]{images/rockbox-manual-img81.png}
&
.mp3
&
Rockbox takes you to the WPS and starts playing the file
\\\hline
[Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=0.019cm,height=0.041cm]{images/rockbox-manual-img82.jpg}
[Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=0.397cm,height=0.45cm]{images/rockbox-manual-img83.png}
&
.m3u
&
Rockbox loads the playlist and starts playing the first file
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.448cm,height=0.51cm]{images/rockbox-manual-img84.png}
&
.ajz/ .mod
&
ROLO will load the new firmware
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.467cm,height=0.513cm]{images/rockbox-manual-img85.png}
&
.wps
&
The new WPS display configuration will be loaded
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.439cm,height=0.437cm]{images/rockbox-manual-img86.png}
&
.lng
&
That language will replace current one
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.439cm,height=0.483cm]{images/rockbox-manual-img87.png}
&
.txt
&
This will display the text file using Rockbox text browser plugin
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.445cm,height=0.487cm]{images/rockbox-manual-img88.png}
&
.cfg
&
The settings file will be loaded
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.492cm,height=0.513cm]{images/rockbox-manual-img89.png}
&
.fnt
&
This font will replace the current one (Recorder only)
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.413cm,height=0.45cm]{images/rockbox-manual-img90.png}
&
.rock
&
Starts a Rockbox plugin
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.413cm,height=0.439cm]{images/rockbox-manual-img91.png}
&
.ucl
&
This Rockbox image will be flashed into the ROM
\\\hline
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.318cm,height=0.423cm]{images/rockbox-manual-img92.png}
\end{center}
&
.ch8
&
Play a Chip8 game
\\\hline
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.318cm,height=0.423cm]{images/rockbox-manual-img93.png}
\end{center}
&
.jpg
&
View a JPEG image
\\\hline
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=0.319cm,height=0.42cm]{images/rockbox-manual-img94.png}
\end{center}
&
.rvf
&
View a movie (Rockbox format)
\\\hline
\end{tabular}\end{center}
\section{Bug reports}
If you experience inappropriate performance from any supported feature,
please file a bug report on our web page. Do not report missing
features as bugs, instead file them as feature requests (see below).
For open bug reports refer to
\url{http://www.rockbox.org/bugs.shtml}{http://www.rockbox.org/bugs.shtml}
{\bfseries
Rules for submitting new bug reports:}
\begin{enumerate}
\item Check that the bug hasn't already been reported
\item Always include the following information in your bug report:
\end{enumerate}
\begin{itemize}
\item \begin{itemize}
\item Which exact model Jukebox you have (as printed on the unit)
\item Which exact ROM firmware version you have
\item Which exact Rockbox version you are using
(Menu{}-{\textgreater}Info {}-{\textgreater} Version)
\item A step{}-by{}-step description of what you did and what happened
\item Whether the problem is repeatable or a one{}-time
\foreignlanguage{english}{occurrence}
\item All relevant data regarding the problem, such as playlists, MP3
files etc. (IMPORTANT!)
\end{itemize}
\end{itemize}
\begin{enumerate}
\item If you have a Sourceforge account, log
in before you file the report.
\item If you don't have a SF account, sign the report
with your email.
\end{enumerate}
\section{Feature requests}
For open feature requests refer to
\url{http://www.rockbox.org/requests.shtml}
{\bfseries
Rules for submitting a new feature request:}
\begin{enumerate}
\item Check that the feature hasn't already been
requested. Duplicates are really boring!
\item Check that the feature hasn't already been
implemented. Download the latest daily build and/or search the mail
list archive.
\item Check that the feature is possible to implement (see page
\pageref{ref:NODO}).
\item You must be logged in with your Sourceforge account to submit a
request. If you don't have an account, get one.
\end{enumerate}
\subsection{\label{ref:NODO}Features we will not implement}
This is a list of Feature Requests we get repeatedly that we simply
cannot do. View it as the opposite of a TODO!
\begin{itemize}
\item {\bfseries
Record to WAV (uncompressed) or MP3pro format!}
The recording hardware (the MAS) does not allow us to do this
\item {\bfseries
Crossfade between tracks!}
Crossfading would require two mp3 decoders,
and we only have one. This is not possible.
\item {\bfseries
Interfacing with other USB devices (like cameras) or 2 player games over
USB}
The USB system demands that there is a master that talks to a slave. The
Jukebox can only serve as a slave, as most other USB devices such as
cameras can. Thus, without a master no communication between the slaves
can take place.
If that is not enough, we have no ways of actually controlling the
communication performed over USB since the USB circuit in the Jukebox
is strictly made for disk{}-access and does not allow us to play with
it the way we'd need for any good communication to
work.
\item {\bfseries
Support MP3pro, WMA or other sound format playback!}
The mp3{}-decoding hardware can only play MP3. We cannot make it play
other sound formats.
\item {\bfseries
Converting OGG{}-{\textgreater}MP3}
The mp3{}-decoding hardware cannot decode OGG. It can be reprogrammed,
but there is too little memory for OGG and we have no documentation on
how to program the MAS' DSP.
Doing the conversion with the CPU is impossible, since a 12MHz SH1 is
far too slow for this daunting task.
\item {\bfseries
Archos Multimedia support!}
The Archos Multimedia is a completely different beast. It is an entirely
different architecture, different CPU and upgrading the software is
done a completely different way. We do not wish to venture into this.
Others may do so. We won't.
\item {\bfseries
Multi{}-band (or graphic) equaliser!}
We cannot access information for that kind of visualisation from the MP3
decoding hardware.
\item {\bfseries
Support other filesystems than FAT32 (like
NTFS or ext2 or whatever)!}
No. Rockbox needs to support FAT32 since it can only start off a FAT32
partition (since that is the only way the ROM can load it), and adding
support for more file systems will just take away valuable ram for
unnecessary features.
You can partition your Jukebox fine, just make sure the first one is
FAT32 and then make the other ones whatever file system you want. Just
don't expect Rockbox to understand them.
\item {\bfseries
Add scandisk{}-like features!}
It would be a very slow operation that would drain the batteries and
take a lot of useful ram for something that is much better and faster
done when connected to a host computer.
\item {\bfseries
CBR recording!}
The MP3 encoding hardware does not allow this.
\item {\bfseries
Change tempo of a song without changing pitch!}
The MP3 decoding hardware does not allow this.
\end{itemize}
\begin{itemize}
\item {\bfseries
Graphic frequency (spectrum analyser!)}
We can't access the audio waveform from the MP3 decoder
so we can't analyse it. Even if we had access to it, the CPU would probably be too slow to perform the analysis anyway.
\end{itemize}
\begin{itemize}
\item {\bfseries
Cool sound effects!}
Adding new sound effects requires reprogramming the MAS chip, and we
can't do that. The MAS chip is programmable, but we
have no access to the chip documentation.
\end{itemize}
\section{What's new since 2.0?}
{\bfseries
Changes in version 2.4}
\begin{itemize}
\item Improved shuffle
\item Improved disk write performance
\item Improved Ondio support
\item Various bug fixes
\item Added 74 and 80 minute recording time splits for convenient CD
creation
\end{itemize}
{\bfseries
Changes in version 2.3}
\begin{itemize}
\item {\bfseries
General changes since 2.2}
\begin{itemize}
\item Spoken menus, filenames and directories
\item Support for Archos Ondio
\item File type associations and ``open with...'' plugin bindings
\item Added ability to delete directories, even recursively
\item New WPS tags for information about next song in playlist
\item ON+PLAY menu can now also be accessed with a long press on PLAY
\item New directory sort options: date and file type
\item Clean shutdown which spins down the disk before cutting power
\item Faster scrolling in file browser
\item Easy{}-to{}-use installation program for windows
\item New language: Bulgarian
\item New plugins: Sort, euroconverter, search, chess clock, vbrfix,
stopwatch, metronome
\end{itemize}
\item {\bfseries
Recorder{}-specific changes since 2.2}
\begin{itemize}
\item During recording disk doesn't spin up until
needed, allowing undisturbed use of internal mic for short recordings
\item Optional button help bar at bottom of screen
\item More detailed MDB (dynamic bass) settings
\item ROMbox, optionally saving \~{}170KB RAM by running code from flash
on Recorder v1 and Ondio SP
\item Recording can pause
\item Recorded files now get ID3 v2.3 tags instead of v2.4, since some
tools have problems reading v2.4 tags
\item Red LED behaviour changed during recording: On during recording
and blinking when paused
\item New font format. 2.3 requires new fonts, 2.2 fonts are not
compatible.
\item New plugins: Minesweeper, solitaire, mp3 split editor, snake2,
pong, JPEG viewer, Mandelbrot
\end{itemize}
\end{itemize}
{\bfseries
Changes in version 2.2}
\begin{itemize}
\item Bookmarking functions added
\item Improved playlist support
\item WPS enhancements
\item New plugins: greyscale, Mandelbrot,
metronome
\item Recording enhancements (recorder)
\item Bug fixes
\end{itemize}
{\bfseries
General changes since 2.0}
\begin{itemize}
\item Loadable plugins
\item Dynamic playlist creation and manipulation
\item Configurable max directory size (default: 400 files)
\item Configurable max playlist size (default: 10000 files)
\item Remote control now works while keys are locked
\item Car mode: Pauses and resumes playback with charger power loss and
restore
\item Caption backlight: Briefly turns on backlight during track change
\item Battery meter is more accurate during the first minutes after boot
\item Automatically detects modified archos.mod/ ajbrec.ajz after
exiting USB mode and asks if you want to run it
\item Files and configurations in /.rockbox are now accessible from Menu
\item Stopped playlists can be resumed from File Browser by pressing ON
\item Never turns off/reboots while charger is connected
\item .wps files now support comments
\item Improved ID3v2 support
\item Option of hiding icons in File Browser
\end{itemize}
{\bfseries
Player{}-specific changes since 2.0}
\begin{itemize}
\item Games: Jackpot and NIM
\item Jump scroll: Scrolls the entire screen width each step
\item The Line In port is enabled
\end{itemize}
{\bfseries
Recorder{}-specific changes since 2.0}
\begin{itemize}
\item Rockbox can now be stored in flash ROM, giving much quicker boot up
\item Support for V2 recorders
\item Radio support (FM Recorder only)
\item Default contrast is now auto{}-detected, preventing unreadable
display
\item Option of using an inverted bar instead of cursor in File Browser
and Menu
\item Frame{}-accurate recording file splits set manually or preset by time
\item Improved Xing header generation in recorded files
\item New games: FlipIt, Snake, Star, Sliding Puzzle and Chip8 emulator
\item A calendar application plugin
\end{itemize}
\section{Credits}
People that have contributed to the project, one way or another.
Friends!}
\begin{center}
\begin{minipage}{16.15cm}
Bj\"orn Stenberg \newline
Linus Nielsen Feltzing \newline
Andy Choi \newline
Andrew Jamieson \newline
Paul Suade \newline
Joachim Schiffer \newline
Daniel Stenberg \newline
Alan Korr \newline
Gary Czvitkovicz \newline
Stuart Martin \newline
Felix Arends \newline
Ulf Ralberg \newline
David H\"ardeman \newline
Thomas Saeys \newline
Grant Wier \newline
Julien Labruy\'ere \newline
Nicolas Sauzede \newline
Robert Hak \newline
Dave Chapman \newline
Stefan Meyer \newline
Eric Linenberg \newline
Tom Cvitan \newline
Magnus \"Oman \newline
Jerome Kuptz \newline
Julien Boissinot \newline
Nuutti Kotivuori \newline
Heikki Hannikainen \newline
Hardeep Sidhu \newline
Markus Braun \newline
Justin Heiner \newline
Magnus Holmgren \newline
Bill Napier \newline
George Styles \newline
Mats Lidell \newline
Lee Marlow \newline
Nate Nystrom \newline
Nick Robinson \newline
Chad Lockwood \newline
John Pybus \newline
Uwe Freese \newline
Randy Wood \newline
Gregory Haerr \newline
Philipp Pertermann \newline
Gilles Roux \newline
Mark Hillebrand \newline
Damien Teney \newline
Andreas Zwirtes \newline
Kjell Ericson \newline
Jim Hagani \newline
Ludovic Lange \newline
Mike Holden \newline
Simon El\'en \newline
Matthew P. OReilly \newline
Christian Sch\"onberger \newline
Henrik Backe \newline
Craig Sather \newline
Jos\'e Maria Garcia{}-Valdecasas Bernal\newline
Stevie Oh \newline
J\"org Hohensohn \newline
Dave Jones \newline
Thomas Paul Diffenbach \newline
Roland Kletzing \newline
Itai Shaked \newline
Keith Hubbard \newline
Benjamin Metzler \newline
Frederic Dang Ngoc \newline
Pierre Delore \newline
Huw Smith \newline
Garrett Derner \newline
Barry McIntosh \newline
Leslie Donaldson \newline
Lee Pilgrim \newline
Zakk Roberts \newline
Francois Boucher \newline
Matthias Wientapper \newline
Brent Coutts \newline
Jens Arnold \newline
Gerald Vanbaren \newline
Christi Scarborough \newline
Steve Cundari \newline
Mat Holton \newline
Jan Gajdos \newline
Antoine Cellerier \newline
Brian King \newline
Jiri Jurecek \newline
Jacob Erlbeck
\end{minipage}\end{center}
\section{GNU Free Documentation Licence}
Version 1.2, November 2002
\begin{verbatim}
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, 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.
\end{verbatim}
\textbf{0. PREAMBLE}
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
\textbf{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 "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications 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 Document's 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 fit the above definition 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 specification 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 file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification 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 modification. 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 work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
\textbf{2. VERBATIM COPYING}
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
\textbf{3. COPYING IN QUANTITY}
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
\textbf{4. MODIFICATIONS}
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
* A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
* B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
* C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
* D. Preserve all the copyright notices of the Document.
* E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
* F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
* G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
* H. Include an unaltered copy of this License.
* I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
* J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
* K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
* L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
* M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
* N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
* O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
\textbf{5. COMBINING DOCUMENTS}
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements."
\textbf{6. COLLECTIONS OF DOCUMENTS}
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
\textbf{7. AGGREGATION WITH INDEPENDENT WORKS}
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
\textbf{8. TRANSLATION}
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
\textbf{9. TERMINATION}
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
\textbf{10. FUTURE REVISIONS OF THIS LICENSE}
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

View file

@ -0,0 +1,139 @@
\section{Before installation}
Before you install Rockbox, you will need to know what model of Archos
Jukebox you own. Rockbox comes in different versions depending on the
model of your Jukebox. There are six different versions of the
software. The table below will help you to identify which version of
the software you need.
The model name is printed on the case. The hard drive size is listed on
the serial number sticker on the back of the unit.
\begin{minipage}{16.589cm}
\begin{center}\begin{tabular}{|p{1.846cm}|p{5.6280003cm}|p{6.053cm}|p{2.195cm}|}
\hline
{\centering\bfseries\itshape
\label{ref:Jukeboxtypetable}Picture
\par}
&
{\centering\bfseries\itshape
DISK size
\par}
&
{\centering\bfseries\itshape
Model Name
\par}
&
{\centering\bfseries\itshape
Version Name
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.117cm,height=2.858cm]{images/rockbox-manual-img2.jpg}
&
{\centering
5GB, 6GB, 10GB, 20GB
\par}
&
{\centering
Jukebox 5000,\newline
Jukebox 6000,\newline
Jukebox Studio 10,\newline
Jukebox Studio 20
\par}
&
{\centering
player
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.117cm,height=2.822cm]{images/rockbox-manual-img3.jpg}
&
{\centering
6GB, 10GB, 15GB, 20GB
\par}
&
{\centering
Jukebox Recorder 6,\newline
Jukebox Recorder 10,\newline
Jukebox Recorder 15,\newline
Jukebox Recorder 20
\par}
&
{\centering
recorder
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img4.jpg}
&
{\centering
20GB
\par}
&
{\centering
Jukebox Recorder v2
\par}
&
{\centering
recorderv2
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img5.jpg}
&
{\centering
20GB
\par}
&
{\centering
Jukebox Recorder FM
\par}
&
{\centering
fmrecorder
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.12cm,height=2.889cm]{images/rockbox-manual-img6.jpg}
&
{\centering
128MB\newline
(flash)
\par}
&
{\centering
Ondio 128 SP
\par}
&
{\centering
ondiosp
\par}
\\\hline
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img7.jpg}
&
{\centering
128MB\newline
(flash)
\par}
&
{\centering
Ondio 128 FM
\par}
&
{\centering
ondiofm
\par}
\\\hline
\end{tabular}\end{center}
\end{minipage}Please note that Rockbox does not run on the Archos
Jukebox Multimedia or any Archos MP3 player products other than those
mentioned here.

View file

@ -0,0 +1,112 @@
\chapter{Getting started}
\newpage
\section{Welcome}
This is the manual for Rockbox. Rockbox is a replacement firmware for the
Jukebox Studio, Recorder and Ondio players made by Archos, the H120/140
players from iRiver and the Apple iPod Nano etc. It is a complete rewrite of
the software used to make the PDA play and record music, and contains many
features and enhancements not available in the original firmware supplied by
the manufacturer. Among the things that Rockbox has to offer are the
following:
\begin{itemize}
\item Faster loading than the \playername firmware
\item Uninterrupted playing of MP3 files {--} skipping is very rare
\item More control over how your music is played
\item Built in viewers for several common file types
\item Sophisticated plugin system that allows the Jukebox to run games,
a calendar, a clock, and many other applications.
\item Totally removable. (Removal of Rockbox before returning the
Jukebox for repair under warranty is advised.)
\item Optional voice user interface for complete control without looking
at the screen
\end{itemize}
Rockbox is a complete from scratch rewrite of the \playername software and
uses no fragments of the original firmware. Not only is it free to
use, it's also released under the GNU public license,
which means that it will always remain free to both use and to change.
\opt{OndioSP,OndioFM}{Although Rockbox also runs on the Archos Ondio series of
flash based MP3 players, this is a recent development, which is not covered
fully in this manual. Most of this manual will, however, apply equally to
Rockbox on the Ondio Jukeboxes. For more details on the Ondio port, please
see the web page:
\url{http://www.rockbox.org/twiki/bin/view/Main/ArchosOndio}.}
\section{Getting more help}
This manual is intended to be a comprehensive introduction to the Rockbox
software. There is, however, more help available. The Rockbox website at
\url{http://www.rockbox.org/}contains very extensive documentation and guides
written by members of the Rockbox community and this should be your first port
of call when looking for further help.
\opt{Archos}{\input{chapter1/archos_choice}}
\section{Downloading Rockbox}
The latest release of the Rockbox software will always be available from
\url{http://www.rockbox.org/download/}.
Windows users may wish to download the self{}-extracting Windows
installer, which works for all Jukebox models, but those wishing to
install manually or using a different operating system should choose
the .zip archive containing the firmware for their model of the
Jukebox.
\section{Installing Rockbox}
Using the Windows self installing executable to install Rockbox is the easiest
method of installing the software on your Jukebox. Simply follow the
on{}-screen instructions and select the appropriate drive letter and Jukebox
model when prompted. You can use ``Add / Remove Programs'' to uninstall the
software at a later date.
For non{}-Windows users and those wishing to install manually from the archive
the procedure is still fairly simple. Connect your \playername to the computer
via USB as described in the manual that came with your \playername. On Windows,
the \playername drive will appear as a drive letter in your ``My Computer''
folder. Take the file that you downloaded above, and unpack its contents to
your \playername drive. You can do this using a program such as
\url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
You will need to unpack all of the files in the archive onto your hard
disk. If this has been done correctly, you will have a file called
\opt{PS}{\fname{archos.mod}}
\opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}}
\opt{H120,H340}{\fname{rockbox.iriver}}
in the main folder of your \playername drive, and also a folder called
/\fname{.rockbox}, which contains a number of system files used by the
software.
\section{Enabling Speech Support (optional)}
If you wish to use speech support you will also need a language file,
available from
\url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}.
For the English language, the file is called \fname{english.voice}.
When it has been downloaded, unpack this file and copy it into the
\fname{lang} folder which is inside the /\fname{.rockbox} folder on
your Jukebox. Voice menus are turned on by default. See page
\pageref{ref:Voiceconfiguration} for details on voice settings.
\section{Running Rockbox}
Remove your Jukebox from the computer's USB port.
Unplug any connected power supply and turn the unit off. When you next
turn the unit on, the Jukebox firmware will start to load, and then it
will load Rockbox for you. When you see the Rockbox splash screen,
Rockbox is loaded and ready for use.
\section{Uninstalling Rockbox}
If you would like to go back to using the
original \playername software, then connect the \playername up to your computer,
and delete the
\opt{PS}{\fname{archos.mod}}
\opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}}
\opt{H120,H340}{\fname{rockbox.iriver}}
If you wish to clean up your disk, you may also wish to delete the
\fname{.rockbox} folder and its contents. Turn the \playername off and on and
the normal \playername software will load.

View file

@ -0,0 +1,804 @@
\chapter{\label{ref:PARTII}The Rockbox interface}
\clearpage
\section{Your Jukebox}
\begin{minipage}{16.554cm}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=7.904cm,height=10.723cm]{images/rockbox-manual-img8.jpg}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=7.87cm,height=10.703cm]{images/rockbox-manual-img9.jpg}
\newline
Jukebox Player Jukebox Recorder
\par}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=7.87cm,height=10.7cm]{images/rockbox-manual-img10.jpg}
\newline
Ondio 128
\par}
\end{minipage}
Throughout this manual, the buttons on the Jukebox are labelled
according to the pictures above. There are minor cosmetic differences
between Jukebox models, but the buttons are in approximately the same
position as on the picture.\\
To turn on a Jukebox containing Rockbox, hold down the ON key
for 2{}-3 seconds. (Flashed Jukeboxes only require a tap of the ON key
{--} see page \textup{\pageref{ref:FlashingRockboxReal}} for more
information about flashing Rockbox.)
\label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings and turns off the hard drive safely. To tell Rockbox to shut the Jukebox down, do the following:
\begin{center}\begin{tabular}{|p{5.905cm}|p{10.558001cm}|}
\hline
{\centering\bfseries\itshape
model
\par}
&
{\centering\bfseries\itshape
POWER OFF
\par}
\\\hline
{\centering
V2 / FM RECORDER/ ONDIO
\par}
&
Hold the OFF key for 2{}-3 seconds
\\\hline
{\centering
V1 RECORDER
\par}
&
Double{}-tap the OFF key when playback is stopped
\\\hline
{\centering
PLAYER
\par}
&
From the Rockbox Main Menu select \textbf{Shutdown}
\\\hline
\end{tabular}\end{center}
In the unlikely event of a software failure, a hardware power off can be
performed by holding down STOP until the Jukebox power light goes off.
This works for all models of Jukebox.\\
For further details about connecting, charging and caring for your
Jukebox, please see the Archos manual that came with it.
\section{\label{ref:PartIIFB}File Browser}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img11.png}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=1.981cm]{images/rockbox-manual-img12.png}
\newline
Recorder file browser Player file browser
\par}
The file browser helps you navigate through the files on your Jukebox,
entering folders and executing the default action on each file. To help
us differentiate files, each file format is displayed with an icon. You
can select which file types are displayed (see page
\pageref{ref:ShowFiles}).
\subsection{\label{ref:PartIISectionCtrls}Controls}
\opt{Rec}{
\begin{center}\begin{tabular}{|p{4cm}|p{10cm}|}
\hline
\tabelth{KEY} & \tabelth{FUNCTION} \\ \hline
%
\tabeltc{UP/DOWN} &
Go to previous/next item in list. If you are on the first/last entry,
the cursor will wrap to the last/first entry. \\ \hline
%
\tabeltc{ON+UP/DOWN} &
Move one page up/down on the list.\\ \hline
%
\tabeltc{LEFT} & Go to the parent directory. \\ \hline
%
\tabeltc{PLAY/RIGHT} &
Executes an action. Depending on the file type, that action may vary.
(See page \pageref{ref:Filemenu}) \\ \hline
%
\tabeltc{centering} &
If there is a MP3 playing, returns to the While Playing Screen (WPS)
without stopping playback. \\ \hline
%
\tabeltc{ON+PLAY/HOLD PLAY} & Enters the File Menu \\ \hline
%
\tabeltc{F1} & Switches to the Main Menu \\ \hline
%
\tabeltc{F2} & Switches to the Browse/Play Quick Menu \\ \hline
%
\tabeltc{F3} & Switches to the Display Quick Menu \\ \hline
%
\end{tabular}\end{center}
}
%
\opt{PS}{
\begin{tabular}[c]{|p{4.314cm}|p{12.288cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
MINUS/PLUS
\par}
&
Go to previous/next item in list. If you are on the first/last entry,
the cursor will wrap to the last/first entry.
\\\hline
{\centering
STOP
\par}
&
Go to the parent directory.
\\\hline
{\centering
PLAY
\par}
&
Executes an action. Depending on the file type, that action may vary.
(See page \pageref{ref:Filemenu})
\\\hline
{\centering
ON
\par}
&
If there is a MP3 playing, returns to the While Playing Screen (WPS)
without stopping playback.
\\\hline
{\centering
ON+PLAY/HOLD PLAY
\par}
&
Enters the File Menu
\\\hline
{\centering
Menu
\par}
&
Switches to the Main Menu
\\\hline
\end{tabular}
The functions of the F keys are also summarised on the button bar at the
bottom of the screen.
}
\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img13.png}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img14.png}
\newline
Recorder file menu Player file menu
\par}
This menu operates on the file that was selected in the browser at the
time ON+PLAY was pressed to enter it. It can also be accessed by
holding down the PLAY key for a short while. It offers the following
options:
\begin{itemize}
\item \textbf{Open with:} Runs a viewer plugin on the file.
Normally the filetype of a file is detected and the appropriate plugin
is run automatically when you press play on it. Use this menu if for
some reason you want to override the default action and select a viewer
by hand. See page \textmd{\pageref{ref:Viewersplugins}} for more details on viewers.
For example, this would be used to run the VBRfix plugin to recreate the
Xing header for an MP3 file, which can fix problems such as
fast{}-forward and rewind not working correctly on a particular MP3 file or the play time of a track being listed incorrectly.
\item \textbf{Playlist:} Change to the Playlist submenu (see below).
\item \textbf{Rename:} This function lets the user modify a file name.
\item \textbf{Delete:} Only files can be deleted, not folders. Rockbox will ask for confirmation before deleting a file. Press PLAY to confirm deletion or any other key to cancel.
\item \textbf{Delete Directory: }Deletes the folder pointed to by the cursor and all the files and folders contained in it. Use with caution.
\item \textbf{Create Directory:} Makes a new folder in the current folder on
the disk.
\end{itemize}
\subsection{\label{ref:Playlistsubmenu}Playlist Submenu}
If the playlist submenu is invoked on a directory, it will act on all the files within that directory. If invoked on a playlist it will act on all the files in that playlist. Otherwise it acts only on the current file.
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img15.png}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img16.png}
\newline
Recorder playlist submenu Player playlist submenu
\par}
This menu provides the following options:
\begin{itemize}
\item \textbf{Insert:} Add track(s) to playlist. If no other tracks have been
inserted then the selected track will be added immediately after
current playing track, otherwise they will be added to end of insertion
list.
\item \textbf{Insert next: }Add track(s) immediately after current playing
track, no matter what else has been inserted.
\item \textbf{Insert last: }Add track(s) to end of playlist.
\item \textbf{Queue: } Queue is the same as Insert except queued
tracks are deleted immediately from the playlist after
they've been played. Also, queued tracks are not saved to the playlist file (see page \pageref{ref:playlistoptions}).
\item \textbf{Queue next:} Queue track(s) immediately after current playing
track.
\item \textbf{Queue last: }Queue track(s) at end of playlist.
\end{itemize}
You can insert a track, directory or playlist even if nothing is
currently playing. In this case, a new playlist is created with only
the selected tracks and then play is started.
Note: The dynamic playlist is saved so resume will restore it exactly as
before shutdown. Stopped playlists can be resumed from File Browser by
pressing ON.
\subsection{Virtual Keyboard}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.165cm,height=2.177cm]{images/rockbox-manual-img17.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=4.598cm,height=2.071cm]{images/rockbox-manual-img18.png}
\newline
Recorder keyboard Player Keyboard
\par}
This is the virtual keyboard that is used when entering file names in
Rockbox.
\opt{Rec}{
\begin{tabular}[c]{|p{3.8799999cm}|p{12.653cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
ARROW KEYS
\par}
&
Move about the virtual keyboard (moves the solid cursor)
\\\hline
{\centering
ON+LEFT/RIGHT
\par}
&
Move about within the current file name (moves the line cursor)
\\\hline
{\centering
PLAY
\par}
&
Inserts the currently selected keyboard letter at the current filename
cursor position
\\\hline
{\centering
STOP
\par}
&
Exits the virtual keyboard without saving any changes
\\\hline
{\centering
ON
\par}
&
No action
\\\hline
{\centering
F1
\par}
&
SHIFT: Shifts between the upper case, lower case and accented keyboards
\\\hline
{\centering
F2
\par}
&
OK: Exits the virtual keyboard and saves any changer
\\\hline
{\centering
F3
\par}
&
DEL: Deletes the character before the current filename cursor
\\\hline
\end{tabular}
}
\opt{PS}{
The current filename is always listed on the first line of the display.
The second line of the display can contain the character selection bar,
as in the screenshot above, or one of a number of other options.
\begin{center}\begin{tabular}{|p{3.86cm}|p{12.708cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
MINUS/PLUS
\par}
&
Moves the arrow to/from the filename and changes between the character
bar and BACKSPACE, DELETE, ACCEPT and ABORT.
\\\hline
{\centering
PLAY/STOP
\par}
&
Varies (see below)
\\\hline
{\centering
ON
\par}
&
Nothing
\\\hline
{\centering
Menu
\par}
&
Shift. When the character selection bar is selected this changes
between upper case, lower case, and accented letters.
\\\hline
\end{tabular}\end{center}
The function of the PLAY and STOP buttons depends on what the arrow is
pointing to, as follows.
\begin{center}\begin{tabular}{|p{4.243cm}|p{12.359cm}|}
\hline
{\centering\bfseries\itshape
SELECTED OPTION
\par}
&
{\centering\bfseries\itshape
PLAY/STOP FUNCTION
\par}
\\\hline
{\centering
filename
\par}
&
Moves the cursor left (STOP) or right (PLAY) within the filename
\\\hline
{\centering
character bar
\par}
&
Moves the character bar to the next (PLAY) or previous (STOP) character.
\\\hline
{\centering
BACKSPACE
\par}
&
PLAY deletes the character before the current cursor position
\\\hline
{\centering
DELETE
\par}
&
PLAY deletes the character at the current cursor position
\\\hline
{\centering
ACCEPT
\par}
&
PLAY exits the virtual keyboard and saves any changes
\\\hline
{\centering
ABORT
\par}
&
PLAY exits the virtual keyboard and discards any changes
\\\hline
\end{tabular}\end{center}
}
\section{\label{ref:WPS}\label{ref:PartIISectionWPS}While Playing
Screen}
The While Playing Screen (WPS) displays various pieces of information
about the currently playing MP3 file:
%
\opt{Rec}{
\begin{itemize}
\item Status bar: Battery level, charger status, volume, play mode, repeat
mode, shuffle mode and clock.
\item Scrolling path+filename of the current song.
\item The ID3 track name.
\item The ID3 album name.
\item The ID3 artist name.
\item Bit rate. VBR files display average bitrate and ``(avg)''
\item Elapsed and total time.
\item A slidebar progress meter representing where in the song you are.
\item Peak meter.
\end{itemize}
Notes:
\begin{itemize}
\item The number of lines shown depends on the size of the font used.
\item The peak meter is only visible if you turn off the status bar or if
using a small font that gives 8 or more display lines.
\end{itemize}
}
%
\opt{PS}{
\begin{itemize}
\item Playlist index/Playlist size: Artist {}- Title.
\item Current{}-time Progress{}-indicator Left.
\end{itemize}
See page \textmd{\pageref{ref:ConfiguringtheWPS}} for
details of customising your WPS (While Playing Screen).
}
\subsection{\label{ref:PartIISectionWPSCtrls}WPS Key Controls}
\opt{Rec}{
\begin{flushleft}\begin{tabular}{|p{3.407cm}|p{13.093cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN
\par}
&
Volume up/down
\\\hline
{\centering
LEFT
\par}
&
(quick press) Go to beginning of track, or if pressed while in the first
seconds of a track, go to previous track
\\\hline
{\centering
LEFT (hold)
\par}
&
Rewind in track
\\\hline
{\centering
RIGHT
\par}
&
(quick press) Go to next track.
\\\hline
{\centering
RIGHT (hold)
\par}
&
Fast forward in track.
\\\hline
{\centering
PLAY
\par}
&
Toggle play/pause
\\\hline
{\centering
ON
\par}
&
(quick press) Go to file browser
\\\hline
{\centering
ON (hold)
\par}
&
Show pitch setting screen
\\\hline
{\centering
STOP
\par}
&
Stop playback
\\\hline
{\centering
F1
\par}
&
Go to Main menu
\\\hline
{\centering
F2
\par}
&
Toggles Play/browse quick menu
\\\hline
{\centering
F3
\par}
&
Toggles Display quick menu
\\\hline
{\centering
F1+DOWN
\par}
&
Key lock on/off
\\\hline
{\centering
F1+PLAY
\par}
&
Mute on/off
\\\hline
{\centering
F1+ON
\par}
&
Enter ID3 viewer
\\\hline
\end{tabular}\end{flushleft}
}
%
\opt{PS}{
\begin{center}\begin{tabular}{|p{3.27cm}|p{13.29cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
MENU+PLUS
\par}
&
Increases volume
\\\hline
{\centering
MENU+MINUS
\par}
&
Decreases volume
\\\hline
{\centering
MINUS
\par}
&
(quick press) Go to beginning of track, or if pressed while in the first
seconds of a track, go to previous track.
\\\hline
{\centering
MINUS (hold)
\par}
&
Rewind in track
\\\hline
{\centering
PLUS
\par}
&
(quick press) Go to next track.
\\\hline
{\centering
PLUS (hold)
\par}
&
Fast{}-forward in track.
\\\hline
{\centering
PLAY
\par}
&
Toggle play/pause
\\\hline
{\centering
ON
\par}
&
Quick press = Go to file browser
\\\hline
{\centering
OFF
\par}
&
Stop playback
\\\hline
{\centering
MENU
\par}
&
Go to Main menu
\\\hline
{\centering
MENU+STOP
\par}
&
Key lock on/off
\\\hline
{\centering
MENU+PLAY
\par}
&
Mute on/off
\\\hline
{\centering
MENU+ON
\par}
&
Enter ID3 viewer
\\\hline
\end{tabular}\end{center}
}
\opt{Rec,Rec2,FMRec,OndioSP,OndioFM,H120}{
\subsection{Peak Meter}
The peak meter can be displayed on the While Playing Screen and consists
of several indicators. For a picture of the peak meter, please see the
While Recording Screen on page \pageref{ref:Whilerecordingscreen}.
\begin{itemize}
\item \textbf{The bar: }This is the wide horizontal bar. It represents the
current volume value.
\item \textbf{The peak indicator:} This is a little vertical line at the right
end of the bar. It indicates the peak volume value that occurred
recently.
\item \textbf{The clip indicator: }This is a little black block that is
displayed at the very right of the scale when an overflow occurs. It
usually doesn't show up during normal playback unless
you play an audio file that is distorted heavily. If you encounter
clipping while recording your recording will sound distorted. You
should lower the gain. Note that the clip detection is not very
precise. Clipping might occur without being indicated.
\item \textbf{The scale: }Between the indicators of the right and left channel
there are little dots. These dots represent important volume values. In
linear mode each dot is a 10\% mark. In dbfs mode the dots represent
the following values (from right to left): 0db, {}-3db, {}-6db, {}-9db,
{}-12db, {}-18db, {}-24db, {}-30db, {}-40db, {}-50db, {}-60db.
\end{itemize}
}
\subsection{\label{ref:ID3viewer}ID3 Viewer}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.833cm,height=2.191cm]{images/rockbox-manual-img21.png}
\newline
The ID3 viewer
\par}
This screen is accessible from the WPS screen by pressing F1+ON (recorder) or MENU+ON (player). It provides a detailed view of all the identity information about the current track that is stored in an MP3 file. Use the LEFT and RIGHT (recorder) or PLUS and MINUS (player) keys to move through the information and the STOP key to exit the viewer.
\opt{Rec,Rec2,FMRec,H120}{
\section{\label{ref:QuickScreenMenus}Quick Screen Menus}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img22.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img23.png}
\newline
F2 Quick Screen Menu F3 Quick Screen Menu
\par}
Rockbox handles function buttons in a different way to the Archos
software. F1 is always bound to the menu function, while F2 and F3
enable two quick menus.
F2 displays some browse and play settings which are likely to be changed
frequently. This settings are Shuffle mode, Repeat mode and the Show
files options
Shuffle mode plays each track in the currently playing list in a random
order rather than in the order shown in the browser.
Repeat mode repeats either a single track (One) or the entire playlist
(All).
Show files determines what type files can be seen in the browser. This
can be just MP3 files and directories (Music), Playlists, MP3 files and directories (Playlists), any files that Rockbox supports (Supported) or all files on the disk (All).
See page \pageref{ref:PlaybackOptions} for more information about these
settings.
\begin{center}\begin{tabular}{|p{2.852cm}|p{8.387cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
LEFT
\par}
&
Controls Shuffle mode setting
\\\hline
{\centering
RIGHT
\par}
&
Controls Repeat mode setting
\\\hline
{\centering
DOWN
\par}
&
Controls Show file setting
\\\hline
\end{tabular}\end{center}
F3 controls frequently used display options.
Scroll bar turns the display of the Scroll bar on the left of the screen
on or off.
Status bar turns the status display at the top of the screen on or off.
Upside down inverts the screen so that the top of the display appears
nearest to the buttons. This is sometimes useful when storing the
Jukebox in a pocket. Key assignments swap over with the display
orientation where it is logical for them to do so.
See page \pageref{ref:Displayoptions} for more information about these
settings.
\begin{tabular}[c]{|p{2.852cm}|p{8.387cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
LEFT
\par}
&
Controls scroll bar display
\\\hline
{\centering
RIGHT
\par}
&
Controls status bar display
\\\hline
{\centering
DOWN
\par}
&
Controls upside down screen setting
\\\hline
\end{tabular}
}

View file

@ -0,0 +1,492 @@
\chapter{The Main Menu}
\newpage
\section{Introducing the Main Menu}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img24.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img25.png}
\newline
Recorder main menu Player main menu
\par}
This is the screen from which the rest of the
Rockbox functions can be accessed. It is used for a variety of
functions, which are detailed below. You can access the Rockbox main
menu by pressing MENU (player/studio version) or F1 (recorder version)
key. All options in Rockbox can be controlled via this menu. Some of
them can also be found in the Quick Menus (recorder version only).
All settings are persistently stored on the unit. However, Rockbox does
not spin up the disk solely for the purpose of saving settings, but
instead will save them when it spins up the disk the next time, for
example when refilling the MP3 buffer or navigating through the file
browser. Changes to settings may therefore not be saved unless the
Jukebox is shut down safely (see page \pageref{ref:Safeshutdown}).
The two settings menus are covered in detail starting on page \pageref{ref:Part4}.
All the other options on the main menu are explained here.
Navigating through the menu:
\subsection{Recorder}
\begin{tabular}[c]{|p{3.27cm}|p{13.318cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP
\par}
&
Moves up in the menu. Inside a setting, increases the value or chooses
next option
\\\hline
{\centering
DOWN
\par}
&
Moves down in the menu. Inside a setting, decreases the value or chooses
previous option
\\\hline
{\centering
PLAY/RIGHT
\par}
&
Selects option
\\\hline
{\centering
OFF/LEFT
\par}
&
Exits menu, setting or moves to parent menu
\\\hline
\end{tabular}
\subsection{Player}
\begin{tabular}[c]{|p{3.27cm}|p{13.317cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
MINUS
\par}
&
Selects previous option in the menu. Inside an setting, decreases the
value or chooses previous option
\\\hline
{\centering
PLUS
\par}
&
Selects next option in the menu. Inside an setting increases the value
or chooses next option
\\\hline
{\centering
PLAY
\par}
&
Selects item
\\\hline
{\centering
STOP
\par}
&
Exit menu, setting or moves to parent menu.
\\\hline
\end{tabular}
\section{\label{ref:Recording}Recording (Recorder, Ondio FM)}
\subsection{\label{ref:Whilerecordingscreen}While Recording Screen}
{\centering\itshape
Recording Screen Recording F2 screen Recording F3 screen
\par}
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img26.png}
\end{center}
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img27.png}
\end{center}
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img28.png}
\end{center}
Entering the ``Recording'' option in the Main menu launches the
recording application. The screen shows the time elapsed and the size
of the file being recorded. A peak meter is present to allow you set
Gain correctly. The frequency, channels and quality settings are shown
on the last line.
The controls for this screen are:
\begin{tabular}[l]{|p{2.033cm}|p{14.603001cm}|}
\hline
{\centering\bfseries\itshape
BUTTON
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
LEFT
\par}
&
Decreases Gain
\\\hline
{\centering
RIGHT
\par}
&
Increases Gain
\\\hline
{\centering
PLAY
\par}
&
Starts recording. While recording, button closes the current file and
opens a new one\newline
(while recording) Pauses / restarts recording
\\\hline
{\centering
STOP
\par}
&
Exits Recording Screen\newline
(while recording) Stop recording
\\\hline
{\centering
F1
\par}
&
Opens Recording Settings screen (see below)
\\\hline
{\centering
F2
\par}
&
Quick menu for recording settings. A quick press will leave the screen
up (press F2 again to exit), while holding it will close the screen
when you release it.
\\\hline
{\centering
F3
\par}
&
Quick menu for source setting. Quick/hold works as for F2.\newline
(while recording) Start a new recording file
\\\hline
\end{tabular}
\subsubsection{\label{ref:Recordingsettings}Recording Settings}
\begin{itemize}
\item \textbf{Quality}
Choose the quality here (0 to 7). Default is 5, best quality is 7,
smallest file size is 0. This setting effects how much your sound
sample will be compressed. Higher quality settings result in larger
MP3 files.
The quality setting is just a way of selecting an average bit rate, or
number of bits per second, for a recording. When this setting is
lowered, recordings are compressed more (meaning worse sound quality),
and the average bitrate changes as follows.
\end{itemize}
\begin{center}\begin{tabular}{|p{4.598cm}|p{8.051001cm}|}
\hline
{\centering\bfseries\itshape
FREQUENCY
\par}
&
{\centering\bfseries\itshape
BITRATE (Kbit/s) {}- quality 0{}-{\textgreater}7
\par}
\\\hline
{\centering
44100Hz stereo:
\par}
&
75, 80, 90, 100, 120, 140, 160, 170
\\\hline
{\centering
22050Hz stereo
\par}
&
39, 41, 45, 50, 60, 80, 110, 130
\\\hline
{\centering
44100Hz mono
\par}
&
65, 68, 73, 80, 90, 105, 125, 140
\\\hline
{\centering
22050Hz mono
\par}
&
35, 38, 40, 45, 50, 60, 75, 90
\\\hline
\end{tabular}\end{center}
\begin{itemize}
\item \textbf{Frequency}
Choose the recording frequency (sample rate) {}- 48kHz, 44.1kHz,
32kHz (MPEG version 1), and 24kHz, 22.05kHz, 16kHz (MPEG version 2) are
available. Higher sample rates use up more disk space, but give better
sound quality. This setting determines which frequency range can
accurately be reproduced during playback. Lower frequencies produce
smaller files, for two reasons. The amount of data to be compressed is
smaller and the data is easier to compress, since higher frequencies
are not present. The frequency setting also determines which version
of the MPEG standard sound is recorded using.
\item \textbf{Source}
Choose the source of the recording. This can be microphone, line in,
or SPDIF (digital). For recording from the radio on the FM recorder,
see page \pageref{ref:FMradio} below.
Note: you cannot change the sample rate for digital recordings.
\item \textbf{Channels}
This allows you to select mono or stereo recording. Please note that
for mono recording, only the left channel is recorded. Mono recordings
are usually somewhat smaller than stereo.
\item \textbf{Independent Frames}
The independent frames option tells the Jukebox to encode with the bit
reservoir disabled, so the frames are independent of each other. This
makes a file easier to edit.
\item \textbf{Time Split}
This option is useful when timing recordings. If set to active it stops
a recording at a given interval and then starts recording again with a
new file., which is useful for long term recordings.
The splits are seamless (frame accurate), no audio is lost at the split
point. The break between recordings is only the time required to stop
and restart the recording, on the order of 2{}-4 seconds.
Options (hours:minutes between splits): off, 24:00, 18:00, 12:00, 10:00,
8:00, 6:00, 4:00, 2:00, 1:20 (80 minute CD), 1:14 (74 minute CD),
1:00, 00:30, 00:15, 00:10, 00:05.
\item \textbf{Prerecord Time}
This setting buffers a small amount of audio so that when the
record button is pressed, the recording will begin from that number of
seconds earlier. This is useful for ensuring that a recording begins
before a cue that is being waited for.\\
Options: Off, 1{}-30 seconds
\end{itemize}
\section{\label{ref:FMradio}FM Radio (FM recorder Ondio FM)}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img29.png}
\newline
FM radio screen
\par}
This menu option switches to the radio screen.
The keys are:
\begin{tabular}[l]{|p{3.211cm}|p{13.424cm}|}
\hline
{\centering\bfseries\itshape
BUTTON
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
LEFT, RIGHT
\par}
&
Change frequency in 0.1 MHz steps. For automatic station seek, hold
LEFT/RIGHT for a little longer.
\\\hline
{\centering
UP, DOWN
\par}
&
Change volume
\\\hline
{\centering
PLAY
\par}
&
\textcolor{black}{(EXPERIMENTAL) } freezes all
screen updates, may enhance radio reception in some cases.
\\\hline
{\centering
ON
\par}
&
Leave the radio screen with the radio playing
\\\hline
{\centering
OFF
\par}
&
Back to main menu
\\\hline
\end{tabular}
The FM radio has the ability to record and to remember station frequency
settings (presets).
\begin{itemize}
\item \textbf{Saving a preset}
You can save your favourite stations in the 32
presets. Press F1 to go to the menu, then select
``Save preset''. Enter the name (maximum number
of characters is 32).
\item \textbf{Selecting a preset}
Press F2 to go to the preset list. Use UP and DOWN to move the cursor
and then press PLAY to select. Use LEFT to leave the preset without
selecting anything.
\item \textbf{Removing a preset}
Press F1 to go to the menu, then select ``Remove preset''.
\item \textbf{Recording}
Press F3 to start recording the currently playing station. Press OFF to
stop recording. Press PLAY again to seamlessly start recording to a new
file. The settings for the recording can be changed in the F1 menu
before starting the recording. See page \pageref{ref:Recordingsettings}
for details of recording settings.
Note: The radio will turn off when playing an MP3.
\end{itemize}
\section{\label{ref:Bookmarkconfig}\label{ref:Bookmarkmenu}Bookmarks}
The bookmarks menu allows you to create and manage bookmark files.
\begin{itemize}
\item \textbf{Create Bookmark}
While playing a track, use this option to save your current position
within the track so that you can return to it at a later time.
Bookmarks are saved on a per folder basis i.e. all of the files in the
same folder have their bookmarks stored together. You can store
multiple bookmarks for the same track.
\item \textbf{List Bookmarks}
% Unhandled or unsupported graphics:
%\includegraphics[width=4.098cm,height=2.341cm]{images/rockbox-manual-img30.png}% Unhandled or unsupported graphics:
%\includegraphics[width=4.669cm,height=2.006cm]{images/rockbox-manual-img31.png}
Recorder bookmark browser Player bookmark browser
While playing a track, use this option to return to any bookmark in the current folder. The bookmark browser
screen (shown above) is now displayed. Use the UP and DOWN keys
(recorder) or MINUS and PLUS keys (player) to navigate between
bookmarks. Press PLAY to jump to a bookmark, ON+PLAY to delete a
bookmark or STOP/OFF to exit the browser.
\item \textbf {Recent bookmarks}
If the ``save a list of recently created bookmarks'' option is enabled
then you can view a list of several recent bookmarks here and select
one to jump straight to that track. This option is off by default.
See page \pageref{ref:Bookmarkconfigactual} for more details on
configuring bookmarking in Rockbox.
\end{itemize}
\section{\label{ref:playlistoptions}Playlist Options}
This menu allows you to work with playlists.
Playlists can either be created automatically by playing a file in
a directory directly, which will cause all of the files in that
directory to be placed in the playlist, or they can be created by hand
using the File Menu (see page \pageref{ref:Filemenu})
or using the Playlist Options menu. Both automatic and manually
created playlists can be edited using this menu.
\begin{itemize}
\item \textbf{Create Playlist}
Rockbox will create a playlist with all tracks in the current directory and all subdirectories. The playlist will be created one folder level ``up'' from
where you currently are.
\item \textbf{View Current Playlist}
Displays the contents of the playlist currently stored in memory.
\item \textbf{Save Current Playlist}
Saves the current dynamic playlist, excluding queued tracks, to the
specified file. If no path is provided then playlist is saved to
current directory (see page \pageref{ref:Playlistsubmenu}).
\item \textbf{Recursively Insert Directories}
If set to ON then when you insert/queue a directory in Dynamic Playlist,
all subdirectories will also be inserted. If set to ASK then you are
prompted about recursive insertion when inserting a directory.
\end{itemize}
\section{Browse Plugins}
With this option you can load and run various plugins that have been
written for Rockbox.\\
A detailed description of the different plugins begins on page \pageref{ref:Part5}.
\section{\label{ref:Info}Info}
This option shows MP3 ram buffer size, battery voltage level and
estimated time remaining, disk total space and disk free space.
On players use the MINUS and PLUS keys to step through several pages of
information.
\begin{itemize}
\item \textbf{Show ID3 info}
This is an alternative way to access the ID3 viewer. See page
\pageref{ref:ID3viewer} for details on the ID3 viewer.
\item \textbf{Rockbox Info}
Displays some basic system information. This is, from top to bottom,
the amount of memory Rockbox has available for storing music (the
buffer), battery status, hard disk size and the amount of free space on
the disk.
\item \textbf{Version}
Software version and credits display.
\item \textbf{Debug (Keep Out!)}
This submenu is intended to be used only by Rockbox developers. It shows
hardware, disk, battery status and a lot of other information. It is
not recommended that users access this menu unless instructed to do so
in the course of fixing a problem with Rockbox. In particular the
``Dump ROM Contents'', ``View/clear RTC RAM'' and
``Screenshot'' and ``Sound test'' functions
should be treated with care.
\end{itemize}
\section{Shutdown (Player)}
This menu option saves the Rockbox configuration and turns off the hard
drive before shutting down the machine. For maximum safety this
procedure is recommended when turning off the Jukebox. (There is a
very small risk of hard disk corruption otherwise.) See page
\pageref{ref:Safeshutdown} for more details.

View file

@ -0,0 +1,615 @@
\chapter{Configuring Rockbox}
\newpage
\section{Sound Settings}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img32.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img33.png}
\newline
Recorder sound settings Player sound settings
\par}
This menu offers a selection of sound properties you may change to
improve your sound experience.
\begin{itemize}
\item \textbf{Volume}
The sound volume your music is played at. Although settable range is
0{}-100\%, many units don't produce audible output
below 40\%. On Recorders, volume settings above 92\% will cause
distortion (clipping) and are not recommended.
\item \textbf{Bass}
This emphasises or suppresses the lower
(bass) sounds in the track. 0 means that bass sounds are unaltered
(flat response).
\item \textbf{Treble}
This emphasises or suppresses the higher
(treble) sounds in the track. 0 means that treble sounds are unaltered
(flat response).
\item \textbf{Balance}
How much of the volume is generated by the left or right channel of the
sound. The default, 0, means that the left and right outputs are equal
in volume. Negative numbers increase the volume of the left channel
relative to the right, positive numbers increase the volume of the
right channel relative to the left.
\item \textbf{Channels}
This option controls the on{}-board mixing
facilities of the Jukebox. A stereo audio signal consists of two
channels, left and right. Available options are
\begin{itemize}
\item \textbf{Mono Left: }Plays the left channel in both stereo channels.
\item \textbf{Mono Right:} Plays the right channel in both stereo channels.
\item \textbf{Mono:} Mix both channels down to mono and send the mixed signal
back to both.
\item \textbf{Stereo:} Do not mix the signal
\item \textbf{Stereo Narrow: }Mixes small amounts of the opposite channel into
the left and right channels, thus making the sound seem closer
together.
\item \textbf{Stereo Wide:} Elements of one channel that are present in the
opposite channel are removed from the latter. This results in the
sound seeming further apart.
\item \textbf{Karaoke:} Removes all sound that is the same in both channels.
Since most vocals are recorded in this way to make the artist sound
central, this often (but not always) has the effect of removing the
voice track from a song.
\end{itemize}
\item \textbf{Loudness (Recorder only)}
Loudness is an effect which emphasises bass and treble. This makes the
track seem louder by amplifying the frequencies that the human ear
finds hard to hear. Frequencies in the vocal range are unaffected,
since the human ear picks these up very easily.
\item \textbf{Auto Volume (Recorder only)}
Auto volume is a feature that automatically lowers the volume on loud
parts, and then slowly restores the volume to the previous level over a
time interval. That time interval is configurable here. Short values
like 20ms are useful for ensuring a constant volume for in car use and
other applications where background noise makes a constant loudness
desirable. A longer timeout means that the change in volume back to
the previous level will be smoother, so there will be less sharp
changes in volume level.
\item \textbf{Super Bass (Recorder Only)}
This setting changes the threshold at which bass frequencies are
affected by the \textbf{Loudness} setting, making the sound of drums
and bass guitar louder in comparison to the rest of the track. This
setting only has an effect if \textbf{Loudness} is set to a value
larger than 0dB.
\item \textbf{MDB {}- Micronas Dynamic Bass (Recorder Only)}
The rest of the parameters on this menu relate to the Micronas Dynamic
Bass (MDB) function. This is designed to enable the user to hear bass
notes that the headphones and/or speakers are not capable of
reproducing. Every tone has a fundamental frequency (the ``main tone'') and also several harmonics, which are related to that tone. The human brain has a
mechanism whereby it can actually infer the presence of bass notes from
the higher harmonics that they would generate.\\
The practical upshot of this is that MDB produces a more authentic
sounding bass by tricking the brain in believing it's
hearing tones that the headphones or speakers aren't
capable of reproducing. Try it and see what you think.\\
The MDB parameters are as follows.
\begin{itemize}
\item \textbf{MDB enable: } This turns the MDB feature on or off. For many
users this will be the only setting they need, since Rockbox picks
sensible defaults for the other parameters. MDB is turned off by
default.
\item \textbf{MDB strength:} How loud the harmonics generated by the MDB will
be.
\item \textbf{MDB Harmonics}: The percentage of the low notes that is
converted into harmonics. If low notes are causing speaker distortion,
this can be set to 100\% to eliminate the fundamental completely and
only produce harmonics in the signal. If set to 0\% this is the same
as turning the MDB feature off.
\item \textbf{MDB Centre Frequency: }The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers.
\item \textbf{MDB shape: }It is recommended that this parameter be set to 1.5
times the centre frequency.\\
This is the frequency up to which harmonics are generated. Some of the
lower fundamentals near the cut{}-off range
will have their lower harmonics cut off, since they will be below the
range of the speakers. Fundamentals between the
cut{}-off frequency and the lower frequency will have their harmonics proportionally boosted to compensate and restore the 'loudness' of these
notes.\\
For most users, the defaults should provide an improvement in sound
quality and can be safely left as they are. For reference, the
defaults Rockbox uses are:
\begin{tabular}[c]{|p{4.5290003cm}|p{1.56cm}|}
\hline
{\centering\bfseries\itshape
Setting
\par}
&
{\centering\bfseries\itshape
Value
\par}
\\\hline
{\centering\upshape
MDB Strength
\par}
&
50dB
\\\hline
{\centering\upshape
MDB Harmonics
\par}
&
48\%
\\\hline
{\centering\upshape
MDB Centre Frequency
\par}
&
60Hz
\\\hline
{\centering\upshape
MDB Shape
\par}
&
90Hz
\\\hline
\end{tabular}
\end{itemize}
\end{itemize}
\section{\label{ref:GeneralSettings}General Settings}
{\centering\mdseries\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.822cm,height=2.184cm]{images/rockbox-manual-img34.png}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.667cm,height=1.963cm]{images/rockbox-manual-img35.png}
\newline
Recorder general settings Player general settings
\par}
\subsubsection{\label{ref:PlaybackOptions}Playback Options}
This menu is for configuring settings related to MP3 playback
\begin{itemize}
\item \textbf{Shuffle}
Select shuffle ON/OFF. This alters how Rockbox will select which next
song to play.
\item \textbf{Repeat}
Repeat modes are Off/One/All. ``Off'' means no
repeat. ``One'' means repeat one track over
and over. ``All'' means repeat playlist/directory.
\item \item{Play Selected First }
This setting controls what happens when you press PLAY on a file in a
directory and shuffle mode is on. If this setting is Yes, the file you
selected will be played first. If this setting is No, a random file in
the directory will be played first.
\item \textbf{Resume}
Sets whether Rockbox will resume playing at the point where you shut
off. Options are: Ask/Yes/No/Ask once.
``Ask'' means it will ask at boot time. ``Yes'' means it will unconditionally try to resume. ``No'' means it will not resume. ``Ask once'' will erase the resume info if you answer no, and thus not ask you again.
\item \textbf{FFwd / Rewind}
Two options are available at this point
\begin{itemize}
\item \textbf{FF/RW Min Step}
The smallest step, in seconds, you want to fast forward or rewind in a
track.
\item \textbf{FF/RW Accel}
How fast you want search (ffwd/rew) to accelerate when you hold
down the button. ``Off'' means no acceleration. ``2x/1s'' means double the
search speed once every second the button is held. ``2x/5s'' means double the search speed once every 5 seconds the button is held.
\end{itemize}
\item \textbf{Anti{}-skip Buffer}
This setting is really ``extra anti{}-skip''. It lets you set
a timer for how many seconds earlier than normally necessary the disk
should spin up and start reading data. You don't need
this unless you shake and bump the unit a lot. Spinning up the disk
earlier than necessary naturally drains the batteries a little extra.
Most users will not need this setting.
\item \textbf{Fade on Stop/Pause}
This setting enables and disables a fade effect when you pause
or stop playing a song. Fade is a progressive increase or reduction of
volume, from your set volume to 0, and vice versa.
\item \textbf{ID3 tag priority}
ID3 tags in an MP3 file contain information about the artist, title,
album etc. of the track. This option controls whether Rockbox uses the information from ID3v2 tags in preference to that from ID3v1 tags when both types of tag are present.
\end{itemize}
\subsection{File View}
This menu deals with options relating to how the file browser displays
files
\begin{itemize}
\item \textbf{Sort Case Sensitive}
If this option is enabled files that start with a
lower case letter will appear after the files that start with an upper case letter have all been listed If disabled, then case will be ignored when sorting files.
\item \textbf{Sort Directories}
This option controls how Rockbox sorts folders. The default is to sort
them alphabetically. ``By date'' sorts them with the oldest folder
first. ``By newest date'' sorts them with the newest folder first.
\item \textbf{Sort Files}
This option controls how Rockbox sorts files. In addition to the
options for directory sorting above, there is a ``By type'' option
which sorts files alphabetically by their type (such as .mp3) then
alphabetically within each type.
\item \textbf{\label{ref:ShowFiles}Show Files}
Controls which files are displayed in the directory browser:
\begin{itemize}
\item \textbf{Music: }
Only directories, .mp3, .mp2, .mpa and .m3u files
are shown. Extensions are strippe'd. Files anddirectories starting with . Or with the ``hidden'' flag set are hidden.
\item \textbf{Playlists:}
Only shows directories and playlists, for
simplified navigation.
\item \textbf{Supported:}
All directories and files Rockbox understands (see page \pageref{ref:Supportedfileformats}) are shown. Files and directories starting with . or with the
``hidden'' flag set are hidden.
\item \textbf{All:}
All files and directories are shown. Extensions are shown. No files or
directories arehidden
\end{itemize}
\item \textbf{Follow Playlist}
If Follow Playlist is set to ``Yes'', you will find yourself in the same
directory as the currently playing file if you go to the Directory
Browser from the WPS. If set to ``No'', you will stay in the same directory as you were last in.
\item \textbf{Show Icons}
This indicates whether Rockbox will display an icon representing what
type a file is on the left of the file in the browser. For details of
these icons, please see page \pageref{ref:Supportedfileformats}.
\end{itemize}
\subsection{\label{ref:Displayoptions}Display Options}
\begin{itemize}
\item \textbf{Browse fonts}
Browse the fonts that reside in your \textbf{/.rockbox} directory.
Selecting one will activate it. See page \pageref{ref:Loadingfonts} for further details about fonts.
\item \textbf{Browse WPS files}
Opens the file browser in the \textbf{/.rockbox} directory and displays
all .wps files. Selecting one will activate it, stop will exit back to
the menu.\\
For further information about the WPS see page \pageref{ref:WPS}. For
information about editing a .wps file see page \pageref{ref:ConfiguringtheWPS}.
\item \textbf{LCD Settings}
%\begin{itemize}
This submenu contains settings that relate to the display of the
Jukebox.
\item \textbf{Backlight:}
How long the backlight shines after a key
press. Set to OFF to never light it, set to ON to never shut it off or
set a preferred timeout period.
\item \textbf{Backlight on WhenPlugged:}
This option turns the backlight on constantly while the charger cable is connected.
\item \textbf{Caption Backlight:} This option turns the backlight on for
25 seconds either side of the start of a new track so that the display
can be read to see song information.
\item \textbf{Contrast:} Changes the contrast of your LCD display.
Warning: Setting the contrast too dark or too light can make it hard to
find this menu option again!
\item \textbf{LCD Mode} (Recorder only): This setting lets you invert
the whole screen, so now you get a black background and green text
graphics.
\item \textbf{Upside Down: }Displays the screen so that the top of the
display is nearest the buttons. This is sometimes useful when carrying
the Recorder in a pocket for easy access to the headphone socket.
\item \textbf{Line Selector: }Select this option to have a bar of
inverted text (``Bar'' option) mark the current line in the File
Browser rather than the default arrow to the left (``Pointer'' option).
This gives slightly more room for filenames.
%\end{itemize}
\item \textbf{Scrolling}
This feature controls how text will scroll in Rockbox. You can configure
the following parameters:
\begin{itemize}
\item \textbf{Scroll Speed:}
Controls how many times per second the scrolling text moves a step.
\item \textbf{Scroll StartDelay:}
Controls how many milliseconds Rockbox should wait before a new text begins scrolling.
\item \textbf{Scroll Step Size:}
Controls how many pixels the text scroll should move for each step. (Recorder/Ondio only)
\item \textbf{Bidirectional Scroll Limit: }
Rockbox has two different scroll methods, always scrolling the text to the left, and when the line has ended, beginning again at the start, or moving to the
left until you can read the end of the line, and scroll right until you
see the beginning again. Rockbox chooses which method it should use,
depending of how much it has to scroll left. This setting lets you tell
Rockbox where that limit is, expressed in percentage of line length.
\end{itemize}
\item \textbf{Status/Scrollbar (Recorder only)}
Settings related to on screen status display and the scrollbar.
\begin{itemize}
\item \textbf{Scroll Bar: }Enables or disables the scroll bar at the
left.
\item \textbf{Status Bar: }Enables or disables the status bar
at the upper side.
\item \textbf{Button Bar:} Enables or disables the button bar prompts
for the F keys at the bottom of the screen.
\item \textbf{Volume Display:} Controls whether the volume is displayed
as a graphic or a numerical percentage value on the Status Bar.
\item \textbf{Battery Display: }Controls whether the battery charge
status is displayed as a graphic or numerical percentage value on the
Status Bar.
\end{itemize}
\item \textbf{Peak Meter (Recorder only) }
The peak meter can be configured with a number of parameters. (For a description of the peak meter see page \pageref{ref:Peakmeter}.)
\begin{itemize}
\item \textbf{Peak Release:}
This determines how fast the bar shrinks when the music becomes softer.
Lower values make the peak meter look smoother.
\item \textbf{Peak Hold Time:}
Specifies the time after which the peak indicator will reset. If you set this value e.g. to 5s then the peak indicator displays the loudest volume value
that occurred within the last 5 seconds. Big values are good if you
want to find the peak level of a song, which might be of interest when
copying music from the jukebox via the analogue output to some other
recording device.
\item \textbf{Clip Hold Time:}
How long the clipping indicator will be visible after clipping was detected
\item \textbf{Performance:}
In high performance mode, the peak meter is updated as often as possible. This reduces the chance of missing a peak value, making the peak meter more precise. In energy save mode the peak meter is updated just often enough to look fluid.
This reduces the load on the CPU and thus saves a little bit of energy. If you crave every second of runtime for your jukebox or simply use the peak meter as a screen effect, the use of energy save mode is recommended. If you want to use
the peak meter as a measuring instrument you'll want to use high performance mode.
\item \textbf{Scale:}
Select whether the peak meter displays linear or logarithmic values. In
``dB'' (decibel) scale the volume values are scaled logarithmically.
This very similar to the perception of loudness. The volume meters of
digital audio devices usually are scaled this way. If you are
interested in the power level that is applied to your headphones you
should choose ``linear'' display. Unfortunately this value
doesn't have real units like volts or watts since that
depends on the phones. So they can only be displayed as percentage
values.
\item \textbf{Minimum and maximum range:} These two options define the
full value range that the peak meter displays. Recommended values for
dbFs are {}-40 for min. and 0 for maximum. For linear display, use 0
and 100\%. Note that {}-40 dbFs is approximately 1\% in linear value,
but if you change the minimum setting in linear mode slightly and then change to dbFs there will be a large change. You can use these values for
'zooming' into the peak meter.
\end{itemize}
\end{itemize}
\subsubsection{\label{ref:SystemOptions}System Options}
\begin{itemize}
\item \textbf{Battery}
Options relating to the batteries in the Jukebox unit.
\begin{itemize}
\item \textbf{Battery Capacity} can be used to tell the Jukebox what
capacity (in mAh) of battery is being used inside it. The default is
1500mAh for NiMH battery based units, and 2300mAh for LiOn battery
based units, which is the capacity value for the standard batteries
shipped with these units. This value is used for calculating remaining
battery life.
\item \textbf{Deep discharge (Non{}-FM recorder only)}
Set this to ON if you intend to keep your charger connected for a long
period of time. It lets the batteries go down to 10\% before starting
to charge again. Setting this to OFF will cause the charging to restart
on 95\%.
\item \textbf{Trickle Charge (Non{}-FM recorder only)}
The Jukebox cannot be turned off while the charger is connected.
Therefore, trickle charge is needed to keep the batteries full after
charging has completed. For more in depth information about charging
see Battery FAQ in your \textbf{/.rockbox/docs }directory.
\end{itemize}
\item \textbf{Disk}
Options relating to the hard disk.
\begin{itemize}
\item \textbf{DiskSpindown:}
Rockbox has a timer that makes it spin down the hard disk after being idle for acertain time. You can modify this timeout here. This idle time is only
affected by user activity, like navigating through file browser. When
the hard disk spins up to fill mp3 buffer, it automatically spins down
afterwards.
\item \textbf{Disk Poweroff:}(non v2/FM{}-recorder only)
Whether the disk is powered OFF or only set to ``sleep'' when spun
down. Power off uses less power but takes longer to spin{}-up.
\end{itemize}
\item \textbf{Time and Date (Recorder Only)}
Time related menu options.
\begin{itemize}
\item \textbf{Set Time/Date: }
Set current time and date.
\item \textbf{Time Format: }
Choose 12 or 24 Hour clock.
\end{itemize}
\item \textbf{\label{ref:idlepoweroff}Idle Poweroff}
Rockbox can be configured to turn off power after the unit has been idle
for a defined number of minutes. The unit is idle when playback is
stopped or paused. It is not idle while the USB or charger is
connected, or while recording.
\item \textbf{Sleep Timer}
This option lets you power off your jukebox after playing for a given
time. This setting is reset on boot. Using this option disables the
\textbf{Wake up alarm} (see below).
\item \textbf{Wake up alarm (Recorder v2/FM only)}
This option turns the Jukebox off and then starts it up again at the
specified time. This is most useful when combined with the Resume
setting in the Playback options set to ``Yes'', so that the Jukebox
wakes up and immediately starts playing music. Use LEFT and RIGHT to
adjust the minutes setting, UP and DOWN to adjust the HOURS. PLAY
confirms the alarm and shuts your Jukebox down, and STOP cancels
setting an alarm. If the Jukebox is turned on again before the alarm
occurs the alarm will be canceled. Using this option disables the \textbf{Sleep Timer} (see above).
\item \textbf{Limits}
This submenu relates to limits in the Rockbox operating system.
\begin{itemize}
\item \textbf{Max files in dir browser: }Configurable limit of files in
the directory browser (file buffer size). You can configure the size to
be between 50 and 10000 files in steps of 50 files. The default is 400,
higher values will shorten the music buffer.\\
Note: the device must be rebooted for settings to take effect!
\item \textbf{Max playlist size: }Option to configure the maximum size
of a playlist. The playlist size can be between 1000 and 20000 files in
steps of 1000. By default it is 10000. Higher values will shorten the
music buffer.\\
Note: the device must be rebooted for settings to take effect!
\end{itemize}
\item \textbf{Car Adapter Mode}
This option turns on and off the car ignition auto stop
function.
When using the Jukebox in a car, car adapter mode automatically stops
playback on the Jukebox when power (i.e. from cigarette lighter power
adapter) to the external DC in jack is turned off.
When the external power off condition is detected, the Car Adapter Mode
function only pauses the playback. In order to shut down the Jukebox
completely the \textbf{Idle Poweroff} function (see above) must also be
set.
If power to the DC in jack is turned back on before the \textbf{Idle
Poweroff} function has shut the Jukebox off, playback will be resumed
5 seconds after the power is applied. This delay is to allow for the
time while the car engine is being started. Once the Jukebox is shut
off either manually, or automatically with the \textbf{Idle Poweroff
}function, it must be powered up manually to resume playback.
\item \textbf{Line In (Player only)}
This option activates the line in port on Jukebox Player, which
is off by default.
This is useful for such applications as:
\begin{itemize}
\item Game boy {}-{\textgreater} Jukebox {}-{\textgreater} human
\item laptop {}-{\textgreater} Jukebox {}-{\textgreater}human
\item LAN party computer {}-{\textgreater} Jukebox {}-{\textgreater} human
\end{itemize}
\item \textbf{Manage settings}
This submenu deals with loading and saving settings.
\begin{itemize}
\item \textbf{Browse .cfg Files: }
This displays a list of configuration
(.cfg) files stored in the \textbf{/.rockbox} system directory. This
is useful if the Jukebox is plugged into more than one different output
device (e.g. headphones, computer, car stereo, hi{}-fi) so that a settings file can be maintained for each.
\item \textbf{Browse Firmwares:} This displays a list of firmware (.mod
for Players and .ajz for Recorders) file in the \textbf{/.rockbox} system directory. Playing a firmware file loads it into memory. Thus it is possible to
run the original Archos firmware or a different version of Rockbox from
here assuming that you have the right files installed on your disk.
\item \textbf{Reset Settings: }This wipes the saved settings in the
Jukebox and resets all settings to their default values.
\item \textbf{Write .cfg file: }Saves the current settings into a .cfg
file for later use with \textbf{Browse .cfg Files} above.
\end{itemize}
\end{itemize}
\subsubsection{\label{ref:Bookmarkconfigactual}Bookmarking}
\begin{itemize}
\item \textbf{Bookmark on Stop}
Write a bookmark to the disk whenever the stop key is pressed. If
playback is stopped it can be resumed easily at a later time. The
\textbf{Resume} function remembers your position in the most
recently accessed track regardless of this setting.
\item \textbf{Load Last Bookmark}
When this is on, Rockbox automatically returns to the position of the
last bookmark within a file when it is played. If set to Ask, Rockbox
will ask the user whether they want to start from the beginning or the
bookmark. When set to no, playback always starts from the beginning
and the Bookmark file must be played or \textbf{Load Bookmark} selected
from the \textbf{Bookmarks} submenu of the Main Menu while the file is
playing.
\item \textbf{Maintain a list of Recently Used Bookmarks}
If this option is turned on, Rockbox will store a list of Bookmarks that
have been accessed recently. This is then accessible from the
\textbf{Recent Bookmarks} option of the \textbf{Bookmarks} submenu of
the Main Menu.
\end{itemize}
\subsection{\label{ref:Language}Language}
This setting controls the language of the Rockbox user interface.
Selecting a language will activate it. The language files must be in
the \textbf{/.rockbox/lang/} directory.
See page \pageref{ref:Loadinglanguages} for further details about
languages.
\subsection{Voice}
\begin{itemize}
\item \textbf{Voice Menus}
This option turns on the Voice User Interface, which will read out menu items and settings as they are selected by the cursor. In order for this to work, a voice file must be present in the \textbf{/.rockbox/lang/} directory on the recorder. Voice files are large (1.5MB) and are not shipped with Rockbox by
default.
The voice file is the name of the language for which it is made,
followed by the extension .voice. So for English, the file name would
be \textbf{english.voice}.
This option is on by default. It will do nothing unless the appropriate
.voice file is installed in the correct place on the Jukebox.
\begin{itemize}
\item \textbf{Limitations}
\begin{itemize}
\item Setting the Sound Option \textbf{Channels} to ``karaoke'' may
disable voice menus.
\item Plugins and the wake up alarm do not support voice features.
\end{itemize}
\item \textbf{Voice Directories}
This option turns on the speaking of directory names. The Jukebox is
not powerful enough to produce these voices in real time, so a number of options are available.
\begin{itemize}
\item \textbf{.talk mp3 clip: }
Use special pre{}-recorded MP3 files (\textbf{\_dirname.talk}) in each directory. These must be generated in advance, and are typically produced synthetically using a text to speech engine on a PC. If no such file exists, the output is as for the ``numbers'' option below.
\item \textbf{Spell: }
Speak the directory name by spelling it out letter
by letter. Support is provided only for the most common letters and
punctuation.
\item \textbf{Numbers: }
Each directory is assigned a number based upon its position in the file list. They are then announced as ``Directory 1'', ``Directory 2'' etc.
\item \textbf{Off: }
No attempt will be made to speak directory names.
\end{itemize}
\item \textbf{Voice Filenames}
This option turns on the speaking of directory names. The options
provided are ``Spell'', ``Numbers'', and ``Off'' which function the same as for \textbf{Voice Directories} and ``.talk mp3 clip'', which functions as above except that the files are named with the same name as the music file (e.g. \textbf{Punkadiddle.mp3 } would require a file called \textbf{Punkadiddle.mp3.talk}).
\end{itemize}
\end{itemize}
See
\url{http://www.rockbox.org/twiki/bin/view/Main/VoiceHowto} for more details on configuring speech support in Rockbox.

View file

@ -0,0 +1,66 @@
\subsection{Bounce}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img48.png}
\newline
The bounce Demo
\par}
This demo is of the word ``Rockbox'' bouncing across the screen. There
is also an analogue clock on the Recorder platform. (The Ondio does
not have clock support.)
Key controls for this demo are:
\begin{center}\begin{tabular}{|p{3.169cm}|p{8.069cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
F1/F2/F3
\par}
&
Enters Bounce configuration options
\\\hline
{\centering
UP/DOWN
\par}
&
Moves to next/previous option
\\\hline
{\centering
LEFT/RIGHT
\par}
&
Increases/decreases option value
\\\hline
{\centering
ON
\par}
&
Changes to Scroll mode
\\\hline
{\centering
OFF
\par}
&
Exits bounce demo
\\\hline
\end{tabular}\end{center}
Available options are:
\begin{itemize}
\item \textbf{Xdist/Ydist:} The distance to X axis and Y axis
respectively
\item \textbf{Xadd/Yadd:} how fast the code moves on the sine curve on
each axis
\item \textbf{Xsane/Ysane:} Changes the appearance of the bouncing.
\end{itemize}

12
manual/chapter5/cube.tex Normal file
View file

@ -0,0 +1,12 @@
\subsection{Cube}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.124cm,height=2.357cm]{images/rockbox-manual-img49.png}
\newline
Cube
\par}
This is a rotating cube screen saver in 3D.
To see it at full speed, press PLAY and it will run at maximum frame rate. Also you can change the size of the x, y and z axis using LEFT, RIGHT, UP, DOWN, F1 and F2.

View file

@ -0,0 +1,89 @@
\subsection{Flipit}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.353cm,height=2.154cm]{images/rockbox-manual-img36.png}
\newline
Flipit plugin
\par}
Flipping the colour of the token under the cursor also flips the tokens
above, below, left and right of the cursor. The aim is to end up with
a screen containing tokens of only one colour.
\begin{tabular}[c]{|p{4.951cm}|p{4.7050004cm}|p{4.1740003cm}|}
\hline
{\centering\bfseries\itshape
Recorder
\par}
&
{\centering\bfseries\itshape
Ondio
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
Changes the cursor
\\\hline
{\centering
PLAY
\par}
&
{\centering
Mode
\par}
&
Toggle
\\\hline
{\centering
F1
\par}
&
{\centering
Mode +Left
\par}
&
Shuffle
\\\hline
{\centering
F2
\par}
&
{\centering
Mode + Right
\par}
&
Solution
\\\hline
{\centering
F3
\par}
&
{\centering
Mode + On/off
\par}
&
Step by step
\\\hline
{\centering
OFF
\par}
&
{\centering
On/off
\par}
&
Stop the game
\\\hline
\end{tabular}

View file

@ -0,0 +1,11 @@
\subsection{Grayscale}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.359cm,height=2.492cm]{images/rockbox-manual-img50.png}
\newline
Grayscale
\par}
This is a demonstration of the Rockbox grayscale engine which supports grayscalegraphics on the Jukebox. Press OFF to quit the demo.

14
manual/chapter5/hello.tex Normal file
View file

@ -0,0 +1,14 @@
\subsection{Hello World}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.688cm,height=1.849cm]{images/rockbox-manual-img51.png}
\newline
Hello world!
\par}
This is a plugin demo for hackers. Every programmer's
first program is the hello world{}-program
which does nothing except displaying ``Hello
world!'' on the screen.

View file

@ -0,0 +1,37 @@
\subsection{Jackpot}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.669cm,height=1.998cm]{images/rockbox-manual-img37.png}
\newline
Jackpot
\par}
This is a jackpot slot machine game. At the beginning of the game you
have 20\$. Payouts are given when three matching symbols come up.
\begin{tabular}[c]{|p{4.7780004cm}|p{4.2770004cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
PLAY
\par}
&
Play
\\\hline
{\centering
STOP
\par}
&
Exit the game
\\\hline
\end{tabular}

View file

@ -0,0 +1,58 @@
\subsection{Mandelbrot}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.865cm,height=2.21cm]{images/rockbox-manual-img52.png}
\newline
Mandelbrot
\par}
This is another demonstration using the grayscale engine. It draws fractal images from the Mandelbrot set.
\begin{center}\begin{tabular}{|p{2.726cm}|p{7.884cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
Arrow keys
\par}
&
Move about the image
\\\hline
{\centering
PLAY
\par}
&
Zoom in
\\\hline
{\centering
OFF
\par}
&
Quit
\\\hline
{\centering
F1
\par}
&
Increase iteration depth (more detail)
\\\hline
{\centering
F2
\par}
&
Decrease iteration depth (less detail)
\\\hline
{\centering
F3
\par}
&
Reset and return to the default image
\\\hline
\end{tabular}\end{center}

View file

@ -0,0 +1,58 @@
\subsection{Minesweeper}
{\centering\itshape
Minesweeper plugin
\par}
\begin{center}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=2.963cm,height=1.693cm]{images/rockbox-manual-img38.png}
\end{center}
The classic game of minesweeper. Use the UP and DOWN keys to select the
required percentage of mines to set the difficulty then press the MENU
key to begin.
The aim of the game is to uncover all of the squares on the board. If a
mine is uncovered then the game is over. If a mine is not uncovered,
then the number of mines adjacent to the current square is revealed.
The aim is to use the information you are given to work out where the
mines are and avoid them. When the player is certain that they know
the location of a mine, it can be tagged to avoid accidentally
``stepping'' on it.
\begin{tabular}[c]{|p{5.0210004cm}|p{10.77cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
Move the cursor across the minefield
\\\hline
{\centering
PLAY / F1
\par}
&
Toggle flag on / off
\\\hline
{\centering
MENU / F2
\par}
&
Reveal the contents of the current square
\\\hline
{\centering
STOP
\par}
&
Exit the game
\\\hline
\end{tabular}

View file

@ -0,0 +1,12 @@
\subsection{Mosaic}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.706cm,height=2.117cm]{images/rockbox-manual-img53.png}
\newline
Mosaic
\par}
This simple graphics demo draws a mosaic picture on the screen of the
Jukebox. Press STOP to quit.

104
manual/chapter5/nim.tex Normal file
View file

@ -0,0 +1,104 @@
subsection{Nim}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=5.128cm,height=1.99cm]{images/rockbox-manual-img39.png}
\newline
Nim plugin
\par}
Rules of Nim: There are 21 matches. Two players (you and the Jukebox)
alternately pick a certain number of matches and the one who takes the
last match loses. You can take up to twice as many matches as the
Jukebox selected, and vice versa.
\begin{center}\begin{tabular}{|p{2.257cm}|p{10.341001cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
MINUS
\par}
&
Decrease the number of matches
\\\hline
{\centering
PLUS
\par}
&
Increase the number of matches
\\\hline
{\centering
PLAY
\par}
&
Remove the number of matches you have selected
\\\hline
{\centering
STOP
\par}
&
Exit the game
\\\hline
\end{tabular}\end{center}
\subsubsection{Pong (Recorder, Ondio)}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.787cm,height=2.164cm]{images/rockbox-manual-img40.png}
\newline
Pong game
\par}
The world's first arcade game comes to Rockbox. This
is a ``tennis game'' for two players. The
left player uses LEFT and F1 to move and the right player uses RIGHT
and F3. The aim is to prevent the ball leaving the screen. The player
that loses the least balls wins.
\begin{center}\begin{tabular}{|p{2.269cm}|p{4.7710004cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
F1
\par}
&
Player 1 up
\\\hline
{\centering
LEFT
\par}
&
Player 1 down
\\\hline
{\centering
F3
\par}
&
Player 2 up
\\\hline
{\centering
RIGHT
\par}
&
Player 2 down
\\\hline
{\centering
OFF
\par}
&
Quit
\\\hline
\end{tabular}\end{center}

View file

@ -0,0 +1,69 @@
\subsection{Oscillograph}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.6cm,height=2.057cm]{images/rockbox-manual-img54.png}
\newline
Oscillograph
\par}
This demo shows the shape of the sound samples that make up the music
being played.
At faster speed rates, the Jukebox is less responsive to user input.
\subsubsection{Key controls:}
\begin{center}\begin{tabular}{|p{2.217cm}|p{8.205cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
F1
\par}
&
toggles whether to scroll or not
\\\hline
{\centering
F2
\par}
&
toggles filled / curve / plot
\\\hline
{\centering
F3
\par}
&
reset speed to 0
\\\hline
{\centering
UP
\par}
&
slow down scrolling
\\\hline
{\centering
DOWN
\par}
&
Speeds up scrolling
\\\hline
{\centering
PLAY
\par}
&
Pauses the demo
\\\hline
{\centering
OFF
\par}
&
Exits demo
\\\hline
\end{tabular}\end{center}

1243
manual/chapter5/plugins.tex Normal file

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,52 @@
\subsection{Rockblox}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.949cm,height=2.23cm]{images/rockbox-manual-img41.png}
\newline
Rockblox plugin
\par}
This well{}-known game will probably be familiar. The aim of the game is
to complete rows with the given pieces (blocks). Pieces can be rotated
to make them fit into the rows. Once you complete a row, it gets
cleared, but if the blocks reach the top row then you lose.
The controls for this game (with the Jukebox turned so that the buttons
are to the right of the screen) are:
\begin{center}\begin{tabular}{|p{3.487cm}|p{9.657001cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP
\par}
&
Rotate piece
\\\hline
{\centering
LEFT/RIGHT
\par}
&
Move piece to the left/right
\\\hline
{\centering
DOWN
\par}
&
Move faster the piece downwards
\\\hline
{\centering
OFF
\par}
&
Exit Rockblox
\\\hline
\end{tabular}\end{center}

View file

@ -0,0 +1,50 @@
\subsection{Sliding Puzzle}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.988cm,height=2.279cm]{images/rockbox-manual-img42.png}
\newline
Sliding puzzle
\par}
The classic sliding puzzle game. Rearrange the pieces so that you can
see the whole picture.
Key controls:
\begin{center}\begin{tabular}{|p{4.7780004cm}|p{4.321cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
Moves
\\\hline
{\centering
F1
\par}
&
Shuffle
\\\hline
{\centering
F2
\par}
&
Change the picture
\\\hline
{\centering
OFF
\par}
&
Stop the game
\\\hline
\end{tabular}\end{center}

View file

@ -0,0 +1,8 @@
\subsection{Snake}
This is the popular snake game. The aim is to grow your snake as large
as possible by eating the dots that appear on the screen. The game will
end when the snake touches either the borders of the screen or itself.
Change levels with UP/DOWN keys (level 1 is slowest, level 9 is
fastest). Press PLAY to start or pause.

View file

@ -0,0 +1,66 @@
\subsection{ Snake 2}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.96cm,height=2.23cm]{images/rockbox-manual-img43.png}
\newline
Snake 2 {--} The Snake Strikes Back
\par}
Another version of the Snake game. Move the snake around, and eat the
apples that pop up on the screen. Each time an apple is eaten, the
snake gets longer. The game ends when the snake hits a wall, or runs
into itself.
The controls are:
\begin{center}\begin{tabular}{|p{5.0550003cm}|p{7.984cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN
\par}
&
(in menu) Set game speed
\\\hline
{\centering
F1
\par}
&
(in menu) Change starting maze
\\\hline
{\centering
F3
\par}
&
(in menu) Select game type (A or B)
\\\hline
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
Steer the snake
\\\hline
{\centering
PLAY
\par}
&
Pause the game
\\\hline
{\centering
STOP
\par}
&
Exit the game
\\\hline
\end{tabular}\end{center}
In game A, the maze stays the same, in Game B
after an increasing number of apples eaten the maze is replaced by a
new one.

12
manual/chapter5/snow.tex Normal file
View file

@ -0,0 +1,12 @@
\subsection{Snow}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img55.png}
\newline
Have you ever seen snow falling?
\par}
This demo replicates snow falling on your screen. If you love winter,
you will love this demo. Or maybe not.

View file

@ -0,0 +1,63 @@
\subsection{Sokoban}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img44.png}
\newline
Sokoban
\par}
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.
The controls are:
\begin{tabular}[c]{|p{5.25cm}|p{10.341001cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN/LEFT/RIGHT
\par}
&
Move the ``sokoban'' up, down, left or right
\\\hline
{\centering
F1
\par}
&
Back to previous level
\\\hline
{\centering
F2
\par}
&
Restart level
\\\hline
{\centering
F3
\par}
&
Go to next level
\\\hline
{\centering
ON
\par}
&
Undo last movement
\\\hline
{\centering
OFF
\par}
&
Exit sokoban
\\\hline
\end{tabular}

View file

@ -0,0 +1,14 @@
\subsection{Solitaire}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.96cm,height=2.251cm]{images/rockbox-manual-img45.png}
\newline
Klondike solitaire
\par}
This is the classic Klondike solitaire game
for Rockbox. Select \textbf{help }from the game menu to get an
explanation of what the keys do. Rules for Klondike solitaire are
available from \url{http://www.solitairecentral.com/rules/klondike.html}.

63
manual/chapter5/star.tex Normal file
View file

@ -0,0 +1,63 @@
\subsection{Star}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.865cm,height=2.208cm]{images/rockbox-manual-img46.png}
\newline
Star game
\par}
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 ``o''s to go to the
next level. The on key allows you to switch between the filled circle,
which can take ``o''s, and the filled square, which is used as a mobile
wall to allow your filled circle to get to places on the screen it
could not otherwise reach. The block cannot take ``o''s.
{\bfseries
Keys:}
\begin{center}\begin{tabular}{|p{4.7780004cm}|p{4.321cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
ON
\par}
&
Toggle control
\\\hline
{\centering
F1
\par}
&
Previous level
\\\hline
{\centering
F2
\par}
&
Reset level
\\\hline
{\centering
F3
\par}
&
Next level
\\\hline
{\centering
OFF
\par}
&
Exit the game
\\\hline
\end{tabular}\end{center}

View file

@ -0,0 +1,82 @@
\subsection{VU meter}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.304cm,height=2.459cm]{images/rockbox-manual-img56.png}
\newline
VU meter
\par}
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.
\begin{tabular}[c]{|p{2.409cm}|p{2.908cm}|p{4.494cm}|}
\hline
{\centering\bfseries\itshape
RECORDER
\par}
&
{\centering\bfseries\itshape
ONDIO
\par}
&
{\centering\bfseries\itshape
FUNCTION
\par}
\\\hline
{\centering
OFF
\par}
&
{\centering
ONOFF
\par}
&
Save settings and quit
\\\hline
{\centering
ON
\par}
&
{\centering
MODE
\par}
&
Help
\\\hline
{\centering
F1
\par}
&
{\centering
HOLD MODE
\par}
&
Settings
\\\hline
{\centering
UP
\par}
&
{\centering
UP
\par}
&
Raise Volume
\\\hline
{\centering
DOWN
\par}
&
{\centering
DOWN
\par}
&
Lower Volume
\\\hline
\end{tabular}

287
manual/chapter5/wormlet.tex Normal file
View file

@ -0,0 +1,287 @@
\subsection{Wormlet}
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img47.png}
\newline
Wormlet game
\par}
Wormlet is a multi{}-user multi{}-worm game on a multi{}-threaded
multi{}-functional Rockbox console. You navigate a hungry little worm.
Help your worm to find food and to avoid poisoned argh{}-tiles. The
goal is to turn your tiny worm into a big worm for as long as possible.
For 2{}-player games a remote control is not necessary but recommended.
If you try to hold the Jukebox in the four hands of two players
you'll find out why. Games with three players are only
possible using a remote control.
{\bfseries
Wormlet main menu controls:}
\begin{center}\begin{tabular}{|p{2.55cm}|p{9.958cm}|}
\hline
{\centering\bfseries\itshape
KEY
\par}
&
{\centering\bfseries\itshape
ACTION
\par}
\\\hline
{\centering
UP/DOWN
\par}
&
Selects number of players
\\\hline
{\centering
LEFT/RIGHT
\par}
&
Controls number of worms on the game
\\\hline
{\centering
F1
\par}
&
Selects game mode.
\\\hline
\end{tabular}\end{center}
{\bfseries
Game controls:}
\begin{center}\begin{tabular}{|p{2.162cm}|p{1.67cm}|p{3.813cm}p{4.256cm}p{4.1000004cm}|}
\hline
{\centering\bfseries\itshape
Players
\par}
&
{\centering\bfseries\itshape
MODES
\par}
&
\multicolumn{1}{p{3.813cm}|}{{\centering\bfseries\itshape
PLAYER 1
\par}
}&
\multicolumn{1}{p{4.256cm}|}{{\centering\bfseries\itshape
PLAYER 2
\par}
}&
{\centering\bfseries\itshape
PLAYER 3
\par}
\\\hline
{\centering
0
\par}
&
{\centering
Out of control
\par}
&
\multicolumn{3}{p{12.569cm}|}{With no player taking part in the game all
worms are out of control and steered by artificial stupidity.
}\\\hline
\multicolumn{1}{|p{2.162cm}}{{\centering
1
\par}
}&
\multicolumn{4}{p{14.439cm}}{\hspace*{-\tabcolsep}\begin{tabular}{|p{1.67cm}|p{3.813cm}|p{4.256cm}|p{4.1000004cm}|}
{\centering
2 key control
\par}
&
on Jukebox\newline
LEFT: turn left\newline
RIGHT: turn right
&
{}-
&
{}-
\\\hline
{\centering
4 key control
\par}
&
on Jukebox\newline
LEFT: turn left\newline
UP: turn up\newline
RIGHT: turn right\newline
DOWN: turn down
&
{}-
&
{}-
\\\hline
\end{tabular}\hspace*{-\tabcolsep}
}\\\cline{1-1}
\multicolumn{1}{|p{2.162cm}}{{\centering
2
\par}
}&
\multicolumn{4}{p{14.439cm}}{\hspace*{-\tabcolsep}\begin{tabular}{|p{1.67cm}|p{3.813cm}|p{4.256cm}|p{4.1000004cm}|}
{\centering
Remote control
\par}
&
on Jukebox\newline
LEFT: turn left\newline
RIGHT: turn right
&
on remote control\newline
VOL DOWN: turn left\newline
VOL UP: turn right
&
{}-
\\\hline
{\centering
No remote control
\par}
&
on Jukebox\newline
LEFT: turn left\newline
RIGHT: turn right
&
on Jukebox\newline
F2: turn left\newline
F3: turn right
&
{}-
\\\hline
\end{tabular}\hspace*{-\tabcolsep}
}\\\cline{1-1}
{\centering
3
\par}
&
{\centering
Remote control
\par}
&
\multicolumn{1}{p{3.813cm}|}{on Jukebox\newline
LEFT: turn left\newline
RIGHT: turn right
}&
\multicolumn{1}{p{4.256cm}|}{on remote control\newline
VOL DOWN: turn left\newline
VOL UP: turn right
}&
on Jukebox\newline
F2: turn left\newline
F3: turn right
\\\hline
\end{tabular}\end{center}
\subsubsection{The game}
Use the control keys of your worm to navigate around obstacles and find
food. Worms do not stop moving except when dead. Dead worms are no fun.
Be careful as your worm will try to eat anything that you steer it
across. It won't distinguish whether it's edible or not.
\begin{itemize}
\item \textbf{Food}
The small square hollow pieces are food. Move the worm over a food tile
to eat it. After eating the worm grows. Each time a piece of food has
been eaten a new piece of food will pop up somewhere. Unfortunately for
each new piece of food that appears two new ``argh'' pieces will
appear, too.
\item \textbf{Argh}
An ``argh'' is a black square poisoned piece {}- slightly bigger than
food {}- that makes a worm say ``Argh!'' when
run into. A worm that eats an ``argh'' is dead. Thus eating an
``argh'' must be avoided under any circumstances. ``Arghs'' have the
annoying tendency to accumulate.
\item \textbf{Worms}
Thou shall not eat worms. Neither other worms nor thyself. Eating worms
is blasphemous cannibalism, not healthy and causes instant
death. And it doesn't help anyway: the other worm
isn't hurt by the bite. It will go on creeping happily
and eat all the food you left on the table.
\item \textbf{Walls}
Don't crash into the walls. Walls are not edible.
Crashing a worm against a wall causes it a headache it
doesn't survive.
\item \textbf{Game over}
The game is over when all worms are dead. The longest worm wins the
game.
\item \textbf{Pause the game}
Press the PLAY key to pause the game. Hit PLAY again to resume the game.
\item \textbf{Stop the game}
There are two ways to stop a running game.
\begin{itemize}
\item If you want to quit Wormlet entirely simply hit the OFF button.
The game will stop immediately and you will return to the game menu.
\item If you want to stop the game and still see the screen hit the ON
button. This freezes the game. If you hit the ON button again a new
game starts with the same configuration. To return to the games menu
you can hit the OFF button. A stopped game can not be resumed.
\end{itemize}
\end{itemize}
\subsubsection{The scoreboard}
On the right side of the game field is the score board. For each worm it
displays its status and its length. The top most entry displays the
state of worm 1, the second worm 2 and the third worm 3. When a worm
dies it's entry on the score board turns black.
\begin{itemize}
\item \textbf{Len:}
Here the current length of the worm is displayed. When a worm is eating
food it grows by one pixel for each step it moves.
\item \textbf{Hungry:}
That's the normal state of a worm. Worms are always
hungry and want to eat. It's good to have a hungry
worm since it means that your worm is alive. But it's
better to get your worm growing.
\item \textbf{Growing:}
When a worm has eaten a piece of food it starts growing. For each step
it moves over food it can grow by one pixel. One piece of food lasts
for 7 steps. After your worm has moved 7 steps the food is used up. If
another piece of food is eaten while growing it will increase the size
of the worm for another 7 steps.
\item \textbf{Crashed:}
This indicates that a worm has crashed against a wall.
\item \textbf{Argh:}
If the score board entry displays ``Argh!'' it
means the worm is dead because it tried to eat an ``argh''. Until we
can make the worm say ``Argh!'' it's your job to say ``Argh!'' aloud.
\item \textbf{Wormed:}
The worm tried to eat another worm or even itself.
That's why it's dead now. Making traps for other players with a worm is a good way to get them out of the game.
\end{itemize}
\subsubsection{Hints}
\begin{itemize}
\item Initially you will be busy with controlling your worm. Try to
avoid other worms and crawl far away from them. Wait until they curl up
themselves and collect the food afterwards. Don't worry if the other worms grow longer than yours {}- you can catch up after they've died.
\item When you are more experienced watch the tactics of other worms.
Those worms controlled by artificial stupidity head straight for the
nearest piece of food. Let the other worm have its next piece of food
and head for the food it would probably want next. Try to put yourself
between the opponent and that food. From now on you can 'control' the other worm by blocking it. You could trap it by making a 1 pixel wide U{}-turn. You also could move from food to food and make sure you keep between your opponent and
the food. So you can always reach it before your opponent.
\item While playing the game the Jukebox can still play music. For
single player game use any music you like. For berserk games with 2 players use hard rock and for 3 player games use heavy metal or X{}-Phobie
(\url{http://www.x-phobie.de/}).
Play fair and don't kick your opponent in the toe or
poke him in the eye. That would be bad manners.
\end{itemize}

View file

@ -0,0 +1,840 @@
\chapter{Advanced Topics}
\newpage
\section{\label{ref:CustomisingUI}Customising the userinterface}
\subsection{\label{ref:GettingExtras}Getting Extras (Fonts,Languages)}
Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of different languages. Rockbox 2.4 comes with 41 fonts and 24 languages already included. If new fonts and language files have been created, then they will be found at \url{http://www.rockbox.org/fonts/} and \url{http://www.rockbox.org/lang/}.
\subsection{\label{ref:LoadingForts}Loading Fonts (Recorder, Ondio)}
Rockbox can load fonts dynamically. Simply copy the .fnt file to the
disk and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} Fonts} from the Main Menu .
If you want a font to be loaded automatically every time you start up,
it must be located in the \textbf{/.rockbox }folder and the file name
must be at most 24 characters long.
Any BDF font file up to 16 pixels high should be usable with Rockbox. To
convert from .bdf to .fnt, use the convbdf tool. This tool can be found
on the Rockbox website
(Linux: \url{http://www.rockbox.org/fonts/convbdf}, Windows: \url{http://www.rockbox.org/fonts/convbdf.exe}).
\subsection{\label{ref:Loadinglanguages}Loading Languages}
Rockbox can load language files at runtime. Simply copy the .lng file
(do not use the .lang file) to the Jukebox and
``play'' it in the Rockbox directory browser
or select \textbf{General Settings {}-{\textgreater} Languages }from
the Main Menu.
If you want a language to be loaded automatically every time you start
up, it must be located in the \textbf{/.rockbox }folder and the file
name must be a maximum of 24 characters long.
Rockbox supports many different languages. You can get .lng files at
\url{http://www.rockbox.org/lang/}.
Currently all of these languages are included in the Rockbox
distribution.
If your language is not yet supported and you want to write your own
language file, follow these instructions:
\begin{itemize}
\item Copy the\url{./ http://www.rockbox.org/lang/english.lang }file and start filling in the ``new:'' lines.
\item Name your file {\textless}language{\textgreater}.lang, where
{\textless}language{\textgreater} is the local name for your language. i.e. svenska.lang, francais.lang etc.
\item When you are done, submit your .lang file to Rockbox patch
tracker.
(\url{http://sourceforge.net/tracker/?group_id=44306&atid=439120})
\end{itemize}
\section{\label{ref:ConfiguringtheWPS}Configuring the WPS}
\subsection{Description / General Info}
\begin{itemize}
\item The Custom While Playing Screen (WPS) display is used on both the
Player and Recorder as a means to customise the WPS to the
user's likings.
\item After editing the .wps file, ``play'' it to make it take effect.
\item The file may be 2 lines long for the Player, and 13 lines for the
Recorder.
\item All characters not preceded by \% are displayed as typed.
\item Lines beginning with \# are comments and will be ignored.
\end{itemize}
\subsection{File Location}
Custom WPS files may be located anywhere on the drive. The only
restriction is that they must end in .wps. When PLAY is pressed on a
.wps file, it will be used for future WPS screens. If the
``played'' .wps file is located in the
/.rockbox folder, it will be remembered and used after reboot. The .wps
filename must be no more than 24 characters long for it to be
remembered.
\subsection{Tags}
\begin{itemize}
\item {\bfseries
ID3 Info Tags:}
\%ia : ID3 Artist
\%ic : ID3 Composer
\%id : ID3 Album Name
\%ig : ID3 Genre Name
\%in : ID3 Track Number
\%it : ID3 Track Title
\%iy : ID3 Year
\%iv : ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)
\item {\bfseries
Battery Info:}
\%bl : Show numeric battery level in percent
\%bt : Show estimated battery time left
\item {\bfseries
File Info Tags:}
\%fb : File Bitrate (in kbps)
\%ff : File Frequency (in Hz)
\%fm : File Name
\%fn : File Name (without extension)
\%fp : File Path
\%fs : File Size (In Kilobytes)
\%fv : ``(vbr)'' if variable bit rate or ``'' if constant bit rate
\%d1 : First directory from end of file path.
\%d2 : Second directory from end of file path.
\%d3 : Third directory from end of file path.
Example for the the \%dN commands: If the path is /Rock/Kent/Isola/11
{}-747.mp3, \%d1 is ``Isola'', \%d2 is ``Kent'', \%d3 is ``Rock''.
\end{itemize}
\begin{itemize}
\item {\bfseries
Playlist/Song Info Tags:}
\%pb : Progress Bar
\begin{itemize}
\item[] {
Player: This will display a 1 character
``cup'' that empties as the song progresses.}
Recorder: This will replace the entire line with a progress bar.
\end{itemize}
\%pf : Player: Full{}-line progress bar + time display
\%pc : Current Time In Song
\%pe : Total Number of Playlist Entries
\%pm : Peak Meter (Recorder only) {}- the entire line is used as volume
peak meter.
\%pn : Playlist Name (Without path or extension)
\%pp : Playlist Position
\%pr : Remaining Time In Song
\%ps : Shuffle. Shows 's' if shuffle
mode is enabled.
\%pt : Total Track Time
\%pv : Current volume
\item {\bfseries
Conditional Tags (If/Else block):}
\%?xx{\textless}{\textbar}{\textgreater} : Conditional: if the tag
specified by ``xx'' has a value, the text
between the ``{\textless}'' and the ``{\textbar}'' is displayed, else the text
between the ``{\textbar}'' and the
``{\textgreater}'' is displayed. The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals
nest, so the text in the if and else part can contain all \% commands,
including conditionals.
\end{itemize}
\begin{itemize}
\item {\bfseries
Next Song info}
You can display information about the next song {}- the song that is
about to play after the one currently playing (unless you change the
plan).
If you use the upper{}-case versions of the
three tags: F, I and D, they will instead refer to the next song
instead of the current one. Example: \%Ig is the genre name used in the
next song and \%Ff is the mp3 frequency.
Take note that the next song information WILL NOT be available at all
times, but will most likely be available at the end of a song. We
suggest you use the conditional display tag a lot when displaying
information about the next song!
\item {\bfseries
Alternating sublines}
It is possible to group items on each line into 2 or more groups or
``sublines''. Each subline will be displayed
in succession on the line for a specified time, alternating
continuously through each defined subline.
Items on a line are broken into sublines with the semicolon
';' character. The display time for
each subline defaults to 2 seconds unless modified by using the
'\%t' tag to specify an alternate
time (in seconds and optional tenths of a second) for the subline to be
displayed.
Subline related special characters and tags:
; : Split items on a line into separate sublines
\%t : Set the subline display time. The
'\%t' is followed by either integer
seconds (\%t5), or seconds and tenths of a second (\%t3.5).
Each alternating subline can still be optionally scrolled while it is
being displayed, and scrollable formats can be displayed on the same
line with non{}-scrollable formats (such as track elapsed time) as long
as they are separated into different sublines.
\item {\bfseries
Other Tags:}
\%\% : Display a '\%'
\%{\textless} : Display a
'{\textless}'
\%{\textbar} : Display a '{\textbar}'
\%{\textgreater} : Display a
'{\textgreater}'
\%s : Indicate that the line should scroll. Can occur anywhere in a line
(given that the text is displayed; see conditionals above). You can
specify up to 10 scrolling lines. Scrolling lines can not contain
dynamic content such as timers, peak meters or progress bars.
\end{itemize}
{\bfseries
Example File}
\%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}-
\%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}-
\%?id{\textless}\%id{\textbar}\%d1{\textgreater}
\%pb\%pc/\%pt
That is, ``tracknum {}- title [artist,
album]'', where most fields are only displayed if
available. Could also be rendered as
``filename'' or ``tracknum {}-title [artist]''.
{\bfseries
Default}
If you haven't selected a .wps file in the /.rockbox
directory, you get the hard coded layout. The default WPS screen for
Players is:
\%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}-
\%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}-
\%?id{\textless}\%id{\textbar}\%d1{\textgreater}
\%pc\%?ps{\textless}*{\textbar}/{\textgreater}\%pt
And for the Recorder and Ondio:
\%s\%?it{\textless}\%?in{\textless}\%in.
{\textbar}{\textgreater}\%it{\textbar}\%fn{\textgreater}
\%s\%?ia{\textless}\%ia{\textbar}\%?d2{\textless}\%d2{\textbar}(root){\textgreater}{\textgreater}
\%s\%?id{\textless}\%id{\textbar}\%?d1{\textless}\%d1{\textbar}(root){\textgreater}{\textgreater}
\%?iy{\textless}(\%iy){\textbar}{\textgreater}
\%pc/\%pt [\%pp:\%pe]
\%fbkBit \%?fv{\textless}avg{\textbar}{\textgreater}
\%?iv{\textless}(id3v\%iv){\textbar}(no id3){\textgreater}
\%pb
\%pm
\section{\label{ref:SettingsFile}Making your own settings file}
A .cfg file is used to load settings from a plain text file. A .cfg file
may reside anywhere on the hard disk. The only restriction is that the
filename must end in .cfg
Hint: Use the ``Write .cfg file'' feature
(Main Menu{}-{\textgreater} General Settings) to save the current
settings, then use a text editor to customize the settings file.
{\bfseries
Format Rules}
\begin{itemize}
\item Format: setting: value
\item Each setting must be on a separate line.
\item Lines starting with \# are ignored.
\end{itemize}
{\bfseries
Settings (allowed values) [unit]}
volume (0 {}- 100)
bass ({}-15 {}- 15)
treble ({}-15 {}- 15)
balance ({}-100 {}- 100)
channels (stereo, stereo narrow, stereo wide, mono, mono left,
mono right, karaoke)
shuffle (on, off)
repeat (off, all, one)
play selected (on, off)
resume (off, ask, ask once, on)
scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60) [secs]
scan accel (0 {}- 15) [double scan speed every X seconds]
antiskip (0 {}- 7) [seconds]
volume fade (on, off)
sort case (on, off)
show files (all, supported, music, playlists)
follow playlist (on, off)
playlist viewer icons
(on, off)
playlist viewer track display
(on, off)
recursive directory insert
(on, off)
scroll speed (0 {}- 15)
scroll delay (0 {}- 250) [1/10s]
scroll step (1 {}- 112) [pixels]
bidir limit (0 {}- 200) [\% of screen width]
contrast (0 {}- 63)
backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25,
30,
45, 60, 90) [seconds]
backlight when plugged
(on, off)
disk spindown (3 {}- 254) [seconds]
battery capacity (1500 {}- 2400) [mAh]
idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60)
[minutes]
lang (/path/filename.lng)
wps (/path/filename.wps)
autocreate bookmarks (on, off)
autoload bookmarks (on, off)
use most{}-recent{}-bookmarks
(on, off)
talk dir (off, number, spell, hover)
talk file (off, number, spell, hover)
talk menu (off, on)
{\bfseries
Recorder{}-specific settings}
loudness (0 {}- 17)
super bass (on, off)
auto volume (off, 0.02, 2, 4, 8) [seconds]
MDB enable (on, off)
MDB strength (0 {--} 127) [dB]
MDB harmonics (0 {--} 100) [\%]
MDB center frequency (20{}-300) [Hz]
MDB shape (50{}-300) [Hz]
peak meter release (1 {}- 126)
peak meter hold (off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8,
9, 10, 15, 20, 30, 1min)
peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
45, 60, 90, 2min, 3min, 5min, 10min, 20min,
45min, 90min)
peak meter busy (on, off)
peak meter dbfs (on, off) (on = dbfs, off = linear)
peak meter min (0 {}- 89) [dB] or (0 {}- 100) [\%]
peak meter max (0 {}- 89) [dB] or (0 {}- 100) [\%]
statusbar (on, off)
scrollbar (on, off)
volume display (graphic, numeric)
battery display (graphic, numeric)
time format (12hour, 24hour)
font (/path/filename.fnt)
invert (on, off)
deep discharge (on, off)
trickle charge (on, off)
disk poweroff (on, off)
rec quality (0 {}- 7) (0=smallest size, 7=highest quality)
rec frequency (48, 44, 32, 24, 22, 16) [kHz]
rec source (mic, line, spdif)
rec channels (mono, stereo)
rec mic gain (0 to 15)
rec left gain (0 to 15)
rec right gain (0 to 15)
editable recordings (on,off)
rec timesplit (off, 00:05, 00:10, 00:20, 00:30, 01:00, 01:12, \newline
01:20, 02:00, 04:00, 06:00, 08:00, 16:00,\newline
24:00) [hh:mm]
pre{}-recording time (off, 1{}-30) [secs]
rec directory (/recordings, current)
{\bfseries
FM recorder specific settings}
\textmd{force fm mono (on,off)}
\textbf{Example File}
volume: 70
bass: 11
treble: 12
balance: 0
time format: 12hour
volume display: numeric
show files: supported
wps: /.rockbox/car.wps
lang: /.rockbox/afrikaans.lng
\section{\label{ref:PartISection1}Differences between binaries}
There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge.
\begin{itemize}
\item \begin{itemize}
\item The current version is the latest stable version developed by the
Rockbox Team. It's free of known critical bugs and works with Archos
Jukebox Player/Studio, Recorders and Ondio devices. It is available
from
\url{http://www.rockbox.org/download/}.
\item The Daily Build is a development version of Rockbox. It supports all new features and patches developed since last stable version. It may also contain bugs! This version is generated automatically every day and can be found at
\url{http://www.rockbox.org/daily.shtml}.
\item Bleeding edge builds are the same as the Daily build, but built
from the latest development code every 20 minutes. These builds are for
people who want to test the code that developers just checked in.
\end{itemize}
\end{itemize}
There are binaries for different Jukebox models:
\begin{itemize}
\item \begin{itemize}
\item The Player version is suitable for Archos Jukebox 5000, 6000 and
all Studio models.
\end{itemize}
\end{itemize}
\begin{itemize}
\item \begin{itemize}
\item If you have a recorder with cylindrically rounded bumpers, you
need the ``regular'' recorder version.
\item FM Recorders are models with a FM radio.
\item The V2 recorder is a recorder in an FM Recorder form factor, but
without radio.
\item The 8mb version requires a hardware hack, where the RAM chips are
replaced.
\item The Ondio builds come with and without radio support, for the
Ondio FM and SP respectively.
\end{itemize}
\end{itemize}
If in doubt as to which version to use, the table on page
\pageref{ref:Jukeboxtypetable} may be of assistance.
Note: All references in this manual to
``Recorder'' apply equally to the FM Recorder
unless otherwise specified.
\section{\label{ref:FirmwareLoading}Firmware Loading}
When your Jukebox powers on, it loads the Archos firmware in ROM, which
automatically checks your Jukebox hard disk's root folder for a file
named \textbf{archos.mod} (on the player version) or
\textbf{ajbrec.ajz} (on the recorder version). Note that Archos
firmware can only read the first ten characters of each file name in
this process, so don't rename your old firmware files with names like
archos.mod.old and so on, because it's possible that the Jukebox will
load a file other than the one you intended.
\section{\label{ref:PartISection4}Using ROLO (Rockbox loader)}
Rockbox is able to load and start another firmware file without
rebooting. You just press PLAY on an .ajz (Recorder, Ondio) or .mod
(Player) file. This can be used to test new firmware versions without
deleting your current version, or to load the original Archos firmware
(you have to download the appropriate file from
Archos' website).
\section{\label{ref:Rockboxinflash}Rockbox in flash (Recorder, Ondio)}
\textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using
Rockbox on your Jukebox Recorder. Please read the whole section
thoroughly before flashing.
\subsection{\label{ref:PartISection61}Introduction}
Flashing in the sense used here and elsewhere in regard to Rockbox means
reprogramming the flash memory of the Jukebox unit. Flash memory
(sometimes called ``Flash ROM'') is a type of
non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable
programmable read{}-only memory (EEPROM).
A from the factory Jukebox comes with the Archos firmware flashed. It is
possible to replace the built{}-in software with Rockbox.
Terminology used in the following:\newline
\textbf{Firmware} means the flash ROM content as a whole.\newline
\textbf{Image} means one operating software started from there.
By reprogramming the firmware, the Jukebox will boot much faster. The
Archos boot loader seems to take forever compared to the Rockbox
version. In fact, the Rockbox boot loader is so fast that it has to
wait for the disk to spin up. The flashing procedure is a bit involved
for the first time, updates are very simple later on.
\subsection{\label{ref:Method}Method}
The replaced firmware will host a bootloader and 2 images. This is made
possible by compression. The first is the
``permanent'' backup. The second is the
default image to be started. The former is only used when you hold the
F1 key during start, and is the original Archos firmware, the second is
a current build of Rockbox. This second image is meant to be
reprogrammed whenever a Rockbox upgrade is performed.
There are two programming tools supplied:
\begin{itemize}
\item The first one is called \textbf{firmware\_flash.rock} and is used
to program the whole flash with new content. It can also be used to
revert back to the original firmware that is backed up as part of this
procedure. This tool will only be needed once, and can be viewed as
``formatting'' the flash with the desired image structure.
\item The second one is called \textbf{rockbox\_flash.rock }and is used
to reprogram only the second image. If the resulting programmed
firmware image is not operational, it is
possible to hold down the F1 key while booting to start the Jukebox
with the Archos firmware and Rockbox booted from disk to reinstall a
working firmware image.
\end{itemize}
\subsubsection{\label{ref:PartISection63}Risks}
Well, is it dangerous? Yes, certainly, like programming a
mainboard BIOS, CD/DVD drive firmware,
mobile phone, etc. If the power fails, the chip malfunctions while
programming or particularly if the programming software malfunctions,
your Jukebox may stop functioning. The Rockbox team take no
responsibility of any kind {}- do this at your own risk.
However, the code has been extensively tested and is known to work well.
The new firmware file is completely read before it starts programming,
there are a lot of sanity checks. If any fail, it will not program.
There is no reason why such low level code should behave differently on
your Jukebox.
There's one ultimate safety net to bring back Jukeboxes
with even completely garbled flash content: the UART boot mod, which in
turn requires the serial mod. This can bring the dead back to life,
with that it's possible to reflash independently from the outside, even
if the flash is completely erased. It has been used during development,
else Rockbox in flash wouldn't have been possible.
Extensive development effort went into the development of the UART boot
mod. Mechanically adept users with good soldering skills can easily
perform these mods. Others may feel uncomfortable using the first tool
(\textbf{firmware\_flash.rock}) for reflashing the firmware.
If you are starting with a known{}-good image, you are unlikely to
experience problems. The flash tools have been stable for quite a
while. Several users have used them extensively, even flashing while
playing! Although it worked, it's not the recommended
method.
The flashing software is very paranoid about making sure that the
correct flash version is being installed. If the wrong file is used,
it will simply refuse to flash the Jukebox.
About the safety of operation: Since the Rockbox boot code gives ``dual
boot'' capability, the Archos firmware is still there when you hold F1
during startup. So even if you have problems with Rockbox from flash, you can still use
the Jukebox, reflash the second image with an updated Rockbox copy,
etc.
The flash chip being used by Archos is specified for 100,000 cycles, so
it's very unlikely that flashing it will wear it out.
\subsection{\label{ref:Requirements}Requirements}
You need two things:
\begin{itemize}
\item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure
you're using the correct package, they differ
depending on your precise hardware! The technology works for the Player
models, too. Players can also be flashed, but Rockbox does not run
cold{}-started on those, yet.
\item Second, you need an in{}-circuit programmable flash. Chances are
about 85\% that you have, but Archos also used an older flash chip
which can't do the trick. You can find out via Rockbox
debug menu, entry Hardware Info. If the flash info gives you question
marks, you're out of luck. The only option for
flashing if this is the case is to solder in the right chip
(SST39VF020), preferably with the firmware already in. If the chip is
blank, you'll need the UART boot mod as well.
\end{itemize}
\subsubsection{\label{ref:FlashingProcedure}Flashing Procedure}
Here are step{}-by{}-step instructions on how to flash and update to a
current build. It is assumed that you can install and operate Rockbox
the usual way. The flashing procedure has a lot of failsafes, and will
check for correct model, file, etc. {}- if something is incompatible it
just won't flash, that's all.
Now here are the steps:
\textbf{Preparation}
Install (with all the files, not just the .ajz) and use the current
daily build you'd like to have. Enable any voice
features that are helpful throughout the process, such as menus and
filename spelling. Set the file view to show all files, with the menu
option \textbf{General Settings {}-{\textgreater} File View
{}-{\textgreater} Show Files} set to ``all''.
Have the Jukebox nicely charged to avoid
running out of power during the flash write. Keep the Jukebox plugged
into the charger until flashing is complete.
{\bfseries
Backup }
Backup the existing flash content. This is not an essential part of the
procedure, but is strongly recommended since you will need these files
if you wish to reverse the flashing procedure, or if you need to update
the bootloader (as opposed to the firmware) in the future. Keep them
safe!
Access the main menu by pressing F1 then select \textbf{Info
{}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM
contents}, by pressing Play one more time. The disk should start to
spin. Wait for it to settle down, then plug in the USB cable to copy
the dump file this has just been created to your PC. The main folder of
your Jukebox now should contain two strange .bin files. Copy the larger
one named
\textbf{internal\_rom\_2000000{}-203FFFF.bin}
to a safe place, then delete them both from the box.
{\bfseries
Copy the new flash content file to your box }
Depending on your model (recorder, FM, V2 recorder), download one of the
3 packages:
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_rec.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_fm.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiosp.zip}
\url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiofm.zip}
The zip archives contain two .bin files each. Those firmware*.bin files
are all we want, copy them to the root directory of your box. The names
differ depending on the model, the flash
plugin will pick the right one, no way of
doing this wrong.
{\bfseries
Install the Rockbox
Bootloader (``formatting'' the flash)}
This procedure is only necessary the first time you flash Rockbox.
Unplug the USB cable again, then select \textbf{Browse
}\textbf{Plugins}\textbf{ } from the main menu (F1). Locate \textbf{firmware\_flash.rock}, and start it with PLAY. Rockbox now displays an info screen, press F1 to acknowledge it and start a file check. Again wait for the disk to
settle, then press F2 to proceed to a warning message (if the plugin
has exited, you don't have the proper file) and F3 to actually program
the file. This takes maybe 15 seconds, wait for the disk to settle
again. Then press a key to exit the plugin.
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png}
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png}
\newline
Flashing boot loader in 3 easy steps
\par}
{\bfseries
\label{ref:FlashingRockbox}Install the Rockbox binary in flash}
All the above was necessary only once, although there will not be any
obvious difference (other than the Archos firmware loading a bit more quickly)
after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when
installing a new release from now on.
\begin{itemize}
\item Unpack the whole build that you are installing onto the Jukebox,
including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox.
\item Test the build you are going to flash by playing the .ajz file so
that ROLO loads it up. This puts the firmware in memory without
changing your flash, so you can check that everything is working. If
you have just installed the bootloader (see above) then this will happen automatically as the existing Archos firmware loads the .ajz that you have just installed. If upgrading ROMbox, this step \textbf{must }be carried out since Rockbox cannot overwrite the ROM while it is running from it.
\item Play the .ucl file, which is usually found in the
\textbf{/.rockbox} directory, this will kick off the
\textbf{rockbox\_flash.rock} plugin. It's a bit
similar to the other one, but it's made different to
make the user aware. It will check the file, available size, etc. With
F2 it begins programming, there is no need for warning this time. If it
goes wrong, you'll still have the permanent image.
{\centering\itshape
[Warning: Image ignored] % Unhandled or unsupported graphics:
%\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png}
\textmd{ } [Warning: Image ignored]
% Unhandled or unsupported graphics:
%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png}
\newline
Using rockbox\_flash to update your boot firmware
\par}
\item It is possible that you could get an ``Incompatible
Version'' error if the plugin interface has changed since
you last flashed Rockbox. This means you are running an
``old'' copy of Rockbox, but are trying to
execute a newer plugin, the one you just downloaded. The easiest
solution is to ROLO into this new version,
by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play
\textbf{rockbox.ucl}.
\item When done, you can restart the box and hopefully your new Rockbox
image.
\end{itemize}
UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4
and also the daily builds.
\subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations}
There are two variants as to how the Jukebox starts, which is why there
are normal and \_norom firmware files. The vast majority of Jukeboxes
all have the same boot ROM content, but some have different flash
content. Rockbox identifies this boot ROM with a CRC value of 0x222F in
the hardware info screen. Some recorders have the boot ROM disabled (it
might be unprogrammed) and start directly from a flash mirror at
address zero. They need the \_norom firmware, it has a slightly
different bootloader. Without a boot ROM there is no UART boot safety
net. To compensate for that as much as possible the MiniMon monitor is
included, and can be started by pressing F3+ON. Using this the box can
be reprogrammed via serial if the UART mod has been applied and the
first \~{}2000 bytes of the flash are OK.
\subsubsection{ROMbox}
ROMbox is a flashable version of Rockbox that is
uncompressed and runs directly from the flash chip rather than being
copied into memory first. The advantage of this is that memory that
would normally be used for storing the Rockbox code can be used for
buffering MP3s instead, resulting in less disk
spin{}-ups and therefore longer battery life
Unfortunately being uncompressed, ROMbox requires more space in flash
than Rockbox and will therefore not fit in the space that is left on an
FM recorder. ROMbox therefore runs on the V1 and V2 recorder models
only.
The procedure for flashing ROMbox is identical to the procedure for
flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}.
The only difference is that the file to install is called
\textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4
and all the current daily builds, so the procedure is identical
otherwise.

View file

@ -0,0 +1,24 @@
\thispagestyle{empty}
\vspace*{0.3cm}
\begin{center}
\Huge {Rockbox - users manual}
\Huge {for }
\Huge {for \playername}
\includegraphics[width=10cm]{frontpage/rockbox3540}
\large rockbox.org
\today
\end{center}
\pagebreak
\thispagestyle{empty}
\cleardoublepage

Binary file not shown.

After

Width:  |  Height:  |  Size: 753 KiB

View file

@ -0,0 +1,8 @@
\chapter*{Introduction}
\vspace{3cm}
\noindent
\bigskip
\noindent
The Rockbox Crew

158
manual/optional.sty Normal file
View file

@ -0,0 +1,158 @@
%
% O P T I O N A L . S T Y
% ~~~~~~~~~~~~~~~~~~~~~~~
% ver 2.2b Jan 2005
%
% Enable multiple versions of a document to be printed from one source file,
% especially if most of the text is shared between versions.
%
% Copyright 1993,1999,2001,2005 by Donald Arseneau (asnd@triumf.ca).
% This software is released under the terms of the LaTeX Project Public
% License (ftp://ctan.tug.org/tex-archive/macros/latex/base/lppl.txt).
% (Essentially: Free to use, copy, distribute (sell) and change, but, if
% changed, that fact must be made apparent to the user.) It has a
% status of "maintained".
%
%
% HOW TO USE
% ~~~~~~~~~~
% One way to use this package is to declare (for example)
%
% \usepackage[opta]{optional}
%
% at the beginning of your document, and flag optional text throughout
% your document like:
%
% \opt{opta}{Do this if option opta was declared}
% \opt{optb}{Do this if option optb was declared}
% \opt{optx,opty}{Do this if either option optx or opty}
% \opt{}{Never print this text!}
% \opt{opta}{\input{appendices}}
% \optv{xam}{Type: \verb|[root /]$ rm -r *|.}
%
% Note that both the package option and the "\opt" argument can contain
% lists of options although, in practice, one or the other should be a
% single option name. Lists are allowed in both places to allow more
% flexibility in the style of use. (But making the definitions much more
% difficult, Grrr.)
%
% Just as for "\includeonly", you will have to edit the main document
% file to switch option codes (i.e., change the "\usepackage" line).
% There are, however, several ways to use this package without altering
% the main document file: separate files, file-name sensing, interactive
% prompting, and command-line option selection.
%
% Typically, different versions of a document will require different
% document class and package setup, besides the different tags for
% optional.sty. In that case it is best to have a separate main file
% for each version of the document. Each stub file will declare the
% document class and load some packages (including this one) and then
% input the rest of the document from a file common to all versions.
%
% \documentclass[A0]{poster}
% \usepackage[poster]{optional}
% \input{my_paper}
%
% If the different opt-tags match the different stub file names (file
% poster.tex will typeset the "poster" version) then you can specify
%
% \usepackage[\jobname]{optional}
%
% Alternatively, this "\jobname" technique can make use of symbolic links,
% if your computer system supports them, by having a single main input
% file accessed under different names (and different "\jobname"s).
%
% Another scheme is to invoke LaTeX with the command line such as:
%
% latex "\def\UseOption{opta,optb}\input{file}"
%
% (with quoting appropriate to your operating system) then options "opta"
% and "optb" will be used in addition to any options specified with the
% "\usepackage" command.
%
% You can prompt yourself to specify the option(s) with every run
% through LaTeX:
%
% \usepackage{optional}
% \newcommand{\ExplainOptions}{man = users manual, check = checklist,
% ref = reference card, post = poster.}
% \AskOption
%
% The definition of "\ExplainOptions" is optional; it only serves to help
% the person who answers the question. The "\AskOption" is also optional;
% it will be executed automatically whenever optional.sty sees no list of
% options. This method is too tedious to use much.
%
% The normal restrictions forbidding special characters in package options
% and reference tags apply also the the tags used by the "\opt" command.
%
% These are not `comment' macros: The optional text must be well-formed
% with balanced braces, even if not printed. The "\opt" command *IS*
% completely `expandable' which means it is robust and can even be used
% in messages ("\typeout").
%
% As usual, "\verb" commands and verbatim environments cannot be used
% in the argument to "\opt". For this purpose there is a variant form
% of "\opt" called "\optv" (optional verbatim) which may have a limited
% class of verbatim material in the argument. It can do so by leaving
% the braces around the argument, which may have undesired side effects.
% For an "\optv" argument to be successfully ignored, the verbatim material
% must have balanced braces etc.
%
% The "\opt" command is only intended for small sections of text. If you
% need to optionally include whole sections or chapters, put that material
% in a separate file, and "\opt"-ionally use an "\input" command:
%
% \opt{internal}{\input{prog_listings}}
%
%====================== END INSTRUCTIONS ========================
\ProvidesPackage{optional}[2005/01/26 ver 2.2b; \space
Optional inclusion/omission]
% Initialize used-option-list to \@gobble to eat the comma when the first
% entry is `appended'.
\@ifundefined{UseOption}{\let\UseOption\@gobble}{}
\DeclareOption*{\edef\UseOption{\UseOption,\CurrentOption}}
\ProcessOptions
\AtBeginDocument{\Opl@Setup}
\newcommand*\opt[1]{\if\Opl@notlisted{#1}\expandafter\@gobble
\else \expandafter\@firstofone \fi}
\newcommand*\optv[1]{\if\Opl@notlisted{#1}\expandafter\@gobble\fi}
% This initial definition forces immediate setup if \opt used in the preamble
\def\Opl@notlisted{\fi \Opl@Setup \if\Opl@notlisted}
\newcommand\AskOption{%
\@ifundefined{ExplainOptions}{}{\typeout{\ExplainOptions}}%
\typein[\UseOption]{Specify which optional text to process:}%
}
\def\Opl@Setup{%
\ifx\UseOption\@gobble\AskOption\fi
\let\Opl@notlisted\@empty % initialize list of checks
\@for\@tempa:=\UseOption\do{%
\ifx\@tempa\@empty\else\expandafter\Opl@oneop\expandafter{\@tempa}\fi}%
\ifx\Opl@notlisted\@empty \PackageWarning{optional}%
{No options were selected, so all optional text will be printed}%
\let\opt\@secondoftwo
\else
\typeout{Using optional text marked with \UseOption. }%
\toks@\expandafter{\Opl@notlisted}%
\edef\@tempa{\def\noexpand\Opl@notlisted####1{,\the\toks@,}}\@tempa
\fi
\let\Opl@Setup\@empty \let\Opl@oneop\undefined
\let\AskOption\undefined \let\ExplainOptions\undefined
}
\begingroup
\catcode`\Z= 3 % special delimiter
\gdef\Opl@oneop#1{%
\@ifundefined{Opl@Match@#1}{%
\toks@\expandafter{\Opl@notlisted}%
\edef\Opl@notlisted{\the\toks@ \csname Opl@Match@#1\endcsname ,####1,#1,Z}%
\@namedef{Opl@Match@#1}##1,#1,##2Z{##2}%
}\relax
}
\endgroup
\endinput

8
manual/platform/Makefile Normal file
View file

@ -0,0 +1,8 @@
# Dummy Makefile to trick the build system into not buiding tools and firmware
#
all:
@true
clean:
@true

5
manual/platform/h1xx.tex Normal file
View file

@ -0,0 +1,5 @@
\def\UseOption{h120}
\newcommand{\playerman}{iRiver}
\newcommand{\playertype}{H1xx}
\newcommand{\playerlongtype}{iHP100, iHP115, iHP120, iHP140, H120 and H140}

5
manual/platform/h300.tex Normal file
View file

@ -0,0 +1,5 @@
\def\UseOption{h300}
\newcommand{\playerman}{iRiver}
\newcommand{\playertype}{H3xx}
\newcommand{\playerlongtype{H320 and H340}

View file

@ -0,0 +1,5 @@
\def\UseOption{ipodcolor}
\newcommand{\playerman}{Apple}
\newcommand{\playertype}{iPod Color}
\newcommand{\playerlongtype}{\playertype}

View file

@ -0,0 +1,5 @@
\def\UseOption{ipodnano}
\newcommand{\playerman}{Apple}
\newcommand{\playertype}{iPod Nano}
\newcommand{\playerlongtype}{\playertype]

View file

@ -0,0 +1,4 @@
\def\UseOption{Iriver,H120}
\newcommand{\playerman}{iRiver}
\newcommand{\playertype}{H1xx}

View file

@ -0,0 +1,5 @@
\def\UseOption{player}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Studio/Player}
\newcommand{\playerlongtype}{Jukebox Studio 5000, 6000, Player 10 and 20}

View file

@ -0,0 +1,5 @@
\def\UseOption{recorder}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Recorder}
\newcommand{\playerlongtype}{Recorder 6, 10, 15 and 20}

View file

@ -0,0 +1,5 @@
\def\UseOption{recorderv2fm}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Recorder V2/FM}
\newcommand{\playertypelong}{Recorder V2 and FM Recorder}

76
manual/preamble.tex Normal file
View file

@ -0,0 +1,76 @@
\documentclass[a4paper,11pt]{report}
\usepackage[latin1]{inputenc}
\usepackage{helvet}
\usepackage{float}
\floatstyle{ruled}
\usepackage{hyperref}
\usepackage{xspace}
\usepackage{optional}
\input{platform/\platform.tex}
\opt{Archos}{\newcommand{\playerman}{Archos\xspace}}
\opt{Iaudio}{\newcommand{\playerman}{iAudio\xspace}}
\opt{Apple}{\newcommand{\playerman}{Apple iPod\xspace}}
\opt{PS}{\newcommand{\playertype}{Player/Studio\xspace}}
\opt{Rec}{\newcommand{\playertype}{Recorder\xspace}}
\opt{FMRec}{\newcommand{\playertype}{FM Recorder\xspace}}
\opt{Rec2}{\newcommand{\playertype}{Recorder V2\xspace}}
\opt{Gmini120}{\newcommand{\playertype}{Gmini 120\xspace}}
\opt{GminiSP}{\newcommand{\playertype}{Gmini SP\xspace}}
\opt{OndioSP}{\newcommand{\playertype}{Ondio SP\xspace}}
\opt{OndioFM}{\newcommand{\playertype}{Ondio FM\xspace}}
\opt{H320}{\newcommand{\playertype}{H320/340\xspace}}
\opt{H100}{\newcommand{\playertype}{iHP-100/iHP-110/iHP-115\xspace}}
\opt{Ifp790}{\newcommand{\playertype}{iFP-790\xspace}}
\opt{X5}{\newcommand{\playertype}{X5\xspace}}
\opt{Color}{\newcommand{\playertype}{Color/Photo\xspace}}
\opt{Nano}{\newcommand{\playertype}{Nano\xspace}}
\opt{Video}{\newcommand{\playertype}{Video\xspace}}
\newcommand{\playername}{\playerman \playertype}
\newcommand{\fname}[1]{\textbf{#1}}
\newcommand{\tabeltc}[1]{{\centering #1 \par}}
\newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
\usepackage{fancyhdr}
\usepackage{graphicx}
\usepackage{verbatim}
\usepackage{lscape}
\usepackage{makeidx}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{fancyvrb}
\usepackage{enumerate}
\usepackage{subfigure}
\usepackage{color}
%\usepackage{url}
%\urlstyle{same}
\pagestyle{fancy}
\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
\fancyhead{}
\fancyfoot{}
\fancyhead[RO]{\iffloatpage{}{\rightmark}}
\fancyhead[LE]{\iffloatpage{}{\leftmark}}
\fancyhead[LO,RE]{\iffloatpage{}{\raisebox{-3pt}}}
\fancyfoot[RO,LE]{\iffloatpage{}{\thepage}}
\fancyfoot[CO,CE]{}
\renewcommand{\headrulewidth}{\iffloatpage{0pt}{0.4pt}}
\renewcommand{\footrulewidth}{\iffloatpage{0pt}{0.4pt}}
\setlength{\headheight}{18.5pt}
\newcounter{example}[chapter]
\newenvironment{example}
{\stepcounter{example}\paragraph{Example \theexample:}}
{\hfill$\Box$
\bigskip
\noindent}
\renewcommand{\familydefault}{\sfdefault}

26
manual/rockbox.tex Normal file
View file

@ -0,0 +1,26 @@
\input{preamble.tex}
\begin{document}
\input{frontpage/frontpage.tex}
\pagestyle{plain}
\include{introduction}
\tableofcontents
\pagestyle{fancy}
\input{chapter1/getting_started.tex}
\input{chapter2/rockbox_interface.tex}
\input{chapter3/main_menu.tex}
\input{chapter4/configure_rockbox.tex}
\input{chapter5/plugins.tex}
\input{chapter6/advanced_topics.tex}
%\input{appendix.tex}
%\appendix
\raggedright
\end{document}

44
tools/configure vendored
View file

@ -425,6 +425,9 @@ fi
apps="apps"
appsdir='\$(ROOTDIR)/apps'
firmdir='\$(ROOTDIR)/firmware'
toolsdir='\$(TOOLSDIR)/tools'
##################################################################
# Figure out target platform
@ -848,7 +851,7 @@ fi
# Figure out build "type"
#
echo ""
echo "Build (N)ormal, (D)evel, (S)imulator, (B)ootloader, (G)DB stub? (N)"
echo "Build (N)ormal, (D)evel, (S)imulator, (B)ootloader, (G)DB stub, (M)anual? (N)"
option=`input`;
@ -893,6 +896,30 @@ fi
esac
echo "GDB stub build selected"
;;
[Mm])
appsdir='\$(ROOTDIR)/manual'
firmdir='\$(ROOTDIR)/manual/platform' # No Makefile here. Effectively ignores target
toolsdir=$firmdir;
toolset='';
apps="manual"
case $archos in
fmrecorder)
archos="recorderv2fm"
;;
recorderv2)
archos="recorderv2fm"
;;
ondio??)
archos="ondio"
;;
h1??)
archos="h1xx"
;;
*)
;;
esac
echo "Manual build selected"
;;
*)
debug=""
echo "Normal build selected"
@ -1030,6 +1057,8 @@ sed > Makefile \
-e "s,@LOADADDRESS@,${loadaddress},g" \
-e "s,@EXTRADEF@,${extradefines},g" \
-e "s,@APPSDIR@,${appsdir},g" \
-e "s,@FIRMDIR@,${firmdir},g" \
-e "s,@TOOLSDIR@,${toolsdir},g" \
-e "s,@APPS@,${apps},g" \
-e "s,@SIMVER@,${simver},g" \
-e "s,@GCCVER@,${gccver},g" \
@ -1043,10 +1072,11 @@ sed > Makefile \
## Automaticly generated. http://www.rockbox.org/
export ROOTDIR=@ROOTDIR@
export FIRMDIR=\$(ROOTDIR)/firmware
export FIRMDIR=@FIRMDIR@
export APPSDIR=@APPSDIR@
export TOOLSDIR=\$(ROOTDIR)/tools
export TOOLSDIR=@TOOLSDIR@
export DOCSDIR=\$(ROOTDIR)/docs
export MANUALDIR=\${ROOTDIR}/manual
export DEBUG=@DEBUG@
export ARCHOS=@ARCHOS@
export ARCHOSROM=@ARCHOSROM@
@ -1092,7 +1122,7 @@ export UNAME=@UNAME@
# Do not print "Entering directory ..."
MAKEFLAGS += --no-print-directory
.PHONY: all clean tags zip tools
.PHONY: all clean tags zip tools manual
all: tools
@SIMUL1@
@ -1104,7 +1134,7 @@ clean:
@\$(MAKE) -C \$(FIRMDIR) clean OBJDIR=\$(BUILDDIR)/firmware
@\$(MAKE) -C \$(APPSDIR) clean OBJDIR=\$(BUILDDIR)/@APPS@
@\$(MAKE) -C \$(TOOLSDIR) clean
@rm -rf rockbox.zip TAGS @APPS@ firmware comsim sim lang.h
@rm -rf rockbox.zip TAGS @APPS@ firmware comsim sim lang.h manual *.pdf
tools:
\$(MAKE) -C \$(TOOLSDIR) CC=\$(HOSTCC) @TOOLSET@
@ -1121,6 +1151,10 @@ zip:
7zip:
@\$(TOOLSDIR)/buildzip.pl -o "rockbox.7z" -z "7za a" -r "\$(ROOTDIR)" \$(TARGET) \$(BINARY)
manual:
@\$(MAKE) -C \$(MANUALDIR) OBJDIR=\$(BUILDDIR)/manual buildmanual
EOF
if [ "yes" = "$simulator" ]; then