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
  85 The \setting{Settings} menu allows to set or adjust many parameters that affect
  86 the way your \dap{} works. There are many submenus for different parameter
  87 areas. Every time you are setting a value of a parameter, and that value is
  88 selected from a list of some predefined available values, you can press
  89 \ActionStdContext, and the selection cursor will jump to the default value for
  90 the parameter. You can then confirm or cancel the value. This is useful if you
  91 have changed the value of the parameter from the default to some other value and
  92 would like to restore the default value.
  93
  94 \subsection{Sound Settings}
  95 The \setting{Sound Settings} menu offers a selection of sound properties you may
  96 change to customise your listening experience. The details of this menu are covered
  97 in \reference{ref:configure_rockbox_sound}.
  98
  99 \subsection{General Settings}
 100 The \setting{General Settings} menu allows you to customise the way Rockbox looks
 101 and the way it plays music. The details of this menu are covered in
 102 \reference{ref:configure_rockbox_general}.
 103
 104 \subsection{Manage Settings}
 105 The \setting{Manage Settings} option allows the saving and re-loading of user
 106 configuration settings, browsing the hard drive for alternate firmwares, and finally
 107 resetting your \dap{} back to initial configuration.
 108 %
 109 \opt{MASCODEC}{This menu also allows the user to load different versions of the
 110 Rockbox firmware.}
 111 %
 112 The details of this menu are covered in
 113 \reference{ref:manage_settings}.
 114
 115 \subsection{Theme Settings}
 116 The \setting{Theme Settings} menu contains options that control the visual
 117 apperance of Rockbox. The details of this menu are covered in
 118 \reference{ref:configure_rockbox_themes}.
 119
 120 \opt{recording}{
 121 \subsection{Recording Settings}
 122 The \setting{Recording Settings} menu allows you to configure settings related
 123 to recording. The details of this menu are covered in detail in
 124 \reference{ref:Recordingsettings}.
 125
 126 \input{main_menu/recording_screen.tex}
 127 }
 128
 129 \opt{radio}{\input{main_menu/fmradio.tex}}
 130
 131 \section{\label{ref:playlistoptions}Playlist}
 132   This menu allows you to work with playlists. Playlists can be created in
 133   three ways. Playing a file in a directory causes all the files in it
 134   to be placed in a playlist. Playlists can be created manually by
 135   either using the  \setting{Context Menu} (see \reference{ref:Contextmenu}) or using
 136   the \setting{Playlist} menu. Both automatically and manually created
 137   playlists can be edited using this menu.
 138
 139 \begin{description}
 140 \item[Create Playlist:]
 141   Rockbox will create a playlist with all tracks in the current directory
 142 and all sub-directories. The playlist will be created one directory level ``up''
 143 from where you currently are.
 144
 145 \item[View Current Playlist:]
 146   Displays the contents of the playlist currently stored in memory.
 147
 148 \item[Save Current Playlist:]
 149   Saves the current dynamic playlist, excluding queued tracks, to the
 150 specified file. If no path is provided then playlist is saved to current
 151 directory (see \reference{ref:Playlistsubmenu}).
 152
 153 \item[Playlist Catalog:]
 154   The \setting{Playlist Catalog} provides a simple interface to maintain
 155   several playlist (see \reference{label:WorkingWithPlaylists}).
 156 \end{description}
 157
 158 \section{Plugins}
 159   With this option you can load and run various plugins that have been
 160 written for Rockbox. There are a wide variety of these supplied with
 161 Rockbox, including several games, some impressive demos and a number of
 162 utilities. A detailed description of the different plugins is to be found in
 163 \reference{ref:plugins}.
 164
 165 \section{\label{ref:Info}System}
 166   This option shows RAM buffer size, battery voltage level and estimated time
 167 remaining, disk total space and disk free space.
 168 \opt{player}{Use the MINUS and PLUS keys to step through several
 169 pages of information.}
 170
 171 \begin{description}
 172 \item[Rockbox Info:]
 173   Displays some basic system information. This is, from top to bottom,
 174   the amount of memory Rockbox has available for storing music (the buffer).
 175   The battery status.
 176 \opt{multivolume}{%
 177   Memory size and amount of free space on the two data volumes, this info is
 178   given seperately for internal memory (\emph{Int}) and for a plugged in
 179   memory card
 180   \opt{ondio}{(\emph{MMC})}
 181   \opt{sansa}{(\emph{MSD})}.
 182 }%
 183 \nopt{multivolume}{Hard disk size and the amount of free space on the disk.}
 184
 185 \item[Version:]
 186   Software version and credits display.
 187
 188 \item[Sleep Timer:]
 189   The \setting{Sleep Timer} powers off your \dap{} after playing for a given
 190   time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
 191   The \setting{Sleep Timer} is reset on boot.
 192   \opt{alarm}{Using this option disables the \setting{Wake up alarm}.}
 193
 194 \item[Debug (Keep Out!):]
 195   This sub menu is intended to be used \emph{only} by Rockbox developers.
 196   It shows hardware, disk, battery status and other technical information.
 197   \warn{It is not recommended that users access this menu unless instructed to
 198   do so in the course of fixing a problem with Rockbox. If you think you have
 199   messed up your settings by use of this menu please try to reset \emph{all}
 200   settings before asking for help.}
 201 \end{description}
 202
 203 \opt{player}{
 204   \section{Shutdown}
 205   This menu option saves the Rockbox configuration and turns off the hard
 206   drive before shutting down the machine. For maximum safety this procedure
 207   is recommended when turning off the \dap. (There is a very small risk
 208   of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
 209   for more details.
 210 }
 211
 212 \nopt{PLAYER_PAD,ONDIO_PAD}
 213 {
 214 \section{Quick Screen}
 215   Whilst not strictly part of the \setting{Main Menu}, it is worth noting that
 216   a few of the more commonly used settings are available from the
 217   \setting{Quick Screen}.
 218   The \setting{Quick Screen} screen is accessed with \ActionStdQuickScreen{}
 219   and exited with the same button.
 220   It allows rapid access to the \setting{Shuffle} and \setting{Repeat}
 221   modes (\reference{ref:PlaybackOptions}) and the \setting{Show Files}
 222   option (\reference{ref:ShowFiles}).
 223 }