blob: 3e3b26877412bb310c83326ad974c017011a39fa [file] [log] [blame]
Dominik Riebelingb7eef892006-04-10 21:47:09 +00001% $Id$ %
Martin Arver8e8207f2006-02-11 00:57:17 +00002\chapter{The Main Menu}
Martin Arver8e8207f2006-02-11 00:57:17 +00003
4\section{Introducing the Main Menu}
Dominik Riebeling2cf5abb2006-04-02 17:29:44 +00005\screenshot{main_menu/images/ss-main-menu}{The main menu}{}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +00006The \setting{Main Menu} is the screen from which the rest of the Rockbox functions can be
Dominik Riebeling1212dce2006-04-02 10:57:54 +00007accessed. It is used for a variety of functions, which are detailed below.
Michael DiFebboe28e2fc2006-05-12 16:56:21 +00008All options in Rockbox can be controlled via the \setting{Main Menu}.
Martin Arver8e8207f2006-02-11 00:57:17 +00009
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000010To enter the \setting{Main Menu},
11 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{press the \ButtonMode\ button.}
12 \opt{RECORDER_PAD}{press the \ButtonFOne\ button.}
13 \opt{PLAYER_PAD,IPOD_4G_PAD,ONDIO_PAD}{press the \ButtonMenu\ button.}
Daniel Stenbergb4370612006-07-12 21:52:19 +000014 \opt{IAUDIO_X5_PAD}{press the \ButtonRec\ button.}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000015
16All settings are stored on the unit. However, Rockbox does not spin up
17the disk solely for the purpose of saving settings. Instead, Rockbox will
18save settings when it spins up the disk the next time, for example when
Dominik Riebeling1212dce2006-04-02 10:57:54 +000019refilling the MP3 buffer or navigating through the file browser. Changes to
20settings may therefore not be saved unless the \dap\ is shut down safely
Martin Arver26c6e7b2006-08-01 11:57:38 +000021(see \reference{ref:Safeshutdown}).
Martin Arver8e8207f2006-02-11 00:57:17 +000022
Michael DiFebbod8848062006-04-01 15:43:04 +000023\section{Navigating the Main Menu}
Martin Arver7eb4d6c2006-03-27 20:01:22 +000024\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000025 \begin{table}
26 \begin{btnmap}{}{}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000027 \opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollFwd}
Martin Arverec3b2932006-03-30 21:21:46 +000028 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000029 & Moves up in the menu.\\
30 & Inside a setting, increases the value or
Dominik Riebeling1212dce2006-04-02 10:57:54 +000031 chooses next option \\
Martin Arver7eb4d6c2006-03-27 20:01:22 +000032 %
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000033 \opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollBack}
Martin Arverec3b2932006-03-30 21:21:46 +000034 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000035 & Moves down in the menu.\\
36 & Inside a setting, decreases the value or
Dominik Riebeling1212dce2006-04-02 10:57:54 +000037 chooses previous option \\
Martin Arver7eb4d6c2006-03-27 20:01:22 +000038 %
39 \opt{RECORDER_PAD}{\ButtonPlay/\ButtonRight}
40 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect/\ButtonRight}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000041 \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonRight}
Martin Arverec3b2932006-03-30 21:21:46 +000042 & Selects option \\
Martin Arver7eb4d6c2006-03-27 20:01:22 +000043 %
44 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff/\ButtonLeft}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000045 \opt{IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonLeft}
Martin Arverec3b2932006-03-30 21:21:46 +000046 & Exits menu, setting or moves to parent menu\\
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000047 \end{btnmap}
48 \end{table}
Martin Arver7eb4d6c2006-03-27 20:01:22 +000049}
50\opt{PLAYER_PAD}{
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000051 \begin{table}
52 \begin{btnmap}{}{}
Martin Arver7eb4d6c2006-03-27 20:01:22 +000053 %
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000054 \ButtonLeft & Selects previous option in the menu.\\
55 & Inside an setting, decreases the value or chooses previous option \\
Martin Arver7eb4d6c2006-03-27 20:01:22 +000056 %
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000057 \ButtonRight & Selects next option in the menu.\\
58 & Inside an setting increases the value or chooses next option \\
Martin Arver7eb4d6c2006-03-27 20:01:22 +000059 %
60 \ButtonPlay & Selects item \\
61 %
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000062 \ButtonStop & Exit menu, setting or moves to parent menu.\\
63 \end{btnmap}
64 \end{table}
Martin Arver5d340b72006-03-15 18:55:47 +000065}
Martin Arver8e8207f2006-02-11 00:57:17 +000066
Dominik Riebeling1212dce2006-04-02 10:57:54 +000067\section {Recent Bookmarks}
Dominik Riebeling2cf5abb2006-04-02 17:29:44 +000068\screenshot{main_menu/images/ss-list-bookmarks}%
Dominik Riebeling1212dce2006-04-02 10:57:54 +000069 {The list bookmarks screen}{}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000070If the \setting{Save a list of recently created bookmarks} option is enabled
Dominik Riebeling1212dce2006-04-02 10:57:54 +000071then you can view a list of several recent bookmarks here and select one to
Martin Arver26c6e7b2006-08-01 11:57:38 +000072jump straight to that track. See \reference{ref:Bookmarkconfigactual}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +000073for more details on configuring bookmarking in Rockbox.
74\note{This option is off by default.}
Dominik Riebeling1212dce2006-04-02 10:57:54 +000075
76\section{Sound Settings}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000077The \setting{Sound Settings} menu offers a selection of sound properties you may
Dominik Riebeling1212dce2006-04-02 10:57:54 +000078change to customize your listening experience. The details of this menu are
Martin Arver26c6e7b2006-08-01 11:57:38 +000079covered in detail in \reference{ref:configure_rockbox_sound}.
Dominik Riebeling1212dce2006-04-02 10:57:54 +000080
81\section{General Settings}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000082The \setting{General Settings} menu allows you to customize the way Rockbox looks
Martin Arver7a473132006-07-31 12:21:57 +000083and the way it plays music. The details of this menu are covered in detail in
Martin Arver26c6e7b2006-08-01 11:57:38 +000084\reference{ref:configure_rockbox_general}.
Dominik Riebeling1212dce2006-04-02 10:57:54 +000085
86\section{Manage Settings}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000087The \setting{Manage Settings} option allows the saving and re-loading of user
88configuration settings, browse the hard drive for alternate firmwares, and finally
89to reset your \dap\ back to initial configuration. The details of this menu are
Martin Arver26c6e7b2006-08-01 11:57:38 +000090covered in detail in \reference{ref:ManageSetting}.
Dominik Riebeling1212dce2006-04-02 10:57:54 +000091
92\section{Browse Themes}
Dominik Riebelingb7eef892006-04-10 21:47:09 +000093This option will display all the currently installed themes on the \dap,
94press \ButtonRight\ to load the chosen theme and apply it.
Dominik Riebelinge2ec5452006-04-02 17:50:21 +000095
Michael DiFebboe28e2fc2006-05-12 16:56:21 +000096A theme is basically a configuration file, stored in a specific directory,
Dominik Riebelingb7eef892006-04-10 21:47:09 +000097that typically changes the WPS
98\opt{h1xx,h300,x5}{and remote WPS}, font used and on some platforms
99additional information such as background image and text colours.
100
Dominik Riebeling0f661ab2006-05-28 15:49:17 +0000101There are a number of themes that ship with Rockbox. If none of
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000102these suit your needs, many more can be downloaded from
Dominik Riebeling0f661ab2006-05-28 15:49:17 +0000103\opt{RECORDER_PAD}{\wikilink{WpsArchos}}%
104\opt{h1xx}{\wikilink{WpsIriverH100}}%
105\opt{h300,ipodcolor}{\wikilink{WpsIriverH300}}%
106\opt{ipodvideo}{\wikilink{WpsIpod5g}}%
107\opt{ipodnano}{\wikilink{WpsIpodNano}}%
108\opt{ipodmini}{\wikilink{WpsIpodMini}}%
109\opt{x5}{\wikilink{WpsIaudioX5}}%
110.
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000111Some of the downloads from this site will actually be standalone WPS files,
112others will be full-blown themes.
113
114\note{Themes do not have to be purely visual. It is quite possible to create
115a theme that switches between audio configurations for use in the car, with
Martin Arver7a473132006-07-31 12:21:57 +0000116headphones and when connected to an external amplifier. See
Martin Arver26c6e7b2006-08-01 11:57:38 +0000117\reference{ref:CreateYourOwnWPS} for more details.
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000118}
119
Nils Wallménius792f64e2006-07-22 09:46:31 +0000120\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000121
Nils Wallménius792f64e2006-07-22 09:46:31 +0000122\opt{HAVE_RECORDING}{\input{main_menu/recording.tex}}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000123
Martin Arver8e8207f2006-02-11 00:57:17 +0000124\section{\label{ref:playlistoptions}Playlist Options}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000125 This menu allows you to work with playlists. Playlists can either be created
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000126automatically by playing a file in a directory directly, which will cause all
127of the files in that directory to be placed in the playlist, or they can be
Martin Arver26c6e7b2006-08-01 11:57:38 +0000128created by hand using the \setting{File Menu} (see \reference{ref:Filemenu})
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000129or using the \setting{Playlist Options} menu. Both automatic and manually
130created playlists can be edited using this menu.
Martin Arver8e8207f2006-02-11 00:57:17 +0000131
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000132\begin{description}
133\item[Create Playlist:]
134 Rockbox will create a playlist with all tracks in the current directory
135and all subdirectories. The playlist will be created one folder level ``up''
136from where you currently are.
Martin Arver29d5dba2006-03-28 22:46:49 +0000137
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000138\item[View Current Playlist:]
Martin Arver29d5dba2006-03-28 22:46:49 +0000139 Displays the contents of the playlist currently stored in memory.
140
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000141\item[Save Current Playlist:]
142 Saves the current dynamic playlist, excluding queued tracks, to the
143specified file. If no path is provided then playlist is saved to current
Martin Arver26c6e7b2006-08-01 11:57:38 +0000144directory (see \reference{ref:Playlistsubmenu}).
Martin Arver29d5dba2006-03-28 22:46:49 +0000145
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000146\item[Recursively Insert Directories: ]
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000147 If set to \setting{On}, then when a directory is inserted or queued into a
148 dynamic playlist, all subdirectories will also be inserted. If set to \setting{Ask},
149 Rockbox will prompt the user about whether to include subdirectories.
150 Options: \setting{Off}, \setting{Ask}, \setting{On}
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000151
152\item[Warn When Erasing Dynamic Playlist: ]
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000153 If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
154 take an action that will cause Rockbox to erase the current dynamic playlist.
155 Options: \setting{Yes}, \setting{No}
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000156\end{description}
Martin Arver8e8207f2006-02-11 00:57:17 +0000157
158\section{Browse Plugins}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000159 With this option you can load and run various plugins that have been
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000160written for Rockbox. There are a wide variety of these supplied with
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000161Rockbox, including several games, some impressive demos and a number of
Martin Arver7a473132006-07-31 12:21:57 +0000162utilities. A detailed description of the different plugins is to be found in
Martin Arver26c6e7b2006-08-01 11:57:38 +0000163\reference{ref:plugins}.
Martin Arver8e8207f2006-02-11 00:57:17 +0000164
165\section{\label{ref:Info}Info}
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000166 This option shows RAM buffer size, battery voltage level and estimated time
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000167remaining, disk total space and disk free space.
168\opt{player}{Use the MINUS and PLUS keys to step through several
169pages of information.}
Martin Arver8e8207f2006-02-11 00:57:17 +0000170
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000171\begin{description}
172\item[Rockbox Info:]
173 Displays some basic system information. This is, from top to bottom,
174the amount of memory Rockbox has available for storing music (the buffer),
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000175battery status, hard disk size and the amount of free space on the disk.
Martin Arver29d5dba2006-03-28 22:46:49 +0000176
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000177\item[Version:]
Martin Arver29d5dba2006-03-28 22:46:49 +0000178 Software version and credits display.
179
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000180\item[Debug (Keep Out!):]
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000181 This submenu is intended to be used \emph{only} by Rockbox developers.
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000182 It shows hardware, disk, battery status and other technical information.
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000183 \warn{It is not recommended that users access this menu unless instructed to
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000184 do so in the course of fixing a problem with Rockbox. If you think you have
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000185 messed up your settings by use of this menu please try to reset \emph{all}
186 settings before asking for help.}
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000187\end{description}
Martin Arver8e8207f2006-02-11 00:57:17 +0000188
Martin Arverec3b2932006-03-30 21:21:46 +0000189\opt{player}{
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000190 \section{Shutdown}
191 This menu option saves the Rockbox configuration and turns off the hard
192 drive before shutting down the machine. For maximum safety this procedure
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000193 is recommended when turning off the \dap. (There is a very small risk
Martin Arver26c6e7b2006-08-01 11:57:38 +0000194 of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000195 for more details.
Martin Arverec3b2932006-03-30 21:21:46 +0000196}
Dominik Riebeling1212dce2006-04-02 10:57:54 +0000197
Nils Wallménius792f64e2006-07-22 09:46:31 +0000198\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000199{
Dominik Riebelingcb3e6962006-04-04 12:27:28 +0000200\section{Quick Menu}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000201 Whilst not strictly part of the \setting{Main Menu}, it is worth noting that a few
202 of the more commonly used settings are available from the \setting{Quick Menu}.
203 The \setting{Quick Menu} screen is accessed by holding the
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000204 \opt{RECORDER_PAD}{\ButtonFTwo}
205 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000206 \opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonMenu}
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000207 \opt{IAUDIO_X5_PAD}{\ButtonRec}
Michael DiFebboe28e2fc2006-05-12 16:56:21 +0000208 key, and it allows rapid access to the \setting{Shuffle} and \setting{Repeat} modes
Martin Arver26c6e7b2006-08-01 11:57:38 +0000209 (\reference{ref:PlaybackOptions})
210 and the \setting{Show Files} option (\reference{ref:ShowFiles}).
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000211}