manual/main_menu/main.tex

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