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
  87 covered in detail 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 detail 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 detail in
 103 \reference{ref:manage_settings}.
 104
 105 \subsection{Browse Themes}
 106 This option will display all the currently installed themes on the \dap,
 107 press \ActionTreeEnter{} to load the chosen theme and apply it.
 108
 109 A theme is basically a configuration file, stored in a specific directory,
 110 that typically changes the WPS
 111 \opt{HAVE_REMOTE_LCD}{and remote WPS}, font used and on some platforms
 112 additional information such as background image and text colours.
 113
 114 There are a number of themes that ship with Rockbox. If none of
 115 these suit your needs, many more can be downloaded from
 116 \opt{RECORDER_PAD}{\wikilink{WpsArchos}}%
 117 \opt{h1xx}{\wikilink{WpsIriverH100}}%
 118 \opt{h300,ipodcolor}{\wikilink{WpsIriverH300}}%
 119 \opt{ipodvideo}{\wikilink{WpsIpod5g}}%
 120 \opt{ipodnano}{\wikilink{WpsIpodNano}}%
 121 \opt{ipodmini}{\wikilink{WpsIpodMini}}%
 122 \opt{x5}{\wikilink{WpsIaudioX5}}%
 123 .
 124 Some of the downloads from this site will actually be standalone WPS files,
 125 others will be full-blown themes.
 126
 127 \note{Themes do not have to be purely visual. It is quite possible to create
 128   a theme that switches between audio configurations for use in the car, with
 129   headphones and when connected to an external amplifier. See
 130   \reference{ref:CreateYourOwnWPS} for more details.}
 131
 132 \subsection{Recording Settings}
 133 The \setting{Recording Settings} menu allows you to configure settings related
 134 to recording. The details of this menu are covered in detail in
 135 \reference{ref:Recordingsettings}.
 136
 137 \opt{HAVE_RECORDING}{\input{main_menu/recording_screen.tex}}
 138
 139 \opt{CONFIG_TUNER}{\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 the
 144   directory to be placed in a playlist. Playlists can be created manually by
 145   either using the  \setting{File Menu} (see \reference{ref:Filemenu}) 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 folder 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 current
 161 directory (see \reference{ref:Playlistsubmenu}).
 162
 163 \item[Playlist Catalog:]
 164   The \setting{Playlist Catalog} provides a simple interface to maintain
 165   several playlist (see \reference{label:WorkingWithPlaylists}).
 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   This option shows RAM buffer size, battery voltage level and estimated time
 177 remaining, disk total space and disk free space.
 178 \opt{player}{Use the MINUS and PLUS keys to step through several
 179 pages of information.}
 180
 181 \begin{description}
 182 \item[Rockbox Info:]
 183   Displays some basic system information. This is, from top to bottom,
 184   the amount of memory Rockbox has available for storing music (the buffer).
 185   The battery status.
 186 \opt{ondio}{%
 187   Memory size and amount of free space on the two data volumes, this info is
 188   given seperately for internal memory (\emph{Int}) and for a plugged in MMC
 189 (\emph{MMC}).
 190 }%
 191 \nopt{ondio}{Hard disk size and the amount of free space on the disk.}
 192
 193 \item[Version:]
 194   Software version and credits display.
 195
 196 \item[Sleep Timer:]
 197   The \setting{Sleep Timer} powers off your \dap{} after playing for a given
 198   time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
 199   The \setting{Sleep Timer} is reset on boot.
 200   \opt{HAVE_RTC_ALARM}{Using this option disables the \setting{Wake up alarm}.}
 201
 202 \item[Debug (Keep Out!):]
 203   This sub menu is intended to be used \emph{only} by Rockbox developers.
 204   It shows hardware, disk, battery status and other technical information.
 205   \warn{It is not recommended that users access this menu unless instructed to
 206   do so in the course of fixing a problem with Rockbox. If you think you have
 207   messed up your settings by use of this menu please try to reset \emph{all}
 208   settings before asking for help.}
 209 \end{description}
 210
 211 \opt{player}{
 212   \section{Shutdown}
 213   This menu option saves the Rockbox configuration and turns off the hard
 214   drive before shutting down the machine. For maximum safety this procedure
 215   is recommended when turning off the \dap. (There is a very small risk
 216   of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
 217   for more details.
 218 }
 219
 220 \nopt{PLAYER_PAD,ONDIO_PAD}
 221 {
 222 \section{Quick Menu}
 223   Whilst not strictly part of the \setting{Main Menu}, it is worth noting that
 224   a few of the more commonly used settings are available from the
 225   \setting{Quick Menu}.
 226   The \setting{Quick Menu} screen is accessed with \ActionStdQuickScreen
 227   and exited with the same button.
 228   It allows rapid access to the \setting{Shuffle} and \setting{Repeat}
 229   modes (\reference{ref:PlaybackOptions}) and the \setting{Show Files}
 230   option (\reference{ref:ShowFiles}).
 231 }