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 can be
   6 accessed. To enter the \setting{Main Menu},
   7   \nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
   8   \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%
   9
  10 All settings are stored on the unit. However, Rockbox does not spin up
  11 the disk solely for the purpose of saving settings. Instead, Rockbox will
  12 save settings when it spins up the disk the next time, for example when
  13 refilling the MP3 buffer or navigating through the \setting{File Browser}.
  14 Changes to settings may therefore not be saved unless the \dap{} is shut down
  15 safely (see \reference{ref:Safeshutdown}).
  16
  17 \section{Navigating the Main Menu}
  18 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
  19   \begin{table}
  20     \begin{btnmap}{}{}
  21       \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollFwd}
  22       \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
  23       \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  24       & Moves up in the menu.\\
  25       & Inside a setting, increases the value or
  26         chooses next option \\
  27       %
  28       \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollBack}
  29       \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
  30       \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  31       & Moves down in the menu.\\
  32       & Inside a setting, decreases the value or
  33         chooses previous option \\
  34       %
  35       \opt{RECORDER_PAD}{\ButtonPlay/\ButtonRight}
  36       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect/\ButtonRight}
  37       \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD,IRIVER_H10_PAD}{\ButtonRight}
  38       & Selects option \\
  39       %
  40       \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff/\ButtonLeft}
  41       \opt{IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD,IRIVER_H10_PAD}{\ButtonLeft}
  42       & Exits menu, setting or moves to parent menu\\
  43     \end{btnmap}
  44   \end{table}
  45 }
  46 \opt{PLAYER_PAD}{
  47   \begin{table}
  48     \begin{btnmap}{}{}
  49       %
  50       \ButtonLeft  & Selects previous option in the menu.\\
  51                    & Inside an setting, decreases the value or chooses previous option \\
  52       %
  53       \ButtonRight & Selects next option in the menu.\\
  54                    & Inside an setting increases the value or chooses next option \\
  55       %
  56       \ButtonPlay  & Selects item \\
  57       %
  58       \ButtonStop  & Exit menu, setting or moves to parent menu.\\
  59     \end{btnmap}
  60   \end{table}
  61 }
  62
  63 \section {Recent Bookmarks}
  64 \screenshot{main_menu/images/ss-list-bookmarks}%
  65   {The list bookmarks screen}{}
  66 If the \setting{Save a list of recently created bookmarks} option is enabled
  67 then you can view a list of several recent bookmarks here and select one to
  68 jump straight to that track. See \reference{ref:Bookmarkconfigactual}
  69 for more details on configuring bookmarking in Rockbox.
  70 \note{This entry is not shown in the \setting{Main Menu} when the option is off
  71   and the option is off by default.}
  72
  73 \section{Files}
  74 Browse the files on your \dap{} (see \reference{ref:file_browser}).
  75
  76 \section{Database}
  77 Browse by the meta-data in your audio files (see \reference{ref:database}).
  78
  79 \section{Now Playing/Resume Playback}
  80 Go to the \setting{While Playing Screen} and resume if music playback is
  81 stopped or paused and there is something to resume (see \reference{ref:WPS}).
  82
  83 \section{Settings}
  84 \subsection{Sound Settings}
  85 The \setting{Sound Settings} menu offers a selection of sound properties you may
  86 change to customise your listening experience. The details of this menu are covered
  87 in \reference{ref:configure_rockbox_sound}.
  88
  89 \subsection{General Settings}
  90 The \setting{General Settings} menu allows you to customise the way Rockbox looks
  91 and the way it plays music. The details of this menu are covered in
  92 \reference{ref:configure_rockbox_general}.
  93
  94 \subsection{Manage Settings}
  95 The \setting{Manage Settings} option allows the saving and re-loading of user
  96 configuration settings, browsing the hard drive for alternate firmwares, and finally
  97 resetting your \dap{} back to initial configuration.
  98 %
  99 \opt{MASCODEC}{This menu also allows the user to load different versions of the
 100 Rockbox firmware.}
 101 %
 102 The details of this menu are covered in
 103 \reference{ref:manage_settings}.
 104
 105 \subsection{Theme Settings}
 106 The \setting{Theme Settings} menu contains options that control the visual
 107 apperance of Rockbox. The details of this menu are covered in
 108 \reference{ref:configure_rockbox_themes}.
 109
 110 \subsection{Recording Settings}
 111 The \setting{Recording Settings} menu allows you to configure settings related
 112 to recording. The details of this menu are covered in detail in
 113 \reference{ref:Recordingsettings}.
 114
 115 \opt{HAVE_RECORDING}{\input{main_menu/recording_screen.tex}}
 116
 117 \opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
 118
 119 \section{\label{ref:playlistoptions}Playlist}
 120   This menu allows you to work with playlists. Playlists can be created in
 121   three ways. Playing a file in a directory causes all the files in it
 122   to be placed in a playlist. Playlists can be created manually by
 123   either using the  \setting{Context Menu} (see \reference{ref:Contextmenu}) or using
 124   the \setting{Playlist} menu. Both automatically and manually created
 125   playlists can be edited using this menu.
 126
 127 \begin{description}
 128 \item[Create Playlist:]
 129   Rockbox will create a playlist with all tracks in the current directory
 130 and all sub-directories. The playlist will be created one directory level ``up''
 131 from where you currently are.
 132
 133 \item[View Current Playlist:]
 134   Displays the contents of the playlist currently stored in memory.
 135
 136 \item[Save Current Playlist:]
 137   Saves the current dynamic playlist, excluding queued tracks, to the
 138 specified file. If no path is provided then playlist is saved to current
 139 directory (see \reference{ref:Playlistsubmenu}).
 140
 141 \item[Playlist Catalog:]
 142   The \setting{Playlist Catalog} provides a simple interface to maintain
 143   several playlist (see \reference{label:WorkingWithPlaylists}).
 144 \end{description}
 145
 146 \section{Plugins}
 147   With this option you can load and run various plugins that have been
 148 written for Rockbox. There are a wide variety of these supplied with
 149 Rockbox, including several games, some impressive demos and a number of
 150 utilities. A detailed description of the different plugins is to be found in
 151 \reference{ref:plugins}.
 152
 153 \section{\label{ref:Info}System}
 154   This option shows RAM buffer size, battery voltage level and estimated time
 155 remaining, disk total space and disk free space.
 156 \opt{player}{Use the MINUS and PLUS keys to step through several
 157 pages of information.}
 158
 159 \begin{description}
 160 \item[Rockbox Info:]
 161   Displays some basic system information. This is, from top to bottom,
 162   the amount of memory Rockbox has available for storing music (the buffer).
 163   The battery status.
 164 \opt{multivolume}{%
 165   Memory size and amount of free space on the two data volumes, this info is
 166   given seperately for internal memory (\emph{Int}) and for a plugged in
 167   memory card
 168   \opt{ondio}{(\emph{MMC})}
 169   \opt{sansa}{(\emph{MSD})}.
 170 }%
 171 \nopt{multivolume}{Hard disk size and the amount of free space on the disk.}
 172
 173 \item[Version:]
 174   Software version and credits display.
 175
 176 \item[Sleep Timer:]
 177   The \setting{Sleep Timer} powers off your \dap{} after playing for a given
 178   time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
 179   The \setting{Sleep Timer} is reset on boot.
 180   \opt{HAVE_RTC_ALARM}{Using this option disables the \setting{Wake up alarm}.}
 181
 182 \item[Debug (Keep Out!):]
 183   This sub menu is intended to be used \emph{only} by Rockbox developers.
 184   It shows hardware, disk, battery status and other technical information.
 185   \warn{It is not recommended that users access this menu unless instructed to
 186   do so in the course of fixing a problem with Rockbox. If you think you have
 187   messed up your settings by use of this menu please try to reset \emph{all}
 188   settings before asking for help.}
 189 \end{description}
 190
 191 \opt{player}{
 192   \section{Shutdown}
 193   This menu option saves the Rockbox configuration and turns off the hard
 194   drive before shutting down the machine. For maximum safety this procedure
 195   is recommended when turning off the \dap. (There is a very small risk
 196   of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
 197   for more details.
 198 }
 199
 200 \nopt{PLAYER_PAD,ONDIO_PAD}
 201 {
 202 \section{Quick Menu}
 203   Whilst not strictly part of the \setting{Main Menu}, it is worth noting that
 204   a few of the more commonly used settings are available from the
 205   \setting{Quick Menu}.
 206   The \setting{Quick Menu} screen is accessed with \ActionStdQuickScreen{}
 207   and exited with the same button.
 208   It allows rapid access to the \setting{Shuffle} and \setting{Repeat}
 209   modes (\reference{ref:PlaybackOptions}) and the \setting{Show Files}
 210   option (\reference{ref:ShowFiles}).
 211 }