Move this call a bit up so that wpses without backdrop show none properly (the main...
[kugel-rb.git] / manual / main_menu / main.tex
blobcbdff0833e548d4629833bd1cb02edfe1e3b5f56
1 % $Id$ %
2 \chapter{The Main Menu}
3 \section{\label{ref:main_menu}Introducing the Main Menu}
4 \screenshot{main_menu/images/ss-main-menu}{The main menu}{}
5 The \setting{Main Menu} is the screen from which all of the Rockbox functions
6 can be accessed. This is the first screen you will see when starting Rockbox.
7 To return to the \setting{Main Menu},
8 \nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
9 \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%
11 All settings are stored on the unit. However, Rockbox does not spin up
12 the disk solely for the purpose of saving settings. Instead, Rockbox will
13 save settings when it spins up the disk the next time, for example when
14 refilling the MP3 buffer or navigating through the \setting{File Browser}.
15 Changes to settings may therefore not be saved unless the \dap{} is shut down
16 safely (see \reference{ref:Safeshutdown}).
18 \section{Navigating the Main Menu}
19 \begin{table}
20 \begin{btnmap}{}{}
21 \ActionStdNext
22 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdNext}
23 & Selects the next option in the menu.\\
25 & \opt{HAVEREMOTEKEYMAP}{&} Inside a setting,
26 increases the value or chooses next option \\
28 \ActionStdPrev
29 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev}
30 & Selects the previous option in the menu.\\
31 & \opt{HAVEREMOTEKEYMAP}{&} Inside a setting,
32 decreases the value or chooses previous option \\
34 \ActionStdOk
35 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk}
36 & Selects option \\
38 \ActionStdCancel
39 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel}
40 & Exits menu, setting or moves to parent menu\\
41 \end{btnmap}
42 \end{table}
44 \section {Recent Bookmarks}
45 \screenshot{main_menu/images/ss-list-bookmarks}%
46 {The list bookmarks screen}{}
47 If the \setting{Save a list of recently created bookmarks} option is enabled
48 then you can view a list of several recent bookmarks here and select one to
49 jump straight to that track.
51 \begin{table}
52 \begin{btnmap}{}{}
53 \ActionStdNext
54 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdNext}
55 & Selects the next bookmark.\\
57 \ActionStdPrev
58 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev}
59 & Selects the previous bookmark.\\
61 \ActionStdOk
62 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdOk}
63 & Resumes from the selected bookmark.\\
65 \ActionStdCancel
66 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdCancel}
67 & Exits Recent Bookmark menu\\
69 \nopt{GIGABEAT_S_PAD}{\ActionBmDelete
70 \opt{HAVEREMOTEKEYMAP}{& \ActionRCBmDelete}
71 & Deletes the currently selected bookmark\\}
73 \ActionStdContext
74 \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
75 & Enters the context menu for the selected bookmark.\\
76 \end{btnmap}
77 \end{table}
79 There are two options in the context menu:\\*
81 \setting{Resume} will commence playback of the currently selected bookmark entry.
83 \setting{Delete} will remove the currently selected bookmark entry from the list.\\*
85 This entry is not shown in the \setting{Main Menu} when the option is off
86 (the default setting). See \reference{ref:Bookmarkconfigactual}
87 for more details on configuring bookmarking in Rockbox.
89 \section{Files}
90 Browse the files on your \dap{} (see \reference{ref:file_browser}).
92 \section{Database}
93 Browse by the meta-data in your audio files (see \reference{ref:database}).
95 \section{Now Playing/Resume Playback}
96 Go to the \setting{While Playing Screen} and resume if music playback is
97 stopped or paused and there is something to resume (see \reference{ref:WPS}).
99 \section{Settings}
101 The \setting{Settings} menu allows to set or adjust many parameters that affect
102 the way your \dap{} works. There are many submenus for different parameter
103 areas. Every time you are setting a value of a parameter, and that value is
104 selected from a list of some predefined available values, you can press
105 \ActionStdContext, and the selection cursor will jump to the default value for
106 the parameter. You can then confirm or cancel the value. This is useful if you
107 have changed the value of the parameter from the default to some other value and
108 would like to restore the default value.
110 \subsection{Sound Settings}
111 The \setting{Sound Settings} menu offers a selection of sound properties you may
112 change to customise your listening experience. The details of this menu are covered
113 in \reference{ref:configure_rockbox_sound}.
115 \subsection{Playback Settings}
116 The \setting{Playback Settings} menu allows you to configure settings related
117 to audio playback. The details of this menu are covered
118 in \reference{ref:configure_rockbox_playback}.
120 \subsection{General Settings}
121 The \setting{General Settings} menu allows you to customise the way Rockbox looks
122 and the way it plays music. The details of this menu are covered in
123 \reference{ref:configure_rockbox_general}.
125 \subsection{Theme Settings}
126 The \setting{Theme Settings} menu contains options that control the visual
127 apperance of Rockbox. The details of this menu are covered in
128 \reference{ref:configure_rockbox_themes}.
130 \opt{recording}{
131 \subsection{Recording Settings}
132 The \setting{Recording Settings} menu allows you to configure settings related
133 to recording. The details of this menu are covered in detail in
134 \reference{ref:Recordingsettings}.
137 \subsection{Manage Settings}
138 The \setting{Manage Settings} option allows the saving and re-loading of user
139 configuration settings, browsing the hard drive for alternate firmwares, and finally
140 resetting your \dap{} back to initial configuration.
142 The details of this menu are covered in
143 \reference{ref:manage_settings}.
145 \opt{recording}{\input{main_menu/recording_screen.tex}}
147 \opt{radio}{\input{main_menu/fmradio.tex}}
149 \section{\label{ref:playlistoptions}Playlist}
150 This menu allows you to work with playlists. Playlists can be created in
151 three ways. Playing a file in a directory causes all the files in it
152 to be placed in a playlist. Playlists can be created manually by
153 either using the \setting{Context Menu} (see \reference{ref:Contextmenu}) or using
154 the \setting{Playlist} menu. Both automatically and manually created
155 playlists can be edited using this menu.
157 \begin{description}
158 \item[Create Playlist:]
159 Rockbox will create a playlist with all tracks in the current directory
160 and all sub-directories. The playlist will be created one directory level ``up''
161 from where you currently are.
163 \item[View Current Playlist:]
164 Displays the contents of the playlist currently stored in memory.
166 \item[Save Current Playlist:]
167 Saves the current dynamic playlist, excluding queued tracks, to the
168 specified file. If no path is provided then playlist is saved to the current
169 directory.
171 \item[Playlist Catalog:]
172 The \setting{Playlist Catalog} provides a simple interface to maintain
173 several playlists (see \reference{ref:working_with_playlists}).
174 \end{description}
176 \section{Plugins}
177 With this option you can load and run various plugins that have been
178 written for Rockbox. There are a wide variety of these supplied with
179 Rockbox, including several games, some impressive demos and a number of
180 utilities. A detailed description of the different plugins is to be found in
181 \reference{ref:plugins}.
183 \section{\label{ref:Info}System}
184 \opt{player}{Use the MINUS and PLUS keys to step through several
185 pages of information.}
187 \begin{description}
188 \opt{rtc}{
189 \item[Time and Date:]
190 Time related menu options. Pressing \ActionStdContext{} will voice the current time if voice support is enabled
191 \begin{description}
192 \item [Set Time/Date: ] Set current time and date.
193 \item[Sleep Timer:]
194 The \setting{Sleep Timer} powers off your \dap{} after playing for a given
195 time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
196 The \setting{Sleep Timer} is reset on boot.
197 \opt{alarm}{Using this option disables the \setting{Wake up alarm}.}
198 \item [Time Format: ] Choose 12 or 24 hour clock.
199 \opt{alarm}{
200 \subsection{Wake-Up Alarm}
201 % TODO this isn't quite right for all targets, I think
202 This option turns the \dap{} off and then starts it up again at the
203 specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust
204 the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to
205 adjust the hours.
206 \ActionAlarmSet{} confirms the alarm and shuts the \dap{} down, and
207 \ActionAlarmCancel{} cancels setting an alarm. If the \dap{} is turned on
208 again before the alarm occurs, the alarm will be cancelled. Using this
209 option disables the \setting{Sleep Timer}.
211 \opt{recording,radio}{
212 \subsection{Alarm Wake up Screen}
213 This option controls what the \dap{} does when it is woken up by the alarm.
216 \end{description}
218 \item[Rockbox Info:]
219 Displays some basic system information. This is, from top to bottom,
220 the amount of memory Rockbox has available for storing music (the buffer).
221 The battery status.
222 \opt{multivolume}{%
223 Memory size and amount of free space on the two data volumes, this info is
224 given seperately for internal memory (\emph{Int}) and for a plugged in
225 memory card
226 \opt{ondio}{(\emph{MMC})}
227 \opt{sansa,e200v2,fuze}{(\emph{MSD})}.
229 \nopt{multivolume}{Hard disk size and the amount of free space on the disk.}
231 \item[Credits:]
232 Display the list of contributors.
234 \nopt{rtc}{
235 \item[Sleep Timer:]
236 The \setting{Sleep Timer} powers off your \dap{} after playing for a given
237 time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
238 The \setting{Sleep Timer} is reset on boot.
239 \opt{alarm}{Using this option disables the \setting{Wake up alarm}.}
242 \item[Debug (Keep Out!):]
243 This sub menu is intended to be used \emph{only} by Rockbox developers.
244 It shows hardware, disk, battery status and other technical information.
245 \warn{It is not recommended that users access this menu unless instructed to
246 do so in the course of fixing a problem with Rockbox. If you think you have
247 messed up your settings by use of this menu please try to reset \emph{all}
248 settings before asking for help.}
249 \end{description}
251 \opt{player}{
252 \section{Shutdown}
253 This menu option saves the Rockbox configuration and turns off the hard
254 drive before shutting down the machine. For maximum safety this procedure
255 is recommended when turning off the \dap. (There is a very small risk
256 of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
257 for more details.
260 \opt{quickscreen}
262 \section{\label{ref:QuickScreen}Quick Screen}
263 Although the \setting{Quick Screen} is accessible from nearly everywhere,
264 not just the \setting{Main Menu}, it is worth mentioning here. It allows
265 rapid access to your three favourite settings. The default settings are
266 \setting{Shuffle} (\reference{ref:PlaybackSettings}),
267 \setting{Repeat} (\reference{ref:PlaybackSettings}) and the
268 \setting{Show Files} (\reference{ref:ShowFiles}) options, but almost all
269 configurable options in Rockbox can be placed on this screen. To change the
270 options, navigate through the menus to the setting you want to add and press
271 \ActionStdContext. In the menu which appears you will be given options
272 to place the setting on the \setting{Quick Screen}.
274 Press \ActionStdQuickScreen{} to access it and \ActionQuickScreenExit{} to exit.
275 The direction buttons will modify the individual setting values as indicated
276 by the arrow icons.