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