len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2025-10-13 10:07:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update the manual to reflect recent menu changes, add descriptions of how to move and remove tracks in the playlist viewer, Recording settings are now in their own chapter.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12553 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Nils Wallménius 2007-03-03 00:07:31 +00:00
parent 79a2a936a2
commit 909b9462da
21 changed files with 224 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

5
manual/configure_rockbox/database.tex Normal file
View file

@ -0,0 +1,5 @@
% $Id: $ %
\section{Database}
This sub menu allows you to configure the database.
See \reference{ref:database} for more information about using
the database.

2
manual/configure_rockbox/display_options.tex
View file

@ -1,5 +1,5 @@
% $Id$ %
\section{\label{ref:Displayoptions}Display Options}
\section{\label{ref:Displayoptions}Display}
\begin{description}
\nopt{player}{

10
manual/configure_rockbox/file_view.tex
View file

@ -36,12 +36,6 @@ displays files.
hidden.
\item[Playlists:] The \setting{File Browser} displays only directories and playlists,
for simplified navigation.
\item[Database:] This shows the files based on the \setting{Database}
information, thus disabling the \setting{File Browser}. You can browse the
database by various tags and search them. Only information present
in music file tags are shown. For a detailed description of
\setting{Database} refer to \reference{ref:database}.
\end{description}
\item[Follow Playlist:]
@ -64,8 +58,4 @@ displays files.
If set to \setting{Current Directory Only} only the name of the current
directory will be displayed.
\item[Database:]
This option allows you to configure the database.
See \reference{ref:database} for more information about using
the database.
\end{description}

10
manual/configure_rockbox/main.tex
View file

@ -6,9 +6,17 @@
\label{ref:configure_rockbox_general}
\input{configure_rockbox/general_settings.tex}
\input{configure_rockbox/playback_options.tex}
\input{configure_rockbox/playlist_options.tex}
\input{configure_rockbox/file_view.tex}
\input{configure_rockbox/database.tex}
\input{configure_rockbox/display_options.tex}
\input{configure_rockbox/system_options.tex}
\input{configure_rockbox/bookmarking.tex}
\input{configure_rockbox/language.tex}
\input{configure_rockbox/voice.tex}
\input{configure_rockbox/voice.tex}
\opt{HAVE_RECORDING}{
\chapter{Recording Settings}
\label{ref:Recordingsettings}
\input{configure_rockbox/recording_settings.tex}
}

22
manual/configure_rockbox/playback_options.tex
View file

@ -1,6 +1,6 @@
% $Id$ %
\section{\label{ref:PlaybackOptions}Playback Options}
The \setting{Playback Options} sub menu allows you to configure settings
\section{\label{ref:PlaybackOptions}Playback}
The \setting{Playback} sub menu allows you to configure settings
related to audio playback.
\begin{description}
\item[Shuffle. ]Alters how Rockbox will select which song to play next.\\
@ -56,31 +56,19 @@ related to audio playback.
}
}
\end{description}
\item[Play Selected First. ]This setting controls what happens when you
select a file for playback while shuffle mode is on. If the
\setting{Play Selected First} setting is \setting{Yes}, the file you
selected will be played first. If this setting is \setting{No}, a random
file in the directory will be played first.
\item[Resume on Startup. ]Rockbox can be configured to start playing automatically
when you turn on the \dap. If the resume function is set to start
automatically playing, Rockbox will start at the point where you last
turned off the \dap. The options for the \setting{Resume on Startup}
function are:
\begin{description}
\item[Yes. ]Rockbox will unconditionally try to resume.
\item[No. ]Rockbox will not resume.
\note{If \setting{Resume on Startup} is set to \setting{No}, Rockbox will
start in the \setting{File Browser}.}
\end{description}
\item[Fast-Forward/Rewind. ]How fast you want search (fast forward or rewind)
to accelerate when you hold down the button. \setting{Off} means no
acceleration. \setting{2x/1s} means double the search speed once every
second the button is held. \setting{2x/5s} means double the search speed
once every 5 seconds the button is held.
\item[Anti-Skip Buffer. ]This setting allows you to control how much music is
stored in the \daps{} memory whilst playing a song, acting as a buffer
against shock or playback problems. The \dap{} transfers the selected

14
manual/configure_rockbox/playlist_options.tex Normal file
View file

@ -0,0 +1,14 @@
% $Id:$ %
\section{\label{ref:PlaylistOptions}Playlist}
The \setting{Playlist} sub menu allows you to configure settings
related to playlists.
\begin{description}
\item[Recursively Insert Directories. ]
If set to \setting{On}, then when a directory is inserted or queued into a
dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask},
Rockbox will prompt the user about whether to include sub-directories.
\item[Warn When Erasing Dynamic Playlist. ]
If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
take an action that will cause Rockbox to erase the current dynamic playlist.
\end{description}

98
manual/main_menu/recording.tex → manual/configure_rockbox/recording_settings.tex
View file

@ -1,66 +1,8 @@
% $Id$ %
\section{\label{ref:Recording}Recording}
\subsection{\label{ref:while_recording_screen}While Recording Screen}
\screenshot{main_menu/images/ss-while-recording-screen}{The while recording
screen}{}
Entering the \setting{Recording} option in the \setting{Main Menu} brings up
a screen in which you can choose to enter the \setting{Recording Screen} or
the \setting{Recording Settings} (see below). The \setting{Recording Screen}
shows the time elapsed and the size of the file being recorded. A peak meter
is present to allow you set gain correctly. There is also a volume setting,
this will only affect the output level of the \dap{} and does \emph{not}
affect the recorded sound.
\opt{SWCODEC}{
\note{When you start a recording, the hard disk will spin up. This will cause
the peak meters to freeze in the process. This is expected behaviour, and
nothing to worry about. The recording continues during the spin up.}}
\opt{MASCODEC}{The frequency, channels and quality}
\opt{SWCODEC}{The frequency and channels} settings are shown on the last line.
The controls for this screen are:
\begin{table}
\begin{btnmap}{}{}
\ActionStdPrev{} / \ActionStdNext & Select setting.\\
%
\ActionSettingsDec{} / \ActionSettingsInc & Adjust selected setting.\\
%
\ActionRecPause & Start recording.\\
& While recording: pause recording (press again to
continue).\\
%
\ActionRecExit & Exit \setting{Recording Screen}.\\
& While recording: Stop recording.\\
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{
\ActionRecNewfile & Starts recording.\\
& While recording: close the current file and open
a new one.\\
}
%
\ActionRecMenu & Open \setting{Recording Settings} (see below).\\
%
\opt{RECORDER_PAD}{
\ActionRecFTwo & Quick menu for recording settings. A quick press will
leave the screen up (press \ActionRecFTwo{} again to exit), while holding
it will close the screen when you release it.\\
}
%
\opt{RECORDER_PAD}{
\ActionRecFThree & Quick menu for source setting.\\
& Quick/hold works as for \ActionRecFTwo.\\
& While recording: Start a new recording file.\\
}
\end{btnmap}
\end{table}
\subsection{\label{ref:Recordingsettings}Recording Settings}
% $Id:$ %
\screenshot{main_menu/images/ss-recording-settings}{The recording settings screen}{}
\opt{MASCODEC}{
\begin{description}
\item[Quality:]
\section{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
@ -70,7 +12,6 @@ The controls for this screen are:
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{description}
\begin{table}[h!]
\begin{center}
@ -85,20 +26,19 @@ The controls for this screen are:
\end{table}
}
\begin{description}
\opt{SWCODEC}{
\item[Format:]
\section{Format}
Choose which format to save your recording in. The available choices are
the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
losslessly compressed \setting{WavPack} and the lossy
\setting{MPEG Layer 3}.
\item[Encoder Settings:]
\section{Encoder Settings}
This sets the bitrate when using the \setting{MPEG Layer 3} format. And has
no settings for the other formats.
}
\item[Frequency:]
\section{Frequency}
Choose the recording frequency (sample rate).
\opt{MASCODEC}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz}
\opt{h1xx,h300}{44.1kHz, 22.05kHz and 11.025kHz}
@ -118,25 +58,25 @@ The controls for this screen are:
{\note{You cannot change the sample rate for digital recordings.}
}
\item[Source:]
\section{Source}
Choose the source of the recording. This can be
\opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}%
\setting{Mic} or \setting{Line In}.
\opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.}
\item[Channels:]
\section{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.
\opt{MASCODEC}{
\item[Independent Frames:]
\section{Independent Frames}
The independent frames option tells the \dap{} to encode with the bit
reservoir disabled, so the frames are independent of each other. This
makes a file easier to edit.
}
\item[File Split Options:]
\section{File Split Options}
This sub menu contains options for file splitting, which can be used to split
up long recordings into manageable pieces. The splits are seamless (frame
accurate), no audio is lost at the split point. The break between recordings
@ -166,32 +106,29 @@ The controls for this screen are:
\end{description}
\item[Prerecord Time:]
\section{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.
\item[Directory:]
\section{Directory}
Allows changing the location where the recorded files are saved. The
default location is \fname{/recordings}. If set to
\setting{Current Directory} the recorded files will be saved in the
directory where the \setting{File Browser} was left.
\item[Show recording screen on startup:]
If set to yes, the \dap{} will start up with the recording screen showing.
\nopt{ondio}{
\item[Clipping Light:]
\nopt{ondio}{
\section{Clipping Light}
Causes the backlight to flash on when clipping has been detected.\\
Options: \setting{Off}, \setting{Main unit only},
\setting{Main and remote unit}, \setting{Remote unit only}.
}
\item[Trigger:]
}
\section{Trigger}
\fixme{Add description of triggered recording.}
\opt{h1xx,h300}{%
\item[Automatic Gain Control:]
\section{Automatic Gain Control}
The \setting{Automatic Gain Control} has five different presets for
automatically controlling the gain while recording.
\begin{description}
@ -218,8 +155,7 @@ The controls for this screen are:
decrease gain to reach it.
\end{description}
\item[AGC clip time:]
\section{AGC clip time}
This setting controls how long the level is too loud or soft before the
\setting{Automatic Gain Control} kicks in.
}%
\end{description}

19
manual/configure_rockbox/system_options.tex
View file

@ -1,5 +1,11 @@
% $Id$ %
\section{\label{ref:SystemOptions}System Options}
\section{\label{ref:SystemOptions}System}
\subsection{Start Screen}
Set the screen that Rockbox will start in. Selecting
\setting{Resume Playback} will resume playback where it was when the \dap{}
was shut off if there is a playlist to resume and will then end up in the
WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
screen it was when the \dap{} was shut off.
\subsection{Battery}
Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}%
@ -78,12 +84,9 @@ paused. It is not idle while the USB or charger is connected, or while
recording. Settings are either \setting{Off} or \setting{1} to \setting{10}
minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
available.
\subsection{Sleep Timer}
This option lets you power off your \dap{} after playing for a given time. Can
be set from \setting{Off} to 5 hours in 5 minute steps.
\opt{recorderv2fm}{This setting is reset on boot. Using this option
disables the \setting{Wake up alarm} (see below).
\subsection{Wake Up alarm}
\opt{HAVE_RTC_ALARM}{
\subsection{Wake Up alarm}
This option turns the \dap{} off and then starts it up again at the
specified time. This is most useful when combined with the \setting{Resume}
setting in the \setting{Playback Options} menu is set to \setting{Yes}, so
@ -93,7 +96,7 @@ be set from \setting{Off} to 5 hours in 5 minute steps.
\ButtonPlay{} confirms the alarm and shuts your \dap{} down, and \ButtonOff
cancels setting an alarm. If the \dap{} is turned on again before the alarm
occurs, the alarm will be cancelled. Using this option disables the
\setting{Sleep Timer}(see above).
\setting{Sleep Timer}.
}
\subsection{Limits}

95
manual/main_menu/main.tex
View file

@ -1,26 +1,18 @@
% $Id$ %
\chapter{The Main Menu}
\section{Introducing the Main Menu}
\section{\label{ref:main_menu}Introducing the Main Menu}
\screenshot{main_menu/images/ss-main-menu}{The main menu}{}
The \setting{Main Menu} 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.
All options in Rockbox can be controlled via the \setting{Main Menu}.
To enter the \setting{Main Menu},
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{press the \ButtonMode\ button.}%
\opt{RECORDER_PAD}{press the \ButtonFOne\ button.}%
\opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{press the \ButtonMenu\
button.}%
The \setting{Main Menu} is the screen from which all of the Rockbox functions can be
accessed. To enter the \setting{Main Menu},
\nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
\opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%
\opt{IAUDIO_X5_PAD}{press the \ButtonRec\ button.}%
\opt{IRIVER_H10_PAD}{press the \ButtonPower\ button.}%
All settings are stored on the unit. However, Rockbox does not spin up
the disk solely for the purpose of saving settings. Instead, Rockbox will
the disk solely for the purpose of saving settings. Instead, Rockbox will
save settings 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 \dap\ is shut down safely
(see \reference{ref:Safeshutdown}).
refilling the MP3 buffer or navigating through the \setting{File Browser}.
Changes to settings may therefore not be saved unless the \dap{} is shut down
safely (see \reference{ref:Safeshutdown}).
\section{Navigating the Main Menu}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
@ -75,19 +67,31 @@ If the \setting{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. See \reference{ref:Bookmarkconfigactual}
for more details on configuring bookmarking in Rockbox.
\note{This option is off by default.}
\note{This entry is not shown in the \setting{Main Menu} when the option is off
and the option is off by default.}
\section{Sound Settings}
\section{Files}
Browse the files on your \dap{} (see \reference{ref:file_browser}).
\section{Database}
Browse by the meta-data in your audio files (see \reference{ref:database}).
\section{Now Playing/Resume Playback}
Go to the \setting{While Playing Screen} and resume if music playback is
stopped or paused and there is something to resume (see \reference{ref:WPS}).
\section{Settings}
\subsection{Sound Settings}
The \setting{Sound Settings} menu offers a selection of sound properties you may
change to customise your listening experience. The details of this menu are
covered in detail in \reference{ref:configure_rockbox_sound}.
\section{General Settings}
\subsection{General Settings}
The \setting{General Settings} menu allows you to customise the way Rockbox looks
and the way it plays music. The details of this menu are covered in detail in
\reference{ref:configure_rockbox_general}.
\section{Manage Settings}
\subsection{Manage Settings}
The \setting{Manage Settings} option allows the saving and re-loading of user
configuration settings, browsing the hard drive for alternate firmwares, and finally
resetting your \dap{} back to initial configuration.
@ -98,13 +102,13 @@ Rockbox firmware.}
The details of this menu are covered in detail in
\reference{ref:manage_settings}.
\section{Browse Themes}
\subsection{Browse Themes}
This option will display all the currently installed themes on the \dap,
press \ButtonRight\ to load the chosen theme and apply it.
press \ActionTreeEnter{} to load the chosen theme and apply it.
A theme is basically a configuration file, stored in a specific directory,
that typically changes the WPS
\opt{h1xx,h300,x5}{and remote WPS}, font used and on some platforms
\opt{HAVE_REMOTE_LCD}{and remote WPS}, font used and on some platforms
additional information such as background image and text colours.
There are a number of themes that ship with Rockbox. If none of
@ -120,22 +124,26 @@ these suit your needs, many more can be downloaded from
Some of the downloads from this site will actually be standalone WPS files,
others will be full-blown themes.
\note{Themes do not have to be purely visual. It is quite possible to create
a theme that switches between audio configurations for use in the car, with
headphones and when connected to an external amplifier. See
\reference{ref:CreateYourOwnWPS} for more details.
}
\note{Themes do not have to be purely visual. It is quite possible to create
a theme that switches between audio configurations for use in the car, with
headphones and when connected to an external amplifier. See
\reference{ref:CreateYourOwnWPS} for more details.}
\subsection{Recording Settings}
The \setting{Recording Settings} menu allows you to configure settings related
to recording. The details of this menu are covered in detail in
\reference{ref:Recordingsettings}.
\opt{HAVE_RECORDING}{\input{main_menu/recording_screen.tex}}
\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
\opt{HAVE_RECORDING}{\input{main_menu/recording.tex}}
\section{\label{ref:playlistoptions}Playlist Options}
\section{\label{ref:playlistoptions}Playlist}
This menu allows you to work with playlists. Playlists can be created in
three ways. Playing a file in a directory causes all the files in the
directory to be placed in a playlist. Playlists can be created manually by
either using the \setting{File Menu} (see \reference{ref:Filemenu}) or using
the \setting{Playlist Options} menu. Both automatically and manually created
the \setting{Playlist} menu. Both automatically and manually created
playlists can be edited using this menu.
\begin{description}
@ -151,27 +159,20 @@ from where you currently are.
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 \reference{ref:Playlistsubmenu}).
\item[Recursively Insert Directories: ]
If set to \setting{On}, then when a directory is inserted or queued into a
dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask},
Rockbox will prompt the user about whether to include sub-directories.
Options: \setting{Off}, \setting{Ask}, \setting{On}
\item[Warn When Erasing Dynamic Playlist: ]
If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
take an action that will cause Rockbox to erase the current dynamic playlist.
Options: \setting{Yes}, \setting{No}
\item[Playlist Catalog:]
The \setting{Playlist Catalog} provides a simple interface to maintain
several playlist (see \reference{label:WorkingWithPlaylists}).
\end{description}
\section{Browse Plugins}
\section{Plugins}
With this option you can load and run various plugins that have been
written for Rockbox. There are a wide variety of these supplied with
Rockbox, including several games, some impressive demos and a number of
utilities. A detailed description of the different plugins is to be found in
\reference{ref:plugins}.
\section{\label{ref:Info}Info}
\section{\label{ref:Info}System}
This option shows RAM buffer size, battery voltage level and estimated time
remaining, disk total space and disk free space.
\opt{player}{Use the MINUS and PLUS keys to step through several
@ -192,6 +193,12 @@ pages of information.}
\item[Version:]
Software version and credits display.
\item[Sleep Timer:]
The \setting{Sleep Timer} powers off your \dap{} after playing for a given
time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
The \setting{Sleep Timer} is reset on boot.
\opt{HAVE_RTC_ALARM}{Using this option disables the \setting{Wake up alarm}.}
\item[Debug (Keep Out!):]
This sub menu is intended to be used \emph{only} by Rockbox developers.
It shows hardware, disk, battery status and other technical information.

56
manual/main_menu/recording_screen.tex Normal file
View file

@ -0,0 +1,56 @@
% $Id$ %
\section{\label{ref:Recording}Recording}
\subsection{\label{ref:while_recording_screen}While Recording Screen}
\screenshot{main_menu/images/ss-while-recording-screen}{The while recording
screen}{}
Entering the \setting{Recording} option in the \setting{Main Menu} brings up
a screen in which you can choose to enter the \setting{Recording Screen} or
the \setting{Recording Settings} (see below). The \setting{Recording Screen}
shows the time elapsed and the size of the file being recorded. A peak meter
is present to allow you set gain correctly. There is also a volume setting,
this will only affect the output level of the \dap{} and does \emph{not}
affect the recorded sound.
\opt{SWCODEC}{
\note{When you start a recording, the hard disk will spin up. This will cause
the peak meters to freeze in the process. This is expected behaviour, and
nothing to worry about. The recording continues during the spin up.}}
\opt{MASCODEC}{The frequency, channels and quality}
\opt{SWCODEC}{The frequency and channels} settings are shown on the last line.
The controls for this screen are:
\begin{table}
\begin{btnmap}{}{}
\ActionStdPrev{} / \ActionStdNext & Select setting.\\
%
\ActionSettingsDec{} / \ActionSettingsInc & Adjust selected setting.\\
%
\ActionRecPause & Start recording.\\
& While recording: pause recording (press again to
continue).\\
%
\ActionRecExit & Exit \setting{Recording Screen}.\\
& While recording: Stop recording.\\
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{
\ActionRecNewfile & Starts recording.\\
& While recording: close the current file and open
a new one.\\
}
%
\ActionRecMenu & Open \setting{Recording Settings} (see below).\\
%
\opt{RECORDER_PAD}{
\ActionRecFTwo & Quick menu for recording settings. A quick press will
leave the screen up (press \ActionRecFTwo{} again to exit), while holding
it will close the screen when you release it.\\
}
%
\opt{RECORDER_PAD}{
\ActionRecFThree & Quick menu for source setting.\\
& Quick/hold works as for \ActionRecFTwo.\\
& While recording: Start a new recording file.\\
}
\end{btnmap}
\end{table}

1
manual/platform/ipod3g.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_3G_PAD}
\edef\UseOption{\UseOption,ipod}

1
manual/platform/ipod4g.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,ipod}

1
manual/platform/ipodcolor.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}

1
manual/platform/ipodmini.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,ipod}

1
manual/platform/ipodnano.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}

1
manual/platform/ipodvideo.tex
View file

@ -3,6 +3,7 @@
\edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}

1
manual/platform/recorderv2fm.tex
View file

@ -4,6 +4,7 @@
\edef\UseOption{\UseOption,HAVE_RECORDING}
\edef\UseOption{\UseOption,CONFIG_TUNER}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,HAVE_RTC_ALARM}
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,RECORDER_PAD}
\edef\UseOption{\UseOption,archos}

34
manual/rockbox_interface/main.tex
View file

@ -209,20 +209,13 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
}
\subsection{The first contact}
After you have first started the \dap{} you'll be presented by the
\setting{File Browser}. With the default settings only supported files are
shown. Rockbox' default view is the \setting{File Browser}, similar to Windows'
Explorer. If you don't have audio files on your \dap{}, or created folders you
will only see a blank screen with the statusbar at the top. If this is your
case, now is a good time to connect your \dap{} to a computer and transfer some
audio files to it.
When you have files on your \dap{} you'll see the supported ones now. Of
course you can change this view later. You can also completely switch to
a view that is based on the meta-data\footnote{ID3 Tags, Vorbis comments, etc.}
of your audio files. This view is called Database (see
\reference{ref:database}). Now you can start browsing the folder structure of
your \dap{}.
After you have first started the \dap{} you'll be presented by the
\setting{Main Menu}. From this menu you can reach every function of Rockbox,
for more information (see \reference{ref:main_menu}). To browse the files
on you \dap{} select \setting{Files} (see\reference{ref:file_browser}), and to
browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
comments, etc.} of your audio files, select \setting{Database} (see
\reference{ref:database}).
\subsection{Basic controls}
When browsing files and moving through menus you usually get a list view
@ -239,20 +232,9 @@ be extended or modified while playing. This is also known as
To go back to the \setting{File Browser} stop the playback with the
\ActionWpsStop{} button or return to the file browser while keeping playback
running using \ActionWpsBrowse{}.
In list views you can go back one step with \ActionStdCancel{}. The file
browser is a bit different in this case as pressing \ActionWpsStop{}
stops the playback instead of going up a level.
In list views you can go back one step with \ActionTreeParentDirectory.
\subsection{Basic concepts}
\subsubsection{Main Screen}
Rockbox' main screen is the \setting{File Browser}. This is pretty different to
most other players that use the ``While Playing Screen'' as their main screen.
In Rockbox' view this doesn't make any sense as when you are not playing a
file, information about the currently playing file isn't available and therefore
useless. Because of this the \dap{} switches to the \setting{File Browser} when
playback gets stopped. There is no point showing the WPS when playback is
stopped, so this is not and will not be possible.
\subsubsection{Playlists}
Rockbox is playlist oriented. This means that every time you play an audio file,
a so-called ``dynamic playlist'' is generated, unless you play a saved

11
manual/rockbox_interface/playback.tex
View file

@ -11,16 +11,17 @@ The \setting{Database Browser}, on the other hand, allows you to navigate
through the music on your player using categories like album, artist, genre,
etc.
You can select whether to browse using the \setting{File Browser} or the
\setting{Database Browser} by adjusting the \setting{Show Files} setting.
If you choose the \setting{File Browser}, the \setting{Show Files} setting also
lets you select what types of files you wish to view. See
You can select whether to browse using the \setting{File Browser} or the
\setting{Database Browser} by selecting either \setting{Files} or
\setting{Database} in the \setting{Main Menu}.
If you choose the \setting{File Browser}, the \setting{Show Files} setting
lets you select what types of files you wish to view. See
\reference{ref:ShowFiles} for more information on the \setting{Show Files}
setting.
\note{The \setting{File Browser} allows you to manipulate your files in ways
that are not available within the \setting{Database Browser}. Read more about
\setting{Database} in \reference{ref:database}. The remainder of this section
\setting{Database} in \reference{ref:database}. The remainder of this section
deals with the \setting{File Browser}.}
\opt{ondio}{

22
manual/rockbox_interface/tagcache.tex
View file

@ -11,7 +11,7 @@ files on your player and allows you to browse them by Artist, Album and Genre.
\subsection{Initializing the database}
Before you use the database for the first time, you must initialize it by using
the \setting{Initialize Now} function in the \setting{Database Menu}
(\setting{General Settings $\rightarrow$ File View $\rightarrow$ Database})
(\setting{Settings $\rightarrow$ General Settings $\rightarrow$ Database})
, which is described in the following section.
\subsection{\label{ref:databasemenu}The Database Menu}
@ -35,10 +35,10 @@ the \setting{Initialize Now} function in the \setting{Database Menu}
boots, the database will automatically be updated.
\opt{SWCODEC}{
\note{The \setting{Auto Update} will only check for deleted files if the
\setting{Directory Cache} (\setting{General Settings $\rightarrow$
System Options $\rightarrow$ Disk $\rightarrow$ Directory Cache}) is
enabled. \setting{Update now} includes that check whether dircache has
been enabled or not.}
\setting{Directory Cache} (\setting{Settings $\rightarrow$ General
Settings $\rightarrow$ System $\rightarrow$ Disk $\rightarrow$
Directory Cache}) is enabled. \setting{Update now} includes that check
whether dircache has been enabled or not.}
}%
\opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove
deleted files from the database you need to run \setting{Update Now}.}%
@ -89,15 +89,13 @@ the \setting{Initialize Now} function in the \setting{Database Menu}
\subsection{Using the database}
Once the database has been initialised, you can browse your music by Artist,
Album, Genre and Song Name. To use the database, change the
\setting{Show Files} show mode by changing the \setting{General Settings
$\rightarrow$ File View $\rightarrow$ Show files} option to
\setting{Database}. This disables the \setting{File Browser} and instead
allows you to view files using the information in the database.\\
Album, Genre and Song Name. To use the database, go to the \setting{Main Menu}
and select \setting{Database}.\\
\note{You may need to increase the value of the \setting{Max files in dir
browser} setting (\setting{General Settings $\rightarrow$ System $\rightarrow$
Limits}) in order to view long lists of tracks in the ID3 database browser.\\
browser} setting (\setting{Settings $\rightarrow$ General Settings
$\rightarrow$ System $\rightarrow$ Limits}) in order to view long lists of
tracks in the ID3 database browser.\\
There is no option to turn off database completely. If you do not want
to use it just don't do the initial build of the database and do not load it

32
manual/working_with_playlists/main.tex
View file

@ -119,16 +119,32 @@ playlist.
\note{You can control whether or not Rockbox includes the contents of
sub-directories when adding an entire directory to a playlists. Set the
\setting{Main Menu $\rightarrow$ Playlist Options $\rightarrow$ Recursively
Insert Directories} setting to \setting{Yes} if you would like Rockbox to
include tracks in sub-directories as well as tracks in the currently-selected
directory.}
\setting{Settings $\rightarrow$ General Settings $\rightarrow$ Playlist
$\rightarrow$ Recursively Insert Directories} setting to \setting{Yes} if
you would like Rockbox to include tracks in sub-directories as well as tracks
in the currently-selected directory.}
Dynamic playlists are saved so resume will restore them exactly as they
were before shutdown.
\note{To view, save or reshuffle the current dynamic playlist use the
\setting{Playlist Options} in the WPS context menu.}
\setting{Playlist} sub menu in the WPS context menu or in the
\setting{Main Menu}.}
\subsection{Modifying playlists}
\subsubsection{Reshuffeling}
Reshuffeling the current playlist is easily done from the \setting{Playlist}
sub menu in the WPS, just select \setting{Reshuffle}.
\subsubsection{Moving and removing tracks}
To move or remove a track from the current playlist enter the
\setting{Playlist Viewer} by selecting \setting{View Current Playlist} in the
\setting{Playlist} submenu in the WPS context menu or the \setting{Main Menu}.
Once in the \setting{Playlist Viewer} open the context menu on the track you
want to move or remove. If you want to move the track, select \setting{Move} in
the context menu and then move the blinking cursor to the place where you want
the track to be moved and confirm with \ActionStdOk. To remove a track, simply
select \setting{Remove} in the context menu.
\subsection{Saving playlists}
To save the current playlist either enter the \setting{Playlist} submenu
@ -156,7 +172,7 @@ It can be used like the \setting{File Browser}.
\subsubsection{Including sub-directories in playlists}
You can control whether or not Rockbox includes the contents of
sub-directories when adding an entire directory to a playlists.
Set the \setting{Main Menu $\rightarrow$ Playlist Options $\rightarrow$
Recursively Insert Directories} setting to \setting{Yes} if you would like
Rockbox to include tracks in sub-directories as well as tracks in the
Set the \setting{Main Menu $\rightarrow$ Settings $\rightarrow$ Playlist
$\rightarrow$ Recursively Insert Directories} setting to \setting{Yes} if you
would like to include tracks in sub-directories as well as tracks in the
currently selected directory.